[WIP] beta

Author: DarkaOnLine

.gitignore

@@ -3,3 +3,4 @@ vendor
 .php_cs.cache
 phpunit.xml
 coverage.xml
+test-reports

.php_cs

@@ -0,0 +1,78 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setUsingCache(false)
+    ->setRules(array(
+        'blank_line_after_opening_tag' => true,
+        'braces' => true,
+        'concat_space' => ['spacing' => 'none'],
+        'no_multiline_whitespace_around_double_arrow' => true,
+        'no_empty_statement' => true,
+        'elseif' => true,
+        'simplified_null_return' => true,
+        'encoding' => true,
+        'single_blank_line_at_eof' => true,
+        'no_extra_consecutive_blank_lines' => true,
+        'no_spaces_after_function_name' => true,
+        'function_declaration' => true,
+        'include' => true,
+        'indentation_type' => true,
+        'no_alias_functions' => true,
+        'blank_line_after_namespace' => true,
+        'line_ending' => true,
+        'no_trailing_comma_in_list_call' => true,
+        'not_operator_with_successor_space' => true,
+        'lowercase_constants' => true,
+        'lowercase_keywords' => true,
+        'method_argument_space' => true,
+        'trailing_comma_in_multiline_array' => true,
+        'no_multiline_whitespace_before_semicolons' => true,
+        'single_import_per_statement' => true,
+        'no_leading_namespace_whitespace' => true,
+        'no_blank_lines_after_class_opening' => true,
+        'no_blank_lines_after_phpdoc' => true,
+        'object_operator_without_whitespace' => true,
+        'binary_operator_spaces' => true,
+        'ordered_class_elements' => true,
+        'ordered_imports' => ['sortAlgorithm' => 'length'],
+        'no_spaces_inside_parenthesis' => true,
+        'phpdoc_indent' => true,
+        'phpdoc_inline_tag' => true,
+        'phpdoc_no_access' => true,
+        'phpdoc_no_package' => true,
+        'phpdoc_scalar' => true,
+        'phpdoc_summary' => true,
+        'phpdoc_to_comment' => true,
+        'phpdoc_trim' => true,
+        'phpdoc_no_alias_tag' => ['type' => 'var'],
+        'phpdoc_var_without_name' => true,
+        'no_leading_import_slash' => true,
+        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
+        'blank_line_before_return' => true,
+        'self_accessor' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'no_short_echo_tag' => true,
+        'full_opening_tag' => true,
+        'no_trailing_comma_in_singleline_array' => true,
+        'single_blank_line_before_namespace' => true,
+        'single_line_after_imports' => true,
+        'single_quote' => true,
+        'no_singleline_whitespace_before_semicolons' => true,
+        'cast_spaces' => true,
+        'standardize_not_equals' => true,
+        'ternary_operator_spaces' => true,
+        'no_trailing_whitespace' => true,
+        'trim_array_spaces' => true,
+        'binary_operator_spaces' => ['align_equals' => false],
+        'unary_operator_spaces' => true,
+        'no_unused_imports' => true,
+        'visibility_required' => true,
+        'no_whitespace_in_blank_line' => true,
+    ))
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in('src')
+            ->in('tests')
+    )
+;

.styleci.yml

@@ -1 +1 @@
-preset: psr2
+preset: laravel

.travis.yml

@@ -1,13 +1,17 @@
 language: php
 
-php:
-  - 7.0
-  - 7.1
-
+git:
+  depth: 1
 env:
-  matrix:
-    - COMPOSER_FLAGS="--prefer-lowest"
-    - COMPOSER_FLAGS=""
+  global:
+  - DEFAULT_COMPOSER_FLAGS="--no-interaction --no-progress --optimize-autoloader"
+  - REPORT_TESTS_COVERAGE=0
+matrix:
+  fast_finish: true
+  include:
+  - php: 7.0
+  - php: 7.1
+    env: REPORT_TESTS_COVERAGE=1
 
 cache:
   directories:
@@ -23,5 +27,5 @@ script:
   - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
 
 after_script:
-  - wget https://scrutinizer-ci.com/ocular.phar
-  - php ocular.phar code-coverage:upload --format=php-clover coverage.clover
+  - if [ $REPORT_TESTS_COVERAGE == 1 ]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [ $REPORT_TESTS_COVERAGE == 1 ]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi

README.md

@@ -1,4 +1,4 @@
-# Laravel Validator Rules - Credit Card
+# [WIP] Laravel Validator Rules - Credit Card
 
 This rule will validate that a given credit card **number**, **expiration date** or **cvc** is valid.
 
@@ -20,6 +20,106 @@ This rule will validate that a given credit card **number**, **expiration date**
   </a>
 </p>
 
