Updated for LVR

tylercd100 · tylercd100 · commit 6de22a1f8b7b · 2017-09-10T02:07:02.000-06:00
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,10 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml        export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+build
+composer.lock
+vendor
+run.php
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,25 @@
+filter:
+    excluded_paths: [tests/*]
+
+tools:
+    external_code_coverage:
+        timeout: '3600'
+        runs: 3
+
+checks:
+    php:
+        code_rating: true
+        duplication: true
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,23 @@
+language: php
+
+php:
+    - 5.5.9
+    - 5.6
+    - 7.0
+
+env:
+    matrix:
+        - COMPOSER_FLAGS="--prefer-lowest"
+        - COMPOSER_FLAGS=""
+
+before_script:
+- travis_retry composer self-update
+- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+
+script:
+  - vendor/bin/phpunit
+  - if [ "$TRAVIS_PHP_VERSION" == "5.5.9" ] || [ "$TRAVIS_PHP_VERSION" == "5.5" ] || [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then vendor/bin/phpunit --coverage-clover build/logs/clover.xml; fi
+
+after_script:
+  - if [ "$TRAVIS_PHP_VERSION" == "5.5.9" ] || [ "$TRAVIS_PHP_VERSION" == "5.5" ] || [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [ "$TRAVIS_PHP_VERSION" == "5.5.9" ] || [ "$TRAVIS_PHP_VERSION" == "5.5" ] || [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml; fi
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to `laravel-validation-rules/us-phone` will be documented in this file.
+
+### 1.0.0
+- Initial release and connected with packagist
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zenapply
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# Validate phone numbers with Laravel 5
+[![Latest Version](https://img.shields.io/github/release/laravel-valiation-rules/us-phone.svg?style=flat-square)](https://github.com/laravel-valiation-rules/us-phone/releases)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![Build Status](https://travis-ci.org/laravel-valiation-rules/us-phone.svg?branch=master)](https://travis-ci.org/laravel-valiation-rules/us-phone)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/laravel-valiation-rules/us-phone/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/laravel-valiation-rules/us-phone/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/laravel-valiation-rules/us-phone/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/laravel-valiation-rules/us-phone/?branch=master)
+[![Total Downloads](https://img.shields.io/packagist/dt/laravel-valiation-rules/us-phone.svg?style=flat-square)](https://packagist.org/packages/laravel-valiation-rules/us-phone)
+
+This package only checks phone number formatting and not actual number validity.
+
+## Installation
+
+Install via [composer](https://getcomposer.org/) - In the terminal:
+```bash
+composer require laravel-valiation-rules/us-phone
+```
+
+Now add the following to the `providers` array in your `config/app.php`
+```php
+LVR\Phone\ServiceProvider::class
+```
+
+## Usage
+
+```php
+// Test any phone number
+Validator::make(['test' => '15556667777'], ['test' => 'phone']); //true
+Validator::make(['test' => '+15556667777'], ['test' => 'phone']); //true
+Validator::make(['test' => '+1 (555) 666-7777'], ['test' => 'phone']); //true
+
+// Test for E164
+Validator::make(['test' => '+15556667777'], ['test' => 'phone:E164']); //true
+
+// Test for NANP (North American Numbering Plan)
+Validator::make(['test' => '+1 (555) 666-7777'], ['test' => 'phone:NANP']); //true
+
+// Test for digits only
+Validator::make(['test' => '15556667777'], ['test' => 'phone:digits']); //true
+```
diff --git a/composer.json b/composer.json
@@ -0,0 +1,40 @@
+{
+    "name": "laravel-validation-rules/us-phone",
+    "description": "Validate that a phone number is in the correct format",
+    "keywords": [
+        "laravel",
+        "validator",
+        "phone",
+        "tylercd100"
+    ],
+    "homepage": "https://github.com/laravel-validation-rules/us-phone",
+    "license": "MIT",  
+    "authors": [
+        {
+            "name": "Tyler Arbon",
+            "email": "tylercd100@gmail.com"
+        }
+    ],
+    "autoload":{
+        "psr-4":{
+            "LVR\\Phone\\":"src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "LVR\\Phone\\Tests\\": "tests/"
+        }
+    },
+    "minimum-stability": "stable",  
+    "require": {
+        "illuminate/validation": "^5.0",
+        "illuminate/support": "^5.0",
+        "php": "^5.5.9|^7.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^4.8|^5.0",
+        "orchestra/testbench": "^3.2"
+    },
+    "suggest": {
+    }
+}
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Zenapply Test Suite">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="tap" target="build/report.tap"/>
+        <log type="junit" target="build/report.junit.xml"/>
+        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-text" target="build/coverage.txt"/>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+</phpunit>
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -0,0 +1,52 @@
+<?php 
+
+namespace LVR\Phone;
+
+use Exception;
+use Illuminate\Support\ServiceProvider as IlluminateProvider;
+use LVR\Phone\Validator;
+
+class ServiceProvider extends IlluminateProvider
+{
+    /**
+     * Bootstrap the application events.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+
+    }
+
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->resolving('validator', function ($factory, $app) {
+            
+            $x = new Validator();
+
+            $factory->extend('phone', function ($attribute, $value, $parameters, $validator) use ($x) {
+                if (count($parameters) > 0) {
+                    switch ($parameters[0]) {
+                        case 'digits':
+                            return $x->isDigits($value);
+                        case 'e164':
+                        case 'E164':
+                            return $x->isE164($value);
+                        case 'nanp':
+                        case 'NANP':
+                            return $x->isNANP($value);
+                        default:
+                            throw new Exception($parameters[0]." is not a supported phone validation type.", 1);
+                    }
+                } else {
+                    return $x->isPhone($value);
+                }
+            }, "Not a valid phone number");
+        });
+    }
+}
diff --git a/src/Validator.php b/src/Validator.php
@@ -0,0 +1,64 @@
+<?php
+
+namespace LVR\Phone;
+
+class Validator
+{
+    public function __call($a, $b)
+    {
+        return empty($b[0]) || $this->{$a}($b[0]);
+    }
+
+    /**
+     * Checks through all validation methods to verify it is in a
+     * phone number format of some type
+     * @param  string  $value The phone number to check
+     * @return boolean        is it correct format?
+     */
+    protected function isPhone($value)
+    {
+        return $this->isE164($value) || $this->isNANP($value) || $this->isDigits($value);
+    }
+
+    /**
+     * Format example 5555555555, 15555555555
+     * @param  [type]  $value [description]
+     * @return boolean        [description]
+     */
+    protected function isDigits($value)
+    {
+        $conditions = [];
+        $conditions[] = strlen($value) >= 10;
+        $conditions[] = strlen($value) <= 16;
+        $conditions[] = preg_match("/[^\d]/i", $value) === 0;
+        return (bool) array_product($conditions);
+    }
+
+    /**
+     * Format example +15555555555
+     * @param  string  $value The phone number to check
+     * @return boolean        is it correct format?
+     */
+    protected function isE164($value)
+    {
+        $conditions = [];
+        $conditions[] = strpos($value, "+") === 0;
+        $conditions[] = strlen($value) >= 9;
+        $conditions[] = strlen($value) <= 16;
+        $conditions[] = preg_match("/[^\d+]/i", $value) === 0;
+        return (bool) array_product($conditions);
+    }
+
+    /**
+     * Format examples: (555) 555-5555, 1 (555) 555-5555, 1-555-555-5555, 555-555-5555, 1 555 555-5555
+     * https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers#United_States.2C_Canada.2C_and_other_NANP_countries
+     * @param  string  $value The phone number to check
+     * @return boolean        is it correct format?
+     */
+    protected function isNANP($value)
+    {
+        $conditions = [];
+        $conditions[] = preg_match("/^(?:\+1|1)?\s?-?\(?\d{3}\)?(\s|-)?\d{3}-\d{4}$/i", $value) > 0;
+        return (bool) array_product($conditions);
+    }
+}
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -0,0 +1,66 @@
+<?php
+
+namespace LVR\Phone\Tests;
+
+use Orchestra\Testbench\TestCase as Orchestra;
+
+class TestCase extends Orchestra
+{
+    /**
+     * Setup the test environment.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+    }
+
+    public function tearDown()
+    {
+        parent::tearDown();
+    }
+
+    /**
+     * @param \Illuminate\Foundation\Application $app
+     */
+    protected function getPackageProviders($app)
+    {
+        return ['LVR\Phone\ServiceProvider'];
+    }
+
+    /**
+     * @param \Illuminate\Foundation\Application $app
+     */
+    protected function getPackageAliases($app)
+    {
+        return [];
+    }
+
+    /**
+     * Define environment setup.
+     *
+     * @param  \Illuminate\Foundation\Application  $app
+     * @return void
+     */
+    protected function getEnvironmentSetUp($app)
+    {
+
+    }
+
+    /**
+     * Call protected/private method of a class.
+     *
+     * @param object &$object    Instantiated object that we will run method on.
+     * @param string $methodName Method name to call
+     * @param array  $parameters Array of parameters to pass into method.
+     *
+     * @return mixed Method return.
+     */
+    public function invokeMethod(&$object, $methodName, array $parameters = array())
+    {
+        $reflection = new \ReflectionClass(get_class($object));
+        $method = $reflection->getMethod($methodName);
+        $method->setAccessible(true);
+
+        return $method->invokeArgs($object, $parameters);
+    }
+}
diff --git a/tests/ValidatorTest.php b/tests/ValidatorTest.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +build
 +composer.lock
 +vendor
 +run.php