Base::isAbbr() - Code Metrics - laravel-validation-rules/us-state - Measure and Improve Code Quality continuously with Scrutinizer

Base::isAbbr() A
last analyzed 2020-03-11 16:43 UTC

↳ Parent: Base

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1

<?php

namespace LVR\State;

use Illuminate\Contracts\Validation\Rule;
use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Str;

abstract class Base implements Rule
{
    protected $country;
    protected $subject;

    function __construct(string $country = null)

    {
        $v = Validator::make([
            "country" => $country,
        ], [
            "country" => "nullable|string|in:US,CA,MX",
        ]);

        if ($v->fails()) {
            throw new \Exception($v->errors()->first(), 1);
        }

        $this->country = $country;
        $this->subject = $this->getSubject($this->country);
    }
   
    protected function isFull($value, string $country = null): bool
    {
        return in_array(Str::title($value), $this->getStateNames($country));
    }

    protected function isAbbr($value, string $country = null): bool
    {
        return in_array(Str::upper($value), $this->getStateAbbreviations($country));
    }

    protected $states = [
        "US" => [
            ["abbr" => 'AL', "name" => 'Alabama'],
            ["abbr" => 'AK', "name" => 'Alaska'],
            ["abbr" => 'AZ', "name" => 'Arizona'],
            ["abbr" => 'AR', "name" => 'Arkansas'],
            ["abbr" => 'CA', "name" => 'California'],
            ["abbr" => 'CO', "name" => 'Colorado'],
            ["abbr" => 'CT', "name" => 'Connecticut'],
            ["abbr" => 'DC', "name" => 'District Of Columbia'],
            ["abbr" => 'DE', "name" => 'Delaware'],
            ["abbr" => 'FL', "name" => 'Florida'],
            ["abbr" => 'GA', "name" => 'Georgia'],
            ["abbr" => 'HI', "name" => 'Hawaii'],
            ["abbr" => 'ID', "name" => 'Idaho'],
            ["abbr" => 'IL', "name" => 'Illinois'],
            ["abbr" => 'IN', "name" => 'Indiana'],
            ["abbr" => 'IA', "name" => 'Iowa'],
            ["abbr" => 'KS', "name" => 'Kansas'],
            ["abbr" => 'KY', "name" => 'Kentucky'],
            ["abbr" => 'LA', "name" => 'Louisiana'],
            ["abbr" => 'ME', "name" => 'Maine'],
            ["abbr" => 'MD', "name" => 'Maryland'],
            ["abbr" => 'MA', "name" => 'Massachusetts'],
            ["abbr" => 'MI', "name" => 'Michigan'],
            ["abbr" => 'MN', "name" => 'Minnesota'],
            ["abbr" => 'MS', "name" => 'Mississippi'],
            ["abbr" => 'MO', "name" => 'Missouri'],
            ["abbr" => 'MT', "name" => 'Montana'],
            ["abbr" => 'NE', "name" => 'Nebraska'],
            ["abbr" => 'NV', "name" => 'Nevada'],
            ["abbr" => 'NH', "name" => 'New Hampshire'],
            ["abbr" => 'NJ', "name" => 'New Jersey'],
            ["abbr" => 'NM', "name" => 'New Mexico'],
            ["abbr" => 'NY', "name" => 'New York'],
            ["abbr" => 'NC', "name" => 'North Carolina'],
            ["abbr" => 'ND', "name" => 'North Dakota'],
            ["abbr" => 'OH', "name" => 'Ohio'],
            ["abbr" => 'OK', "name" => 'Oklahoma'],
            ["abbr" => 'OR', "name" => 'Oregon'],
            ["abbr" => 'PA', "name" => 'Pennsylvania'],
            ["abbr" => 'RI', "name" => 'Rhode Island'],
            ["abbr" => 'SC', "name" => 'South Carolina'],
            ["abbr" => 'SD', "name" => 'South Dakota'],
            ["abbr" => 'TN', "name" => 'Tennessee'],
            ["abbr" => 'TX', "name" => 'Texas'],
            ["abbr" => 'UT', "name" => 'Utah'],
            ["abbr" => 'VT', "name" => 'Vermont'],
            ["abbr" => 'VA', "name" => 'Virginia'],
            ["abbr" => 'WA', "name" => 'Washington'],
            ["abbr" => 'WV', "name" => 'West Virginia'],
            ["abbr" => 'WI', "name" => 'Wisconsin'],
            ["abbr" => 'WY', "name" => 'Wyoming'],
            ["abbr" => 'AS', "name" => 'American Samoa'],
            ["abbr" => 'FM', "name" => 'Federated States Of Micronesia'],
            ["abbr" => 'GU', "name" => 'Guam'],
            ["abbr" => 'MH', "name" => 'Marshall Islands'],
            ["abbr" => 'MP', "name" => 'Northern Mariana Islands'],
            ["abbr" => 'PW', "name" => 'Pala'],
            ["abbr" => 'PR', "name" => 'Puerto Rico'],
            ["abbr" => 'VI', "name" => 'Virgin Islands']
        ],
        "CA" => [
            ["abbr" => 'AB', "name" => 'Alberta'],
            ["abbr" => 'BC', "name" => 'British Columbia'],
            ["abbr" => 'MB', "name" => 'Manitoba'],
            ["abbr" => 'NB', "name" => 'New Brunswick'],
            ["abbr" => 'NL', "name" => 'Newfoundland And Labrador'],
            ["abbr" => 'NS', "name" => 'Nova Scotia'],
            ["abbr" => 'NT', "name" => 'Northwest Territories'],
            ["abbr" => 'NU', "name" => 'Nunavut'],
            ["abbr" => 'ON', "name" => 'Ontario'],
            ["abbr" => 'PE', "name" => 'Prince Edward Island'],
            ["abbr" => 'QC', "name" => 'Quebec'],
            ["abbr" => 'SK', "name" => 'Saskatchewan'],
            ["abbr" => 'YT', "name" => 'Yukon'],
        ],
		"MX" => [
            ["abbr" => "AGU", "name" => "Aguascalientes"],
            ["abbr" => "BCN", "name" => "Baja California"],
            ["abbr" => "BCS", "name" => "Baja California Sur"],
            ["abbr" => "CAM", "name" => "Campeche"],
            ["abbr" => "CHP", "name" => "Chiapas"],
            ["abbr" => "CHH", "name" => "Chihuahua"],
            ["abbr" => "CMX", "name" => "Ciudad de México"],
            ["abbr" => "COA", "name" => "Coahuila de Zaragoza"],
            ["abbr" => "COL", "name" => "Colima"],
            ["abbr" => "DUR", "name" => "Durango"],
            ["abbr" => "GUA", "name" => "Guanajuato"],
            ["abbr" => "GRO", "name" => "Guerrero"],
            ["abbr" => "HID", "name" => "Hidalgo"],
            ["abbr" => "JAL", "name" => "Jalisco"],
            ["abbr" => "MIC", "name" => "Michoacán de Ocampo"],
            ["abbr" => "MOR", "name" => "Morelos"],
            ["abbr" => "MEX", "name" => "México"],
            ["abbr" => "NAY", "name" => "Nayarit"],
            ["abbr" => "NLE", "name" => "Nuevo León"],
            ["abbr" => "OAX", "name" => "Oaxaca"],
            ["abbr" => "PUE", "name" => "Puebla"],
            ["abbr" => "QUE", "name" => "Querétaro"],
            ["abbr" => "ROO", "name" => "Quintana Roo"],
            ["abbr" => "SLP", "name" => "San Luis Potosí"],
            ["abbr" => "SIN", "name" => "Sinaloa"],
            ["abbr" => "SON", "name" => "Sonora"],
            ["abbr" => "TAB", "name" => "Tabasco"],
            ["abbr" => "TAM", "name" => "Tamaulipas"],
            ["abbr" => "TLA", "name" => "Tlaxcala"],
            ["abbr" => "VER", "name" => "Veracruz de Ignacio de la Llave"],
            ["abbr" => "YUC", "name" => "Yucatán"],
            ["abbr" => "ZAC", "name" => "Zacatecas"],
        ],
    ];

