Refactor for readability and simplicity

Author: ivanvermeyen

.scrutinizer.yml

@@ -1,8 +1,5 @@
 filter:
     excluded_paths:
-        - "config/"
-        - "resources/"
-        - "routes/"
         - "tests/"
 checks:
     php:

CHANGELOG.md

@@ -7,7 +7,6 @@ All notable changes to `BrowserLocale` will be documented in this file.
 - Rename main class & remove interface for simplicity
 - Make constructor argument required
 - Make private methods protected
-- Rename `$locale` property to `$full` in `Locale` class
 - Switch to PHPUnit for testing
 - Add ServiceProvider for Laravel
 

README.md

@@ -11,9 +11,12 @@
 
 Every browser has a setting for preferred website locales.
 
-This can be read by PHP, usually with the `$_SERVER["HTTP_ACCEPT_LANGUAGE"]` variable. Its value is a string that looks like this: `nl-NL,nl;q=0.8,en-US;q=0.6,en;q=0.4`.
+This can be read by PHP, usually with the `$_SERVER["HTTP_ACCEPT_LANGUAGE"]` variable.
+
+> `$_SERVER["HTTP_ACCEPT_LANGUAGE"]` will return a comma separated list of language codes. Each language code MAY have a "relative quality factor" attached ("nl;q=0.8") which determines the order of preference. For example: `nl-NL,nl;q=0.8,en-US;q=0.6,en;q=0.4`. If no relative quality factor is present, the value is by default `1.0`.
+
+**BrowserLocale** parses this string and lets you access the preferred locales quickly and easily.
 
-`BrowserLocale` parses this string and lets you access the preferred locales quickly and easily.
 
 ##  Requirements
 
