Initial commit

Author: Log1x

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.php]
+indent_size = 4

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Brandon Nifong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,102 @@
+# Sage SVG
+
+[![Latest Stable Version](https://poser.pugx.org/log1x/sage-svg/v/stable)](https://packagist.org/packages/log1x/sage-svg) 
+[![Total Downloads](https://poser.pugx.org/log1x/sage-svg/downloads)](https://packagist.org/packages/log1x/sage-svg)
+
+Sage SVG is a simple package for handling inline SVG's in your Sage 10 projects. 
+
+## Requirements
+
+- [Sage](https://github.com/roots/sage) >= 10.0
+- [PHP](https://secure.php.net/manual/en/install.php) >= 7.1.3
+- [Composer](https://getcomposer.org/download/)
+
+## Installation
+
+Install via Composer:
+
+```bash
+$ composer require log1x/sage-svg
+```
+
+## Usage
+
+By default, the following paths are checked for your SVG (in order):
+
+- If passed an array containing `id`, it is assumed to be a WordPress attachment and is ran through [`get_attached_file()`](https://codex.wordpress.org/Function_Reference/get_attached_file).
+- Your default asset manifest (usually `mix-manifest.json`).
+- Path relative to `config('svg.path')` which is `public_path()` (`dist/`) by default.
+- Absolute web root path.
+
+### Blade directive
+
+Unless you require advance functionality from somewhere such as a Controller, the best way to use Sage SVG is with the Blade directive straight in your templates.
+
+```php
+# Relative path (with dot notation)
+@svg('images.logo')
+
+# Absolute path from webroot with `w-32 h-auto` CSS classes and an aria-label
+@svg('app/uploads/2019/07/logo.svg', 'w-32 h-auto', ['aria-label' => 'Logo'])
+```
+
+### Helper
+
+The easiest way to use SVG outside of a Blade template is the global `get_svg()` helper function. `get_svg()` will return `false` if no image is found.
+
+```php
+# Relative path
+$image = get_svg('images.logo');
+
+# Absolute path from webroot with `w-32 h-auto` CSS classes
+$image = get_svg('app/uploads/2019/07/logo.svg', 'w-32 h-auto');
+
+# WordPress attachment (e.g. ACF field) with `my-logo` CSS class
+$image = get_svg(
+    get_field('logo_svg'),
+    'my-logo'
+); 
+```
+
+### App Container
+
+While it's easier to use the Helper function, if it not available or sane for your scenario, you can render your SVG using the initialized `SageSvg` instance from the app container.
+
+```php
+use function Roots\app;
+
+$image = app(SageSvg::class)->render('images.logo');
+```
+
+## Configuration
+
+The configuration file, `svg.php`, can be published using Acorn:
+
+```bash
+$ wp acorn vendor:publish --provider='Log1x\SageSvg\SageSvgServiceProvider'
+```
+
+You can read the DocBlocks in `config/svg.php` for more details.
+
+## Why another SVG Package?
+
+> Didn't you author Blade SVG Sage? Why another SVG package?
+
+While I do have my fork of [Blade SVG](https://github.com/adamwathan/blade-sage-svg) called [Blade SVG Sage](https://github.com/log1x/blade-svg-sage), I find it rather underwhelming due to the following reasons:
+
+- Unable to handle WordPress attachments
+- Unable to inline SVG's that aren't set in a specific path
+- Unable to properly use the asset manifest.
+- I know QWp6t
+
+## Bug Reports
+
+If you discover a bug in Sage SVG, please [open an issue](https://github.com/log1x/sage-svg/issues).
+
+## Contributing
+
+Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.
+
+## License
+
+Sage SVG is provided under the [MIT License](https://github.com/log1x/sage-svg/blob/master/LICENSE.md).

composer.json

@@ -0,0 +1,38 @@
+{
+  "name": "log1x/sage-svg",
+  "type": "package",
+  "license": "MIT",
+  "description": "A simple package for handling inline SVG's in Sage 10 projects.",
+  "authors": [
+    {
+      "name": "Brandon Nifong",
+      "email": "[email protected]"
+    }
+  ],
+  "keywords": [
+    "wordpress",
+    "sage",
+    "svg"
+  ],
+  "support": {
+    "issues": "https://github.com/log1x/sage-svg/issues"
+  },
+  "autoload": {
+    "psr-4": {
+      "Log1x\\SageSvg\\": "src/"
+    },
+    "files": [
+      "src/helpers.php"
+    ]
+  },
+  "require": {
+    "php": ">=7.1.3"
+  },
+  "extra": {
+    "acorn": {
+      "providers": [
+        "Log1x\\SageSvg\\SageSvgServiceProvider"
+      ]
+    }
+  }
+}

config/svg.php

@@ -0,0 +1,32 @@
+<?php
+
+use function Roots\public_path;
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Path
+    |--------------------------------------------------------------------------
+    |
+    | This value is the default path used by SageSVG for finding SVG files.
+    | This path is then resolved internally if an absolute path is not being
+    | used.
+    |
+    */
+
+    'path' => public_path(),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Class
+    |--------------------------------------------------------------------------
+    |
+    | Here you can specify a default class to be added on all inlined SVGs.
+    | Much like how you would define multiple classes in an HTML attribute,
+    | you may separate each class using a space.
+    |
+    */
+
+    'class' => '',
+];

src/SageSvg.php

@@ -0,0 +1,175 @@
+<?php
+
+namespace Log1x\SageSvg;
+
+use Illuminate\Support\HtmlString;
+use Illuminate\Support\Str;
+use Illuminate\Filesystem\Filesystem;
+
+use function Roots\asset;
+
+class SageSvg
+{
+    /**
+     * Files
+     *
+     * @var \Illuminate\Filesystem\Filesystem
+     */
+    protected $files;
+
+    /**
+     * Config
+     *
+     * @var array
+     */
+    protected $config = [
+        'path' => '',
+        'class' => ''
+    ];
+
+    /**
+     * Initialize SVG
+     *
+     * @param  array $config
+     * @return void
+     */
+    public function __construct($config = [])
+    {
+        $this->config = collect($this->config)->merge($config);
+        $this->cache = collect();
+        $this->files = new Filesystem;
+    }
+
+    /**
+     * Render the SVG as HTML
+     *
+     * @param  string       $image
+     * @param  string|array $class
+     * @param  array        $attrs
+     * @return \Illuminate\Support\HtmlString
+     */
+    public function render($image, $class = '', $attrs = [])
+    {
+        if (is_array($class)) {
+            $class = implode(' ', $class);
+        }
+
+        $attrs = collect($attrs)->merge([
+            'class' => $this->buildClass($class)
+        ])->filter()->all();
+
+        return new HtmlString(
+            str_replace(
+                '<svg',
+                sprintf('<svg%s', $this->buildAttributes($attrs)),
+                $this->get(
+                    $this->prepare($image)
+                )
+            )
+        );
+    }
+
+    /**
+     * Get SVG from Filesystem
+     *
+     * @param  string|array $image
+     * @return mixed
+     */
+    protected function get($image)
+    {
+        if (asset($image)->exists()) {
+            return trim(
+                asset($image)->contents()
+            );
+        }
+
+        if ($this->files->exists($image)) {
+            return trim(
+                $this->files->get($image)
+            );
+        }
+
+        if ($this->files->exists($this->withPath($image))) {
+            return trim(
+                $this->files->get($this->withPath($image))
+            );
+        }
+
+        return sprintf('<!-- %s not found. -->', $image);
+    }
+
+    /**
+     * Return a prepared SVG image path.
+     *
+     * @param  string|array $image
+     * @return string
+     */
+    protected function prepare($image)
+    {
+        if (is_array($image) && ! empty($image['id'])) {
+            return get_attached_file($image['id']);
+        }
+
+        if (is_string($image)) {
+            if (Str::startsWith($image, '/')) {
+                $image = Str::replaceFirst('/', '', $image);
+            }
+
+            if (! Str::contains($image, '/')) {
+                $image = str_replace('.', '/', $image);
+            }
+
+            return Str::finish(
+                strtok($image, '?'),
+                '.svg'
+            );
+        }
+
+        return $image;
+    }
+
+    /**
+     * Return the passed string alongside the config path.
+     *
+     * @param  string $image
+     * @return string
+     */
+    protected function withPath($image)
+    {
+        return Str::finish($this->config->get('path'), '/') . $image;
+    }
+
+    /**
+     * Build CSS Classes
+     *
+     * @param  string $class
+     * @return string
+     */
+    protected function buildClass($class)
+    {
+        return trim(
+            sprintf('%s %s', $this->config->get('class'), $class)
+        );
+    }
+
+    /**
+     * Build element attributes.
+     *
+     * @param  array $attrs
+     * @return string
+     */
+    protected function buildAttributes($attrs = [])
+    {
+        if (empty($attrs)) {
+            return '';
+        }
+
+        return ' ' . collect($attrs)->map(function ($value, $attr) {
+            if (is_int($attr)) {
+                return $value;
+            }
+
+            return sprintf('%s="%s"', $attr, $value);
+        })->implode(' ');
+    }
+}