Merge pull request #6 from ARCANEDEV/patch-1

Cleaning the package

.gitattributes

@@ -1,8 +1,12 @@
+* text=auto
+
+/.github          export-ignore
 /_docs            export-ignore
 /tests            export-ignore
-/.editorconfig    export-ignore
-/.gitattributes   export-ignore
-/.gitignore       export-ignore
-/.scrutinizer.yml export-ignore
-/.travis.yml      export-ignore
-/phpunit.xml      export-ignore
+.editorconfig     export-ignore
+.gitattributes    export-ignore
+.gitignore        export-ignore
+.scrutinizer.yml  export-ignore
+.travis.yml       export-ignore
+phpunit.xml.dist  export-ignore
+CONTRIBUTING.md   export-ignore

.travis.yml

@@ -12,12 +12,9 @@ matrix:
   allow_failures:
     - php: nightly
 
-env:
-  - TESTBENCH_VERSION=3.4.*
-
 before_script:
   - travis_retry composer self-update
-  - travis_retry composer require --prefer-source --no-interaction --dev "orchestra/testbench:${TESTBENCH_VERSION}" "orchestra/database:${TESTBENCH_VERSION}"
+  - travis_retry composer install --prefer-source --no-interaction
 
 script:
   - composer validate

_docs/2-Configuration.md

