Refactor the package

- Publishing package configuration is no longer requried if you're satisfied with the defaults - Adhere to PSR-4 autoloading standard - Define package dependencies better - Add simple PHPUnit tests - Rename Guide facade to Country facade for clarity - Add phpDoc comments for better code intel
Vinelab · Mar 29, 2019 · 25a0b3a · 25a0b3a
1 parent 5147267
commit 25a0b3a
Show file tree

Hide file tree

Showing 10 changed files with 409 additions and 303 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,11 +1,5 @@
 language: php
-
-php: 
-  - 5.3
-  - 5.4
-
-before_script:
-  - curl -s http://getcomposer.org/installer | php
-  - php composer.phar install --dev
-
-script: phpunit
+php:
+  - 7.0
+  - 7.1
+before_script: composer install
diff --git a/README.md b/README.md
@@ -1,15 +1,16 @@
-## Country package for Laravel 4 & 5
+## Country package for Laravel 5
+
 Translates between country name and abbreviation and vise versa.
 
 ## Installation
 
 ```
-composer update vinelab/country
+composer require vinelab/country
 ```
 
 ## Publish Config File
 ```
-php artisan vendor:publish
+php artisan vendor:publish --provider="Vinelab\Country\CountryServiceProvider"
 ```
 
 ## Usage
