initial commit

Author: kykurniawan

.gitignore

@@ -0,0 +1 @@
+/vendor/

CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# Code of Conduct
+
+### Our Pledge
+
+We, as contributors and maintainers, pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+For answers to common questions about this code of conduct, see [FAQ](https://www.contributor-covenant.org/faq).

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+We welcome and encourage community contributions to enhance the "Laravel Settings" package. Whether you want to report a bug, suggest a new feature, or actively participate in development, your input is invaluable.
+
+Here's how you can get involved:
+
+1. **Reporting Issues:**
+
+   - If you encounter a bug or have a suggestion for an improvement, please open an issue on our [GitHub repository](https://github.com/ruangdeveloper/laravel-settings/issues).
+
+2. **Feature Requests:**
+
+   - If you have an idea for a new feature or enhancement, feel free to create an issue on our GitHub repository with the "Feature Request" label. We'll review and discuss it with the community.
+
+3. **Pull Requests:**
+
+   - If you're a developer and would like to contribute directly, you can submit a pull request. Please ensure the following:
+     - Fork the repository and create a feature branch for your changes.
+     - Write clear and comprehensive documentation for new features.
+     - Make sure your code adheres to our coding standards and passes any existing tests.
+     - Open a pull request with a detailed description of the changes you've made.
+
+4. **Documentation:**
+
+   - We greatly appreciate improvements to our documentation. If you find gaps or have suggestions for clearer explanations, please submit documentation updates.
+
+5. **Spreading the Word:**
+   - If you enjoy using "Laravel Settings," consider sharing it with others. The more users and contributors we have, the better the package becomes.
+
+By participating in this open-source project, you become an integral part of the "Laravel Settings" community, and together we can create a powerful and versatile package.
+
+**Code of Conduct:**
+
+To ensure a welcoming and respectful environment for all contributors, please review and abide by our [Code of Conduct](https://github.com/ruangdeveloper/laravel-settings/CODE_OF_CONDUCT.md). We have a zero-tolerance policy for harassment or discrimination, and we're committed to fostering a collaborative and inclusive community.
+
+Thank you for considering contributing to "Laravel Settings." Your involvement helps us improve and expand the package, benefiting developers worldwide.

LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 Ruang Developer
+
+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,215 @@
+# Laravel Settings
+
+Introducing "Laravel Settings" – a powerful and flexible Laravel package designed to simplify the management of application settings, both at the global and model-specific levels. With this package, developers can effortlessly store, retrieve, and customize settings within the database, enhancing the configuration and flexibility of Laravel-based projects.
+
+Whether you need to manage site-wide configurations, user preferences, or any other form of customizable settings, "Laravel Settings" provides an elegant solution to streamline the process. It offers a clean and intuitive API, ensuring that you can get started quickly without any steep learning curve.
+
+## Key Features:
+
+- Global and Model-Specific Settings: "Laravel Settings" allows you to define both global settings, which apply to your entire application, and model-specific settings, which are associated with specific Eloquent models.
+
+- Easy Configuration: You can define settings in a configuration file, making it a breeze to set up and manage your application's settings.
+
+- Customizable: The package offers the flexibility to create custom setting types, ensuring that you can handle various data types, validation rules, and display options.
+
+- Eloquent Integration: "Laravel Settings" seamlessly integrates with Laravel's Eloquent ORM, enabling you to link settings to specific database records.
+
+## Requirements
+
+- Laravel ^10.0
+
+## Installation:
+
+To get started with "Laravel Settings," follow these simple installation steps:
+
+Install the package via Composer:
+
+```bash
+composer require ruangdeveloper/laravel-settings
+```
+
+**Publish the configuration file:**
+
+```bash
+php artisan vendor:publish --provider="RuangDeveloper\LaravelSettings\LaravelSettingsServiceProvider" --tag="config"
+```
+
+Configure the settings in `config/laravel-settings.php` according to your application's requirements.
+
+**Publish the migration file**
+
+```bash
+php artisan vendor:publish --provider="RuangDeveloper\LaravelSettings\LaravelSettingsServiceProvider" --tag="migrations"
+```
+
+## Usage
+
+Let's take a quick look at how you can use "Laravel Settings" to manage a global setting for your application.
+
+**Set a global setting**
+
+```php
+use RuangDeveloper\LaravelSettings\Facades\Settings;
+
+// setting the global site title
+Settings::set('site_title', 'Your Awesome Website');
+
+```
+
+**Get a global setting**
+
+```php
+use RuangDeveloper\LaravelSettings\Facades\Settings;
+
+// retrieve the global site title
+$siteTItle = Settings::get('site_title');
+
+// you may want to add a default fallback value if the setting
+// with provided key doesn't exists in the database
+$siteTitle = Settings::get('site_title', 'Your Default Awesome Website');
+```
+
+### Forget a global setting
+
+Now, if you want to delete the setting
+
+```php
+use RuangDeveloper\LaravelSettings\Facades\Settings;
+
+Settings::forget('site_title');
+```
+
+## Model Specific Setting
+
+This package allow you to link the setting to a specific model. For example, you may want to store user's preferences.
+
+**Model Configuration**
+The first step before linking the setting to a specific model, you need to configure your model to use the `HasSettings` traits.
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use RuangDeveloper\LaravelSettings\Traits\HasSettings;
+
+class User extends Model
+{
+    use HasSettings; // use the HasSettings trait
+
+    protected $guarded = [];
+}
+
+```
+
+Now, you can use the setting for an user.
+
+**Set a setting**
+
+```php
+$user = App\Models\User::find(1);
+$user->setSetting('subscribe_newsletter', true);
+```
+
+**Get a setting**
+
+```php
+$user = App\Models\User::find(1);
+$isSubscribed = $user->getSetting('subscribe_newsletter');
+
+// you may want to add a default fallback value if the setting
+// with provided key doesn't exists in the database
+$isSubscribed = $user->getSetting('subscribe_newsletter', false);
+//
+```
+
+**Forget a setting**
+
+```php
+$user = App\Models\User::find(1);
+$user->forgetSetting('subscribe_newsletter');
+```
+
+## Default Settings
+
+You may want add default settings value for global or model specific settings. You can add these settings value in the configuration file located at `configs/laravel-settings.php`.
+
+> Note: if you cannot find the config file, you need to publish the configuration first.
+
+**Default global settings**
+
+```php
+return [
+    // others config
+
+    'defaults' => [
+        'site_title' => 'Your Awesome Site',
+    ],
+];
+```
+
+Now, you will always get the default site title setting if there is no setting stored in the database.
+
+```php
+use RuangDeveloper\LaravelSettings\Facades\Settings;
+
+
+$siteTItle = Settings::get('site_title');
+
+echo $siteTitle; // Your Awesome Site
+```
+
+**Default model specific settings**
+
+```php
+return [
+    // others config
+
+    'model_defaults' => [
+        'App\Models\User' => [
+            'subscribe_newsletter' => false
+        ],
+    ],
+];
+```
+
+Now, you will always get the default subscribe newsletter setting when you try to retrieve it from an user that didn't have setting for subscribe newsletter.
+
+```php
+$user = App\Models\User::find(1);
+$isSubscribed = $user->getSetting('subscribe_newsletter');
+
+echo $isSubscribed // false
+```
+
+## Customization
+
+### Using Your Own Model
+
+While this package covers almost everything that you need to manage the settings, you may want to use your own model. To do this, you can extends the Setting model from this package.
+
+```php
+use RuangDeveloper\LaravelSettings\Models\Setting;
+
+class CustomSetting extends Setting
+{
+    //
+}
+```
+
+After that, you need to tell this package to use the model you just created. Please update in the `configs/laravel-settings.php`.
+
+```php
+return [
+    // others config
+
+    'model' => App\Models\CustomSetting::class,
+];
+```
+
+Certainly, adding a "Contributing" section to your package's documentation is a great way to invite other developers to collaborate and make your package even better. Here's a sample "Contributing" section that you can include:
+
+# Contributing
+
+https://github.com/ruangdeveloper/laravel-settings/CONTRIBUTING.md
+
+# License
+
+https://github.com/ruangdeveloper/laravel-settings/LICENSE.md

composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "ruangdeveloper/laravel-settings",
+    "description": "Manage model or application settings in database",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "RuangDeveloper\\LaravelSettings\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "RuangDeveloper\\LaravelSettings\\LaravelSettingsServiceProvider"
+            ]
+        }
+    },
+    "authors": [
+        {
+            "name": "Ruang Developer",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require": {
+        "laravel/framework": "^10.0.0"
+    }
+}