Reorganised custom classes to a new directory.

Sandeesh · Sandeesh · commit 499dbb2496ae · 2017-05-12T21:58:42.000+05:30
Changed trait names to better suit functionality.
Updated Slug class to better use separator.
Small code style fixes.
diff --git a/app/Article.php b/app/Article.php
@@ -2,16 +2,14 @@
 
 namespace App;
 
-use App\Filters\Filterable;
-use App\Sluggable\HasSlug;
-use App\Traits\FavoritedTrait;
+use App\RealWorld\Slug\HasSlug;
+use App\RealWorld\Filters\Filterable;
+use App\RealWorld\Favorite\Favoritable;
 use Illuminate\Database\Eloquent\Model;
 
 class Article extends Model
 {
-    use Filterable,
-        FavoritedTrait,
-        HasSlug;
+    use Favoritable, Filterable, HasSlug;
 
     /**
      * The attributes that are mass assignable.
diff --git a/app/Http/Controllers/Api/ApiController.php b/app/Http/Controllers/Api/ApiController.php
@@ -3,14 +3,14 @@
 namespace App\Http\Controllers\Api;
 
 use Exception;
-use App\Paginate\Paginator;
-use App\Transformers\Transformer;
-use App\Http\Controllers\Controller;
 use Illuminate\Support\Collection;
+use App\Http\Controllers\Controller;
+use App\RealWorld\Paginate\Paginate;
+use App\RealWorld\Transformers\Transformer;
 
 class ApiController extends Controller
 {
-    /** \App\Transformers\Transformer
+    /** \App\RealWorld\Transformers\Transformer
      *
      * @var null
      */
@@ -53,18 +53,18 @@ protected function respondWithTransformer($data, $statusCode = 200, $headers = [
     /**
      * Respond with pagination.
      *
-     * @param $paginator
+     * @param $paginated
      * @param int $statusCode
      * @param array $headers
      * @return \Illuminate\Http\JsonResponse
      */
-    protected function respondWithPagination($paginator, $statusCode = 200, $headers = [])
+    protected function respondWithPagination($paginated, $statusCode = 200, $headers = [])
     {
-        $this->checkPaginator($paginator);
+        $this->checkPaginated($paginated);
 
         $this->checkTransformer();
 
-        $data = $this->transformer->paginate($paginator);
+        $data = $this->transformer->paginate($paginated);
 
         return $this->respond($data, $statusCode, $headers);
     }
@@ -188,15 +188,15 @@ private function checkTransformer()
     }
 
     /**
-     * Check if valid paginator.
+     * Check if valid paginate instance.
      *
-     * @param $paginator
+     * @param $paginated
      * @throws Exception
      */
-    private function checkPaginator($paginator)
+    private function checkPaginated($paginated)
     {
-        if (! $paginator instanceof Paginator) {
-            throw new Exception('Expected instance of Paginator.');
+        if (! $paginated instanceof Paginate) {
+            throw new Exception('Expected instance of Paginate.');
         }
     }
 }
diff --git a/app/Http/Controllers/Api/ArticleController.php b/app/Http/Controllers/Api/ArticleController.php
@@ -4,12 +4,12 @@
 
 use App\Tag;
 use App\Article;
-use App\Paginate\Paginator;
-use App\Filters\ArticleFilter;
+use App\RealWorld\Paginate\Paginate;
+use App\RealWorld\Filters\ArticleFilter;
 use App\Http\Requests\Api\CreateArticle;
 use App\Http\Requests\Api\UpdateArticle;
 use App\Http\Requests\Api\DeleteArticle;
-use App\Transformers\ArticleTransformer;
+use App\RealWorld\Transformers\ArticleTransformer;
 
 class ArticleController extends ApiController
 {
@@ -34,7 +34,7 @@ public function __construct(ArticleTransformer $transformer)
      */
     public function index(ArticleFilter $filter)
     {
-        $articles = new Paginator(Article::loadRelations()->filter($filter));
+        $articles = new Paginate(Article::loadRelations()->filter($filter));
 
         return $this->respondWithPagination($articles);
     }
diff --git a/app/Http/Controllers/Api/AuthController.php b/app/Http/Controllers/Api/AuthController.php
@@ -4,9 +4,9 @@
 
 use Auth;
 use App\User;
-use App\Transformers\UserTransformer;
 use App\Http\Requests\Api\LoginUser;
 use App\Http\Requests\Api\RegisterUser;
+use App\RealWorld\Transformers\UserTransformer;
 
 class AuthController extends ApiController
 {
diff --git a/app/Http/Controllers/Api/CommentController.php b/app/Http/Controllers/Api/CommentController.php
@@ -6,7 +6,7 @@
 use App\Comment;
 use App\Http\Requests\Api\CreateComment;
 use App\Http\Requests\Api\DeleteComment;
-use App\Transformers\CommentTransformer;
+use App\RealWorld\Transformers\CommentTransformer;
 
 class CommentController extends ApiController
 {
diff --git a/app/Http/Controllers/Api/FavoriteController.php b/app/Http/Controllers/Api/FavoriteController.php
@@ -3,7 +3,7 @@
 namespace App\Http\Controllers\Api;
 
 use App\Article;
-use App\Transformers\ArticleTransformer;
+use App\RealWorld\Transformers\ArticleTransformer;
 
 class FavoriteController extends ApiController
 {
diff --git a/app/Http/Controllers/Api/FeedController.php b/app/Http/Controllers/Api/FeedController.php
@@ -2,8 +2,8 @@
 
 namespace App\Http\Controllers\Api;
 
-use App\Paginate\Paginator;
-use App\Transformers\ArticleTransformer;
+use App\RealWorld\Paginate\Paginate;
+use App\RealWorld\Transformers\ArticleTransformer;
 
 class FeedController extends ApiController
 {
@@ -28,7 +28,7 @@ public function index()
     {
         $user = auth()->user();
 
-        $articles = new Paginator($user->feed());
+        $articles = new Paginate($user->feed());
 
         return $this->respondWithPagination($articles);
     }
diff --git a/app/Http/Controllers/Api/ProfileController.php b/app/Http/Controllers/Api/ProfileController.php
@@ -3,7 +3,7 @@
 namespace App\Http\Controllers\Api;
 
 use App\User;
-use App\Transformers\ProfileTransformer;
+use App\RealWorld\Transformers\ProfileTransformer;
 
 class ProfileController extends ApiController
 {
diff --git a/app/Http/Controllers/Api/TagController.php b/app/Http/Controllers/Api/TagController.php
@@ -3,7 +3,7 @@
 namespace App\Http\Controllers\Api;
 
 use App\Tag;
-use App\Transformers\TagTransformer;
+use App\RealWorld\Transformers\TagTransformer;
 
 class TagController extends ApiController
 {
diff --git a/app/Http/Controllers/Api/UserController.php b/app/Http/Controllers/Api/UserController.php
@@ -2,8 +2,8 @@
 
 namespace App\Http\Controllers\Api;
 
-use App\Transformers\UserTransformer;
 use App\Http\Requests\Api\UpdateUser;
+use App\RealWorld\Transformers\UserTransformer;
 
 class UserController extends ApiController
 {
diff --git a/app/RealWorld/Favorite/Favoritable.php b/app/RealWorld/Favorite/Favoritable.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace App\Traits;
+namespace App\RealWorld\Favorite;
 
 use App\User;
 
-trait FavoritedTrait
+trait Favoritable
 {
     /**
      * Check if the authenticated user has favorited the article.
diff --git a/app/RealWorld/Favorite/HasFavorite.php b/app/RealWorld/Favorite/HasFavorite.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace App\Traits;
+namespace App\RealWorld\Favorite;
 
 use App\Article;
 
-trait FavoriteTrait
+trait HasFavorite
 {
     /**
      * Favorite the given article.
diff --git a/app/RealWorld/Filters/ArticleFilter.php b/app/RealWorld/Filters/ArticleFilter.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Filters;
+namespace App\RealWorld\Filters;
 
 use App\Tag;
 use App\User;
diff --git a/app/RealWorld/Filters/Filter.php b/app/RealWorld/Filters/Filter.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Filters;
+namespace App\RealWorld\Filters;
 
 use ReflectionClass;
 use Illuminate\Http\Request;
diff --git a/app/RealWorld/Filters/Filterable.php b/app/RealWorld/Filters/Filterable.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Filters;
+namespace App\RealWorld\Filters;
 
 trait Filterable
 {
diff --git a/app/RealWorld/Follow/Followable.php b/app/RealWorld/Follow/Followable.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace App\Traits;
+namespace App\RealWorld\Follow;
 
 use App\User;
 
-trait FollowableTrait
+trait Followable
 {
     /**
      * Check if the authenticated user is following this user.
diff --git a/app/RealWorld/Paginate/Paginate.php b/app/RealWorld/Paginate/Paginate.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace App\Paginate;
+namespace App\RealWorld\Paginate;
 
 use Illuminate\Database\Eloquent\Builder;
 
-class Paginator
+class Paginate
 {
     /**
      * Total count of the items.
@@ -21,7 +21,7 @@ class Paginator
     protected $data;
 
     /**
-     * Paginator constructor.
+     * Paginate constructor.
      *
      * @param \Illuminate\Database\Eloquent\Builder $builder
      * @param int $limit
diff --git a/app/RealWorld/Slug/HasSlug.php b/app/RealWorld/Slug/HasSlug.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Sluggable;
+namespace App\RealWorld\Slug;
 
 trait HasSlug
 {
diff --git a/app/RealWorld/Slug/Slug.php b/app/RealWorld/Slug/Slug.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Sluggable;
+namespace App\RealWorld\Slug;
 
 use Illuminate\Database\Eloquent\Model;
 
@@ -61,21 +61,21 @@ public function generate()
 
         $suffix = $this->generateSuffix($slug, $notAllowed);
 
-        return "{$slug}-{$suffix}";
+        return $slug . static::SEPARATOR . $suffix;
 
     }
 
     /**
      * Generate suffix for unique slug
      *
      * @param string $slug
-     * @param array $notAllowed
+     * @param \Illuminate\Support\Collection $notAllowed
      * @return string
      */
     public function generateSuffix($slug, $notAllowed)
     {
-        /** @var Collection $notAllowed */
-        $notAllowed->transform(function ($item, $key) use ($slug) {
+        /** @var \Illuminate\Support\Collection $notAllowed */
+        $notAllowed->transform(function ($item) use ($slug) {
 
             if ($slug == $item) {
                 return 0;
@@ -124,11 +124,12 @@ private function getSimilarSlugs($slug)
         if (!$this->model instanceof Model || !method_exists($this->model, 'getSlugColumn')) {
             return collect([]);
         }
+
         $slugColumn = $this->model->getSlugColumn();
 
         return $this->model->newQuery()
             ->where($slugColumn, $slug)
-            ->orWhere($slugColumn, 'LIKE', "{$slug}-%")
+            ->orWhere($slugColumn, 'LIKE', $slug . static::SEPARATOR . '%')
             ->get()
             ->pluck($slugColumn);
     }
diff --git a/app/RealWorld/Transformers/ArticleTransformer.php b/app/RealWorld/Transformers/ArticleTransformer.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Transformers;
+namespace App\RealWorld\Transformers;
 
 class ArticleTransformer extends Transformer
 {
diff --git a/app/RealWorld/Transformers/CommentTransformer.php b/app/RealWorld/Transformers/CommentTransformer.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Transformers;
+namespace App\RealWorld\Transformers;
 
 class CommentTransformer extends Transformer
 {
diff --git a/app/RealWorld/Transformers/ProfileTransformer.php b/app/RealWorld/Transformers/ProfileTransformer.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Transformers;
+namespace App\RealWorld\Transformers;
 
 class ProfileTransformer extends Transformer
 {
diff --git a/app/RealWorld/Transformers/TagTransformer.php b/app/RealWorld/Transformers/TagTransformer.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Transformers;
+namespace App\RealWorld\Transformers;
 
 class TagTransformer extends Transformer
 {
diff --git a/app/RealWorld/Transformers/Transformer.php b/app/RealWorld/Transformers/Transformer.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace App\Transformers;
+namespace App\RealWorld\Transformers;
 
-use App\Paginate\Paginator;
 use Illuminate\Support\Collection;
+use App\RealWorld\Paginate\Paginate;
 
 abstract class Transformer
 {
@@ -43,21 +43,21 @@ public function item($data)
     /**
      * Transform a paginated item.
      *
-     * @param Paginator $paginator
+     * @param Paginate $paginated
      * @return array
      */
-    public function paginate(Paginator $paginator)
+    public function paginate(Paginate $paginated)
     {
         $resourceName = str_plural($this->resourceName);
 
         $countName = str_plural($this->resourceName) . 'Count';
 
         $data = [
-            $resourceName => $paginator->getData()->map([$this, 'transform'])
+            $resourceName => $paginated->getData()->map([$this, 'transform'])
         ];
 
         return array_merge($data, [
-            $countName => $paginator->getTotal()
+            $countName => $paginated->getTotal()
         ]);
     }
 
diff --git a/app/RealWorld/Transformers/UserTransformer.php b/app/RealWorld/Transformers/UserTransformer.php
diff --git a/app/User.php b/app/User.php

Original file line number	Diff line number	Diff line change
`@@ -3,14 +3,14 @@`
`3`	`3`	`namespace App\Http\Controllers\Api;`
`4`	`4`
`5`	`5`	`use Exception;`
`6`		`-use App\Paginate\Paginator;`
`7`		`-use App\Transformers\Transformer;`
`8`		`-use App\Http\Controllers\Controller;`
`9`	`6`	`use Illuminate\Support\Collection;`
	`7`	`+use App\Http\Controllers\Controller;`
	`8`	`+use App\RealWorld\Paginate\Paginate;`
	`9`	`+use App\RealWorld\Transformers\Transformer;`
`10`	`10`
`11`	`11`	`class ApiController extends Controller`
`12`	`12`	`{`
`13`		`- /** \App\Transformers\Transformer`
	`13`	`+ /** \App\RealWorld\Transformers\Transformer`
`14`	`14`	`*`
`15`	`15`	`* @var null`
`16`	`16`	`*/`
`@@ -53,18 +53,18 @@ protected function respondWithTransformer($data, $statusCode = 200, $headers = [`
`53`	`53`	`/**`
`54`	`54`	`* Respond with pagination.`
`55`	`55`	`*`
`56`		`- * @param $paginator`
	`56`	`+ * @param $paginated`
`57`	`57`	`* @param int $statusCode`
`58`	`58`	`* @param array $headers`
`59`	`59`	`* @return \Illuminate\Http\JsonResponse`
`60`	`60`	`*/`
`61`		`- protected function respondWithPagination($paginator, $statusCode = 200, $headers = [])`
	`61`	`+ protected function respondWithPagination($paginated, $statusCode = 200, $headers = [])`
`62`	`62`	`{`
`63`		`- $this->checkPaginator($paginator);`
	`63`	`+ $this->checkPaginated($paginated);`
`64`	`64`
`65`	`65`	`$this->checkTransformer();`
`66`	`66`
`67`		`- $data = $this->transformer->paginate($paginator);`
	`67`	`+ $data = $this->transformer->paginate($paginated);`
`68`	`68`
`69`	`69`	`return $this->respond($data, $statusCode, $headers);`
`70`	`70`	`}`
`@@ -188,15 +188,15 @@ private function checkTransformer()`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`/**`
`191`		`- * Check if valid paginator.`
	`191`	`+ * Check if valid paginate instance.`
`192`	`192`	`*`
`193`		`- * @param $paginator`
	`193`	`+ * @param $paginated`
`194`	`194`	`* @throws Exception`
`195`	`195`	`*/`
`196`		`- private function checkPaginator($paginator)`
	`196`	`+ private function checkPaginated($paginated)`
`197`	`197`	`{`
`198`		`- if (! $paginator instanceof Paginator) {`
`199`		`- throw new Exception('Expected instance of Paginator.');`
	`198`	`+ if (! $paginated instanceof Paginate) {`
	`199`	`+ throw new Exception('Expected instance of Paginate.');`
`200`	`200`	`}`
`201`	`201`	`}`
`202`	`202`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,9 @@`
`4`	`4`
`5`	`5`	`use Auth;`
`6`	`6`	`use App\User;`
`7`		`-use App\Transformers\UserTransformer;`
`8`	`7`	`use App\Http\Requests\Api\LoginUser;`
`9`	`8`	`use App\Http\Requests\Api\RegisterUser;`
	`9`	`+use App\RealWorld\Transformers\UserTransformer;`
`10`	`10`
`11`	`11`	`class AuthController extends ApiController`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use App\Comment;`
`7`	`7`	`use App\Http\Requests\Api\CreateComment;`
`8`	`8`	`use App\Http\Requests\Api\DeleteComment;`
`9`		`-use App\Transformers\CommentTransformer;`
	`9`	`+use App\RealWorld\Transformers\CommentTransformer;`
`10`	`10`
`11`	`11`	`class CommentController extends ApiController`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`namespace App\Http\Controllers\Api;`
`4`	`4`
`5`	`5`	`use App\Article;`
`6`		`-use App\Transformers\ArticleTransformer;`
	`6`	`+use App\RealWorld\Transformers\ArticleTransformer;`
`7`	`7`
`8`	`8`	`class FavoriteController extends ApiController`
`9`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace App\Http\Controllers\Api;`
`4`	`4`
`5`		`-use App\Paginate\Paginator;`
`6`		`-use App\Transformers\ArticleTransformer;`
	`5`	`+use App\RealWorld\Paginate\Paginate;`
	`6`	`+use App\RealWorld\Transformers\ArticleTransformer;`
`7`	`7`
`8`	`8`	`class FeedController extends ApiController`
`9`	`9`	`{`
`@@ -28,7 +28,7 @@ public function index()`
`28`	`28`	`{`
`29`	`29`	`$user = auth()->user();`
`30`	`30`
`31`		`- $articles = new Paginator($user->feed());`
	`31`	`+ $articles = new Paginate($user->feed());`
`32`	`32`
`33`	`33`	`return $this->respondWithPagination($articles);`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`namespace App\Http\Controllers\Api;`
`4`	`4`
`5`	`5`	`use App\Tag;`
`6`		`-use App\Transformers\TagTransformer;`
	`6`	`+use App\RealWorld\Transformers\TagTransformer;`
`7`	`7`
`8`	`8`	`class TagController extends ApiController`
`9`	`9`	`{`