Merge branch 'dev' into main

Author: wilsenhc

.github/workflows/run-tests.yml

@@ -0,0 +1,43 @@
+name: run-tests
+
+on: [push, pull_request]
+
+jobs:
+    test:
+        runs-on: ${{ matrix.os }}
+        strategy:
+            fail-fast: true
+            matrix:
+                os: [ubuntu-latest]
+                php: [8.0, 7.3]
+                laravel: [8.*]
+                dependency-version: [prefer-lowest, prefer-stable]
+                include:
+                    -   laravel: 8.*
+                        testbench: 6.*
+
+        name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
+
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v2
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: ${{ matrix.php }}
+                    extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+                    coverage: none
+
+            -   name: Setup problem matchers
+                run: |
+                    echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+                    echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+            -   name: Install dependencies
+                run: |
+                    composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+                    composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+
+            -   name: Execute tests
+                run: vendor/bin/phpunit

.gitignore

@@ -3,4 +3,5 @@ composer.lock
 docs
 vendor
 coverage
-.php_cs.cache
+.php_cs.cache
+.phpunit.result.cache

composer.json

@@ -0,0 +1,48 @@
+{
+    "name": "wilsenhc/laravel-rif-validation",
+    "description": "Regla de Validación para conocer si un RIF (Registro Único de Información Fiscal) está bien formado",
+    "keywords": [
+        "wilsenhc",
+        "seniat",
+        "rif",
+        "laravel-rif-validation",
+        "laravel-validar-rif"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Wilsen Hernández",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.3|^8.0",
+        "illuminate/support": "^8.0",
+        "illuminate/contracts": "^8.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^6.0",
+        "phpunit/phpunit": "^9.4"
+    },
+    "autoload": {
+        "psr-4": {
+            "Wilsenhc\\RifValidation\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Wilsenhc\\RifValidation\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
+    },
+    "extra": {
+        "laravel" : {
+            "providers" : [
+                "Wilsenhc\\RifValidation\\RifValidationServiceProvider"
+            ]
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" cacheResult="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Wilsenhc Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

resources/lang/en/messages.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'rif' => 'RIF is invalid.',
+];

resources/lang/es/messages.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'rif' => 'El RIF es inválido.',
+];

src/RifValidationServiceProvider.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Wilsenhc\RifValidation;
+
+use Illuminate\Support\ServiceProvider;
+
+class RifValidationServiceProvider extends ServiceProvider
+{
+    public function boot()
+    {
+        $this->publishes([
+            __DIR__.'/../resources/lang' => resource_path('lang/vendor/validateRif'),
+        ]);
+
+        $this->loadTranslationsFrom(__DIR__.'/../resources/lang/', 'validateRif');
+    }
+}

src/Rules/Rif.php

@@ -0,0 +1,102 @@
+<?php
+
+namespace Wilsenhc\RifValidation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+class Rif implements Rule
+{
+    /** @var string */
+    protected $attribute;
+
+    /** @var array */
+    protected $nationality_array;
+
+    /** @var array */
+    protected $multipliers;
+
+    public function __construct()
+    {
+        $this->nationality_array = [
+            'V' => '1',
+            'E' => '2',
+            'J' => '3',
+            'P' => '4',
+            'G' => '5',
+            'C' => '3',
+        ];
+
+        $this->multipliers = [4, 3, 2, 7 ,6, 5, 4, 3, 2];
+    }
+
+    /**
+     * Determine if the RIF validation rule passes.
+     *
+     * @param  string  $attribute
+     * @param  mixed  $value
+     * @return bool
+     */
+    public function passes($attribute, $value): bool
+    {
+        $this->attribute = $attribute;
+
+        // Verificar si el RIF tiene el formato valido
+        if (!preg_match('/^[VEPJGC]-?[\d]{8}-?[\d]$/i', $value))
+        {
+            return false;
+        }
+
+        $full_rif = strtoupper($value);
+        $full_rif = str_replace('-', '', $value);
+
+        $contributor = substr($full_rif, 0, -1);
+        $validationNumber = substr($full_rif, -1, 1);
+
+        return $this->validationNumber($contributor) == $validationNumber;
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message(): string
+    {
+        return __('validateRif::messages.rif', [
+            'attribute' => $this->attribute,
+        ]);
+    }
+
+    /**
+     * Calcate the Validation Number
+     *
+     * @param  string  $rif
+     * @return string
+     */
+    private function validationNumber($rif): string
+    {
+        // FIRST STEP:
+        // Replace the letter for its numeric value.
+        $rif[0] = $this->nationality_array[$rif[0]];
+
+        $split_rif = str_split($rif);
+
+        // SECOND STEP
+        // Multiply each value by its *constant* multiplier from the multipiers
+        // array.
+        $sum = 0;
+        foreach ($split_rif as $index => $value)
+        {
+            $sum += intval($value) * $this->multipliers[$index];
+        }
+
+        // THIRD STEP
+        $remainder = intval($sum % 11);
+
+        // FOURTH STEP
+        $difference = 11 - $remainder;
+
+        // FINAL STEP
+        return ($difference > 9) ? '0' : strval($difference);
+    }
+}

tests/Rules/RifTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Wilsenhc\RifValidation\Tests\Rules;
+
+use Orchestra\Testbench\TestCase;
+
+use Wilsenhc\RifValidation\Rules\Rif;
+use Wilsenhc\RifValidation\RifValidationServiceProvider;
+
+class RifTest extends TestCase
+{
+    /**
+     * @var  \Wilsenhc\RifValidation\Rules\Rif  $rule
+     */
+    protected $rule;
+
+    /**
+     * Setup the test environment.
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->rule = new Rif();
+    }
+
+    protected function getPackageProviders($app)
+    {
+        return [
+            RifValidationServiceProvider::class,
+        ];
+    }
+
+    /** @test */
+    public function it_will_return_true_if_rif_is_valid()
+    {
+        // Valid RIF of "Universidad de Carabobo"
+        $rif = 'G-20000041-4';
+
+        $this->assertTrue($this->rule->passes('rif', $rif));
+
+        // Valid RIF of "Banesco Banco Universal"
+        $rif = 'J-07013380-5';
+
+        $this->assertTrue($this->rule->passes('rif', $rif));
+
+        // Valid RIF of "Nicolas Maduro Moros"
+        $rif = 'V-05892464-0';
+
+        $this->assertTrue($this->rule->passes('rif', $rif));
+    }
+
+    /** @test */
+    public function it_will_return_false_if_format_is_invalid()
+    {
+        // Starts with a RIF Type that doesn't exist
+        $rif = 'Q-00000000-0';
+
+        $this->assertFalse($this->rule->passes('rif', $rif));
+
+        // Extra number
+        $rif = 'G-200000041-4';
+
+        $this->assertFalse($this->rule->passes('rif', $rif));
+
+        // Missing numbers
+        $rif = 'V-5892464';
+
+        $this->assertFalse($this->rule->passes('rif', $rif));
+
+        // Letter where there should be only numbers
+        $rif = 'G-200F00041-F';
+
+        $this->assertFalse($this->rule->passes('rif', $rif));
+    }
+}