Merge pull request #2 from glhd/development

inxilpro · web-flow · commit eb6dc2111bd7 · 2017-08-14T23:54:24.000-06:00
0.4.3
diff --git a/.idea/composerJson.xml b/.idea/composerJson.xml
diff --git a/README.md b/README.md
@@ -141,4 +141,4 @@ GET /galahad/addressing/countries?locale=pt
 
 ### Thanks!
 
-Special thanks to [Commerce Guys](https://github.com/commerceguys) for their amazing [addressing](https://github.com/commerceguys/addressing) and [intl](https://github.com/commerceguys/intl) packages, which this project relies heavily on.
+Special thanks to [Commerce Guys](https://github.com/commerceguys) for their amazing [addressing](https://github.com/commerceguys/addressing) and [intl](https://github.com/commerceguys/intl) packages, which this project relies heavily on.
diff --git a/src/Entity/Country.php b/src/Entity/Country.php
@@ -67,6 +67,7 @@ public function administrativeAreas()
      */
     public function administrativeArea($code)
     {
+    	$code = strtoupper($code);
         if (strpos($code, '-') === false) {
             $code = $this->getCountryCode().'-'.$code;
         }
@@ -83,7 +84,7 @@ public function administrativeArea($code)
     public function administrativeAreaByName($administrativeAreaName)
     {
         foreach ($this->getAdministrativeAreasList() as $code => $name) {
-            if ($name == $administrativeAreaName) {
+            if (0 === strcasecmp($name, $administrativeAreaName)) {
                 return $this->administrativeArea($code);
             }
         }
@@ -97,12 +98,11 @@ public function administrativeAreaByName($administrativeAreaName)
      */
     public function findAdministrativeArea($codeOrName)
     {
-        $administrativeArea = $this->administrativeArea($codeOrName);
-        if (! $administrativeArea instanceof AdministrativeArea) {
-            return $this->administrativeAreaByName($codeOrName);
+        if ($administrativeArea = $this->administrativeArea($codeOrName)) {
+        	return $administrativeArea;
         }
-
-        return $administrativeArea;
+	
+	    return $this->administrativeAreaByName($codeOrName);
     }
 
     /**
@@ -130,4 +130,4 @@ public function getLocale()
     {
         return $this->addressing->getLocale();
     }
-}
+}
diff --git a/src/LaravelAddressing.php b/src/LaravelAddressing.php
@@ -55,6 +55,7 @@ public function __construct($locale = 'en')
      */
     public function country($countryCode)
     {
+    	$countryCode = strtoupper($countryCode);
         return $this->getCountryRepository()->get($countryCode, $this->locale);
     }
 
@@ -83,10 +84,13 @@ public function countryByName($countryName)
      */
     public function findCountry($codeOrName)
     {
+    	$code = strtoupper($codeOrName);
         $countryList = $this->getCountryList();
-        if (isset($countryList[$codeOrName])) {
-            return $this->country($codeOrName);
+        
+        if (isset($countryList[$code])) {
+            return $this->country($code);
         }
+        
         return $this->countryByName($codeOrName);
     }
 
@@ -163,4 +167,4 @@ public function getAdministrativeAreaRepository()
 	    
         return $this->administrativeAreaRepository;
     }
-}
+}
diff --git a/src/Repository/AdministrativeAreaRepository.php b/src/Repository/AdministrativeAreaRepository.php
@@ -50,6 +50,7 @@ protected function createSubdivisionFromDefinitions($id, array $definitions, $lo
      */
     public function getAll($countryCode, $parentId = null, $locale = null)
     {
+    	$countryCode = strtoupper($countryCode);
         $subdivisions = parent::getAll($countryCode, $parentId, $locale);
 
         return new AdministrativeAreaCollection($subdivisions);
@@ -66,4 +67,4 @@ public function get($id, $locale = null)
     {
         return parent::get($id, $locale);
     }
-}
+}
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -5,6 +5,7 @@
 use Galahad\LaravelAddressing\Validator\AdministrativeAreaValidator;
 use Galahad\LaravelAddressing\Validator\CountryValidator;
 use Galahad\LaravelAddressing\Validator\PostalCodeValidator;
+use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Validation\Factory;
 
 /**
@@ -21,56 +22,89 @@ class ServiceProvider extends \Illuminate\Support\ServiceProvider
      */
     public function boot()
     {
-        if (!$this->app->routesAreCached()) {
-            require_once __DIR__ . '/routes.php';
-        }
-        $this->registerValidators($this->app->validator);
+        $this->bootRoutes();
         $this->loadTranslationsFrom(__DIR__.'/../lang', 'laravel-addressing');
     }
+	
+	/**
+	 * Boot routes if routing is supported
+	 */
+	protected function bootRoutes()
+	{
+		if (method_exists($this->app, 'routesAreCached') && $this->app->routesAreCached()) {
+			return;
+		}
+		
+		try {
+			$route = $this->app->make('router');
+			$route->group(['prefix' => 'galahad/addressing'], function($route) {
+				$route->get('/{country}/administrative-areas', [
+					'as' => 'galahad.addressing.administrative-areas',
+					'uses' => '\\Galahad\\LaravelAddressing\\Controller@getAdministrativeAreas',
+				]);
+				$route->get('/{country}/{administrativeArea}/cities', [
+					'as' => 'galahad.addressing.cities',
+					'uses' => '\\Galahad\\LaravelAddressing\\Controller@getCities',
+				]);
+				$route->get('/countries', [
+					'as' => 'galahad.addressing.countries',
+					'uses' => '\\Galahad\\LaravelAddressing\\Controller@getCountries',
+				]);
+			});
+		} catch (BindingResolutionException $exception) {
+			// Skip routes if no router exists
+		}
+	}
 
     /**
      * Register the LaravelAddressing instance
      */
     public function register()
     {
-        $this->app->singleton(LaravelAddressing::class, function ($app) {
-            return new LaravelAddressing();
-        });
+	    $this->app->singleton(LaravelAddressing::class, function($app) {
+		    return new LaravelAddressing(
+			    $app->make('config')->get('app.locale', 'en')
+		    );
+	    });
+	
+	    $this->registerValidators();
     }
 
     /**
      * Register all custom validators
-     *
-     * @param Factory $validatorFactory
      */
-    protected function registerValidators(Factory $validatorFactory)
+    protected function registerValidators()
     {
-        // Country validators
-        $validatorFactory->extend(
-            'country_code',
-            CountryValidator::class.'@validateCountryCode'
-        );
-        $validatorFactory->extend(
-            'country_name',
-            CountryValidator::class.'@validateCountryName'
-        );
-        // Administrative Area validators
-        $validatorFactory->extend(
-            'administrative_area_code',
-            AdministrativeAreaValidator::class.'@validateAdministrativeAreaCode'
-        );
-        $validatorFactory->extend(
-            'administrative_area_name',
-            AdministrativeAreaValidator::class.'@validateAdministrativeAreaName'
-        );
-        $validatorFactory->extend(
-            'administrative_area',
-            AdministrativeAreaValidator::class.'@validateAdministrativeArea'
-        );
-        // Postal Code validator
-        $validatorFactory->extend(
-            'postal_code',
-            PostalCodeValidator::class.'@validatePostalCode'
-        );
+	    $this->app->resolving('validator', function($validator, $app) {
+		    // Country validators
+		    $validator->extend(
+			    'country_code',
+			    CountryValidator::class.'@validateCountryCode'
+		    );
+		    $validator->extend(
+			    'country_name',
+			    CountryValidator::class.'@validateCountryName'
+		    );
+		
+		    // Administrative Area validators
+		    $validator->extend(
+			    'administrative_area_code',
+			    AdministrativeAreaValidator::class.'@validateAdministrativeAreaCode'
+		    );
+		    $validator->extend(
+			    'administrative_area_name',
+			    AdministrativeAreaValidator::class.'@validateAdministrativeAreaName'
+		    );
+		    $validator->extend(
+			    'administrative_area',
+			    AdministrativeAreaValidator::class.'@validateAdministrativeArea'
+		    );
+		
+		    // Postal Code validator
+		    $validator->extend(
+			    'postal_code',
+			    PostalCodeValidator::class.'@validatePostalCode'
+		    );
+	    });
     }
 }
diff --git a/tests/LaravelAddressingTest.php b/tests/LaravelAddressingTest.php
@@ -130,4 +130,13 @@ public function testFindAdministrativeArea()
         $alabama = $country->findAdministrativeArea('Alabama');
         $this->assertEquals($alabama->getCode(), 'AL');
     }
-}
+	
+	public function testIsCaseInsensitive()
+	{
+		$country = $this->addressing->country('us');
+		$alabama = $country->findAdministrativeArea('al');
+		$this->assertEquals($alabama->getName(), 'Alabama');
+		$alabama = $country->findAdministrativeArea('alabama');
+		$this->assertEquals($alabama->getCode(), 'AL');
+	}
+}
diff --git a/tests/TranslationTest.php b/tests/TranslationTest.php
@@ -16,17 +16,33 @@ class TranslationTest extends TestCase
      */
     protected $validator;
 
