Merge pull request #9 from ARCANEDEV/dev

arcanedev-maroc · web-flow · commit c97630beeaf8 · 2018-01-31T17:42:05.000Z
Updating the package
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -23,7 +23,7 @@ checks:
 tools:
     external_code_coverage:
         timeout: 600
-        runs: 2
+        runs: 3
     php_code_sniffer:
         enabled: true
         config:
diff --git a/.travis.yml b/.travis.yml
@@ -5,6 +5,7 @@ sudo: false
 php:
   - 7.0
   - 7.1
+  - 7.2
   - nightly
 
 matrix:
diff --git a/_docs/3.Usage.md b/_docs/3.Usage.md
@@ -64,7 +64,7 @@ class Post extends Model {
      }
 }
 ```
- 
+
 #### Getting Notes
  
 ```php
@@ -73,7 +73,19 @@ $notes = $post->notes;
 ```
  
 > **NOTE :** `$post->notes` relation property is only available in the `HasManyNotes` trait. If you're using `HasOneNote` trait, use `$post->note` instead.    
+
+#### Getting the author's notes 
  
+You can also retrieve all the author's notes by using the `Arcanedev\LaravelNotes\Traits\AuthoredNotes` Trait in your User model (for example).
+
+```php
+$user = App\User::first();
+$post = App\Post::first();
+$post->createNote('Hello world #1', $user);
+
+$notes = $user->authoredNotes;
+```
+
 #### Finding a note with a specific ID
 
 ```php
diff --git a/database/migrations/2016_10_00_000001_create_notes_table.php b/database/migrations/2016_10_00_000001_create_notes_table.php
@@ -24,9 +24,7 @@ public function __construct()
     {
         parent::__construct();
 
-        $this->setTable(
-            $this->getTableFromConfig('notes', 'notes')
-        );
+        $this->setTable(config('notes.notes.table', 'notes'));
     }
 
     /* -----------------------------------------------------------------
@@ -43,8 +41,13 @@ public function up()
             $table->increments('id');
             $table->text('content');
             $table->morphs('noteable');
-            $table->integer('author_id', false, true)->nullable();
+            $table->unsignedInteger('author_id')->nullable();
             $table->timestamps();
+
+            $table->foreign('author_id')
+                  ->references('id')
+                  ->on(config('notes.authors.table', 'users'))
+                  ->onDelete('cascade');
         });
     }
 }
diff --git a/src/Bases/Migration.php b/src/Bases/Migration.php
@@ -1,7 +1,6 @@
 <?php namespace Arcanedev\LaravelNotes\Bases;
 
-use Arcanedev\LaravelNotes\Traits\ConfigHelper;
-use Arcanedev\Support\Bases\Migration as BaseMigration;
+use Arcanedev\Support\Database\Migration as BaseMigration;
 
 /**
  * Class     Migration
@@ -11,13 +10,6 @@
  */
 abstract class Migration extends BaseMigration
 {
-    /* -----------------------------------------------------------------
-     |  Traits
-     | -----------------------------------------------------------------
-     */
-
-    use ConfigHelper;
-
     /* -----------------------------------------------------------------
      |  Constructor
      | -----------------------------------------------------------------
@@ -28,7 +20,7 @@ abstract class Migration extends BaseMigration
      */
     public function __construct()
     {
-        $this->setConnection($this->getFromConfig('database.connection'));
-        $this->setPrefix($this->getFromConfig('database.prefix'));
+        $this->setConnection(config('notes.database.connection'));
+        $this->setPrefix(config('notes.database.prefix'));
     }
 }
diff --git a/src/Models/AbstractModel.php b/src/Models/AbstractModel.php
@@ -1,23 +1,15 @@
 <?php namespace Arcanedev\LaravelNotes\Models;
 
-use Arcanedev\LaravelNotes\Traits\ConfigHelper;
-use Arcanedev\Support\Bases\Model as BaseModel;
+use Arcanedev\Support\Database\Model;
 
 /**
  * Class     AbstractModel
  *
  * @package  Arcanedev\LaravelMessenger\Bases
  * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
  */
