Initial commit

Author: webstractions

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,6 @@
+.cache-loader
+node_modules
+npm-debug.log
+yarn-error.log
+vendor
+.idea

README.md

@@ -0,0 +1,232 @@
+# Roots\Sage Developer Extensions
+
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![Build Status](https://img.shields.io/travis/appstract/laravel-blade-directives/master.svg?style=flat-square)](https://travis-ci.org/webstractions/sage955)
+
+A collection of extensions for your Roots\Sage themes.
+
+- **Blade Directives:** @directives for loop, query, sidebar, FontAwesome, and more.
+- **Whoops Pretty Debugger:** PHP error handler for cool kids .
+- **GetTheImage:** (very soon) Adapted version of Justin Tadlock's plugin for Sage use.
+- **Schema Attributes:** (planned) Add schema.org attributes with no fuss.
+- **Template Utilities:** (planned) Bootstrap Walker Menu, filter/action configurations, etc.
+- **Sage CLI:** (planned) A Sage counterpart to Laravel Artisan.
+
+## Requirements
+This package is specifically built for `Roots\Sage 9.0.0-beta.4` and above. It goes without saying that your development server needs to have `Php 7.0` or greater as well.
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require webstractions/sage-devtools
+```
+
+## Whoops Setup
+Add the following to the top of your `app\setup.php` file. The higher up the better, preferrably following all of the `use` statements:
+
+```php
+namespace App;
+
+use Roots\Sage\Container;
+use Roots\Sage\Assets\JsonManifest;
+use Roots\Sage\Template\Blade;
+use Roots\Sage\Template\BladeProvider;
+use This\Other\Class\Too;
+
+// Copy this part into app\setup.php
+function registerWhoops() {
+    $whoops = new \Whoops\Run;
+    $whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler);
+    $whoops->register();
+}
+registerWhoops();
+```
+
+## Blade Directives Setup
+
+Add to your `after_theme_setup` action in `app/setup.php` file. It is important that you make this addition **after** Sage's singleton for the `BladeProvider`:
+
+```php
+add_action('after_setup_theme', function (){
+
+  /**
+    * Add Blade to Sage container
+    */
+  sage()->singleton('sage.blade', function (Container $app) {
+      $cachePath = config('view.compiled');
+      if (!file_exists($cachePath)) {
+          wp_mkdir_p($cachePath);
+      }
+      (new BladeProvider($app))->register();
+      return new Blade($app['view']);
+  });
+
+  // Copy this part into app\setup.php after_theme_setup action.
+  // Make sure it follows the Sage singleton for the Blade Provider.
+  (new \SageDevTools\Blade\DirectivesProvider(sage()))->register();
+
+});
+```
+
+## Blade Directives Usage
+
+### @loop
+
+```blade
+@loop
+
+   {{-- Code inside of the loop --}}
+
+@endloop
+```
+Output:
+
+```php
+if (have_posts()) :
+  while(have_posts()) :
+    the_post();
+
+    // Code inside of the loop
+
+  endwhile;
+endif;
+```
+
+### @query( $query )
+
+```blade
+@query('expression')
+
+   {{-- Code inside of your new query loop --}}
+
+@endquery
+```
+
+Output:
+```php
+$__query = new WP_Query(' . $expression . ');
+if ($__query->have_posts()) :
+  while($__query->have_posts()) :
+    $__query->the_post(); ?>";
+
+    // Code inside of your new query loop
+
+  endwhile;
+endif;
+```
+
+### @doaction( $action )
+
+```blade
+@doaction('before_header')
+```
+
+### @sidebar( $location )
+
+```blade
+@sidebar('primary')
+```
+
+### @wphead and @wpfooter
+
+```blade
+@wphead
+@wpfooter
+```
+
+### @fa
+
+Quickly output a Font Awesome icon.
+
+```blade
+@fa('address-book')
+```
+
+
+### @istrue
+
+Only show when ```$variable``` isset and true.
+
+```blade
+@istrue($variable)
+   This will be echoed
+@endistrue
+```
+
+Or when you would like to quickly echo
+
+```blade
+@istrue($variable, 'This will be echoed')
+```
+
+### @isfalse
+
+Same as ```@istrue``` but checks for isset and false.
+
+```blade
+@isfalse($variable)
+   This will be echoed
+@endisfalse
+```
+
+### @dump and @dd
+
+```blade
+@dump($var)
+
+@dd($var)
+```
+
+### @mix
+
+Create a HTML element to your Laravel-Mix css or js.
+```blade
+@mix('/css/app.css')
+@mix('/css/app.js')
+```
+Output:
+
+```blade
+<link rel="stylesheet" href="{{ mix('/css/app.css') }}">
+<script src="{{ mix('/css/app.js') }}"></script>
+```
+
+### @style
+
+Create a ```<style>``` element or ```<link>``` element with a css path.
+
+```blade
+@style
+    body { background: black }
+@endstyle
+
+
+@style('/css/app.css')
+```
+
+### @script
+
+Create a ```<script>``` element with or without a js path.
+
+```blade
+@script
+    alert('hello world')
+@endscript
+
+
+@script('/js/app.js')
+```
+
+### @inline
+
+Load the contents of a css or js file inline in your view.
+
+```blade
+@inline('/js/manifest.js')
+```
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,31 @@
+{
+    "name": "webstractions/sage-devtools",
+    "description": "Extends Sage ~9-beta with handy development tools. ",
+    "type": "package",
+    "keywords": [
+        "webstractions",
+        "roots",
+        "sage"
+    ],
+    "homepage": "https://github.com/webstractions/sage-devtools",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Ron Pugmire",
+            "homepage": "https://github.com/webstractions",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=7"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.7",
+        "filp/whoops": "^2.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "SageDevTools\\": "src"
+        }
+    }
+}

config/.gitkeep

@@ -0,0 +1,21 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Directives
+    |--------------------------------------------------------------------------
+    |
+    | This is a list of directives you'd like to register.
+    | Use the directive name as key, and a closure.
+    |
+    */
+
+    'directives' => [
+
+        // 'name' => function($expresion) {}
+
+    ],
+
+];

config/blade-directives.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace SageDevTools\Blade;
+
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\ServiceProvider;
+use Roots\Sage\Container;
+
+class DirectivesProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     */
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__.'/../config/blade-directives.php' => config_path('blade-directives.php'),
+            ], 'config');
+        }
+
+        $this->registerDirectives();
+    }
+
+    /**
+     * Register the application services.
+     */
+    public function register()
+    {
+        $this->registerDirectives($this->app);
+        $this->mergeConfigFrom(__DIR__.'/../../config/blade-directives.php', 'blade-directives');
+    }
+
+    /**
+     * Register all directives.
+     *
+     * @return void
+     */
+    public function registerDirectives($app)
+    {
+        $directives = require __DIR__.'/directives.php';
+
+        $sageBlade = $app->get('sage.blade');
+
+        // $directives = array_merge(
+        //     $directives,
+        //     Config::get('blade-directives.directives')
+        // );
+
+        DirectivesRepository::register($directives, $sageBlade);
+    }
+}

src/Blade/DirectivesProvider.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace SageDevTools\Blade;
+
+// use Illuminate\Support\Facades\Blade;
+use Roots\Sage\Container;
+
+class DirectivesRepository
+{
+    /**
+     * Register the directives.
+     *
+     * @param  array $directives
+     * @return void
+     */
+    public static function register(array $directives, $sageBlade )
+    {
+
+        collect($directives)->each(function ($item, $key) use($sageBlade) {
+            $sageBlade->compiler()->directive($key, $item);
+        });
+    }
+
+    /**
+     * Parse expression.
+     *
+     * @param  string $expression
+     * @return \Illuminate\Support\Collection
+     */
+    public static function parseMultipleArgs($expression)
+    {
+        return collect(explode(',', $expression))->map(function ($item) {
+            return trim($item);
+        });
+    }
+
+    /**
+     * Strip single quotes.
+     *
+     * @param  string $expression
+     * @return string
+     */
+    public static function stripQuotes($expression)
+    {
+        return str_replace("'", '', $expression);
+    }
+}