wip

Author: semiherdogan

.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

.gitattributes

@@ -0,0 +1,7 @@
+/.github export-ignore
+/tests export-ignore
+/.editorconfig export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/CHANGELOG.md export-ignore
+/CONTRIBUTING.md export-ignore

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Semih ERDOGAN
+
+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

@@ -1,7 +1,57 @@
 # Laravel Eloquent Filters
 
-Create eloquent filters easily
+Create and use eloquent filters easily.
+
+# Installation
+
+You can install the package via composer:
+
+```bash
+$ composer require laratoolbox/database-viewer
+```
+
+# Usage
+
+First create filter like below.
 
 ```shell
 php artisan make:filter UserFilter
 ```
+
+After creating the filter, add Filter trait into your eloquent model.
+
+```php
+use \LaraToolbox\EloquentFilters\Traits\Filters;
+```
+
+Then you may use filter like below.
+
+```php
+MyEloquentModel::filter( new UserFilter(request()) )->get();
+```
+
+# Testing
+
+// TODO:
+
+# Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+# Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+ Credits
+
+- [Semih ERDOGAN](https://github.com/laratoolbox)
+- [Dincer DEMIRCIOGLU](https://github.com/dinncer)
+- [All contributors](https://github.com/laratoolbox/database-viewer/graphs/contributors)
+
+# License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

src/Commands/MakeFilter.php

@@ -48,7 +48,7 @@ public function handle()
                 config('eloquent_filters.namespace', 'App\Filters'),
                 $filterClass,
             ],
-            file_get_contents('../stub/filter.stub') // TODO: make stub customizable
+            $this->getStub()
         );
 
         file_put_contents(
@@ -59,4 +59,10 @@ public function handle()
         $this->info('Filter created.');
         return 0;
     }
+
+    private function getStub()
+    {
+        // TODO: make stub customizable
+        return '<?php'.PHP_EOL.PHP_EOL.file_get_contents('../stub/filter.stub');
+    }
 }

src/PackageServiceProvider.php

@@ -5,7 +5,7 @@
 use Illuminate\Support\ServiceProvider;
 use LaraToolbox\EloquentFilters\Commands\MakeFilter;
 
-class DatabaseViewerServiceProvider extends ServiceProvider
+class PackageServiceProvider extends ServiceProvider
 {
     /**
      * Bootstrap the application services.