Merge pull request #13 from rennokki/refactor/laravel-6.0-and-refactoring

[refactor] Laravel 6.0 and refactoring the core

Author: rennokki

.travis.yml

@@ -1,8 +1,8 @@
 language: php
 
 php:
-  - 7.1
   - 7.2
+  - 7.3
 
 env:
   matrix:

composer.json

@@ -22,12 +22,12 @@
         }
     ],
     "require": {
-        "laravel/framework": "~5.5"
+        "laravel/framework": "~5.5|^6.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^6.2|^7.0",
-        "orchestra/testbench": "~3.5.0|~3.6.0",
-        "orchestra/database": "~3.5.0|~3.6.0"
+        "phpunit/phpunit": "^6.2|^7.0|^8.0",
+        "orchestra/testbench": "~3.5.0|~3.6.0|~4.0.0",
+        "orchestra/database": "~3.5.0|~3.6.0|~4.0.0"
     },
     "autoload": {
         "psr-4": {

config/rating.php

@@ -7,7 +7,9 @@
      */
 
     'models' => [
+
         'rating' => \Rennokki\Rating\Models\RaterModel::class,
+
     ],
 
 ];

database/factories/PageFactory.php

@@ -1,4 +1,7 @@
 <?php
+
+use Illuminate\Support\Str;
+
 /*
 |--------------------------------------------------------------------------
 | Model Factories
@@ -12,6 +15,6 @@
 
 $factory->define(\Rennokki\Rating\Test\Models\Page::class, function () {
     return [
-        'name' => 'Page'.str_random(5),
+        'name' => 'Page'.Str::random(5),
     ];
 });

database/factories/SimplePageFactory.php

@@ -1,4 +1,7 @@
 <?php
+
+use Illuminate\Support\Str;
+
 /*
 |--------------------------------------------------------------------------
 | Model Factories
@@ -12,6 +15,6 @@
 
 $factory->define(\Rennokki\Rating\Test\Models\SimplePage::class, function () {
     return [
-        'name' => 'Page'.str_random(5),
+        'name' => 'Page'.Str::random(5),
     ];
 });

database/factories/UserFactory.php

@@ -1,4 +1,7 @@
 <?php
+
+use Illuminate\Support\Str;
+
 /*
 |--------------------------------------------------------------------------
 | Model Factories
@@ -12,9 +15,9 @@
 
 $factory->define(\Rennokki\Rating\Test\Models\User::class, function () {
     return [
-        'name'           => 'Name'.str_random(5),
-        'email'          => str_random(5).'@gmail.com',
+        'name'           => 'Name'.Str::random(5),
+        'email'          => Str::random(5).'@gmail.com',
         'password'       => '$2y$10$TKh8H1.PfQx37YgCzwiKb.KjNyWgaHb9cbcoQgdIVFlYg7B77UdFm', // secret
-        'remember_token' => str_random(10),
+        'remember_token' => Str::random(10),
     ];
 });

database/migrations/2018_07_14_183253_ratings.php

@@ -1,8 +1,8 @@
 <?php
 
-use Illuminate\Support\Facades\Schema;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
 
 class Ratings extends Migration
 {

src/Contracts/Rater.php

@@ -4,13 +4,45 @@
 
 interface Rater
 {
+    /**
+     * Relationship for models that this model currently rated.
+     *
+     * @param  null|\Illuminate\Database\Eloquent\Model  $model
+     * @return mixed
+     */
     public function ratings($model = null);
 
+    /**
+     * Check if the current model is rating another model.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @return bool
+     */
     public function hasRated($model): bool;
 
-    public function rate($model, $rating): bool;
+    /**
+     * Rate a certain model.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @param  float  $rating
+     * @return bool
+     */
+    public function rate($model, float $rating): bool;
 
-    public function updateRatingFor($model, $rating): bool;
+    /**
+     * Update the rating for a model.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @param  float  $newRating
+     * @return bool
+     */
+    public function updateRatingFor($model, $newRating): bool;
 
+    /**
+     * Unrate a certain model.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @return bool
+     */
     public function unrate($model): bool;
 }

src/Models/RaterModel.php

@@ -6,17 +6,38 @@
 
 class RaterModel extends Model
 {
+    /**
+     * {@inheritdoc}
+     */
     protected $table = 'ratings';
+
+    /**
+     * {@inheritdoc}
+     */
     protected $guarded = [];
+
+    /**
+     * {@inheritdoc}
+     */
     protected $casts = [
         'rating' => 'float',
     ];
 
+    /**
+     * The relationship function for the model who was rated.
+     *
+     * @return mixed
+     */
     public function rateable()
     {
         return $this->morphTo();
     }
 
+    /**
+     * The relationship function for the model who rated.
+     *
+     * @return mixed
+     */
     public function rater()
     {
         return $this->morphTo();

src/Traits/CanBeRated.php

@@ -7,25 +7,28 @@ trait CanBeRated
     /**
      * Relationship for models that rated this model.
      *
-     * @param Model $model The model types of the results.
-     * @return morphToMany The relationship.
+     * @param  null|\Illuminate\Database\Eloquent\Model  $model
+     * @return mixed
      */
     public function raters($model = null)
     {
-        return $this->morphToMany(($model) ?: $this->getMorphClass(), 'rateable', 'ratings', 'rateable_id', 'rater_id')
+        $modelClass = $model ? (new $model)->getMorphClass() : $this->getMorphClass();
+
+        return $this->morphToMany($modelClass, 'rateable', 'ratings', 'rateable_id', 'rater_id')
                     ->withPivot('rater_type', 'rating')
-                    ->wherePivot('rater_type', ($model) ?: $this->getMorphClass())
+                    ->wherePivot('rater_type', $modelClass)
                     ->wherePivot('rateable_type', $this->getMorphClass());
     }
 
     /**
      * Calculate the average rating of the current model.
      *
-     * @return float The average rating.
+     * @param  null|\Illuminate\Database\Eloquent\Model  $model
+     * @return float
      */
     public function averageRating($model = null): float
     {
-        if ($this->raters($model)->count() == 0) {
+        if ($this->raters($model)->count() === 0) {
             return (float) 0.00;
         }