Extract View Throttle filter to Filter class. Extract increment view to Event class

Author: stidges

app/Controllers/TricksController.php

@@ -3,6 +3,7 @@
 namespace Controllers;
 
 use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Session;
 use Illuminate\Support\Facades\Request;
 use Illuminate\Support\Facades\Response;
@@ -48,7 +49,7 @@ public function getShow($slug = null)
             return $this->redirectRoute('home');
         }
 
-        $trick = $this->incrementViews($trick);
+        Event::fire('trick.view', $trick);
 
         $this->view('tricks.single', compact('trick'));
     }
@@ -72,7 +73,7 @@ public function postLike($slug)
         }
 
         $user = Auth::user();
-        
+
         $voted = $trick->votes()->whereUserId($user->id)->first();
 
         if(!$voted) {
@@ -92,24 +93,4 @@ public function postLike($slug)
 
         return Response::make($trick->vote_cache, 200);
     }
-
-    /**
-     * Increment the view count on the given trick.
-     *
-     * @param  \Trick $trick
-     * @return \Trick
-     */
-    private function incrementViews($trick)
-    {
-        $viewed = Session::get('viewed_tricks', []);
-
-        if (! array_key_exists($trick->id, $viewed)) {
-            $trick = $this->tricks->incrementViews($trick);
-        }
-
-        $viewed[$trick->id] = time();
-        Session::put('viewed_tricks', $viewed);
-
-        return $trick;
-    }
 }

app/Tricks/Events/ViewTrickHandler.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Tricks\Events;
+
+use Illuminate\Session\Store;
+use Tricks\Repositories\TrickRepositoryInterface;
+
+class ViewTrickHandler
+{
+    /**
+     * Trick repository instance.
+     *
+     * @var \Tricks\Repositories\TrickRepositoryInterface
+     */
+    protected $tricks;
+
+    /**
+     * Session store instance.
+     *
+     * @var \Illuminate\Session\Store
+     */
+    protected $session;
+
+    /**
+     * Create a new view trick handler instance.
+     *
+     * @param  \Tricks\Repositories\TrickRepositoryInterface  $tricks
+     * @param  \Illuminate\Session\Store                      $session
+     * @return void
+     */
+    public function __construct(TrickRepositoryInterface $tricks, Store $session)
+    {
+        $this->tricks  = $tricks;
+        $this->session = $session;
+    }
+
+    /**
+     * Handle the view trick event.
+     *
+     * @param  \Tricks\Trick  $trick
+     * @return void
+     */
+    public function handle($trick)
+    {
+        if (! $this->hasViewedTrick($trick)) {
+            $trick = $this->tricks->incrementViews($trick);
+
+            $this->storeViewedTrick($trick);
+        }
+    }
+
+    /**
+     * Determine whether the user has viewed the trick.
+     *
+     * @param  \Tricks\Trick  $trick
+     * @return bool
+     */
+    protected function hasViewedTrick($trick)
+    {
+        return array_key_exists($trick->id, $this->getViewedTricks());
+    }
+
+    /**
+     * Get the users viewed trick from the session.
+     *
+     * @return array
+     */
+    protected function getViewedTricks()
+    {
+        return $this->session->get('viewed_tricks', []);
+    }
+
+    /**
+     * Append the newly viewed trick to the session.
+     *
+     * @param  \Tricks\Trick  $trick
+     * @return void
+     */
+    protected function storeViewedTrick($trick)
+    {
+        $key = 'viewed_tricks.' . $trick->id;
+
+        $this->session->put($key, time());
+    }
+}

app/Tricks/Filters/ViewThrottleFilter.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace Tricks\Filters;
+
+use Illuminate\Session\Store;
+use Illuminate\Config\Repository;
+
+class ViewThrottleFilter
+{
+    /**
+     * Config repository instance.
+     *
+     * @var \Illuminate\Config\Repository
+     */
+    protected $config;
+
+    /**
+     * Session store instance.
+     *
+     * @var \Illuminate\Session\Store
+     */
+    protected $session;
+
+    /**
+     * Create a new view throttle filter instance.
+     *
+     * @param  \Illuminate\Config\Repository  $config
+     * @param  \Illuminate\Session\Store      $session
+     * @return void
+     */
+    public function __construct(Repository $config, Store $session)
+    {
+        $this->config  = $config;
+        $this->session = $session;
+    }
+
+    /**
+     * Execute the route filter.
+     *
+     * @return void
+     */
+    public function filter()
+    {
+        $tricks = $this->getViewedTricks();
+
+        if ($tricks !== null) {
+            $tricks = $this->purgeExpiredTricks($tricks);
+
+            $this->storeViewedTricks($tricks);
+        }
+    }
+
+    /**
+     * Get the recently viewed tricks from the session.
+     *
+     * @return array|null
+     */
+    protected function getViewedTricks()
+    {
+        return $this->session->get('viewed_tricks', null);
+    }
+
+    /**
+     * Get the view throttle time from the config.
+     *
+     * @return int
+     */
+    protected function getThrottleTime()
+    {
+        return $this->config->get('config.view_throttle_time');
+    }
+
+    /**
+     * Filter the tricks array, removing expired tricks.
+     *
+     * @param  array  $tricks
+     * @return array
+     */
+    protected function purgeExpiredTricks(array $tricks)
+    {
+        $time         = time();
+        $throttleTime = $this->getThrottleTime();
+
+        return array_filter($tricks, function ($timestamp) use ($time, $throttleTime) {
+            return ($timestamp + $throttleTime) > $time;
+        });
+    }
+
+    /**
+     * Store the recently viewed tricks in the session.
+     *
+     * @param  array  $tricks
+     * @return void
+     */
+    protected function storeViewedTricks(array $tricks)
+    {
+        $this->session->put('viewed_tricks', $tricks);
+    }
+}

app/Tricks/Providers/EventServiceProvider.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Tricks\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class EventServiceProvider extends ServiceProvider
+{
+    public function boot()
+    {
+        $this->app['events']->listen('trick.view', 'Tricks\Events\ViewTrickHandler');
+    }
+
+    public function register()
+    {
+
+    }
+}

app/config/app.php

@@ -117,6 +117,7 @@
         'Tricks\Providers\UploadServiceProvider',
         'Tricks\Providers\NavigationServiceProvider',
         'Tricks\Providers\SitemapServiceProvider',
+        'Tricks\Providers\EventServiceProvider',
     ),
 
     /*

app/filters.php

@@ -83,17 +83,4 @@
 	}
 });
 
-Route::filter('trick.view_throttle', function() {
-	if (! is_null($trickIds = Session::get('viewed_tricks', null))) {
-		$expireTime = time() + Config::get('config.view_expire_time');
-		$temp       = $trickIds;
-
-		foreach ($trickIds as $id => $timestamp) {
-			if ($timestamp < $expireTime) {
-				unset($temp[$id]);
-			}
-		}
-
-		Session::put('viewed_tricks', $temp);
-	}
-});
+Route::filter('trick.view_throttle', 'Tricks\Filters\ViewThrottleFilter');

app/routes.php

@@ -1,7 +1,7 @@
 <?php
 # Route filters
 Route::when('admin/*', 'admin');
-Route::when('*', 'tricks.view_throttle');
+Route::when('*', 'trick.view_throttle');
 
 # Route patterns
 Route::pattern('tag_slug', '[a-z0-9\-]+');