Ensure locales always behave as expected

Author: SidOfc

lib/browserino/methods.rb

@@ -13,11 +13,30 @@ def self.analyze(uas, matcher = nil, headers = nil)
  props = fill_missing_with_headers headers, props
  end
 
+ props = fix_inconsistent_props props
+
  like = Client.new props.merge(like_attrs(props, like, uas)) if like
 
  Client.new props, like
  end
 
+ def self.fix_inconsistent_props(hsh)
+ # patch locale and locales props
+ if hsh[:locales].any?
+ # when locale is not present in locales, append it
+ hsh[:locales] << hsh[:locale] unless hsh[:locales].include? hsh[:locale]
+
+ # ensure locales.first == locale when locale present in locales
+ hsh[:locale] = hsh[:locales].first
+ elsif hsh[:locale]
+ # no locales from header but locale is found in UA, append locale
+ # to locales to ensure expected output
+ hsh[:locales] << hsh[:locale]
+ end
+
+ hsh
+ end
+
  def self.normalize_header_keys(headers)
  headers.each_with_object({}) do |(header, value), normalized|
  header = header.gsub(/^HTTP_/i, '').tr('-', '_').downcase.to_sym

spec/missing_props_spec.rb

@@ -39,5 +39,32 @@
  expect(client.locale).to be_nil
  expect(client.locales).to eq %i[]
  end
+
+ it 'prefers http header locale over user agent when possible' do
+ client = Browserino.parse(
+ 'Mozilla/5.0 (Linux; Android 5.1; ZTE Blade L6 Build/LMY47I it-IT) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.91 Mobile Safari/537.36',
+ {'HTTP_ACCEPT_LANGUAGE' => 'en-US,en;q=0.9,nl-NL;q=0.8,nl;q=0.7'}
+ )
+
+ expect(client.locale).to eq :en_us
+ expect(client.locales).to include :it_it
+ end
+
+ it 'adds locale to locales when locale is found in UA but no headers are given' do
+ client = Browserino.parse 'Mozilla/5.0 (Linux; Android 5.1; ZTE Blade L6 Build/LMY47I it-IT) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.91 Mobile Safari/537.36'
+
+ expect(client.locale).to eq :it_it
+ expect(client.locales).to include :it_it
+ end
+
+ it 'sets locale to locales.first when locale is found in headers but not in UA' do
+ client = Browserino.parse(
+ 'Mozilla/5.0 (Linux; Android 5.1; ZTE Blade L6 Build/LMY47I) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.91 Mobile Safari/537.36',
+ {'HTTP_ACCEPT_LANGUAGE' => 'en-US,en;q=0.9,nl-NL;q=0.8,nl;q=0.7'}
+ )
+
+ expect(client.locale).to eq :en_us
+ expect(client.locales).to include :en_us
+ end
  end
 end