@@ -13,18 +13,21 @@ After you've published the config file `config/laravel-messenger.php`, you can c
 <?php
 
 return [
-    /* ------------------------------------------------------------------------------------------------
+
+    /* -----------------------------------------------------------------
      |  Database
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     'database' => [
         'connection' => config('database.default'),
     ],
 
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Models
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     'users' => [
         'table' => 'users',
         'model' => App\User::class,
@@ -44,5 +47,6 @@ return [
         'table' => 'messages',
         'model' => Arcanedev\LaravelMessenger\Models\Message::class
     ],
+
 ];
 ```

composer.json

@@ -17,11 +17,13 @@
     "license": "MIT",
     "require": {
         "php":               ">=5.6.4",
-        "arcanedev/support": "~4.0"
+        "arcanedev/support": "~4.1.0"
     },
     "require-dev": {
-        "phpunit/phpcov":  "~3.0",
-        "phpunit/phpunit": "~5.0"
+        "orchestra/testbench": "~3.4.0",
+        "orchestra/database":  "~3.4.0",
+        "phpunit/phpcov":      "~3.0",
+        "phpunit/phpunit":     "~5.0"
     },
     "autoload": {
         "psr-4": {
@@ -32,15 +34,5 @@
         "psr-4": {
             "Arcanedev\\LaravelMessenger\\Tests\\": "tests/"
         }
-    },
-    "scripts": {
-        "testbench": "composer require --dev \"orchestra/testbench=~3.0\" \"orchestra/database=~3.0\""
-    },
-    "extra": {
-        "branch-alias": {
-            "dev-master": "2.0-dev"
-        }
-    },
-    "minimum-stability": "dev",
-    "prefer-stable" : true
+    }
 }

config/laravel-messenger.php

@@ -1,18 +1,21 @@
 <?php
 
 return [
-    /* ------------------------------------------------------------------------------------------------
+
+    /* -----------------------------------------------------------------
      |  Database
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     'database' => [
         'connection' => config('database.default'),
     ],
 
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Models
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     'users' => [
         'table' => 'users',
         'model' => App\User::class,
@@ -32,4 +35,5 @@
         'table' => 'messages',
         'model' => Arcanedev\LaravelMessenger\Models\Message::class
     ],
+
 ];

database/migrations/2016_08_01_000001_create_discussions_table.php

@@ -7,15 +7,18 @@
  * Class     CreateDiscussionsTable
  *
  * @author   ARCANEDEV <[email protected]>
+ *
+ * @see \Arcanedev\LaravelMessenger\Models\Discussion
  */
 class CreateDiscussionsTable extends Migration
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Constructor
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
-     * CreateParticipantsTable constructor.
+     * CreateDiscussionsTable constructor.
      */
     public function __construct()
     {
@@ -26,10 +29,11 @@ public function __construct()
         );
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Run the migrations.
      */

database/migrations/2016_08_01_000002_create_messages_table.php

@@ -7,15 +7,18 @@
  * Class     CreateMessagesTable
  *
  * @author   ARCANEDEV <[email protected]>
+ *
+ * @see \Arcanedev\LaravelMessenger\Models\Message
  */
 class CreateMessagesTable extends Migration
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Constructor
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
-     * CreateParticipantsTable constructor.
+     * CreateMessagesTable constructor.
      */
     public function __construct()
     {
@@ -26,19 +29,20 @@ public function __construct()
         );
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Run the migrations.
      */
     public function up()
     {
         $this->createSchema(function (Blueprint $table) {
             $table->increments('id');
-            $table->integer('discussion_id')->unsigned();
-            $table->integer('user_id')->unsigned();
+            $table->unsignedInteger('discussion_id');
+            $table->unsignedInteger('user_id');
             $table->text('body');
             $table->timestamps();
         });

database/migrations/2016_08_01_000003_create_participants_table.php

@@ -7,13 +7,16 @@
  * Class     CreateParticipantsTable
  *
  * @author   ARCANEDEV <[email protected]>
+ *
+ * @see \Arcanedev\LaravelMessenger\Models\Participant
  */
 class CreateParticipantsTable extends Migration
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Constructor
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * CreateParticipantsTable constructor.
      */
@@ -26,19 +29,20 @@ public function __construct()
         );
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Run the migrations.
      */
     public function up()
     {
         $this->createSchema(function (Blueprint $table) {
             $table->increments('id');
-            $table->integer('discussion_id')->unsigned();
-            $table->integer('user_id')->unsigned();
+            $table->unsignedInteger('discussion_id');
+            $table->unsignedInteger('user_id');
             $table->dateTime('last_read')->nullable();
             $table->timestamps();
             $table->softDeletes();

src/Bases/Migration.php

@@ -15,12 +15,14 @@ abstract class Migration extends BaseMigration
      |  Traits
      | -----------------------------------------------------------------
      */
+
     use ConfigHelper;
 
     /* -----------------------------------------------------------------
      |  Constructor
      | -----------------------------------------------------------------
      */
+
     /**
      * Migration constructor.
      */

src/Contracts/Discussion.php

@@ -30,6 +30,7 @@ interface Discussion
      |  Relationships
      | -----------------------------------------------------------------
      */
+
     /**
      * Participants relationship.
      *
@@ -62,6 +63,7 @@ public function creator();
      |  Scopes
      | -----------------------------------------------------------------
      */
+
     /**
      * Scope discussions that the user is associated with.
      *
@@ -107,6 +109,7 @@ public function scopeSubject(Builder $query, $subject, $strict = false);
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Get the latest_message attribute.
      *
@@ -118,6 +121,7 @@ public function getLatestMessageAttribute();
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Returns all of the latest discussions by `updated_at` date.
      *
@@ -147,7 +151,7 @@ public function participantsUserIds($userId = null);
     /**
      * Add a user to discussion as a participant.
      *
-     * @param  int   $userId
+     * @param  int  $userId
      *
      * @return \Arcanedev\LaravelMessenger\Models\Participant
      */

src/Contracts/Message.php

@@ -24,6 +24,7 @@ interface Message
      |  Relationships
      | -----------------------------------------------------------------
      */
+
     /**
      * Discussion relationship.
      *
@@ -56,6 +57,7 @@ public function participants();
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Recipients of this message.
      *

src/Contracts/Participant.php

@@ -22,6 +22,7 @@ interface Participant
      |  Relationships
      | -----------------------------------------------------------------
      */
+
     /**
      * Discussion relationship.
      *
@@ -40,6 +41,7 @@ public function user();
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Get the participant string info.
      *
@@ -51,6 +53,7 @@ public function stringInfo();
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Restore a soft-deleted model instance.
      *