Small coding standards and docs improvements

henriquemoody · henriquemoody · commit cd4654585524 · 2015-10-24T01:32:07.000-02:00
diff --git a/docs/ArrayVal.md b/docs/ArrayVal.md
@@ -2,7 +2,7 @@
 
 - `v::arrayVal()`
 
-Validates if the input is an array or if the input be used as an array
+Validates if the input is an array or if the input can be used as an array
 (instance of `ArrayAccess`).
 
 ```php
diff --git a/library/Exceptions/BoolValException.php b/library/Exceptions/BoolValException.php
@@ -18,6 +18,6 @@ class BoolValException extends ValidationException
         ],
         self::MODE_NEGATIVE => [
             self::STANDARD => '{{name}} must not be a boolean value',
-        ]
+        ],
     ];
 }
diff --git a/library/Exceptions/FloatTypeException.php b/library/Exceptions/FloatTypeException.php
@@ -19,6 +19,6 @@ class FloatTypeException extends ValidationException
         ],
         self::MODE_NEGATIVE => [
             self::STANDARD => '{{name}} must not be of the type float',
-        ]
+        ],
     ];
 }
diff --git a/library/Rules/Bsn.php b/library/Rules/Bsn.php
@@ -12,7 +12,7 @@
 namespace Respect\Validation\Rules;
 
 /**
- * Validates a Dutch citizen service number (BSN)
+ * Validates a Dutch citizen service number (BSN).
  *
  * @author Ronald Drenth <ronalddrenth@gmail.com>
  *
@@ -34,7 +34,7 @@ public function validate($input)
         }
 
         $sum = -1 * $input[8];
-        for ($i = 9; $i > 1; $i--) {
+        for ($i = 9; $i > 1; --$i) {
             $sum += $i * $input[9 - $i];
         }
 
diff --git a/library/Rules/CountryCode.php b/library/Rules/CountryCode.php
@@ -18,8 +18,8 @@
  */
 class CountryCode extends AbstractSearcher
 {
-    const ALPHA2  = 'alpha-2';
-    const ALPHA3  = 'alpha-3';
+    const ALPHA2 = 'alpha-2';
+    const ALPHA3 = 'alpha-3';
     const NUMERIC = 'numeric';
 
     /**
@@ -293,7 +293,7 @@ public function __construct($set = self::ALPHA2)
             throw new ComponentException(sprintf('"%s" is not a valid country set for ISO 3166-1', $set));
         }
 
-        $this->set   = $set;
+        $this->set = $set;
         $this->index = $index;
     }
 
diff --git a/library/Rules/CreditCard.php b/library/Rules/CreditCard.php
@@ -27,7 +27,7 @@ private function verifyMod10($input)
     {
         $sum = 0;
         $input = strrev($input);
-        for ($i = 0; $i < strlen($input); $i++) {
+        for ($i = 0; $i < strlen($input); ++$i) {
             $current = substr($input, $i, 1);
             if ($i % 2 == 1) {
                 $current *= 2;
diff --git a/library/Rules/NfeAccessKey.php b/library/Rules/NfeAccessKey.php
@@ -33,7 +33,7 @@ public function validate($aK)
         }
 
         $w = [];
-        for ($i = 0, $z = 5, $m = 43; $i <= $m; $i++) {
+        for ($i = 0, $z = 5, $m = 43; $i <= $m; ++$i) {
             $z = ($i < $m) ? ($z - 1) == 1 ? 9 : ($z - 1)  : 0;
             $w[] = $z;
         }
diff --git a/library/Rules/VideoUrl.php b/library/Rules/VideoUrl.php
@@ -34,7 +34,7 @@ class VideoUrl extends AbstractRule
     ];
 
     /**
-     * Create a new instance VideoUrl
+     * Create a new instance VideoUrl.
      *
      * @param string $service
      */
diff --git a/library/Validator.php b/library/Validator.php
@@ -55,7 +55,7 @@
  * @method static Validator each(Validatable $itemValidator = null, Validatable $keyValidator = null)
  * @method static Validator email()
  * @method static Validator endsWith(mixed $endValue, bool $identical = false)
- * @method static Validator equals(mixed $compareTo, bool $compareIdentical = false)
+ * @method static Validator equals(mixed $compareTo)
  * @method static Validator even()
  * @method static Validator executable()
  * @method static Validator exists()
diff --git a/tests/integration/exception_update.phpt b/tests/integration/exception_update.phpt
@@ -8,7 +8,7 @@ use Respect\Validation\Validator as v;
 try {
     v::not(v::alnum())->check('abc123');
 } catch (Exception $exception) {
-    $exception->setParam('translator', function() {
+    $exception->setParam('translator', function () {
         return '{{name}} não deve conter letras (a-z) ou dígitos (0-9)';
     });
     echo $exception->getMessage();
diff --git a/tests/integration/issue-425.phpt b/tests/integration/issue-425.phpt
@@ -3,8 +3,8 @@
 
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\AllOfException;
+use Respect\Validation\Validator as v;
 
 $validator = v::create()
     ->key('age', v::intType()->notEmpty()->noneOf(v::stringType()))
diff --git a/tests/integration/readme/example_1.phpt b/tests/integration/readme/example_1.phpt
@@ -4,11 +4,11 @@ require 'vendor/autoload.php';
 
 use Respect\Validation\Validator as v;
 
-$user = new stdClass;
+$user = new stdClass();
 $user->name = 'Alexandre';
 $user->birthdate = '1987-07-01';
 
-$userValidator = v::attribute('name', v::stringType()->length(1,32))
+$userValidator = v::attribute('name', v::stringType()->length(1, 32))
                   ->attribute('birthdate', v::date()->age(18));
 
 $userValidator->assert($user);
diff --git a/tests/integration/readme/example_2.phpt b/tests/integration/readme/example_2.phpt
@@ -2,14 +2,14 @@
 <?php
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\NestedValidationException;
+use Respect\Validation\Validator as v;
 
 $usernameValidator = v::alnum()->noWhitespace()->length(1, 15);
 try {
     $usernameValidator->assert('really messed up screen#name');
-} catch(NestedValidationException $exception) {
-   echo $exception->getFullMessage();
+} catch (NestedValidationException $exception) {
+    echo $exception->getFullMessage();
 }
 ?>
 --EXPECTF--
diff --git a/tests/integration/readme/example_3.phpt b/tests/integration/readme/example_3.phpt
@@ -2,13 +2,13 @@
 <?php
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\NestedValidationException;
+use Respect\Validation\Validator as v;
 
 $usernameValidator = v::alnum()->noWhitespace()->length(1, 15);
 try {
     $usernameValidator->assert('really messed up screen#name');
-} catch(NestedValidationException $exception) {
+} catch (NestedValidationException $exception) {
     print_r($exception->findMessages(['alnum', 'noWhitespace']));
 }
 ?>
diff --git a/tests/integration/readme/example_4.phpt b/tests/integration/readme/example_4.phpt
@@ -2,13 +2,13 @@
 <?php
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\NestedValidationException;
+use Respect\Validation\Validator as v;
 
 $usernameValidator = v::alnum()->noWhitespace()->length(1, 15);
 try {
     $usernameValidator->assert('really messed up screen#name');
-} catch(NestedValidationException $exception) {
+} catch (NestedValidationException $exception) {
     print_r($exception->getMessages());
 }
 ?>
diff --git a/tests/integration/rules/allOf_2.phpt b/tests/integration/rules/allOf_2.phpt
@@ -2,8 +2,8 @@
 <?php
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\ConsonantException;
+use Respect\Validation\Validator as v;
 
 try {
     v::allOf(v::stringType(), v::consonant())->check('Luke i\'m your father');
diff --git a/tests/integration/rules/allOf_3.phpt b/tests/integration/rules/allOf_3.phpt
@@ -2,8 +2,8 @@
 <?php
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\AllOfException;
+use Respect\Validation\Validator as v;
 
 try {
     v::allOf(v::stringType(), v::consonant())->assert(42);
diff --git a/tests/integration/rules/allOf_4.phpt b/tests/integration/rules/allOf_4.phpt
@@ -2,8 +2,8 @@
 <?php
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\IntTypeException;
+use Respect\Validation\Validator as v;
 
 try {
     v::not(v::allOf(v::intType(), v::positive()))->check(42);
diff --git a/tests/integration/rules/allOf_5.phpt b/tests/integration/rules/allOf_5.phpt
@@ -2,8 +2,8 @@
 <?php
 require 'vendor/autoload.php';
 
-use Respect\Validation\Validator as v;
 use Respect\Validation\Exceptions\AllOfException;
+use Respect\Validation\Validator as v;
 
 try {
     v::not(v::allOf(v::stringType(), v::length(10)))->assert('Frank Zappa is fantastic');
diff --git a/tests/integration/rules/beetwen_1.phpt b/tests/integration/rules/beetwen_1.phpt
@@ -8,7 +8,7 @@ use Respect\Validation\Validator as v;
 
 v::intType()->between(1, 42)->check(2);
 v::intType()->between(1, 2)->assert(2);
-v::date()->between('1989-12-20', 'tomorrow', false)->assert(new DateTime);
+v::date()->between('1989-12-20', 'tomorrow', false)->assert(new DateTime());
 v::stringType()->between('a', 'e', false)->assert('d');
 
 ?>
diff --git a/tests/integration/rules/boolval_2.phpt b/tests/integration/rules/boolval_2.phpt
@@ -9,25 +9,25 @@ use Respect\Validation\Validator as v;
 try {
     v::boolVal()->check('ok');
 } catch (BoolValException $e) {
-    echo $e->getMainMessage() . PHP_EOL;
+    echo $e->getMainMessage().PHP_EOL;
 }
 
 try {
     v::not(v::boolVal())->check('yes');
 } catch (BoolValException $e) {
-    echo $e->getMainMessage() . PHP_EOL;
+    echo $e->getMainMessage().PHP_EOL;
 }
 
 try {
     v::boolVal()->assert('yep');
 } catch (AllOfException $e) {
-    echo $e->getFullMessage() . PHP_EOL;
+    echo $e->getFullMessage().PHP_EOL;
 }
 
 try {
     v::not(v::boolVal())->assert('on');
 } catch (AllOfException $e) {
-    echo $e->getFullMessage() . PHP_EOL;
+    echo $e->getFullMessage().PHP_EOL;
 }
 ?>
 --EXPECTF--
diff --git a/tests/integration/rules/ip_3.phpt b/tests/integration/rules/ip_3.phpt
@@ -9,13 +9,13 @@ use Respect\Validation\Validator as v;
 try {
     v::ip()->check('foo');
 } catch (IpException $e) {
-    echo $e->getMainMessage() . PHP_EOL;
+    echo $e->getMainMessage().PHP_EOL;
 }
 
 try {
     v::ip()->assert('foo');
 } catch (AllOfException $e) {
-    echo $e->getFullMessage() . PHP_EOL;
+    echo $e->getFullMessage().PHP_EOL;
 }
 ?>
 --EXPECTF--
diff --git a/tests/integration/rules/ip_4.phpt b/tests/integration/rules/ip_4.phpt
@@ -9,13 +9,13 @@ use Respect\Validation\Validator as v;
 try {
     v::not(v::ip())->check('10.0.0.1');
 } catch (IpException $e) {
-    echo $e->getMainMessage() . PHP_EOL;
+    echo $e->getMainMessage().PHP_EOL;
 }
 
 try {
     v::not(v::ip())->assert('10.0.0.1');
 } catch (AllOfException $e) {
-    echo $e->getFullMessage() . PHP_EOL;
+    echo $e->getFullMessage().PHP_EOL;
 }
 ?>
 --EXPECTF--
diff --git a/tests/integration/rules/ip_5.phpt b/tests/integration/rules/ip_5.phpt
@@ -9,13 +9,13 @@ use Respect\Validation\Validator as v;
 try {
     v::ip('127.0.1.*')->check('127.0.0.1');
 } catch (IpException $e) {
-    echo $e->getMainMessage() . PHP_EOL;
+    echo $e->getMainMessage().PHP_EOL;
 }
 
 try {
     v::ip('127.0.1.*')->assert('127.0.0.1');
 } catch (AllOfException $e) {
-    echo $e->getFullMessage() . PHP_EOL;
+    echo $e->getFullMessage().PHP_EOL;
 }
 ?>
 --EXPECTF--
diff --git a/tests/integration/rules/iterable_1.phpt b/tests/integration/rules/iterable_1.phpt
@@ -6,6 +6,6 @@ require 'vendor/autoload.php';
 use Respect\Validation\Validator as v;
 
 v::iterable()->assert([1, 2, 3]);
-v::iterable()->check(new ArrayObject);
+v::iterable()->check(new ArrayObject());
 ?>
 --EXPECTF--
diff --git a/tests/integration/rules/keyValue_1.phpt b/tests/integration/rules/keyValue_1.phpt
@@ -7,7 +7,7 @@ use Respect\Validation\Validator as v;
 $data = [
     'password' => 'shuberry',
     'password_confirmation' => 'shuberry',
-    'valid_passwords' => ['shuberry', 'monty-python']
+    'valid_passwords' => ['shuberry', 'monty-python'],
 ];
 
 v::keyValue('password', 'equals', 'password_confirmation')->check($data);
diff --git a/tests/integration/rules/keyValue_2.phpt b/tests/integration/rules/keyValue_2.phpt
@@ -7,7 +7,7 @@ use Respect\Validation\Validator as v;
 
 $data = [
     'password' => 'shuberry',
-    'password_confirmation' => '_shuberry_'
+    'password_confirmation' => '_shuberry_',
 ];
 
 try {
diff --git a/tests/integration/rules/notBlank_1.phpt b/tests/integration/rules/notBlank_1.phpt
@@ -7,7 +7,7 @@ use Respect\Validation\Validator as v;
 $notBlankValues = [
     'a',
     1,
-    1.0
+    1.0,
 ];
 
 //Check the "pure" value
diff --git a/tests/integration/rules/notEmpty_1.phpt b/tests/integration/rules/notEmpty_1.phpt
@@ -7,7 +7,7 @@ use Respect\Validation\Validator as v;
 $notEmptyValues = [
     'a',
     1,
-    1.0
+    1.0,
 ];
 
 //Check not empty values
diff --git a/tests/integration/rules/objectType_1.phpt b/tests/integration/rules/objectType_1.phpt
@@ -4,7 +4,7 @@ require 'vendor/autoload.php';
 
 use Respect\Validation\Validator as v;
 
-v::objectType()->assert(new stdClass);
-v::objectType()->check(new stdClass);
+v::objectType()->assert(new stdClass());
+v::objectType()->check(new stdClass());
 ?>
 --EXPECTF--
diff --git a/tests/unit/Exceptions/NestedValidationExceptionTest.php b/tests/unit/Exceptions/NestedValidationExceptionTest.php
@@ -13,7 +13,7 @@
 
 /**
  * phpunit has an issue with mocking exceptions when in HHVM:
- * https://github.com/sebastianbergmann/phpunit-mock-objects/issues/207
+ * https://github.com/sebastianbergmann/phpunit-mock-objects/issues/207.
  */
 class PrivateNestedValidationException extends NestedValidationException
 {
diff --git a/tests/unit/Exceptions/ValidationExceptionTest.php b/tests/unit/Exceptions/ValidationExceptionTest.php
diff --git a/tests/unit/Rules/CountableTest.php b/tests/unit/Rules/CountableTest.php
diff --git a/tests/unit/Rules/CountryCodeTest.php b/tests/unit/Rules/CountryCodeTest.php
diff --git a/tests/unit/Rules/CurrencyCodeTest.php b/tests/unit/Rules/CurrencyCodeTest.php
diff --git a/tests/unit/Rules/FloatTypeTest.php b/tests/unit/Rules/FloatTypeTest.php
diff --git a/tests/unit/Rules/IterableTest.php b/tests/unit/Rules/IterableTest.php
diff --git a/tests/unit/Rules/KeyNestedTest.php b/tests/unit/Rules/KeyNestedTest.php

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,6 @@ class BoolValException extends ValidationException`
`18`	`18`	`],`
`19`	`19`	`self::MODE_NEGATIVE => [`
`20`	`20`	`self::STANDARD => '{{name}} must not be a boolean value',`
`21`		`- ]`
	`21`	`+ ],`
