Simplify code complexity & fix few issues round 3

rinvex · Jun 16, 2016 · 4de4c2f · 4de4c2f
1 parent ba87e29
commit 4de4c2f
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 42 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -19,6 +19,8 @@ engines:
         enabled: false
       Naming/ShortVariable:
         enabled: false
+      CleanCode/ElseExpression:
+        enabled: false
 ratings:
   paths:
   - "**.inc"

diff --git a/README.md b/README.md
@@ -26,8 +26,8 @@
     - [EloquentRepository](#eloquentrepository)
         - [`setContainer()`, `getContainer()`](#setcontainer-getcontainer)
         - [`setRepositoryId()`, `getRepositoryId()`](#setrepositoryid-getrepositoryid)
-        - [`setCacheStatus()`, `getCacheStatus()`](#setcachestatus-getcachestatus)
-        - [`setCacheClearStatus()`, `getCacheClearStatus()`](#setcacheclearstatus-getcacheclearstatus)
+        - [`enableCache()`, `isCacheEnabled()`](#enablecache-iscacheenabled)
+        - [`enableCacheClear()`, `isCacheClearEnabled()`](#enablecacheclear-iscacheclearenabled)
         - [`addGlobalScope()`, `withoutGlobalScopes()`](#addglobalscope-withoutglobalscopes)
         - [`retrieveModel()`](#retrievemodel)
         - [`forgetCache()`](#forgetcache)
@@ -277,26 +277,26 @@ $repository->setRepositoryId('rinvex.repository.entity');
 $repositoryId = $repository->getRepositoryId();
 ```
 
-#### `setCacheStatus()`, `getCacheStatus()`
+#### `enableCache()`, `isCacheEnabled()`
 
-The `setCacheStatus` method sets the repository cache status, while `getCacheStatus` returns it:
+The `enableCache` method enables repository cache, while `isCacheEnabled` determines it's state:
 ```php
-// Set the repository cache status
-$repository->setCacheStatus(true);
+// Enable repository cache
+$repository->enableCache(true);
 
-// Get the repository cache status
-$repository->getCacheStatus();
+// Determine if repository cache is enabled
+$repository->isCacheEnabled();
 ```
 
-#### `setCacheClearStatus()`, `getCacheClearStatus()`
+#### `enableCacheClear()`, `isCacheClearEnabled()`
 
-The `setCacheClearStatus` method sets the repository cache clear status, while `getCacheClearStatus` returns it:
+The `enableCacheClear` method enables repository cache clear, while `isCacheClearEnabled` determines it's state:
 ```php
-// Set the repository cache clear status
-$repository->setCacheClearStatus(true);
+// Enable repository cache clear
+$repository->enableCacheClear(true);
 
-// Get the repository cache clear status
-$repository->getCacheClearStatus();
+// Determine if repository cache clear is enabled
+$repository->isCacheClearEnabled();
 ```
 
 #### `addGlobalScope()`, `withoutGlobalScopes()`

diff --git a/src/Contracts/RepositoryContract.php b/src/Contracts/RepositoryContract.php
@@ -55,36 +55,36 @@ public function setRepositoryId($repositoryId);
     public function getRepositoryId();
 
     /**
-     * Set the repository cache status.
+     * Enable repository cache.
      *
      * @param bool $status
      *
      * @return $this
      */
-    public function setCacheStatus($status);
+    public function enableCache($status = true);
 
     /**
-     * Get the repository cache status.
+     * Determine if repository cache is enabled.
      *
      * @return bool
      */
-    public function getCacheStatus();
+    public function isCacheEnabled();
 
     /**
-     * Set the repository cache clear status.
+     * Enable repository cache clear.
      *
      * @param bool $status
      *
      * @return $this
      */
-    public function setCacheClearStatus($status);
+    public function enableCacheClear($status);
 
     /**
-     * Get the repository cache clear status.
+     * Determine if repository cache clear is enabled.
      *
      * @return bool
      */
-    public function getCacheClearStatus();
+    public function isCacheClearEnabled();
 
     /**
      * Retrieve the repository model.
@@ -160,7 +160,7 @@ public function findAll($columns = ['*'], $with = []);
     /**
      * Paginate all entities.
      *
-     * @param int      $perPage
+     * @param int|null $perPage
      * @param array    $columns
      * @param string   $pageName
      * @param int|null $page

diff --git a/src/Listeners/RepositoryEventListener.php b/src/Listeners/RepositoryEventListener.php
@@ -44,7 +44,7 @@ public function entityCreated(RepositoryContract $repository, $entity)
     {
         $clearOn = $repository->getContainer('config')->get('rinvex.repository.cache.clear_on');
 
-        if ($repository->getCacheClearStatus() && in_array('create', $clearOn)) {
+        if ($repository->isCacheClearEnabled() && in_array('create', $clearOn)) {
             $repository->forgetCache();
         }
     }
@@ -61,7 +61,7 @@ public function entityUpdated(RepositoryContract $repository, $entity)
     {
         $clearOn = $repository->getContainer('config')->get('rinvex.repository.cache.clear_on');
 
-        if ($repository->getCacheClearStatus() && in_array('update', $clearOn)) {
+        if ($repository->isCacheClearEnabled() && in_array('update', $clearOn)) {
             $repository->forgetCache();
         }
     }
@@ -78,7 +78,7 @@ public function entityDeleted(RepositoryContract $repository, $entity)
     {
         $clearOn = $repository->getContainer('config')->get('rinvex.repository.cache.clear_on');
 
-        if ($repository->getCacheClearStatus() && in_array('delete', $clearOn)) {
+        if ($repository->isCacheClearEnabled() && in_array('delete', $clearOn)) {
             $repository->forgetCache();
         }
     }

diff --git a/src/Repositories/BaseRepository.php b/src/Repositories/BaseRepository.php
@@ -43,25 +43,25 @@ abstract class BaseRepository implements RepositoryContract
     protected $repositoryId;
 
     /**
-     * The repository cache status.
+     * Indicate if the repository cache is enabled.
      *
      * @var bool
      */
     protected $cacheEnabled = true;
 
     /**
-     * The repository cache clear status.
+     * Indicate if the repository cache clear is enabled.
      *
      * @var bool
      */
-    protected $cacheClear = true;
+    protected $cacheClearEnabled = true;
 
     /**
      * Execute given callback and cache result set.
      *
      * @param string   $class
      * @param string   $method
-     * @param string   $cacheKey
+     * @param string   $hash
      * @param \Closure $closure
      *
      * @return mixed
@@ -136,51 +136,51 @@ public function getRepositoryId()
     }
 
     /**
-     * Set the repository cache status.
+     * Enable repository cache.
      *
      * @param bool $status
      *
      * @return $this
      */
-    public function setCacheStatus($status)
+    public function enableCache($status = true)
     {
-        $this->cacheEnabled = (bool) $status;
+        $this->cacheEnabled = $status;
 
         return $this;
     }
 
     /**
-     * Get the repository cache status.
+     * Determine if repository cache is enabled.
      *
      * @return bool
      */
-    public function getCacheStatus()
+    public function isCacheEnabled()
     {
         return $this->cacheEnabled;
     }
 
     /**
-     * Set the repository cache clear status.
+     * Enable repository cache clear.
      *
      * @param bool $status
      *
      * @return $this
      */
-    public function setCacheClearStatus($status)
+    public function enableCacheClear($status = true)
     {
-        $this->cacheClear = (bool) $status;
+        $this->cacheClearEnabled = $status;
 
         return $this;
     }
 
     /**
-     * Get the repository cache clear status.
+     * Determine if repository cache clear is enabled.
      *
      * @return bool
      */
-    public function getCacheClearStatus()
+    public function isCacheClearEnabled()
     {
-        return $this->cacheClear;
+        return $this->cacheClearEnabled;
     }
 
     /**

diff --git a/src/Repositories/EloquentRepository.php b/src/Repositories/EloquentRepository.php
@@ -108,7 +108,7 @@ public function findAll($columns = ['*'], $with = [])
     /**
      * Paginate all entities.
      *
-     * @param int      $perPage
+     * @param int|null $perPage
      * @param array    $columns
      * @param string   $pageName
      * @param int|null $page