Updated README.md. Removed "Active" methods from BaseRepository, added "is_active" condition to __call() method

Author: freevital

README.md

@@ -1,2 +1,208 @@
 # Laravel Repositories
+
 Laravel Repositories to abstract the database layer.
+
+##Installation
+
+Run the following command to install the latest version
+
+```bash
+composer require "freevital/laravel-repository"
+```
+
+##Usage
+
+###Create a Repository
+
+Your repository class must extend `Freevital\Repository\Eloquent\BaseRepository` abstract class and implement method `model()` which returns model's class name.
+
+```php
+namespace App\Repositories\Eloquent;
+
+use Freevital\Repository\Eloquent\BaseRepository;   
+
+class PostRepository extends BaseRepository
+{
+    /**
+     * Specify Model class name.
+     *
+     * @return string
+     */
+    public function model()
+    {
+        return "App\Post";
+    }
+}
+```
+
+###Use the repository in the controller
+
+```php
+namespace App\Http\Controllers;
+
+use App\Http\Controllers\Controller;
+use App\Repositories\Criteria\BySlugCriteria;
+use App\Repositories\Criteria\WithCommentsCriteria;
+use App\Repositories\Eloquent\PostRepository;
+
+class PostController extends Controller
+{
+    /**
+     * @var PostRepository
+     */
+    protected $postRepository;
+
+    /**
+     * @param PostRepository $postRepository
+     */
+    public function __construct(PostRepository $postRepository)
+    {
+        $this->postRepository = $postRepository;
+    }
+
+    /**
+     * Get all posts.
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function index()
+    {
+        $posts = $this->postRepository->all();
+    
+        return \Response::json(compact('posts'));
+    }
+}
+```
+
+###Create a Repository Criteria
+
+Optionally you may create a separate Criteria class to apply specific query conditions. Your Criteria class must implement `Freevital\Repository\Contracts\CriteriaContract` interface.
+
+```php
+namespace App\Repositories\Criteria;
+
+use Illuminate\Database\Eloquent\Builder;
+use Freevital\Repository\Contracts\CriteriaContract;
+use Freevital\Repository\Contracts\RepositoryContract;
+
+class BySlugCriteria implements CriteriaContract
+{
+    /**
+     * @var string
+     */
+    protected $title;
+
+    /**
+     * @param string $slug
+     */
+    public function __construct($slug)
+    {
+        $this->slug = $slug;
+    }
+
+    /**
+     * Apply criteria in query repository.
+     *
+     * @param Builder            $query
+     * @param RepositoryContract $repository
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function apply(Builder $query, RepositoryContract $repository)
+    {
+        return $query->where('name', $this->slug);
+    }
+}
+```
+
+###Use Repository Criteria in the controller
+
+You may use multiple criteria in a repository.
+
+```php
+namespace App\Http\Controllers;
+
+use App\Http\Controllers\Controller;
+use App\Repositories\Criteria\BySlugCriteria;
+use App\Repositories\Criteria\WithCommentsCriteria;
+use App\Repositories\Eloquent\PostRepository;
+
+class PostController extends Controller
+{
+     /**
+     * Get a post by slug.
+     *
+     * @param string $slug
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function show($slug)
+    {
+        $post = $this->postRepository
+            ->pushCriteria(new WithCommentsCriteria($slug))
+            ->pushCriteria(new BySlugCriteria($slug))
+            ->first();
+    
+        return \Response::json(compact('post'));
+    }
+}
+```
+
+##Available Methods
+
+###Freevital\Repository\Contracts\RepositoryContract
+
+```php
+paginate($limit = null, $columns = ['*'], $method = 'paginate')
+simplePaginate($limit = null, $columns = ['*'])
+all($columns = ['*'])
+lists($column, $key = null)
+find($id, $columns = ['*'])
+first($columns = ['*'])
+findByField($field, $value, $columns = ['*'])
+findWhere(array $where, $columns = ['*'])
+findWhereIn($field, array $values, $columns = ['*'])
+findWhereNotIn($field, array $values, $columns = ['*'])
+count()
+create(array $attributes)
+update(array $attributes, $id)
+updateOrCreate(array $attributes, array $values = [])
+updateActiveStatus($status, int $id)
+delete($id)
+forceDelete($id)
+deleteWhere(array $where)
+forceDeleteWhere(array $where)
+has($relation)
+with($relations)
+whereHas($relation, $closure)
+orderBy($column, $direction = 'asc')
+visible(array $fields)
+hidden(array $fields)
+scopeQuery(\Closure $scope)
+resetScope()
+```
+
+###Freevital\Repository\Contracts\RepositoryCriteriaContract
+
+```php
+pushCriteria($criteria)
+popCriteria($criteria)
+getCriteria()
+getByCriteria(CriteriaContract $criteria)
+skipCriteria($status = true)
+resetCriteria()
+```
+
+###Freevital\Repository\Contracts\CriteriaContract
+
+```php
+apply(Builder $query, RepositoryContract $repository)
+```
+
+##Credits
+
+This package in mainly based on package by [@andersao](https://github.com/andersao/l5-repository).
+
+##License
+
+The contents of this repository is released under the MIT license.

src/Contracts/RepositoryContract.php

@@ -15,16 +15,6 @@ interface RepositoryContract
      */
     public function paginate($limit = null, $columns = ['*'], $method = 'paginate');
 
-    /**
-     * Retrieve all active entities and build a paginator.
-     *
-     * @param integer|null $limit
-     * @param array        $columns
-     *
-     * @return mixed
-     */
-    public function paginateActive($limit = null, $columns = ['*']);
-
     /**
      * Retrieve all entities and build a simple paginator.
      *
@@ -35,16 +25,6 @@ public function paginateActive($limit = null, $columns = ['*']);
      */
     public function simplePaginate($limit = null, $columns = ['*']);
 
-    /**
-     * Retrieve all active entities and build a simple paginator.
-     *
-     * @param integer|null $limit
-     * @param array        $columns
-     *
-     * @return mixed
-     */
-    public function simplePaginateActive($limit = null, $columns = ['*']);
-
     /**
      * Retrieve all entities.
      *
@@ -54,15 +34,6 @@ public function simplePaginateActive($limit = null, $columns = ['*']);
      */
     public function all($columns = ['*']);
 
-    /**
-     * Retrieve all active entities.
-     *
-     * @param array $columns
-     *
-     * @return mixed
-     */
-    public function allActive($columns = ['*']);
-
     /**
      * Retrieve the entities array for populate field select.
      *
@@ -73,16 +44,6 @@ public function allActive($columns = ['*']);
      */
     public function lists($column, $key = null);
 
-    /**
-     * Retrieve the active entities array for populate field select.
-     *
-     * @param string      $column
-     * @param string|null $key
-     *
-     * @return \Illuminate\Support\Collection|array
-     */
-    public function listsActive($column, $key = null);
-
     /**
      * Find an entity by id.
      *
@@ -93,16 +54,6 @@ public function listsActive($column, $key = null);
      */
     public function find($id, $columns = ['*']);
 
-    /**
-     * Find an active entity by id.
-     *
-     * @param int   $id
-     * @param array $columns
-     *
-     * @return mixed
-     */
-    public function findActive($id, $columns = ['*']);
-
     /**
      * Find a first entity.
      *
@@ -112,15 +63,6 @@ public function findActive($id, $columns = ['*']);
      */
     public function first($columns = ['*']);
 
-    /**
-     * Find a first active entity.
-     *
-     * @param array $columns
-     *
-     * @return mixed
-     */
-    public function firstActive($columns = ['*']);
-
     /**
      * Find the entities by field and value.
      *
@@ -226,7 +168,7 @@ public function delete($id);
      *
      * @return mixed
      */
-    public function forceDelete(int $id);
+    public function forceDelete($id);
 
     /**
      * Delete multiple entities by given criteria.