`22`	`22`	`];`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,6 @@ class FloatTypeException extends ValidationException`
`19`	`19`	`],`
`20`	`20`	`self::MODE_NEGATIVE => [`
`21`	`21`	`self::STANDARD => '{{name}} must not be of the type float',`
`22`		`- ]`
	`22`	`+ ],`
`23`	`23`	`];`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`namespace Respect\Validation\Rules;`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * Validates a Dutch citizen service number (BSN)`
	`15`	`+ * Validates a Dutch citizen service number (BSN).`
`16`	`16`	`*`
`17`	`17`	`* @author Ronald Drenth <[email protected]>`
`18`	`18`	`*`
`@@ -34,7 +34,7 @@ public function validate($input)`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`$sum = -1 * $input[8];`
`37`		`- for ($i = 9; $i > 1; $i--) {`
	`37`	`+ for ($i = 9; $i > 1; --$i) {`
`38`	`38`	`$sum += $i * $input[9 - $i];`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,8 @@`
`18`	`18`	`*/`
`19`	`19`	`class CountryCode extends AbstractSearcher`
`20`	`20`	`{`
`21`		`- const ALPHA2 = 'alpha-2';`
`22`		`- const ALPHA3 = 'alpha-3';`
	`21`	`+ const ALPHA2 = 'alpha-2';`
	`22`	`+ const ALPHA3 = 'alpha-3';`
`23`	`23`	`const NUMERIC = 'numeric';`
`24`	`24`
`25`	`25`	`/**`
`@@ -293,7 +293,7 @@ public function __construct($set = self::ALPHA2)`
`293`	`293`	`throw new ComponentException(sprintf('"%s" is not a valid country set for ISO 3166-1', $set));`
`294`	`294`	`}`
`295`	`295`
`296`		`- $this->set = $set;`
	`296`	`+ $this->set = $set;`
`297`	`297`	`$this->index = $index;`
`298`	`298`	`}`
`299`	`299`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ private function verifyMod10($input)`
`27`	`27`	`{`
`28`	`28`	`$sum = 0;`
`29`	`29`	`$input = strrev($input);`
`30`		`- for ($i = 0; $i < strlen($input); $i++) {`
	`30`	`+ for ($i = 0; $i < strlen($input); ++$i) {`
`31`	`31`	`$current = substr($input, $i, 1);`
`32`	`32`	`if ($i % 2 == 1) {`
`33`	`33`	`$current *= 2;`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function validate($aK)`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`$w = [];`
`36`		`- for ($i = 0, $z = 5, $m = 43; $i <= $m; $i++) {`
	`36`	`+ for ($i = 0, $z = 5, $m = 43; $i <= $m; ++$i) {`
`37`	`37`	`$z = ($i < $m) ? ($z - 1) == 1 ? 9 : ($z - 1) : 0;`
`38`	`38`	`$w[] = $z;`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class VideoUrl extends AbstractRule`
`34`	`34`	`];`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * Create a new instance VideoUrl`
	`37`	`+ * Create a new instance VideoUrl.`
`38`	`38`	`*`
`39`	`39`	`* @param string $service`
`40`	`40`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* phpunit has an issue with mocking exceptions when in HHVM:`
`16`		`- * https://github.com/sebastianbergmann/phpunit-mock-objects/issues/207`
	`16`	`+ * https://github.com/sebastianbergmann/phpunit-mock-objects/issues/207.`
`17`	`17`	`*/`
`18`	`18`	`class PrivateNestedValidationException extends NestedValidationException`
`19`	`19`	`{`