refactor: added helper and service

.php-cs-fixer.dist.php

@@ -2,15 +2,24 @@
 
 declare(strict_types=1);
 
+/**
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
+ *
+ * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 use CodeIgniter\CodingStandard\CodeIgniter4;
 use Nexus\CsConfig\Factory;
 use PhpCsFixer\Finder;
 
 $finder = Finder::create()
     ->files()
     ->in([
-        __DIR__ . '/src/',
-        __DIR__ . '/tests/',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
     ])
     ->exclude('build')
     ->append([
@@ -25,4 +34,9 @@
     'cacheFile' => 'build/.php-cs-fixer.cache',
 ];
 
-return Factory::create(new CodeIgniter4(), $overrides, $options)->forProjects();
+return Factory::create(new CodeIgniter4(), $overrides, $options)->forLibrary(
+    'PHPDevsr/recaptcha-codeigniter4',
+    'Denny Septian Panggabean',
+    'xamidimura@gmail.com',
+    2023
+);

admin/pre-commit

@@ -19,21 +19,6 @@ if [ "$STAGED_PHP_FILES" != "" ]; then
     done
 fi
 
-if [ "$FILES" != "" ]; then
-    echo "Running PHPStan..."
-
-    if [ -d /proc/cygdrive ]; then
-        XDEBUG_MODE=off ./vendor/bin/phpstan analyse
-    else
-        XDEBUG_MODE=off php ./vendor/bin/phpstan analyse
-    fi
-
-    if [ $? != 0 ]; then
-        echo "Fix the phpstan error(s) before commit."
-        exit 1
-    fi
-fi
-
 if [ "$FILES" != "" ]; then
     echo "Running PHP CS Fixer..."
 

composer.json

@@ -21,9 +21,13 @@
         "php": "^7.4 || ^8.0"
     },
     "require-dev": {
-        "codeigniter4/devkit": "^1.0",
         "codeigniter4/framework": "^4.3",
-        "rector/rector": "^0.18"
+        "codeigniter/coding-standard": "^1.7",
+        "nexusphp/tachycardia": "^1.4",
+        "php-coveralls/php-coveralls": "^2.5",
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^9.6",
+        "rector/rector": "0.18.3"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

phpunit.xml.dist

@@ -47,7 +47,7 @@
 			<arguments>
 				<array>
 					<element key="timeLimit">
-						<double>0.50</double>
+						<double>0.40</double>
 					</element>
 					<element key="reportable">
 						<integer>30</integer>

rector.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 /**
- * This file is part of PHPDevsr/Minifyku.
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
  *
  * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
  *

src/Commands/ConfigPublish.php

@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
+ *
+ * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 namespace PHPDevsr\Recaptcha\Commands;
 
 use CodeIgniter\CLI\BaseCommand;
@@ -42,7 +51,7 @@ protected function determineSourcePath()
     {
         $this->sourcePath = realpath(__DIR__ . '/../');
 
-        if ($this->sourcePath === '/' || empty($this->sourcePath)) {
+        if (in_array($this->sourcePath, ['/', ''], true) || $this->sourcePath === false) {
             CLI::error('Unable to determine the correct source directory. Bailing.');
 
             exit();

src/Config/Recaptcha.php

@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
+ *
+ * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 namespace PHPDevsr\Recaptcha\Config;
 
 use CodeIgniter\Config\BaseConfig;

src/Config/Services.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
+ *
+ * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace PHPDevsr\Recaptcha\Config;
+
+use CodeIgniter\Config\BaseService;
+use PHPDevsr\Recaptcha\Recaptcha;
+
+class Services extends BaseService
+{
+    public static function recaptcha(bool $getShared = true): Recaptcha
+    {
+        if ($getShared) {
+            return self::getSharedInstance('recaptcha');
+        }
+
+        return new Recaptcha(config('Recaptcha'));
+    }
+}

src/Helpers/recaptcha_helper.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
+ *
+ * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+if (! function_exists('getWidget')) {
+    /**
+     * Render reCAPTCHA Widget
+     *
+     * @param array $parameters Attribute
+     */
+    function getWidget(array $parameters = []): string
+    {
+        $recaptcha = service('recaptcha');
+
+        return $recaptcha->getWidget($parameters);
+    }
+}
+
+if (! function_exists('getScriptTag')) {
+    /**
+     * Render Script Tag
+     *
+     * @param array $parameters Attribute
+     */
+    function getScriptTag(array $parameters = []): string
+    {
+        $recaptcha = service('recaptcha');
+
+        return $recaptcha->getScriptTag($parameters);
+    }
+}
+
+if (! function_exists('verifyResponse')) {
+    /**
+     * Verify Response
+     *
+     * @param string $response response string from Recaptcha Verification
+     */
+    function verifyResponse($response): array
+    {
+        $recaptcha = service('recaptcha');
+
+        return $recaptcha->verifyResponse($response);
+    }
+}

src/Recaptcha.php

@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
+ *
+ * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 namespace PHPDevsr\Recaptcha;
 
 use CodeIgniter\Config\Services;
@@ -22,14 +31,12 @@ class Recaptcha
     protected RecaptchaConfig $config;
     protected CURLRequest $curl;
 
-    public function __construct(?RecaptchaConfig $config = null)
+    public function __construct(RecaptchaConfig $config)
     {
         // Set Config
-        if (null !== $config) {
-            $this->config = $config;
-        }
+        $this->config = $config;
 
-        if (empty($this->config->recaptchaSiteKey) || empty($this->config->recaptchaSecretKey)) {
+        if ($this->config->recaptchaSiteKey === '' || $this->config->recaptchaSecretKey === '') {
             throw new Exception('To use reCAPTCHA you must get an API key from ' . self::sign_up_url);
         }
 
@@ -71,7 +78,7 @@ protected function _submitHTTPGet(array $data = [])
      */
     public function verifyResponse($response, $remoteIp = null)
     {
-        $remoteIp = (! empty($remoteIp)) ? $remoteIp : $_SERVER['REMOTE_ADDR'];
+        $remoteIp = (empty($remoteIp)) ? $_SERVER['REMOTE_ADDR'] : $remoteIp;
 
         // Discard empty solution submissions
         if (empty($response)) {

tests/RecaptchaTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * This file is part of PHPDevsr/recaptcha-codeigniter4.
+ *
+ * (c) 2023 Denny Septian Panggabean <xamidimura@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 namespace Tests;
 
 use CodeIgniter\Test\CIUnitTestCase;
@@ -17,7 +26,12 @@ public function testExceptionAPIKey()
         $this->expectException(Exception::class);
         $this->expectExceptionMessage('To use reCAPTCHA you must get an API key from https://www.google.com/recaptcha/admin');
 
-        new Recaptcha();
+        $config                     = new RecaptchaConfig();
+        $config->recaptchaSiteKey   = '';
+        $config->recaptchaSecretKey = '';
+        $config->recaptchaLang      = 'id';
+
+        new Recaptcha($config);
     }
 
     public function testGetScriptTagDefault()