+    /**
+     * @var string
+     */
+    protected $translationDirectory;
+
     public function setUp()
     {
         parent::setUp();
         $this->validator = $this->app['validator'];
+        $this->translationDirectory = __DIR__.'/../lang';
     }
 
     protected function getPackageProviders($app)
     {
         return [ServiceProvider::class];
     }
 
+    protected function getMessage($locale, $filename, $key, $field)
+    {
+        $filePath = sprintf('%s/%s/%s.php', $this->translationDirectory, $locale, $filename);
+        $arrayContent = include $filePath;
+
+        if (isset($arrayContent[$key])) {
+            return str_replace(':attribute', $field, $arrayContent[$key]);
+        }
+    }
+
     public function testENMessages()
     {
         $this->app->setLocale('en');
@@ -37,7 +53,8 @@ public function testENMessages()
         if ($validator->fails()) {
             $messages = $validator->errors()->get('country');
             $first = array_shift($messages);
-            $this->assertEquals($first, 'The country field is not a valid country code.');
+            $expectedMessage = $this->getMessage('en', 'validation', 'country_code', 'country');
+            $this->assertEquals($first, $expectedMessage);
         }
     }
 
@@ -51,7 +68,8 @@ public function testPT_BRMessages()
         if ($validator->fails()) {
             $messages = $validator->errors()->get('country');
             $first = array_shift($messages);
-            $this->assertEquals($first, 'O campo country não possui um código de país válido.');
+            $expectedMessage = $this->getMessage('pt-br', 'validation', 'country_code', 'country');
+            $this->assertEquals($first, $expectedMessage);
         }
     }
 