    protected function getSubject(string $country = null): string
    {
        switch($country)
        {
            case "US":
            case "MX":
                return "State";
            case "CA":
                return "Province";
            default:
                return "State or Province";
        }
    }

    protected function getStateAbbreviations($country = null)

    {
        $x = [];
        foreach ($this->states as $c => $states) {
            if ($country === null || $c === $country) {
                foreach ($states as $state) {
                    $x[] = $state['abbr'];
                }
            }
        }
        return $x;
    }

    protected function getStateNames($country = null)

    {
        $x = [];
        foreach ($this->states as $c => $states) {
            if ($country === null || $c === $country) {
                foreach ($states as $state) {
                    $x[] = $state['name'];
                }
            }
        }
        return $x;
    }

    /**
     * Determine if the validation rule passes.
     *
     * @param  string $attribute
     * @param  mixed  $value
     * @return bool
     */
    abstract public function passes($attribute, $value);

    /**
     * Get the validation error message.
     *
     * @return string
     */
    abstract public function message();
}


1			<?php
2
3			namespace LVR\State;
4
5			use Illuminate\Contracts\Validation\Rule;
6			use Illuminate\Support\Facades\Validator;
7			use Illuminate\Support\Str;
8
9			abstract class Base implements Rule
10			{
11			protected $country;
12			protected $subject;
13
14	15		function __construct(string $country = null)
			0 ignored issues – show Best Practice introduced 2017-09-12 17:32 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
15			{
16	15		$v = Validator::make([
17	15		"country" => $country,
18			], [
19	15		"country" => "nullable\|string\|in:US,CA,MX",
20			]);
21
22	15		if ($v->fails()) {
23	3		throw new \Exception($v->errors()->first(), 1);
24			}
25
26	12		$this->country = $country;
27	12		$this->subject = $this->getSubject($this->country);
28	12		}
29
30	12		protected function isFull($value, string $country = null): bool
31			{
32	12		return in_array(Str::title($value), $this->getStateNames($country));
33			}
34
35	12		protected function isAbbr($value, string $country = null): bool
36			{
37	12		return in_array(Str::upper($value), $this->getStateAbbreviations($country));
38			}
39
40			protected $states = [
41			"US" => [
42			["abbr" => 'AL', "name" => 'Alabama'],
43			["abbr" => 'AK', "name" => 'Alaska'],
44			["abbr" => 'AZ', "name" => 'Arizona'],
45			["abbr" => 'AR', "name" => 'Arkansas'],
46			["abbr" => 'CA', "name" => 'California'],
47			["abbr" => 'CO', "name" => 'Colorado'],
48			["abbr" => 'CT', "name" => 'Connecticut'],
49			["abbr" => 'DC', "name" => 'District Of Columbia'],
50			["abbr" => 'DE', "name" => 'Delaware'],
51			["abbr" => 'FL', "name" => 'Florida'],
52			["abbr" => 'GA', "name" => 'Georgia'],
53			["abbr" => 'HI', "name" => 'Hawaii'],
54			["abbr" => 'ID', "name" => 'Idaho'],
55			["abbr" => 'IL', "name" => 'Illinois'],
56			["abbr" => 'IN', "name" => 'Indiana'],
57			["abbr" => 'IA', "name" => 'Iowa'],
58			["abbr" => 'KS', "name" => 'Kansas'],
59			["abbr" => 'KY', "name" => 'Kentucky'],
60			["abbr" => 'LA', "name" => 'Louisiana'],
61			["abbr" => 'ME', "name" => 'Maine'],
62			["abbr" => 'MD', "name" => 'Maryland'],
63			["abbr" => 'MA', "name" => 'Massachusetts'],
64			["abbr" => 'MI', "name" => 'Michigan'],
65			["abbr" => 'MN', "name" => 'Minnesota'],
66			["abbr" => 'MS', "name" => 'Mississippi'],
67			["abbr" => 'MO', "name" => 'Missouri'],
68			["abbr" => 'MT', "name" => 'Montana'],
69			["abbr" => 'NE', "name" => 'Nebraska'],
70			["abbr" => 'NV', "name" => 'Nevada'],
71			["abbr" => 'NH', "name" => 'New Hampshire'],
72			["abbr" => 'NJ', "name" => 'New Jersey'],
73			["abbr" => 'NM', "name" => 'New Mexico'],
74			["abbr" => 'NY', "name" => 'New York'],
75			["abbr" => 'NC', "name" => 'North Carolina'],
76			["abbr" => 'ND', "name" => 'North Dakota'],
77			["abbr" => 'OH', "name" => 'Ohio'],
78			["abbr" => 'OK', "name" => 'Oklahoma'],
79			["abbr" => 'OR', "name" => 'Oregon'],
80			["abbr" => 'PA', "name" => 'Pennsylvania'],
81			["abbr" => 'RI', "name" => 'Rhode Island'],
82			["abbr" => 'SC', "name" => 'South Carolina'],
83			["abbr" => 'SD', "name" => 'South Dakota'],
84			["abbr" => 'TN', "name" => 'Tennessee'],
85			["abbr" => 'TX', "name" => 'Texas'],
86			["abbr" => 'UT', "name" => 'Utah'],
87			["abbr" => 'VT', "name" => 'Vermont'],
88			["abbr" => 'VA', "name" => 'Virginia'],
89			["abbr" => 'WA', "name" => 'Washington'],
90			["abbr" => 'WV', "name" => 'West Virginia'],
91			["abbr" => 'WI', "name" => 'Wisconsin'],
92			["abbr" => 'WY', "name" => 'Wyoming'],
93			["abbr" => 'AS', "name" => 'American Samoa'],
94			["abbr" => 'FM', "name" => 'Federated States Of Micronesia'],
95			["abbr" => 'GU', "name" => 'Guam'],
96			["abbr" => 'MH', "name" => 'Marshall Islands'],
97			["abbr" => 'MP', "name" => 'Northern Mariana Islands'],
98			["abbr" => 'PW', "name" => 'Pala'],
99			["abbr" => 'PR', "name" => 'Puerto Rico'],
100			["abbr" => 'VI', "name" => 'Virgin Islands']
101			],
102			"CA" => [
103			["abbr" => 'AB', "name" => 'Alberta'],
104			["abbr" => 'BC', "name" => 'British Columbia'],
105			["abbr" => 'MB', "name" => 'Manitoba'],
106			["abbr" => 'NB', "name" => 'New Brunswick'],
107			["abbr" => 'NL', "name" => 'Newfoundland And Labrador'],
108			["abbr" => 'NS', "name" => 'Nova Scotia'],
109			["abbr" => 'NT', "name" => 'Northwest Territories'],
110			["abbr" => 'NU', "name" => 'Nunavut'],
111			["abbr" => 'ON', "name" => 'Ontario'],
112			["abbr" => 'PE', "name" => 'Prince Edward Island'],
113			["abbr" => 'QC', "name" => 'Quebec'],
114			["abbr" => 'SK', "name" => 'Saskatchewan'],
115			["abbr" => 'YT', "name" => 'Yukon'],
116			],
117			"MX" => [
118			["abbr" => "AGU", "name" => "Aguascalientes"],
119			["abbr" => "BCN", "name" => "Baja California"],
120			["abbr" => "BCS", "name" => "Baja California Sur"],
121			["abbr" => "CAM", "name" => "Campeche"],
122			["abbr" => "CHP", "name" => "Chiapas"],
123			["abbr" => "CHH", "name" => "Chihuahua"],
124			["abbr" => "CMX", "name" => "Ciudad de México"],
125			["abbr" => "COA", "name" => "Coahuila de Zaragoza"],
126			["abbr" => "COL", "name" => "Colima"],
127			["abbr" => "DUR", "name" => "Durango"],
128			["abbr" => "GUA", "name" => "Guanajuato"],
129			["abbr" => "GRO", "name" => "Guerrero"],
130			["abbr" => "HID", "name" => "Hidalgo"],
131			["abbr" => "JAL", "name" => "Jalisco"],
132			["abbr" => "MIC", "name" => "Michoacán de Ocampo"],
133			["abbr" => "MOR", "name" => "Morelos"],
134			["abbr" => "MEX", "name" => "México"],
135			["abbr" => "NAY", "name" => "Nayarit"],
136			["abbr" => "NLE", "name" => "Nuevo León"],
137			["abbr" => "OAX", "name" => "Oaxaca"],
138			["abbr" => "PUE", "name" => "Puebla"],
139			["abbr" => "QUE", "name" => "Querétaro"],
140			["abbr" => "ROO", "name" => "Quintana Roo"],
141			["abbr" => "SLP", "name" => "San Luis Potosí"],
142			["abbr" => "SIN", "name" => "Sinaloa"],
143			["abbr" => "SON", "name" => "Sonora"],
144			["abbr" => "TAB", "name" => "Tabasco"],
145			["abbr" => "TAM", "name" => "Tamaulipas"],
146			["abbr" => "TLA", "name" => "Tlaxcala"],
147			["abbr" => "VER", "name" => "Veracruz de Ignacio de la Llave"],
148			["abbr" => "YUC", "name" => "Yucatán"],
149			["abbr" => "ZAC", "name" => "Zacatecas"],
150			],
151			];
152
153	12		protected function getSubject(string $country = null): string
154			{
155	8		switch($country)
156			{
157	12		case "US":
158	9		case "MX":
159	6		return "State";
160	6		case "CA":
161	3		return "Province";
162			default:
163	3		return "State or Province";
164			}
165			}
166
167	12	View Code Duplication	protected function getStateAbbreviations($country = null)
			0 ignored issues – show Duplication introduced 2017-09-10 09:06 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
168			{
169	12		$x = [];
170	12		foreach ($this->states as $c => $states) {
171	12		if ($country === null \|\| $c === $country) {
172	12		foreach ($states as $state) {
173	12		$x[] = $state['abbr'];
174			}
175			}
176			}
177	12		return $x;
178			}
179
180	12	View Code Duplication	protected function getStateNames($country = null)
			0 ignored issues – show Duplication introduced 2017-09-10 09:06 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
181			{
182	12		$x = [];
183	12		foreach ($this->states as $c => $states) {
184	12		if ($country === null \|\| $c === $country) {
185	12		foreach ($states as $state) {
186	12		$x[] = $state['name'];
187			}
188			}
189			}
190	12		return $x;
191			}
192
193			/**
194			* Determine if the validation rule passes.
195			*
196			* @param string $attribute
197			* @param mixed $value
198			* @return bool
199			*/
200			abstract public function passes($attribute, $value);
201
202			/**
203			* Get the validation error message.
204			*
205			* @return string
206			*/
207			abstract public function message();
208			}
209

laravel-validation-rules / us-state

Base::isAbbr() A last analyzed 2020-03-11 16:43 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Base::isAbbr() A
last analyzed 2020-03-11 16:43 UTC