@@ -18,5 +19,3 @@ php artisan vendor:publish
 $countryName = Country::name('US'); // United States
 $countryAbbreviation = Country::abbreviation('United States'); // US
 ```
-
-> No tests provided with this package as it is a bit tricky to test at this point...
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "vinelab/country",
-    "description": "",
+    "description": "Country names and abbreviations",
     "keywords": ["laravel", "countries"],
     "license": "MIT",
     "authors": [
@@ -10,18 +10,23 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0",
-        "illuminate/support": "5.*"
+        "php": ">=7.0",
+        "illuminate/contracts": "5.4.*|5.5.*|5.6.*|5.7.*|5.8.",
+        "illuminate/support": "5.4.*|5.5.*|5.6.*|5.7.*|5.8."
     },
-
     "require-dev": {
-        "mockery/mockery": "dev-master"
+        "phpunit/phpunit": "^6.5",
+        "mockery/mockery": "^1.2"
     },
-
     "autoload": {
-        "psr-0": {
-            "Vinelab\\Country": "src/"
+        "psr-4": {
+            "Vinelab\\Country\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Vinelab\\Country\\Tests\\": "tests/"
         }
     },
     "minimum-stability": "stable"
-}
+}
diff --git a/src/config/.gitkeep → config/.gitkeep b/src/config/.gitkeep → config/.gitkeep
diff --git a/config/countries.php b/config/countries.php
@@ -0,0 +1,281 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Countries
+    |--------------------------------------------------------------------------
+    |
+    | The following lines contain the default list of countries with their
+    | respective codes. Feel free to tweak these as needed.
+    |
+    */
+
+    'AD' => 'Andorra',
+    'AE' => ['UAE', 'United Arab Emirates'],
+    'AF' => 'Afghanistan',
+    'AG' => 'Antigua And Barbuda',
+    'AI' => 'Anguilla',
+    'AL' => 'Albania',
+    'AM' => 'Armenia',
+    'AN' => 'Netherlands Antilles',
+    'AO' => 'Angola',
+    'AQ' => 'Antarctica',
+    'AR' => 'Argentina',
+    'AS' => 'American Samoa',
+    'AT' => 'Austria',
+    'AU' => 'Australia',
+    'AW' => 'Aruba',
+    'AX' => 'Åland Islands',
+    'AZ' => 'Azerbaijan',
+    'BA' => 'Bosnia And Herzegovina',
+    'BB' => 'Barbados',
+    'BD' => 'Bangladesh',
+    'BE' => 'Belgium',
+    'BF' => 'Burkina Faso',
+    'BG' => 'Bulgaria',
+    'BH' => 'Bahrain',
+    'BI' => 'Burundi',
+    'BJ' => 'Benin',
+    'BL' => 'Saint Barthélemy',
+    'BM' => 'Bermuda',
+    'BN' => 'Brunei',
+    'BO' => 'Bolivia',
+    'BQ' => 'British Antarctic Territory',
+    'BR' => 'Brazil',
+    'BS' => 'Bahamas',
+    'BT' => 'Bhutan',
+    'BV' => 'Bouvet Island',
+    'BW' => 'Botswana',
+    'BY' => 'Belarus',
+    'BZ' => 'Belize',
+    'CA' => 'Canada',
+    'CC' => 'Cocos [Keeling] Islands',
+    'CD' => 'Congo - Kinshasa',
+    'CF' => 'Central African Republic',
+    'CG' => 'Congo - Brazzaville',
+    'CH' => 'Switzerland',
+    'CI' => 'Côte d’Ivoire',
+    'CK' => 'Cook Islands',
+    'CL' => 'Chile',
+    'CM' => 'Cameroon',
+    'CN' => 'China',
+    'CO' => 'Colombia',
+    'CR' => 'Costa Rica',
+    'CS' => 'Serbia And Montenegro',
+    'CT' => 'Canton And Enderbury Islands',
+    'CU' => 'Cuba',
+    'CV' => 'Cape Verde',
+    'CX' => 'Christmas Island',
+    'CY' => 'Cyprus',
+    'CZ' => 'Czech Republic',
+    'DD' => 'East Germany',
+    'DE' => 'Germany',
+    'DJ' => 'Djibouti',
+    'DK' => 'Denmark',
+    'DM' => 'Dominica',
+    'DO' => ['Dominican Republic', 'Dom. Republic'],
+    'DZ' => 'Algeria',
+    'EC' => 'Ecuador',
+    'EE' => 'Estonia',
+    'EG' => 'Egypt',
+    'EH' => 'Western Sahara',
+    'ER' => 'Eritrea',
+    'ES' => 'Spain',
+    'ET' => 'Ethiopia',
+    'FI' => 'Finland',
+    'FJ' => 'Fiji',
+    'FK' => 'Falkland Islands',
+    'FM' => 'Micronesia',
+    'FO' => 'Faroe Islands',
+    'FQ' => 'French Southern And Antarctic Territories',
+    'FR' => 'France',
+    'FX' => 'Metropolitan France',
+    'GA' => 'Gabon',
+    'GB' => 'United Kingdom',
+    'GD' => 'Grenada',
+    'GE' => 'Georgia',
+    'GF' => 'French Guiana',
+    'GG' => 'Guernsey',
+    'GH' => 'Ghana',
+    'GI' => 'Gibraltar',
+    'GL' => 'Greenland',
+    'GM' => 'Gambia',
+    'GN' => 'Guinea',
+    'GP' => 'Guadeloupe',
+    'GQ' => 'Equatorial Guinea',
+    'GR' => 'Greece',
+    'GS' => 'South Georgia And the South Sandwich Islands',
+    'GT' => 'Guatemala',
+    'GU' => 'Guam',
+    'GW' => 'Guinea-Bissau',
+    'GY' => 'Guyana',
+    'HK' => 'Hong Kong SAR China',
+    'HM' => 'Heard Island And McDonald Islands',
+    'HN' => 'Honduras',
+    'HR' => 'Croatia',
+    'HT' => 'Haiti',
+    'HU' => 'Hungary',
+    'ID' => 'Indonesia',
+    'IE' => 'Ireland',
+    'IL' => 'Israel',
+    'IM' => 'Isle of Man',
+    'IN' => 'India',
+    'IO' => 'British Indian Ocean Territory',
+    'IQ' => 'Iraq',
+    'IR' => 'Iran',
+    'IS' => 'Iceland',
+    'IT' => 'Italy',
+    'JE' => 'Jersey',
+    'JM' => 'Jamaica',
+    'JO' => 'Jordan',
+    'JP' => 'Japan',
+    'JT' => 'Johnston Island',
+    'KE' => 'Kenya',
+    'KG' => 'Kyrgyzstan',
+    'KH' => 'Cambodia',
+    'KI' => 'Kiribati',
+    'KM' => 'Comoros',
+    'KN' => 'Saint Kitts And Nevis',
+    'KP' => 'North Korea',
+    'KR' => 'South Korea',
+    'KW' => 'Kuwait',
+    'KY' => 'Cayman Islands',
+    'KZ' => 'Kazakhstan',
+    'LA' => 'Laos',
+    'LB' => 'Lebanon',
+    'LC' => 'Saint Lucia',
+    'LI' => 'Liechtenstein',
+    'LK' => 'Sri Lanka',
+    'LR' => 'Liberia',
+    'LS' => 'Lesotho',
+    'LT' => 'Lithuania',
+    'LU' => 'Luxembourg',
+    'LV' => 'Latvia',
+    'LY' => 'Libya',
+    'MA' => 'Morocco',
+    'MC' => 'Monaco',
+    'MD' => 'Moldova',
+    'ME' => 'Montenegro',
+    'MF' => 'Saint Martin',
+    'MG' => 'Madagascar',
+    'MH' => 'Marshall Islands',
+    'MI' => 'Midway Islands',
+    'MK' => 'Macedonia',
+    'ML' => 'Mali',
+    'MM' => 'Myanmar [Burma]',
+    'MN' => 'Mongolia',
+    'MO' => 'Macau SAR China',
+    'MP' => 'Northern Mariana Islands',
+    'MQ' => 'Martinique',
+    'MR' => 'Mauritania',
+    'MS' => 'Montserrat',
+    'MT' => 'Malta',
+    'MU' => 'Mauritius',
+    'MV' => 'Maldives',
+    'MW' => 'Malawi',
+    'MX' => 'Mexico',
+    'MY' => 'Malaysia',
+    'MZ' => 'Mozambique',
+    'NA' => 'Namibia',
+    'NC' => 'New Caledonia',
+    'NE' => 'Niger',
+    'NF' => 'Norfolk Island',
+    'NG' => 'Nigeria',
+    'NI' => 'Nicaragua',
+    'NL' => 'Netherlands',
+    'NO' => 'Norway',
+    'NP' => 'Nepal',
+    'NQ' => 'Dronning Maud Land',
+    'NR' => 'Nauru',
+    'NT' => 'Neutral Zone',
+    'NU' => 'Niue',
+    'NZ' => 'New Zealand',
+    'OM' => 'Oman',
+    'PA' => 'Panama',
+    'PC' => 'Pacific Islands Trust Territory',
+    'PE' => 'Peru',
+    'PF' => 'French Polynesia',
+    'PG' => 'Papua New Guinea',
+    'PH' => 'Philippines',
+    'PK' => 'Pakistan',
+    'PL' => 'Poland',
+    'PM' => 'Saint Pierre And Miquelon',
+    'PN' => 'Pitcairn Islands',
+    'PR' => 'Puerto Rico',
+    'PS' => 'Palestine',
+    'PT' => 'Portugal',
+    'PU' => 'U.S. Miscellaneous Pacific Islands',
+    'PW' => 'Palau',
+    'PY' => 'Paraguay',
+    'PZ' => 'Panama Canal Zone',
+    'QA' => 'Qatar',
+    'RE' => 'Réunion',
+    'RO' => 'Romania',
+    'RS' => 'Serbia',
+    'RU' => 'Russia',
+    'RW' => 'Rwanda',
+    'SA' => 'Saudi Arabia',
+    'SB' => 'Solomon Islands',
+    'SC' => 'Seychelles',
+    'SD' => 'Sudan',
+    'SE' => 'Sweden',
+    'SG' => 'Singapore',
+    'SH' => 'Saint Helena',
+    'SI' => 'Slovenia',
+    'SJ' => 'Svalbard And Jan Mayen',
+    'SK' => 'Slovakia',
+    'SL' => 'Sierra Leone',
+    'SM' => 'San Marino',
+    'SN' => 'Senegal',
+    'SO' => 'Somalia',
+    'SR' => 'Suriname',
+    'SS' => 'South Sudan',
+    'ST' => 'São Tomé And Príncipe',
+    'SU' => 'Union of Soviet Socialist Republics',
+    'SV' => 'El Salvador',
+    'SY' => 'Syria',
+    'SZ' => 'Swaziland',
+    'TC' => 'Turks And Caicos Islands',
+    'TD' => 'Chad',
+    'TF' => 'French Southern Territories',
+    'TG' => 'Togo',
+    'TH' => 'Thailand',
+    'TJ' => 'Tajikistan',
+    'TK' => 'Tokelau',
+    'TL' => 'Timor-Leste',
+    'TM' => 'Turkmenistan',
+    'TN' => 'Tunisia',
+    'TO' => 'Tonga',
+    'TR' => 'Turkey',
+    'TT' => 'Trinidad And Tobago',
+    'TV' => 'Tuvalu',
+    'TW' => 'Taiwan',
+    'TZ' => 'Tanzania',
+    'UA' => 'Ukraine',
+    'UG' => 'Uganda',
+    'UM' => 'U.S. Minor Outlying Islands',
+    'US' => 'United States',
+    'UY' => 'Uruguay',
+    'UZ' => 'Uzbekistan',
+    'VA' => 'Vatican City',
+    'VC' => 'Saint Vincent And the Grenadines',
+    'VD' => 'North Vietnam',
+    'VE' => 'Venezuela',
+    'VG' => 'British Virgin Islands',
+    'VI' => 'U.S. Virgin Islands',
+    'VN' => 'Vietnam',
+    'VU' => 'Vanuatu',
+    'WF' => 'Wallis And Futuna',
+    'WK' => 'Wake Island',
+    'WS' => 'Samoa',
+    'YD' => 'People\'s Democratic Republic of Yemen',
+    'YE' => 'Yemen',
+    'YT' => 'Mayotte',
+    'ZA' => 'South Africa',
+    'ZM' => 'Zambia',
+    'ZW' => 'Zimbabwe',
+    'ZZ' => 'Unknown or Invalid Region',
+
+];