first public release

Author: kiroushi

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,5 @@
+/vendor
+composer.phar
+composer.lock
+.DS_Store
+.idea

.scrutinizer.yml

@@ -0,0 +1,18 @@
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true

.travis.yml

@@ -0,0 +1,17 @@
+language: php
+
+php:
+  - 7.2
+  - 7.3
+
+env:
+  matrix:
+    - COMPOSER_FLAGS="--prefer-lowest"
+    - COMPOSER_FLAGS=""
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+
+script:
+  - phpunit --coverage-text --coverage-clover=coverage.clover

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to `laravel-db-blade` will be documented in this file
+
+## 0.1.0 - 2019-04-16
+- first public release

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2019 © Javier Pérez — [email protected]
+
+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,116 @@
+# Laravel DB Blade
+
+
+## Render Blade templates from Eloquent Model Fields
+
+This package allows you to render Blade templates from a database model instead of files. It is based on [Flynsarmy](https://github.com/Flynsarmy/)'s [**laravel-db-blade-compiler**](https://github.com/Flynsarmy/laravel-db-blade-compiler).
+
+
+## Installation
+
+You can install the package via composer:
+
+``` bash
+composer require kiroushi/laravel-db-blade
+```
+
+Publish the assets using artisan:
+
+```bash
+php artisan vendor:publish
+```
+
+And then set up your DbView model in the `config/db-blade.php` configuration file. A default model (**Kiroushi\DbBlade\Models\DbView**) is included in the package:
+
+```php
+return [
+
+    'model_name' => 'Kiroushi\DbBlade\Models\DbView',
+    'table_name' => 'db_views',
+
+    /**
+     * The default name field used to look up for the model.
+     * e.g. DbView::make($viewName) or dbview($viewName)
+     */
+    'name_field' => 'name',
+
+    /**
+     * The default model field to be compiled when not explicitly specified
+     * with DbView::field($fieldName) or DbView::model($modelName, $fieldName)
+     */
+    'content_field' => 'content',
+
+    /**
+     * This property will be added to models being compiled with DbView
+     * to keep track of which field in the model is being compiled
+     */
+    'model_property' => '__db_blade_compiler_content_field',
+
+    'cache' => false,
+    'cache_path' => 'app/db-blade/cache/views'
+
+];
+```
+
+After the configuration and ensuring that the migration has been published, you can create the database views table by running the migrations:
+
+```bash
+php artisan migrate
+```
+
+## Usage
+
+This package offers a `DbView` facade with the exact same syntax and functionality than `View`:
+
+```php
+return DbView::make('home')->with(['foo' => 'bar']);
+```
+
+You can also use the `dbview()` helper matching Laravel's base `view()` helper functionality. If no arguments are supplied, the factory is returned:
+
+```php
+return dbview()->make('home')->with(['foo' => 'bar']);
+```
+
+If a string is supplied, a view with that name will be looked up for and rendered:
+
+```php
+return dbview('home')->with(['foo' => 'bar']);
+```
+
+### Overriding settings at runtime
+
+You can override individual settings for the model, name field and content field by using associated methods:
+
+```php
+return DbView::make('home')->model('App\Template');
+
+return DbView::make('home')->field('template_name');
+
+// You can also pass the model and name field as a shorthand:
+return DbView::make('home')->model('App\Template', 'template_name');
+
+// Override content field
+return DbView::make('home')->contentField('template_content');
+
+// ... or a combination of these
+return DbView::make('home')->model('App\Template', 'template_name')->contentField('template_content');
+```
+
+### Cache
+
+By default, cache is disabled in config file. If you enable the setting, a compiled version of the views will be stored at the desired path. If the model is updated, the *updated_at* field will be checked against the file modification date and the view will be re-rendered and cached.
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## To do list
+
+- Expose view finder callback
+- Separate standard view composers from dbview composers.
+- Unit tests
+
+## License
+
+**laravel-db-blade** is open-sourced software licensed under the MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,45 @@
+{
+    "name": "kiroushi/laravel-db-blade",
+    "description": "Render Blade templates from Eloquent Model Fields",
+    "keywords": [
+        "laravel",
+        "blade",
+        "compiler",
+        "eloquent",
+        "model"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Javier Pérez <Kiroushi>",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.2",
+        "laravel/framework": "~5.8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Kiroushi\\DbBlade\\": "src/"
+        },
+        "files": [
+            "src/helpers.php"
+        ]
+    },
+    "minimum-stability": "stable",
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Kiroushi\\DbBlade\\DbBladeCompilerServiceProvider"
+            ],
+            "aliases": {
+                "DbView": "Kiroushi\\DbBlade\\Facades\\DbView"
+            }
+        }
+    }
+}

config/.gitkeep

@@ -0,0 +1,29 @@
+<?php
+
+return [
+
+    'model_name' => 'Kiroushi\DbBlade\Models\DbView',
+    'table_name' => 'db_views',
+
+    /**
+     * The default name field used to look up for the model.
+     * e.g. DbView::make($viewName) or dbview($viewName)
+     */
+    'name_field' => 'name',
+
+    /**
+     * The default model field to be compiled when not explicitly specified
+     * with DbView::field($fieldName) or DbView::model($modelName, $fieldName)
+     */
+    'content_field' => 'content',
+
+    /**
+     * This property will be added to models being compiled with DbView
+     * to keep track of which field in the model is being compiled
+     */
+    'model_property' => '__db_blade_compiler_content_field',
+
+    'cache' => false,
+    'cache_path' => 'app/db-blade/cache/views'
+
+];