Minor fixes

ARCANEDEV · Sep 1, 2017 · 8bfe8f8 · 8bfe8f8
1 parent 7fd3c6b
commit 8bfe8f8
Show file tree

Hide file tree

Showing 15 changed files with 105 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,6 @@ Feel free to check out the [releases](https://github.com/ARCANEDEV/Notify/releas
 
 ## Table of contents
 
-  0. [Home](_docs/0-Home.md)
   1. [Installation and Setup](_docs/1-Installation-and-Setup.md)
   2. [Configuration](_docs/2-Configuration.md)
   3. [Usage](_docs/3-Usage.md)

diff --git a/_docs/1-Installation-and-Setup.md b/_docs/1-Installation-and-Setup.md
@@ -2,10 +2,9 @@
 
 ## Table of contents
 
-0. [Home](0-Home.md)
-1. [Installation and Setup](1-Installation-and-Setup.md)
-2. [Configuration](2-Configuration.md)
-3. [Usage](3-Usage.md)
+  1. [Installation and Setup](1-Installation-and-Setup.md)
+  2. [Configuration](2-Configuration.md)
+  3. [Usage](3-Usage.md)
 
 ## Server Requirements
 

diff --git a/_docs/2-Configuration.md b/_docs/2-Configuration.md
@@ -2,7 +2,6 @@
 
 ## Table of contents
 
-  0. [Home](0-Home.md)
   1. [Installation and Setup](1-Installation-and-Setup.md)
   2. [Configuration](2-Configuration.md)
   3. [Usage](3-Usage.md)

diff --git a/_docs/3-Usage.md b/_docs/3-Usage.md
@@ -2,7 +2,6 @@
 
 ## Table of contents
 
-  0. [Home](0-Home.md)
   1. [Installation and Setup](1-Installation-and-Setup.md)
   2. [Configuration](2-Configuration.md)
   3. [Usage](3-Usage.md)

diff --git a/src/Contracts/Notify.php b/src/Contracts/Notify.php
@@ -8,10 +8,11 @@
  */
 interface Notify
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * Get the notification message.
      *
@@ -61,10 +62,11 @@ public function hasOption($key);
      */
     public function ready();
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Flash a message.
      *

diff --git a/src/Contracts/SessionStore.php b/src/Contracts/SessionStore.php
@@ -8,10 +8,11 @@
  */
 interface SessionStore
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Flash a message to the session.
      *

diff --git a/src/Facades/Notify.php b/src/Facades/Notify.php
@@ -1,5 +1,6 @@
 <?php namespace Arcanedev\Notify\Facades;
 
+use Arcanedev\Notify\Contracts\Notify as NotifyContract;
 use Illuminate\Support\Facades\Facade as Facade;
 
 /**
@@ -15,8 +16,5 @@ class Notify extends Facade
      *
      * @return string
      */
-    protected static function getFacadeAccessor()
-    {
-        return \Arcanedev\Notify\Contracts\Notify::class;
-    }
+    protected static function getFacadeAccessor() { return NotifyContract::class; }
 }
diff --git a/src/Notify.php b/src/Notify.php
@@ -12,10 +12,11 @@
  */
 class Notify implements NotifyContract
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Properties
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * Session prefix name.
      *
@@ -30,10 +31,11 @@ class Notify implements NotifyContract
      */
     private $session;
 
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Constructor
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * Create a new flash notifier instance.
      *
@@ -46,10 +48,11 @@ public function __construct(SessionStore $session, $prefix)
         $this->sessionPrefix = $prefix;
     }
 
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * Get the notification message.
      *
@@ -117,10 +120,11 @@ public function ready()
         return ! empty($this->message());
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Flash a message.
      *
@@ -141,10 +145,11 @@ public function flash($message, $type = '', array $options = [])
         return $this;
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Other Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Other Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Prefix the name.
      *

diff --git a/src/NotifyServiceProvider.php b/src/NotifyServiceProvider.php
@@ -10,10 +10,11 @@
  */
 class NotifyServiceProvider extends ServiceProvider
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Properties
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * Package name.
      *
@@ -28,20 +29,6 @@ class NotifyServiceProvider extends ServiceProvider
      */
     protected $defer = true;
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Getters & Setters
-     | ------------------------------------------------------------------------------------------------
-     */
-    /**
-     * Get the base path of the package.
-     *
-     * @return string
-     */
-    public function getBasePath()
-    {
-        return dirname(__DIR__);
-    }
-
     /* ------------------------------------------------------------------------------------------------
      |  Main Functions
      | ------------------------------------------------------------------------------------------------
@@ -51,6 +38,8 @@ public function getBasePath()
      */
     public function register()
     {
+        parent::register();
+
         $this->registerConfig();
 
         $this->bindSession();

diff --git a/src/Storage/Session.php b/src/Storage/Session.php
@@ -11,21 +11,23 @@
  */
 class Session implements SessionStore
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Properties
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * The Illuminate Session instance.
      *
      * @var \Illuminate\Session\Store
      */
     private $session;
 
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Constructor
-     | ------------------------------------------------------------------------------------------------
+     | -----------------------------------------------------------------
      */
+
     /**
      * Make session store instance.
      *
@@ -36,10 +38,11 @@ public function __construct(IlluminateSession $session)
         $this->session = $session;
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     /**
      * Flash a message to the session.
      *

diff --git a/tests/Facades/NotifyTest.php b/tests/Facades/NotifyTest.php
@@ -11,10 +11,11 @@
  */
 class NotifyTest extends TestCase
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Test Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Tests
+     | -----------------------------------------------------------------
      */
+
     /** @test */
     public function it_can_flash_a_notification_with_only_message()
     {

diff --git a/tests/HelperTest.php b/tests/HelperTest.php
@@ -8,21 +8,23 @@
  */
 class HelperTest extends TestCase
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     public function setUp()
     {
         parent::setUp();
 
         $this->assertFalse(notify()->ready());
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Test Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Tests
+     | -----------------------------------------------------------------
      */
+
     /** @test */
     public function it_can_flash_a_notification_with_only_message()
     {

diff --git a/tests/NotifyServiceProviderTest.php b/tests/NotifyServiceProviderTest.php
@@ -10,19 +10,19 @@
  */
 class NotifyServiceProviderTest extends TestCase
 {
-    /* ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
      |  Properties
-     | ------------------------------------------------------------------------------------------------
-     */
-    /**
-     * @var NotifyServiceProvider
+     | -----------------------------------------------------------------
      */
+
+    /** @var \Arcanedev\Notify\NotifyServiceProvider */
     private $provider;
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
      */
+
     public function setUp()
     {
         parent::setUp();
@@ -37,10 +37,26 @@ public function tearDown()
         parent::tearDown();
     }
 
-    /* ------------------------------------------------------------------------------------------------
-     |  Test Functions
-     | ------------------------------------------------------------------------------------------------
+    /* -----------------------------------------------------------------
+     |  Tests
+     | -----------------------------------------------------------------
      */
+
+    /** @test */
+    public function it_can_be_instantiated()
+    {
+        $expectations = [
+            \Illuminate\Support\ServiceProvider::class,
+            \Arcanedev\Support\ServiceProvider::class,
+            \Arcanedev\Support\PackageServiceProvider::class,
+            \Arcanedev\Notify\NotifyServiceProvider::class,
+        ];
+
+        foreach ($expectations as $expected) {
+            $this->assertInstanceOf($expected, $this->provider);
+        }
+    }
+
     /** @test */
     public function it_can_provides()
     {