Merge pull request #6 from ARCANEDEV/develop

arcanedev-maroc · web-flow · commit 21b7eff00117 · 2017-09-08T14:49:16.000+01:00
Updating the package for Laravel 5.5
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -23,7 +23,7 @@ checks:
 tools:
     external_code_coverage:
         timeout: 600
-        runs: 3
+        runs: 2
     php_code_sniffer:
         enabled: true
         config:
diff --git a/.travis.yml b/.travis.yml
@@ -3,7 +3,6 @@ language: php
 sudo: false
 
 php:
-  - 5.6
   - 7.0
   - 7.1
   - nightly
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ Spam Blocker is a package that allows you to block referral spammers.
   * Easy setup &amp; configuration.
   * Well documented &amp; IDE Friendly.
   * Well tested with maximum code quality.
-  * Laravel `5.1 | 5.2 | 5.3 | 5.4` are supported.
+  * Laravel `5.1 | 5.2 | 5.3 | 5.4 | 5.5` are supported.
   * Made with :heart: &amp; :coffee:.
   
 ## TODOS
@@ -45,7 +45,7 @@ If you discover any security related issues, please email arcanedev.maroc@gmail.
 - [ARCANEDEV][link-author]
 - [All Contributors][link-contributors]
 
-[badge_laravel]:      https://img.shields.io/badge/Laravel-5.1%20to%205.4-orange.svg?style=flat-square
+[badge_laravel]:      https://img.shields.io/badge/Laravel-5.1%20to%205.5-orange.svg?style=flat-square
 [badge_license]:      https://img.shields.io/packagist/l/arcanedev/spam-blocker.svg?style=flat-square
 [badge_build]:        https://img.shields.io/travis/ARCANEDEV/SpamBlocker.svg?style=flat-square
 [badge_coverage]:     https://img.shields.io/scrutinizer/coverage/g/ARCANEDEV/SpamBlocker.svg?style=flat-square
diff --git a/_docs/0.Home.md b/_docs/0.Home.md
@@ -7,7 +7,7 @@ Spam Blocker is a package that allows you to block referral spammers.
   * Easy setup &amp; configuration.
   * Well documented &amp; IDE Friendly.
   * Well tested with maximum code quality.
-  * Laravel `5.1 | 5.2 | 5.3 | 5.4` are supported.
+  * Laravel `5.1 | 5.2 | 5.3 | 5.4 | 5.5` are supported.
   * Made with :heart: &amp; :coffee:.
 
 ## Table of contents
diff --git a/_docs/1.Installation-and-Setup.md b/_docs/1.Installation-and-Setup.md
@@ -11,7 +11,7 @@
 The Spam Blocker package has a few system requirements:
 
 ```
-- PHP >= 5.6.4
+- PHP >= 7.0
 ```
 
 ## Version Compatibility
@@ -20,14 +20,17 @@ The Spam Blocker package has a few system requirements:
 |:-------------------------------------------|:---------------------------------------------------------------------------------------|
 | ![Spam Blocker v1.2.x][spam_blocker_1_2_x] | ![Laravel v5.1][laravel_5_1] ![Laravel v5.2][laravel_5_2] ![Laravel v5.3][laravel_5_3] |
 | ![Spam Blocker v1.3.x][spam_blocker_1_3_x] | ![Laravel v5.4][laravel_5_4]                                                           |
+| ![Spam Blocker v1.4.x][spam_blocker_1_4_x] | ![Laravel v5.5][laravel_5_5]                                                           |
 
 [laravel_5_1]:  https://img.shields.io/badge/v5.1-supported-brightgreen.svg?style=flat-square "Laravel v5.1"
 [laravel_5_2]:  https://img.shields.io/badge/v5.2-supported-brightgreen.svg?style=flat-square "Laravel v5.2"
 [laravel_5_3]:  https://img.shields.io/badge/v5.3-supported-brightgreen.svg?style=flat-square "Laravel v5.3"
 [laravel_5_4]:  https://img.shields.io/badge/v5.4-supported-brightgreen.svg?style=flat-square "Laravel v5.4"
+[laravel_5_5]:  https://img.shields.io/badge/v5.5-supported-brightgreen.svg?style=flat-square "Laravel v5.5"
 
 [spam_blocker_1_2_x]: https://img.shields.io/badge/version-1.2.*-blue.svg?style=flat-square "Spam Blocker v1.2.*"
 [spam_blocker_1_3_x]: https://img.shields.io/badge/version-1.3.*-blue.svg?style=flat-square "Spam Blocker v1.3.*"