+## Installation
+
+```bash
+composer require laravel-validation-rules/credit-card
+```
+
+## Usage
+### As FormRequest
+```php
+<?php
+
+namespace App\Http\Requests;
+
+use LVR\CreditCard\CardCvc;
+use LVR\CreditCard\CardNumber;
+use LVR\CreditCard\CardExpirationYear;
+use LVR\CreditCard\CardExpirationMonth;
+use Illuminate\Foundation\Http\FormRequest;
+
+class CreditCardRequest extends FormRequest
+{
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'card_number' => ['required', new CardNumber],
+            'expiration_year' => ['required', new CardExpirationYear($this->get('expiration_month'))],
+            'expiration_month' => ['required', new CardExpirationMonth($this->get('expiration_year'))],
+            'cvc' => ['required', new CardCvc($this->get('card_number'))]
+        ];
+    }
+}
+```
+
+### Card number
+#### From request
+```php
+$request->validate(
+    ['card_number' => '37873449367100'],
+    ['card_number' => new LVR\CreditCard\CardNumber]
+);
+```
+#### Directly
+```php
+(new LVR\CreditCard\Cards\Visa)
+    ->setCardNumber('4012888888881881')
+    ->isValidCardNumber()
+```
+
+
+### Card expiration
+#### From request
+```php
+// CardExpirationYear requires card expiration month
+$request->validate(
+    ['expiration_year' => '2017'],
+    ['expiration_year' => ['required', new LVR\CreditCard\CardExpirationYear($request->get('expiration_month'))]]
+);
+
+// CardExpirationMonth requires card expiration year
+$request->validate(
+    ['expiration_month' => '11'],
+    ['expiration_month' => ['required', new LVR\CreditCard\CardExpirationMonth($request->get('expiration_year'))]]
+);
+
+// CardExpirationDate requires date format
+$request->validate(
+    ['expiration_date' => '02-18'],
+    ['expiration_mont' => ['required', new LVR\CreditCard\CardExpirationDate('m-y')]]
+);
+```
+#### Directly
+```php
+LVR\CreditCard\Cards\Card::isValidExpirationDate(
+    $expiration_year,
+    $expiration_month
+);
+```
+
+
+### Card CVC
+#### From request
+```php
+// CardCvc requires card number to determine allowed cvc length
+$request->validate(
+    ['cvc' => '123'],
+    ['cvc' => new LVR\CreditCard\CardCvc($request->get('card_number'))]
+);
+
+```
+#### Directly
+```php
+LVR\CreditCard\Cards\Card::isValidCvcLength($cvc);
+```
+
+
 ### License
 This project is licensed under an Apache 2.0 license which you can find
 [in this LICENSE](https://github.com/laravel-validation-rules/credit-card/blob/master/LICENSE).

composer.json

@@ -7,8 +7,8 @@
         "illuminate/translation": "^5.5"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "~2.0",
-        "phpunit/phpunit": "~6.0",
+        "friendsofphp/php-cs-fixer": "~2.6",
+        "phpunit/phpunit": "6.2.*",
         "orchestra/testbench": "^3.5"
     },
     "autoload": {
@@ -22,7 +22,7 @@
         }
     },
     "scripts": {
-        "cs-fix": "php-cs-fixer fix . --rules=@PSR2",
+        "cs-fix": "php-cs-fixer fix .",
         "test": "phpunit --colors=always"
     },
     "license": "Apache-2.0",
@@ -31,5 +31,9 @@
             "name": "Darius Matulionis",
             "email": "[email protected]"
         }
-    ]
+    ],
+    "config": {
+        "preferred-install": "dist",
+        "sort-packages": true
+    }
 }

composer.lock

@@ -24,5 +24,8 @@
     </filter>
     <logging>
         <log type="coverage-clover" target="coverage.xml" showUncoveredFiles="true"/>
+        <log type="coverage-html" target="./test-reports" charset="UTF-8"
+             yui="true" highlight="true"
+             lowUpperBound="50" highLowerBound="80" />
     </logging>
 </phpunit>

phpunit.xml.dist

@@ -0,0 +1,53 @@
+<?php
+
+namespace LVR\CreditCard;
+
+use LVR\CreditCard\Cards\Card;
+use Illuminate\Contracts\Validation\Rule;
+
+class CardCvc implements Rule
+{
+    const MSG_CARD_CVC_INVALID = 'validation.credit_card.card_cvc_invalid';
+
+    protected $message;
+
+    /**
+     * Credit card number.
+     *
+     * @var string
+     */
+    protected $card_number;
+
+    public function __construct(string $card_number)
+    {
+        $this->message = static::MSG_CARD_CVC_INVALID;
+        $this->card_number = $card_number;
+    }
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param  string $attribute
+     * @param  mixed $value
+     *
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        try {
+            return Factory::makeFromNumber($this->card_number)->isValidCvc($value);
+        } catch (\Exception $ex) {
+            return false;
+        }
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return $this->message;
+    }
+}