-abstract class AbstractModel extends BaseModel
+abstract class AbstractModel extends Model
 {
-    /* -----------------------------------------------------------------
-     |  Traits
-     | -----------------------------------------------------------------
-     */
-
-    use ConfigHelper;
-
     /* -----------------------------------------------------------------
      |  Constructor
      | -----------------------------------------------------------------
@@ -32,7 +24,7 @@ public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
 
-        $this->setConnection($this->getFromConfig('database.connection'));
-        $this->setPrefix($this->getFromConfig('database.prefix'));
+        $this->setConnection(config('notes.database.connection'));
+        $this->setPrefix(config('notes.database.prefix'));
     }
 }
diff --git a/src/Models/Note.php b/src/Models/Note.php
@@ -63,7 +63,7 @@ public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
 
-        $this->setTable($this->getTableFromConfig('notes', 'notes'));
+        $this->setTable(config('notes.notes.table', 'notes'));
     }
 
     /* -----------------------------------------------------------------
@@ -88,6 +88,6 @@ public function noteable()
      */
     public function author()
     {
-        return $this->belongsTo($this->getModelFromConfig('authors'));
+        return $this->belongsTo(config('notes.authors.model'));
     }
 }
diff --git a/src/Traits/AuthoredNotes.php b/src/Traits/AuthoredNotes.php
@@ -0,0 +1,29 @@
+<?php namespace Arcanedev\LaravelNotes\Traits;
+
+use Arcanedev\LaravelNotes\Models\Note;
+
+/**
+ * Trait     AuthoredNotes
+ *
+ * @package  Arcanedev\LaravelNotes\Traits
+ * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
+ *
+ * @property  \Illuminate\Database\Eloquent\Collection  authoredNotes
+ */
+trait AuthoredNotes
+{
+    /* -----------------------------------------------------------------
+     |  Relationships
+     | -----------------------------------------------------------------
+     */
+
+    /**
+     * Relation to ONE note.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function authoredNotes()
+    {
+        return $this->hasMany(config('notes.notes.model', Note::class), 'author_id');
+    }
+}
diff --git a/src/Traits/ConfigHelper.php b/src/Traits/ConfigHelper.php
diff --git a/src/Traits/HasManyNotes.php b/src/Traits/HasManyNotes.php
@@ -14,13 +14,6 @@
  */
 trait HasManyNotes
 {
-    /* -----------------------------------------------------------------
-     |  Traits
-     | -----------------------------------------------------------------
-     */
-
-    use ConfigHelper;
-
     /* -----------------------------------------------------------------
      |  Relationships
      | -----------------------------------------------------------------
@@ -33,7 +26,7 @@ trait HasManyNotes
      */
     public function notes()
     {
-        return $this->morphMany($this->getModelFromConfig('notes'), 'noteable');
+        return $this->morphMany(config('notes.notes.model'), 'noteable');
     }
 
     /* -----------------------------------------------------------------
@@ -57,7 +50,9 @@ public function createNote($content, $author = null, $reload = true)
             $this->prepareNoteAttributes($content, $author)
         );
 
-        if ($reload) $this->load(['notes']);
+        $relations = array_merge(['notes'], method_exists($this, 'authoredNotes') ? ['authoredNotes'] : []);
+
+        if ($reload) $this->load($relations);
 
         return $note;
     }
diff --git a/src/Traits/HasOneNote.php b/src/Traits/HasOneNote.php
@@ -9,18 +9,9 @@
  * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
  *
  * @property  \Arcanedev\LaravelNotes\Models\Note  note
- *
- * @method    \Illuminate\Database\Eloquent\Relations\MorphOne  morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
  */
 trait HasOneNote
 {
-    /* -----------------------------------------------------------------
-     |  Traits
-     | -----------------------------------------------------------------
-     */
-
-    use ConfigHelper;
-
     /* -----------------------------------------------------------------
      |  Relationships
      | -----------------------------------------------------------------
@@ -33,7 +24,7 @@ trait HasOneNote
      */
     public function note()
     {
-        return $this->morphOne($this->getModelFromConfig('notes'), 'noteable');
+        return $this->morphOne(config('notes.notes.model'), 'noteable');
     }
 
     /* -----------------------------------------------------------------
diff --git a/tests/LaravelNotesServiceProviderTest.php b/tests/LaravelNotesServiceProviderTest.php
@@ -1,4 +1,5 @@
 <?php namespace Arcanedev\LaravelNotes\Tests;
+
 use Arcanedev\LaravelNotes\LaravelNotesServiceProvider;
 
 /**
diff --git a/tests/Models/NoteTest.php b/tests/Models/NoteTest.php
@@ -150,7 +150,7 @@ public function it_can_add_note()
     /** @test */
     public function it_can_add_note_without_get_current_author_id_method()
     {
-        /** @var  UserWithAuthorId  $user */
+        /** @var  \Arcanedev\LaravelNotes\Tests\Stubs\Models\UserWithAuthorId  $user */
         $user = $this->factory->create(UserWithAuthorId::class);
 
         $this->assertCount(0, $user->notes);
@@ -172,4 +172,40 @@ public function it_can_find_note_by_its_id()
 
         $this->assertSame($note->id, $created->id);
     }
+
+    /** @test */
+    public function it_can_retrieve_authored_notes()
+    {
+        /** @var  \Arcanedev\LaravelNotes\Tests\Stubs\Models\User  $user */
+        $user = $this->factory->create(User::class);
+
+        $this->assertCount(0, $user->notes);
+        $this->assertCount(0, $user->authoredNotes);
+
+        $user->createNote('Hello World #1', $user);
+        $user->createNote('Hello World #2', $user);
+
+        $this->assertCount(2, $user->notes);
+        $this->assertCount(2, $user->authoredNotes()->get());
+    }
+
+    /** @test */
+    public function it_must_retrieve_authored_notes_foreach_owner()
+    {
+        /**
+         * @var  \Arcanedev\LaravelNotes\Tests\Stubs\Models\User  $userOne
+         * @var  \Arcanedev\LaravelNotes\Tests\Stubs\Models\User  $userTwo
+         */
+        $userOne = $this->factory->create(UserWithAuthorId::class);
+        $userTwo = $this->factory->create(UserWithAuthorId::class);
+
+        $userOne->createNote('Hello World #1');
+        $userOne->createNote('Hello World #2', $userTwo);
+
+        $this->assertCount(2, $userOne->notes);
+        $this->assertCount(1, $userOne->authoredNotes);
+
+        $this->assertCount(0, $userTwo->notes);
+        $this->assertCount(1, $userTwo->authoredNotes);
+    }
 }
diff --git a/tests/Stubs/Models/User.php b/tests/Stubs/Models/User.php
@@ -1,6 +1,7 @@
 <?php namespace Arcanedev\LaravelNotes\Tests\Stubs\Models;
 
 use Arcanedev\LaravelNotes\Models\AbstractModel;
+use Arcanedev\LaravelNotes\Traits\AuthoredNotes;
 use Arcanedev\LaravelNotes\Traits\HasManyNotes;
 
 /**
@@ -18,7 +19,8 @@ class User extends AbstractModel
      | -----------------------------------------------------------------
      */
 
-    use HasManyNotes;
+    use HasManyNotes,
+        AuthoredNotes;
 
     /* -----------------------------------------------------------------
      |  Properties
diff --git a/tests/Stubs/Models/UserWithAuthorId.php b/tests/Stubs/Models/UserWithAuthorId.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/fixtures/migrations/2016_10_00_000000_create_users_table.php b/tests/fixtures/migrations/2016_10_00_000000_create_users_table.php
diff --git a/tests/fixtures/migrations/2016_10_01_000000_create_posts_table.php b/tests/fixtures/migrations/2016_10_01_000000_create_posts_table.php

-Original file line number
+Diff line change
 php:
   - 7.0
   - 7.1
 +  - 7.2
   - nightly
 matrix:
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,7 @@ public function __construct()`
`24`	`24`	`{`
`25`	`25`	`parent::__construct();`
`26`	`26`
`27`		`- $this->setTable(`
`28`		`- $this->getTableFromConfig('notes', 'notes')`
`29`		`- );`
	`27`	`+ $this->setTable(config('notes.notes.table', 'notes'));`
`30`	`28`	`}`
`31`	`29`
`32`	`30`	`/* -----------------------------------------------------------------`
`@@ -43,8 +41,13 @@ public function up()`
`43`	`41`	`$table->increments('id');`
`44`	`42`	`$table->text('content');`
`45`	`43`	`$table->morphs('noteable');`
`46`		`- $table->integer('author_id', false, true)->nullable();`
	`44`	`+ $table->unsignedInteger('author_id')->nullable();`
`47`	`45`	`$table->timestamps();`
	`46`	`+`
	`47`	`+ $table->foreign('author_id')`
	`48`	`+ ->references('id')`
	`49`	`+ ->on(config('notes.authors.table', 'users'))`
	`50`	`+ ->onDelete('cascade');`
`48`	`51`	`});`
`49`	`52`	`}`
`50`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public function __construct(array $attributes = [])`
`63`	`63`	`{`
`64`	`64`	`parent::__construct($attributes);`
`65`	`65`
`66`		`- $this->setTable($this->getTableFromConfig('notes', 'notes'));`
	`66`	`+ $this->setTable(config('notes.notes.table', 'notes'));`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/* -----------------------------------------------------------------`
`@@ -88,6 +88,6 @@ public function noteable()`
`88`	`88`	`*/`
`89`	`89`	`public function author()`
`90`	`90`	`{`
`91`		`- return $this->belongsTo($this->getModelFromConfig('authors'));`
	`91`	`+ return $this->belongsTo(config('notes.authors.model'));`
`92`	`92`	`}`
`93`	`93`	`}`