@@ -65,7 +83,8 @@ public function testENMessagesForAdministrativeAreaValidator()
         if ($validator->fails()) {
             $messages = $validator->errors()->get('state');
             $first = array_shift($messages);
-            $this->assertEquals($first, 'The state field is not a valid state/province.');
+            $expectedMessage = $this->getMessage('en', 'validation', 'administrative_area', 'state');
+            $this->assertEquals($first, $expectedMessage);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -141,4 +141,4 @@ GET /galahad/addressing/countries?locale=pt`
`141`	`141`
`142`	`142`	`### Thanks!`
`143`	`143`
`144`		`-Special thanks to [Commerce Guys](https://github.com/commerceguys) for their amazing [addressing](https://github.com/commerceguys/addressing) and [intl](https://github.com/commerceguys/intl) packages, which this project relies heavily on.`
	`144`	`+Special thanks to [Commerce Guys](https://github.com/commerceguys) for their amazing [addressing](https://github.com/commerceguys/addressing) and [intl](https://github.com/commerceguys/intl) packages, which this project relies heavily on.`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ public function administrativeAreas()`
`67`	`67`	`*/`
`68`	`68`	`public function administrativeArea($code)`
`69`	`69`	`{`
	`70`	`+ $code = strtoupper($code);`
`70`	`71`	`if (strpos($code, '-') === false) {`
`71`	`72`	`$code = $this->getCountryCode().'-'.$code;`
`72`	`73`	`}`
`@@ -83,7 +84,7 @@ public function administrativeArea($code)`
`83`	`84`	`public function administrativeAreaByName($administrativeAreaName)`
`84`	`85`	`{`
`85`	`86`	`foreach ($this->getAdministrativeAreasList() as $code => $name) {`
`86`		`- if ($name == $administrativeAreaName) {`
	`87`	`+ if (0 === strcasecmp($name, $administrativeAreaName)) {`
`87`	`88`	`return $this->administrativeArea($code);`
`88`	`89`	`}`
`89`	`90`	`}`
`@@ -97,12 +98,11 @@ public function administrativeAreaByName($administrativeAreaName)`
`97`	`98`	`*/`
`98`	`99`	`public function findAdministrativeArea($codeOrName)`
`99`	`100`	`{`
`100`		`- $administrativeArea = $this->administrativeArea($codeOrName);`
`101`		`- if (! $administrativeArea instanceof AdministrativeArea) {`
`102`		`- return $this->administrativeAreaByName($codeOrName);`
	`101`	`+ if ($administrativeArea = $this->administrativeArea($codeOrName)) {`
	`102`	`+ return $administrativeArea;`
`103`	`103`	`}`
`104`		`-`
`105`		`- return $administrativeArea;`
	`104`	`+`
	`105`	`+ return $this->administrativeAreaByName($codeOrName);`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`/**`
`@@ -130,4 +130,4 @@ public function getLocale()`
`130`	`130`	`{`
`131`	`131`	`return $this->addressing->getLocale();`
`132`	`132`	`}`
`133`		`-}`
	`133`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ public function __construct($locale = 'en')`
`55`	`55`	`*/`
`56`	`56`	`public function country($countryCode)`
`57`	`57`	`{`
	`58`	`+ $countryCode = strtoupper($countryCode);`
`58`	`59`	`return $this->getCountryRepository()->get($countryCode, $this->locale);`
`59`	`60`	`}`
`60`	`61`
`@@ -83,10 +84,13 @@ public function countryByName($countryName)`
`83`	`84`	`*/`
`84`	`85`	`public function findCountry($codeOrName)`
`85`	`86`	`{`
	`87`	`+ $code = strtoupper($codeOrName);`
`86`	`88`	`$countryList = $this->getCountryList();`
`87`		`- if (isset($countryList[$codeOrName])) {`
`88`		`- return $this->country($codeOrName);`
	`89`	`+`
	`90`	`+ if (isset($countryList[$code])) {`
	`91`	`+ return $this->country($code);`
`89`	`92`	`}`
	`93`	`+`
`90`	`94`	`return $this->countryByName($codeOrName);`
`91`	`95`	`}`
`92`	`96`
`@@ -163,4 +167,4 @@ public function getAdministrativeAreaRepository()`
`163`	`167`
`164`	`168`	`return $this->administrativeAreaRepository;`
`165`	`169`	`}`
`166`		`-}`
	`170`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,7 @@ protected function createSubdivisionFromDefinitions($id, array $definitions, $lo`
`50`	`50`	`*/`
`51`	`51`	`public function getAll($countryCode, $parentId = null, $locale = null)`
`52`	`52`	`{`
	`53`	`+ $countryCode = strtoupper($countryCode);`
`53`	`54`	`$subdivisions = parent::getAll($countryCode, $parentId, $locale);`
`54`	`55`
`55`	`56`	`return new AdministrativeAreaCollection($subdivisions);`
`@@ -66,4 +67,4 @@ public function get($id, $locale = null)`
`66`	`67`	`{`
`67`	`68`	`return parent::get($id, $locale);`
`68`	`69`	`}`
`69`		`-}`
	`70`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -16,17 +16,33 @@ class TranslationTest extends TestCase`
`16`	`16`	`*/`
`17`	`17`	`protected $validator;`
`18`	`18`
	`19`	`+ /**`
	`20`	`+ * @var string`
	`21`	`+ */`
	`22`	`+ protected $translationDirectory;`
	`23`	`+`
`19`	`24`	`public function setUp()`
`20`	`25`	`{`
`21`	`26`	`parent::setUp();`
`22`	`27`	`$this->validator = $this->app['validator'];`
	`28`	`+ $this->translationDirectory = __DIR__.'/../lang';`
`23`	`29`	`}`
`24`	`30`
`25`	`31`	`protected function getPackageProviders($app)`
`26`	`32`	`{`
`27`	`33`	`return [ServiceProvider::class];`
`28`	`34`	`}`
`29`	`35`
	`36`	`+ protected function getMessage($locale, $filename, $key, $field)`
	`37`	`+ {`
	`38`	`+ $filePath = sprintf('%s/%s/%s.php', $this->translationDirectory, $locale, $filename);`
	`39`	`+ $arrayContent = include $filePath;`
	`40`	`+`
	`41`	`+ if (isset($arrayContent[$key])) {`
	`42`	`+ return str_replace(':attribute', $field, $arrayContent[$key]);`
	`43`	`+ }`
	`44`	`+ }`
	`45`	`+`
`30`	`46`	`public function testENMessages()`
`31`	`47`	`{`
`32`	`48`	`$this->app->setLocale('en');`
`@@ -37,7 +53,8 @@ public function testENMessages()`
`37`	`53`	`if ($validator->fails()) {`
`38`	`54`	`$messages = $validator->errors()->get('country');`
`39`	`55`	`$first = array_shift($messages);`
`40`		`- $this->assertEquals($first, 'The country field is not a valid country code.');`
	`56`	`+ $expectedMessage = $this->getMessage('en', 'validation', 'country_code', 'country');`
	`57`	`+ $this->assertEquals($first, $expectedMessage);`
`41`	`58`	`}`
`42`	`59`	`}`
`43`	`60`
`@@ -51,7 +68,8 @@ public function testPT_BRMessages()`
`51`	`68`	`if ($validator->fails()) {`
`52`	`69`	`$messages = $validator->errors()->get('country');`
`53`	`70`	`$first = array_shift($messages);`
`54`		`- $this->assertEquals($first, 'O campo country não possui um código de país válido.');`
	`71`	`+ $expectedMessage = $this->getMessage('pt-br', 'validation', 'country_code', 'country');`
	`72`	`+ $this->assertEquals($first, $expectedMessage);`
`55`	`73`	`}`
`56`	`74`	`}`
`57`	`75`
`@@ -65,7 +83,8 @@ public function testENMessagesForAdministrativeAreaValidator()`
`65`	`83`	`if ($validator->fails()) {`
`66`	`84`	`$messages = $validator->errors()->get('state');`
`67`	`85`	`$first = array_shift($messages);`
`68`		`- $this->assertEquals($first, 'The state field is not a valid state/province.');`
	`86`	`+ $expectedMessage = $this->getMessage('en', 'validation', 'administrative_area', 'state');`
	`87`	`+ $this->assertEquals($first, $expectedMessage);`
`69`	`88`	`}`
`70`	`89`	`}`
`71`	`90`	`}`