feat: initial commit

Author: jfrosorio

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+### Description
+
+Explain what are you submitting.
+
+### Fixes
+
+Enter the issue you are fixing (e.g. This fixes #1.).
+
+
+
+

.gitignore

@@ -0,0 +1 @@
+/.idea

README.md

@@ -1,2 +1,85 @@
-# laravel-settingable
+# Laravel Settingable
+
 Endow your Laravel models with settings!
+
+[![Latest version](https://img.shields.io/github/release/CodeTechPt/laravel-settingable?style=flat-square)](https://github.com/CodeTechPt/laravel-settingable/releases)
+[![GitHub license](https://img.shields.io/github/license/CodeTechPt/laravel-settingable?style=flat-square)](https://github.com/CodeTechPt/laravel-settingable/blob/master/LICENSE)
+
+
+## Installation
+
+Add the package to your Laravel app using composer
+
+```
+composer require codetech/laravel-settingable
+```
+
+
+### Service Provider
+
+Register the package's service provider in config/app.php. In Laravel versions 5.5 and beyond, this step can be skipped if package auto-discovery is enabled.
+
+```
+'providers' => [
+
+    ...
+    CodeTech\Settingable\Providers\SettingableServiceProvider::class,
+    ...
+
+];
+```
+
+
+### Migrations
+
+Execute the next Artisan command to run the migrations.
+
+```
+php artisan migrate
+
+```
+
+
+## Usage
+
+To start logging CRUD operations simply use the trait on your models.
+
+```
+
+use CodeTechCMS\Settingable\Traits\Settingable;
+
+class Theme extends Model
+{
+    use Settingable;
+
+    ...
+```
+
+### Retrieve model settings
+
+#### Querying the database
+```
+// Get all settings
+$settings = $theme->settings;
+
+// Get settings from a specific scope
+$scopedSettings = $theme->settings()->ofScope('colors')->get();
+```
+
+#### Using the config helper
+```
+config('theme.colors.primary');
+```
+
+
+---
+
+
+## License
+
+**codetech/laravel-settingable** is open-sourced software licensed under the [MIT license](https://github.com/CodeTechPt/laravel-settingable/blob/master/LICENSE).
+
+
+## About CodeTech
+
+[CodeTech](https://www.codetech.pt) is a web development agency based on Matosinhos, Portugal. Oh, and we LOVE Laravel!

composer.json

@@ -0,0 +1,37 @@
+{
+  "name": "codetech/laravel-settingable",
+  "description": "Endow your Laravel models with settings!",
+  "keywords": [
+    "codetech",
+    "laravel-settingable",
+    "laravel",
+    "settings",
+    "polymorphic"
+  ],
+  "authors": [
+    {
+      "name": "José Osório",
+      "email": "jfrosorio@gmail.com",
+      "role": "Developer"
+    }
+  ],
+  "license": "MIT",
+  "require": {
+    "php": "^7.2",
+    "laravel/framework": "~6.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "CodeTech\\Settingable\\": "src/"
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "extra": {
+    "laravel": {
+      "providers": [
+        "CodeTech\\Settingable\\Providers\\SettingableServiceProvider"
+      ]
+    }
+  }
+}

src/Models/ModelSetting.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace CodeTechCMS\Settingable\Models;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+class ModelSetting extends Model
+{
+    /**
+     * @inheritDoc
+     */
+    protected $fillable = [
+        'path',
+        'name',
+        'scope',
+        'value'
+    ];
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | Scopes
+    |--------------------------------------------------------------------------
+    */
+
+    /**
+     * Scope a query to only include media items of a given scope.
+     *
+     * @param Builder $query
+     * @param string $scope
+     * @return Builder
+     */
+    public function scopeOfScope(Builder $query, string $scope)
+    {
+        return $query->where('scope', $scope);
+    }
+
+
+    /*
+    |--------------------------------------------------------------------------
+    | Relationships
+    |--------------------------------------------------------------------------
+    */
+
+    /**
+     * Get the owning commentable model.
+     */
+    public function settingable()
+    {
+        return $this->morphTo();
+    }
+}

src/Providers/SettingableServiceProvider.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace CodeTechCMS\Settingable\Providers;
+
+use CodeTechCMS\Settingable\Models\ModelSetting;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\ServiceProvider;
+
+class SettingableServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->mergeConfigFrom(
+            __DIR__ . '/../config/settingable.php', 'settingable'
+        );
+    }
+
+    /**
+     * Bootstrap services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        // Load migrations from custom path
+        $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
+
+        $this->setPublishableFiles();
+
+        if (config('settingable.load_into_memory')) {
+            $this->loadSettings();
+        }
+    }
+
+    /**
+     * Set which files can be published.
+     */
+    private function setPublishableFiles()
+    {
+        $this->publishes([
+            __DIR__ . '/../config/settingable.php' => config_path('settingable.php')
+        ], 'config');
+
+        $this->publishes([
+            __DIR__ . '/../database/migrations/' => database_path('migrations')
+        ], 'migrations');
+    }
+
+    /**
+     * Load settings into memory.
+     */
+    private function loadSettings()
+    {
+        $settings = ModelSetting::select('root', 'path', 'value')->get();
+
+        $results = [];
+
+        foreach ($settings as $setting) {
+            $fullPath = $setting->root . '.' . $setting->path;
+
+            $keys = explode('.', $fullPath);
+
+            $temp = &$results;
+
+            foreach ($keys as $key) {
+                $temp = &$temp[$key];
+            }
+
+            $temp = $setting->value;
+
+            unset($temp);
+        }
+
+        foreach ($results as $key => $result) {
+            if (!is_array($result)) {
+                Config::set($key, $result);
+
+                continue;
+            }
+
+            $configs = config($key) ? array_merge(config($key), $result) : $result;
+
+            Config::set($key, $configs);
+        }
+    }
+}

src/Traits/Settingable.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace CodeTechCMS\Settingable\Traits;
+
+use CodeTechCMS\Settingable\Models\ModelSetting;
+
+trait Settingable
+{
+    /**
+     * Get all of this model's settings.
+     */
+    public function settings()
+    {
+        return $this->morphMany(ModelSetting::class, 'settingable');
+    }
+
+}

src/config/settingable.php

@@ -0,0 +1,17 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Load from database
+    |--------------------------------------------------------------------------
+    |
+    | Determines whether settings should be loaded into memory. When set
+    | to true, settings will be accessible using the config() helper.
+    |
+    */
+
+    'load_into_memory' => true,
+
+];