@@ -51,7 +54,7 @@ This will return an instance of `\CodeZero\BrowserLocale\Locale` or `null` if no
 
 ``` php
 if ($locale !== null) {
-    $full     = $locale->full;     // Example: "en-US"
+    $full     = $locale->locale;   // Example: "en-US"
     $language = $locale->language; // Example: "en"
     $country  = $locale->country;  // Example: "US"
     $weight   = $locale->weight;   // Example: 1.0
@@ -70,7 +73,7 @@ If no locales exist, an empty array will be returned.
 
 ``` php
 foreach ($locales as $locale) {
-    $full     = $locale->full;     // Example: "en-US"
+    $full     = $locale->locale;   // Example: "en-US"
     $language = $locale->language; // Example: "en"
     $country  = $locale->country;  // Example: "US"
     $weight   = $locale->weight;   // Example: 1.0  
@@ -82,7 +85,7 @@ foreach ($locales as $locale) {
 You can get a flattened array, containing only specific locale info. These arrays will always be sorted by weight in descending order. There will be no duplicate values! (e.g. `en` and `en-US` are both the language `en`)
 
 ``` php
-$locales = $browser->getLocales('full');
+$locales = $browser->getLocales('locale');
 //=> Result: ['en-US', 'en', 'nl-BE', 'nl']
 
 $languages = $browser->getLocales('language');

phpunit.xml.dist

@@ -16,6 +16,9 @@
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">./src</directory>
+            <exclude>
+                <file>./src/Laravel/BrowserLocaleServiceProvider.php</file>
+            </exclude>
         </whitelist>
     </filter>
 </phpunit>

src/BrowserLocale.php

@@ -5,8 +5,7 @@
 class BrowserLocale
 {
     /**
-     * Array of all preferred locales that are
-     * configured in a visitor's browser.
+     * Array of \CodeZero\BrowserLocale\Locale instances.
      *
      * @var array
      */
@@ -17,7 +16,7 @@ class BrowserLocale
      *
      * @var array
      */
-    protected $filters = ['full', 'language', 'country', 'weight'];
+    protected $filters = ['locale', 'language', 'country', 'weight'];
 
     /**
      * Create a new BrowserLocale instance.
@@ -26,10 +25,7 @@ class BrowserLocale
      */
     public function __construct($httpAcceptLanguages)
     {
-        // $_SERVER["HTTP_ACCEPT_LANGUAGE"] will return a comma separated list of language codes.
-        // Each language code MAY have a "relative quality factor" attached ("nl;q=0.8") which
-        // determines the order of preference. For example: "nl-NL,nl;q=0.8,en-US;q=0.6,en;q=0.4"
-        $this->parseAcceptLanguages($httpAcceptLanguages);
+        $this->parseHttpAcceptLanguages($httpAcceptLanguages);
     }
 
     /**
@@ -44,21 +40,19 @@ public function getLocale()
 
     /**
      * Get an array of Locale objects in descending order of preference.
+     * Specify a Locale property to get a flattened array of values of that property.
      *
-     * If a property filter is specified, a flattened array of locale information,
-     * containing only the requested property values will be returned instead.
-     *
-     * @param string $propertyFilter
+     * @param string $property
      *
      * @return array
      */
-    public function getLocales($propertyFilter = null)
+    public function getLocales($property = null)
     {
-        if ($propertyFilter === null) {
+        if ( ! in_array($property, $this->filters)) {
             return $this->locales;
         }
 
-        return $this->filterLocaleInfo($propertyFilter);
+        return $this->filterLocaleInfo($property);
     }
 
     /**
@@ -68,127 +62,94 @@ public function getLocales($propertyFilter = null)
      *
      * @return void
      */
-    protected function parseAcceptLanguages($httpAcceptLanguages)
+    protected function parseHttpAcceptLanguages($httpAcceptLanguages)
     {
-        if (empty($httpAcceptLanguages)) {
-            return;
-        }
+        $locales = $this->split($httpAcceptLanguages, ',');
 
-        foreach ($this->splitAcceptLanguages($httpAcceptLanguages) as $httpAcceptLanguage) {
-            if ($locale = $this->parseAcceptLanguage($httpAcceptLanguage)) {
-                $this->locales[] = $locale;
-            }
+        foreach ($locales as $httpAcceptLanguage) {
+            $this->makeLocale($httpAcceptLanguage);
         }
 
         $this->sortLocales();
     }
 
     /**
-     * Extract and save information from a HTTP Accept Language.
+     * Convert the given HTTP Accept Language to a Locale object.
      *
      * @param string $httpAcceptLanguage
      *
-     * @return \CodeZero\BrowserLocale\Locale|null
+     * @return void
      */
-    protected function parseAcceptLanguage($httpAcceptLanguage)
+    protected function makeLocale($httpAcceptLanguage)
     {
-        $parts = $this->splitAcceptLanguage($httpAcceptLanguage);
+        $parts = $this->split($httpAcceptLanguage, ';');
 
-        $locale = $parts[0] ?? null;
+        $locale = $parts[0];
         $weight = $parts[1] ?? null;
 
-        if ($locale === null) {
-            return null;
+        if (empty($locale)) {
+            return;
         }
 
-        $localeInstance = new Locale();
-        $localeInstance->full = $locale;
-        $localeInstance->language = $this->getLanguage($locale);
-        $localeInstance->country = $this->getCountry($locale);
-        $localeInstance->weight = $this->getWeight($weight);
-
-        return $localeInstance;
-    }
-
-    /**
-     * Convert a comma separated list to an array.
-     *
-     * Example: ["en", "en-US;q=0.8"]
-     *
-     * @param string $httpAcceptLanguages
-     *
-     * @return array
-     */
-    protected function splitAcceptLanguages($httpAcceptLanguages)
-    {
-        return explode(',', $httpAcceptLanguages) ?: [];
+        $this->locales[] = new Locale(
+            $locale,
+            $this->getLanguage($locale),
+            $this->getCountry($locale),
+            $this->getWeight($weight)
+        );
     }
 
     /**
-     * Split a language code and the relative quality factor by semicolon.
+     * Split the given string by the delimiter.
      *
-     * Example: ["en"] or ["en-US"] or ["en-US", "q=0.8"]
-     *
-     * @param string $httpAcceptLanguage
+     * @param string $string
+     * @param string $delimiter
      *
      * @return array
      */
-    protected function splitAcceptLanguage($httpAcceptLanguage)
+    protected function split($string, $delimiter)
     {
-        return explode(';', trim($httpAcceptLanguage)) ?: [];
+        return explode($delimiter, trim($string)) ?: [];
     }
 
     /**
      * Get the 2-letter language code from the locale.
      *
-     * Example: "en"
-     *
      * @param string $locale
      *
      * @return string
      */
     protected function getLanguage($locale)
     {
-        return substr($locale, 0, 2);
+        return substr($locale, 0, 2) ?: '';
     }
 
     /**
      * Get the 2-letter country code from the locale.
      *
-     * Example: "US"
-     *
      * @param string $locale
      *
      * @return string
      */
     protected function getCountry($locale)
     {
-        if (($divider = strpos($locale, '-')) === false){
-            return '';
-        }
-
-        return substr($locale, $divider + 1, 2);
+        return substr($locale, 3, 2) ?: '';
     }
 
     /**
      * Parse the relative quality factor and return its value.
      *
-     * Example: 1.0 or 0.8
-     *
      * @param string $q
      *
      * @return float
      */
     protected function getWeight($q)
     {
-        $weight = 1.0;
-        $parts = explode('=', $q);
+        $parts = $this->split($q, '=');
 
-        if (isset($parts[1])) {
-            $weight = ((float) $parts[1]);
-        }
+        $weight = $parts[1] ?? 1.0;
 
-        return $weight;
+        return (float) $weight;
     }
 
     /**
@@ -217,15 +178,9 @@ protected function sortLocales()
      */
     protected function filterLocaleInfo($property)
     {
-        $locales = $this->locales;
-
-        if ( ! in_array($property, $this->filters)) {
-            return $locales;
-        }
-
         $filtered = [];
 
-        foreach ($locales as $locale) {
+        foreach ($this->locales as $locale) {
             if ($locale->$property && ! in_array($locale->$property, $filtered)) {
                 $filtered[] = $locale->$property;
             }

src/Locale.php

@@ -5,11 +5,11 @@
 class Locale
 {
     /**
-     * Full locale with language and country code.
+     * Full locale with language and optional country code.
      *
      * @var string
      */
-    public $full;
+    public $locale;
 
     /**
      * Language code of the locale.
@@ -32,4 +32,20 @@ class Locale
      * @var float
      */
     public $weight;
+
+    /**
+     * Create a new Locale instance.
+     *
+     * @param string $locale
+     * @param string $language
+     * @param string $country
+     * @param float $weight
+     */
+    public function __construct($locale, $language, $country, $weight)
+    {
+        $this->locale = $locale;
+        $this->language = $language;
+        $this->country = $country;
+        $this->weight = $weight;
+    }
 }