Merge pull request #169 from mewebstudio/dev

Support Laravel 6

Author: mewebstudio

.travis.yml

@@ -1,14 +1,21 @@
 language: php
 
 php:
-  - 5.6
-  - 7.0
-  - 7.1
   - 7.2
   - 7.3
 
+# This triggers builds to run on the new TravisCI infrastructure.
+# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
+
+## Cache composer
+cache:
+  directories:
+    - $HOME/.composer/cache
+
 before_script:
   - travis_retry composer self-update
-  - travis_retry composer install --prefer-source --no-interaction
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
 
-script: make test
+script:
+  - phpunit --coverage-text --coverage-clover=coverage.clover

README.md

@@ -1,8 +1,12 @@
-# Captcha for Laravel 5
+# Captcha for Laravel 5 & 6
 
 [![Build Status](https://travis-ci.org/mewebstudio/captcha.svg?branch=master)](https://travis-ci.org/mewebstudio/captcha) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mewebstudio/captcha/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mewebstudio/captcha/?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/mews/captcha/v/stable.svg)](https://packagist.org/packages/mews/captcha)
+[![Latest Stable Version](https://poser.pugx.org/mews/captcha/v/unstable.svg)](https://packagist.org/packages/mews/captcha)
+[![License](https://poser.pugx.org/mews/captcha/license.svg)](https://packagist.org/packages/mews/captcha)
+[![Total Downloads](https://poser.pugx.org/mews/captcha/downloads.svg)](https://packagist.org/packages/mews/captcha)
 
-A simple [Laravel 5](http://www.laravel.com/) service provider for including the [Captcha for Laravel 5](https://github.com/mewebstudio/captcha).
+A simple [Laravel 5/6](http://www.laravel.com/) service provider for including the [Captcha for Laravel 5](https://github.com/mewebstudio/captcha).
 
 for Laravel 4 [Captcha for Laravel Laravel 4](https://github.com/mewebstudio/captcha/tree/master-l4)
 

composer.json

@@ -1,8 +1,8 @@
 {
 	"name": "mews/captcha",
 	"type": "package",
-	"description": "Laravel 5 Captcha Package",
-	"keywords": ["laravel5 Captcha", "laravel5 Security", "Captcha"],
+	"description": "Laravel 5 & 6 Captcha Package",
+	"keywords": ["laravel6 Captcha", "laravel6 Security", "laravel6 Captcha", "laravel5 Security", "Captcha"],
 	"homepage": "https://github.com/mewebstudio/captcha",
 	"license": "MIT",
 	"authors": [
@@ -14,17 +14,18 @@
 		}
 	],
 	"require": {
-		"php": ">=5.4",
+		"php": "^7.2",
 		"ext-gd": "*",
-		"illuminate/config": "~5.0",
-		"illuminate/filesystem": "~5.0",
-		"illuminate/support": "~5.0",
-		"illuminate/hashing": "~5.0",
-		"intervention/image": "~2.2"
+		"illuminate/config": "~5.0|^6.0",
+		"illuminate/filesystem": "~5.0|^6.0",
+		"illuminate/support": "~5.0|^6.0",
+		"illuminate/hashing": "~5.0|^6.0",
+		"illuminate/session": "~5.0|^6.0",
+		"intervention/image": "~2.5"
 	},
 	"require-dev": {
-		"phpunit/phpunit": "~4.1",
-        "mockery/mockery": "0.9.*"
+		"phpunit/phpunit": "^8.0",
+		"mockery/mockery": "^1.0"
 	},
 	"autoload": {
 		"psr-4": {
@@ -42,7 +43,7 @@
 			"Mews\\Test\\": "tests/"
 		}
 	},
-	"minimum-stability": "dev",
+	"minimum-stability": "stable",
 	"extra": {
 		"laravel": {
 			"providers": [

src/Captcha.php

@@ -3,7 +3,7 @@
 namespace Mews\Captcha;
 
 /**
- * Laravel 5 Captcha package
+ * Laravel 5 & 6 Captcha package
  *
  * @copyright Copyright (c) 2015 MeWebStudio
  * @version 2.x
@@ -18,8 +18,10 @@
 use Illuminate\Config\Repository;
 use Illuminate\Hashing\BcryptHasher as Hasher;
 use Illuminate\Filesystem\Filesystem;
-use Illuminate\Support\Facades\Crypt;
+use Illuminate\Http\File;
 use Illuminate\Support\Str;
+use Intervention\Image\Gd\Font;
+use Intervention\Image\Image;
 use Intervention\Image\ImageManager;
 use Illuminate\Session\Store as Session;
 use Illuminate\Support\HtmlString;
@@ -66,7 +68,7 @@ class Captcha
     protected $canvas;
 
     /**
-     * @var ImageManager->image
+     * @var Image
      */
     protected $image;
 
@@ -194,8 +196,7 @@ public function __construct(
         Session $session,
         Hasher $hasher,
         Str $str
-    )
-    {
+    ) {
         $this->files = $files;
         $this->config = $config;
         $this->imageManager = $imageManager;
@@ -223,16 +224,18 @@ protected function configure($config)
      * Create captcha image
      *
      * @param string $config
-     * @param boolean $api
-     * @return ImageManager->response
+     * @param bool $api
+     * @return array|mixed
+     * @throws Exception
      */
-    public function create($config = 'default', $api = false)
+    public function create(string $config = 'default', bool $api = false)
     {
         $this->backgrounds = $this->files->files(__DIR__ . '/../assets/backgrounds');
         $this->fonts = $this->files->files($this->fontsDirectory);
 
         if (version_compare(app()->version(), '5.5.0', '>=')) {
             $this->fonts = array_map(function ($file) {
+                /* @var File $file */
                 return $file->getPathName();
             }, $this->fonts);
         }
@@ -272,7 +275,7 @@ public function create($config = 'default', $api = false)
             $this->image->sharpen($this->sharpen);
         }
         if ($this->invert) {
-            $this->image->invert($this->invert);
+            $this->image->invert();
         }
         if ($this->blur) {
             $this->image->blur($this->blur);
@@ -290,22 +293,22 @@ public function create($config = 'default', $api = false)
      *
      * @return string
      */
-    protected function background()
+    protected function background(): string
     {
         return $this->backgrounds[rand(0, count($this->backgrounds) - 1)];
     }
 
     /**
      * Generate captcha text
      *
-     * @return string
+     * @return array
+     * @throws Exception
      */
-    protected function generate()
+    protected function generate(): array
     {
         $characters = is_string($this->characters) ? str_split($this->characters) : $this->characters;
 
         $bag = [];
-        $key = '';
 
         if ($this->math) {
             $x = random_int(10, 30);
@@ -336,8 +339,10 @@ protected function generate()
 
     /**
      * Writing captcha text
+     *
+     * @return void
      */
-    protected function text()
+    protected function text(): void
     {
         $marginTop = $this->image->height() / $this->length;
 
@@ -350,6 +355,7 @@ protected function text()
             $marginLeft = $this->textLeftPadding + ($key * ($this->image->width() - $this->textLeftPadding) / $this->length);
 
             $this->image->text($char, $marginLeft, $marginTop, function ($font) {
+                /* @var Font $font */
                 $font->file($this->font());
                 $font->size($this->fontSize());
                 $font->color($this->fontColor());
@@ -365,32 +371,32 @@ protected function text()
      *
      * @return string
      */
-    protected function font()
+    protected function font(): string
     {
         return $this->fonts[rand(0, count($this->fonts) - 1)];
     }
 
     /**
      * Random font size
      *
-     * @return integer
+     * @return int
      */
-    protected function fontSize()
+    protected function fontSize(): int
     {
         return rand($this->image->height() - 10, $this->image->height());
     }
 
     /**
      * Random font color
      *
-     * @return array
+     * @return string
      */
-    protected function fontColor()
+    protected function fontColor(): string
     {
         if (!empty($this->fontColors)) {
             $color = $this->fontColors[rand(0, count($this->fontColors) - 1)];
         } else {
-            $color = [rand(0, 255), rand(0, 255), rand(0, 255)];
+            $color = '#' . str_pad(dechex(mt_rand(0, 0xFFFFFF)), 6, '0', STR_PAD_LEFT);
         }
 
         return $color;
@@ -401,15 +407,15 @@ protected function fontColor()
      *
      * @return int
      */
-    protected function angle()
+    protected function angle(): int
     {
         return rand((-1 * $this->angle), $this->angle);
     }
 
     /**
      * Random image lines
      *
-     * @return \Intervention\Image\Image
+     * @return Image|ImageManager
      */
     protected function lines()
     {
@@ -420,6 +426,7 @@ protected function lines()
                 rand(0, $this->image->width()),
                 rand(0, $this->image->height()),
                 function ($draw) {
+                    /* @var Font $draw */
                     $draw->color($this->fontColor());
                 }
             );
@@ -431,10 +438,10 @@ function ($draw) {
     /**
      * Captcha check
      *
-     * @param $value
+     * @param string $value
      * @return bool
      */
-    public function check($value)
+    public function check(string $value): bool
     {
         if (!$this->session->has('captcha')) {
             return false;
@@ -448,7 +455,7 @@ public function check($value)
         }
 
         $check = $this->hasher->check($value, $key);
-        //  if verify pass,remove session
+        // if verify pass,remove session
         if ($check) {
             $this->session->remove('captcha');
         }
@@ -459,34 +466,35 @@ public function check($value)
     /**
      * Captcha check
      *
-     * @param $value
+     * @param string $value
+     * @param string $key
      * @return bool
      */
-    public function check_api($value, $key)
+    public function check_api($value, $key): bool
     {
         return $this->hasher->check($value, $key);
     }
 
     /**
      * Generate captcha image source
      *
-     * @param null $config
+     * @param string|null $config
      * @return string
      */
-    public function src($config = null)
+    public function src(?string $config): string
     {
         return url('captcha' . ($config ? '/' . $config : '/default')) . '?' . $this->str->random(8);
     }
 
     /**
      * Generate captcha image html tag
      *
-     * @param null $config
-     * @param array $attrs HTML attributes supplied to the image tag where key is the attribute
-     * and the value is the attribute value
+     * @param string|null $config
+     * @param array|null $attrs
+     * $attrs -> HTML attributes supplied to the image tag where key is the attribute and the value is the attribute value
      * @return string
      */
-    public function img($config = null, $attrs = [])
+    public function img(?string $config, ?array $attrs): string
     {
         $attrs_str = '';
         foreach ($attrs as $attr => $value) {

src/CaptchaController.php

@@ -2,6 +2,7 @@
 
 namespace Mews\Captcha;
 
+use Exception;
 use Illuminate\Routing\Controller;
 
 /**
@@ -13,11 +14,12 @@ class CaptchaController extends Controller
     /**
      * get CAPTCHA
      *
-     * @param \Mews\Captcha\Captcha $captcha
+     * @param Captcha $captcha
      * @param string $config
-     * @return \Intervention\Image\ImageManager->response
+     * @return array|mixed
+     * @throws Exception
      */
-    public function getCaptcha(Captcha $captcha, $config = 'default')
+    public function getCaptcha(Captcha $captcha, string $config = 'default')
     {
         if (ob_get_contents()) {
             ob_clean();
@@ -29,11 +31,12 @@ public function getCaptcha(Captcha $captcha, $config = 'default')
     /**
      * get CAPTCHA api
      *
-     * @param \Mews\Captcha\Captcha $captcha
+     * @param Captcha $captcha
      * @param string $config
-     * @return \Intervention\Image\ImageManager->response
+     * @return array|mixed
+     * @throws Exception
      */
-    public function getCaptchaApi(Captcha $captcha, $config = 'default')
+    public function getCaptchaApi(Captcha $captcha, string $config = 'default')
     {
         return $captcha->create($config, true);
     }