+[spam_blocker_1_4_x]: https://img.shields.io/badge/version-1.4.*-blue.svg?style=flat-square "Spam Blocker v1.4.*"
 
 ## Composer
 
@@ -37,6 +40,8 @@ You can install this package via [Composer](http://getcomposer.org/) by running
 
 ### Setup
 
+> **NOTE :** The package will automatically register itself if you're using Laravel `>= v5.5`, so you can skip this section.
+
 Once the package is installed, you can register the service provider in `config/app.php` in the `providers` array:
 
 ```php
diff --git a/_docs/2.Configuration.md b/_docs/2.Configuration.md
@@ -1,3 +1,9 @@
 # 2. Configuration
 
-### Coming Soon&hellip;
+## Table of contents
+
+  1. [Installation and Setup](1.Installation-and-Setup.md)
+  2. [Configuration](2.Configuration.md)
+  3. [Usage](3.Usage.md)
+
+> Coming Soon&hellip;
diff --git a/_docs/3.Usage.md b/_docs/3.Usage.md
@@ -1,3 +1,9 @@
 # 3. Usage
 
-### Coming Soon&hellip;
+## Table of contents
+
+  1. [Installation and Setup](1.Installation-and-Setup.md)
+  2. [Configuration](2.Configuration.md)
+  3. [Usage](3.Usage.md)
+
+> Coming Soon&hellip;
diff --git a/composer.json b/composer.json
@@ -14,14 +14,14 @@
     "type":    "library",
     "license": "MIT",
     "require": {
-        "php":                           ">=5.6.4",
-        "arcanedev/support":             "~4.1.0",
+        "php":                           ">=7.0",
+        "arcanedev/support":             "~4.2.0",
         "piwik/referrer-spam-blacklist": "~1.0"
     },
     "require-dev": {
-        "orchestra/testbench": "~3.4.0",
-        "phpunit/phpcov":      "~3.0",
-        "phpunit/phpunit":     "~5.0"
+        "orchestra/testbench": "~3.5.0",
+        "phpunit/phpcov":      "~4.0",
+        "phpunit/phpunit":     "~6.0"
     },
     "autoload": {
         "psr-4": {
@@ -32,5 +32,15 @@
         "psr-4": {
             "Arcanedev\\SpamBlocker\\Tests\\": "tests/"
         }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Arcanedev\\SpamBlocker\\SpamBlockerServiceProvider"
+            ],
+            "aliases": {
+                "SpamBlocker": "Arcanedev\\SpamBlocker\\Facades\\SpamBlocker"
+            }
+        }
     }
 }
diff --git a/src/Contracts/SpamBlocker.php b/src/Contracts/SpamBlocker.php
@@ -16,7 +16,7 @@ interface SpamBlocker
     /**
      * Get the loaded spammers.
      *
-     * @return \Arcanedev\SpamBlocker\Entities\Spammers
+     * @return \Arcanedev\SpamBlocker\Entities\SpammerCollection
      */
     public function spammers();
 
@@ -94,7 +94,7 @@ public function block($host);
     /**
      * Get all spammers (allowed and blocked one).
      *
-     * @return \Arcanedev\SpamBlocker\Entities\Spammers
+     * @return \Arcanedev\SpamBlocker\Entities\SpammerCollection
      */
     public function all();
 
diff --git a/src/Entities/SpammerCollection.php b/src/Entities/SpammerCollection.php
@@ -1,14 +1,14 @@
 <?php namespace Arcanedev\SpamBlocker\Entities;
 
-use Arcanedev\Support\Collection;
+use Illuminate\Support\Collection;
 
 /**
- * Class     Spammers
+ * Class     SpammerCollection
  *
  * @package  Arcanedev\SpamBlocker\Entities
  * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
  */
-class Spammers extends Collection
+class SpammerCollection extends Collection
 {
     /* -----------------------------------------------------------------
      |  Main Methods
diff --git a/src/SpamBlocker.php b/src/SpamBlocker.php
@@ -1,7 +1,8 @@
 <?php namespace Arcanedev\SpamBlocker;
 
 use Arcanedev\SpamBlocker\Contracts\SpamBlocker as SpamBlockerContract;
-use Arcanedev\SpamBlocker\Entities\Spammers;
+use Arcanedev\SpamBlocker\Entities\SpammerCollection;
+use Closure;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Cache;
 
@@ -42,7 +43,7 @@ class SpamBlocker implements SpamBlockerContract
     /**
      * The spammers collection.
      *
-     * @var \Arcanedev\SpamBlocker\Entities\Spammers
+     * @var \Arcanedev\SpamBlocker\Entities\SpammerCollection
      */
     protected $spammers;
 
@@ -89,7 +90,7 @@ public function __construct(array $config)
     /**
      * Get the loaded spammers.
      *
-     * @return \Arcanedev\SpamBlocker\Entities\Spammers
+     * @return \Arcanedev\SpamBlocker\Entities\SpammerCollection
      */
     public function spammers()
     {
@@ -185,7 +186,7 @@ public function load()
         $this->checkSource();
 
         $this->spammers = $this->cacheSpammers(function () {
-            return Spammers::load(
+            return SpammerCollection::load(
                 file($this->source, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES)
             );
         });
@@ -228,7 +229,7 @@ public function block($host)
     /**
      * Get all spammers (allowed and blocked ones).
      *
-     * @return \Arcanedev\SpamBlocker\Entities\Spammers
+     * @return \Arcanedev\SpamBlocker\Entities\SpammerCollection
      */
     public function all()
     {
@@ -350,9 +351,9 @@ protected function resetCache()
      *
      * @param  \Closure  $callback
      *
-     * @return \Arcanedev\SpamBlocker\Entities\Spammers
+     * @return \Arcanedev\SpamBlocker\Entities\SpammerCollection
      */
-    private function cacheSpammers(\Closure $callback)
+    private function cacheSpammers(Closure $callback)
     {
         return Cache::remember($this->cacheKey, $this->cacheExpires, $callback);
     }
diff --git a/tests/Entities/SpammerCollectionTest.php b/tests/Entities/SpammerCollectionTest.php
@@ -1,22 +1,22 @@
 <?php namespace Arcanedev\SpamBlocker\Tests\Entities;
 
-use Arcanedev\SpamBlocker\Entities\Spammers;
+use Arcanedev\SpamBlocker\Entities\SpammerCollection;
 use Arcanedev\SpamBlocker\Tests\TestCase;
 
 /**
- * Class     SpammersTest
+ * Class     SpammerCollectionTest
  *
  * @package  Arcanedev\SpamBlocker\Tests\Entities
  * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
  */
-class SpammersTest extends TestCase
+class SpammerCollectionTest extends TestCase
 {
     /* -----------------------------------------------------------------
      |  Properties
      | -----------------------------------------------------------------
      */
 
-    /** @var  \Arcanedev\SpamBlocker\Entities\Spammers */
+    /** @var  \Arcanedev\SpamBlocker\Entities\SpammerCollection */
     private $spammers;
 
     /* -----------------------------------------------------------------
@@ -28,7 +28,7 @@ public function setUp()
     {
         parent::setUp();
 
-        $this->spammers = new Spammers;
+        $this->spammers = new SpammerCollection;
     }
 
     public function tearDown()
@@ -48,8 +48,7 @@ public function it_can_be_instantiated()
     {
         $expectations = [
             \Illuminate\Support\Collection::class,
-            \Arcanedev\Support\Collection::class,
-            \Arcanedev\SpamBlocker\Entities\Spammers::class,
+            \Arcanedev\SpamBlocker\Entities\SpammerCollection::class,
         ];
 
         foreach ($expectations as $expected) {
@@ -66,7 +65,7 @@ public function it_can_load_spammers()
             'spammer-three.com',
         ];
 
-        $this->spammers = Spammers::load($spammers);
+        $this->spammers = SpammerCollection::load($spammers);
 
         $this->assertCount(count($spammers), $this->spammers);
 
diff --git a/tests/Facades/SpamBlockerTest.php b/tests/Facades/SpamBlockerTest.php
@@ -22,7 +22,7 @@ public function it_can_get_spammers()
         $spammers = SpamBlocker::spammers();
 
         $this->assertInstanceOf(
-            \Arcanedev\SpamBlocker\Entities\Spammers::class,
+            \Arcanedev\SpamBlocker\Entities\SpammerCollection::class,
             $spammers
         );
 
diff --git a/tests/SpamBlockerTest.php b/tests/SpamBlockerTest.php
@@ -73,7 +73,7 @@ public function it_can_get_spammers()
         $spammers = $this->blocker->spammers();
 
         $this->assertInstanceOf(
-            \Arcanedev\SpamBlocker\Entities\Spammers::class,
+            \Arcanedev\SpamBlocker\Entities\SpammerCollection::class,
             $spammers
         );
 

-Original file line number
+Diff line change
 sudo: false
 php:
 -  - 5.6
   - 7.0
   - 7.1
   - nightly