accept_language 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af6ad773549b67a530133a79fd84c7b6de133ab571cb14642ce261eb0f9255d4
-  data.tar.gz: c5a11c41e67023583c9b3ece32babeee369760d6d8b5f0fb2890f4dc055da5dc
+  metadata.gz: 803066f79c629cbd5fc0f3b2090492069bf371f94def82983665b4e0b2be27b2
+  data.tar.gz: aa20bcefe4bc9a687b25ce4275ab721fdabf81f03c6306affc23fb8ed2b8beb3
 SHA512:
-  metadata.gz: f35d229b0ab907ebcbeba66f6163c7f66ef7567cca0795bb669487713ed0eb9bcf1caff663ae953ef070eca4f0a2f932ffb72a5ed4349f876ed871df3649dcae
-  data.tar.gz: a05701325ee77c8aab3ce9057bd26bff5e75564e937020a7694306e81257a72ffbae7530dae570027dcff72afa8f8c2af31acc29ab50005638ecaf9f04f22af6
+  metadata.gz: c81186ce6869f201daf1414714a6792248a3ee89e8208d6cad3d37e605330cdbdfa1ce7206ee36ae1354f191c816b8b2b050e6ef52b5af4ccc427f2f9bfb5e43
+  data.tar.gz: 7d3c640960e56adb03937706b325492ce50be3e3d659927ffc348f8fb638b2fb515ed29c5425cb1878967bf0ccad04cb1e161f0476dc555f8a06dcae01792c66

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-06-12 23:02:50 +0200 using RuboCop version 0.71.0.
+# on 2019-06-14 00:44:48 +0200 using RuboCop version 0.71.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,22 +8,22 @@
 
 # Offense count: 1
 Metrics/AbcSize:
-  Max: 19
+  Max: 18
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 80
+  Max: 75
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 11
 
-# Offense count: 15
+# Offense count: 8
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 110
+  Max: 112

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    accept_language (0.1.3)
+    accept_language (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,12 +20,12 @@ GEM
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.1)
       rspec-support (~> 3.8.0)
     rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)

data/README.md

@@ -31,8 +31,8 @@ It's intended to be used in a Web server that supports some level of internation
 Examples:
 
 ```ruby
-AcceptLanguage.parse('da, en-gb;q=0.8, en;q=0.7') # => [:da, :"en-gb", :en]
-AcceptLanguage.parse('fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5') # => [:"fr-ch", :fr, :en, :de, :*]
+AcceptLanguage.parse('da, en-gb;q=0.8, en;q=0.7')                     # => {:da=>1.0, :"en-gb"=>0.8, :en=>0.7}
+AcceptLanguage.parse('fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5')  # => {:"fr-ch"=>1.0, :fr=>0.9, :en=>0.8, :de=>0.7, :*=>0.5}
 ```
 
 In order to help facilitate better i18n, a method is provided to return the intersection of the languages the user prefers and the languages your application supports.
@@ -40,14 +40,13 @@ In order to help facilitate better i18n, a method is provided to return the inte
 Examples:
 
 ```ruby
-AcceptLanguage.intersection('da, en-gb;q=0.8, en;q=0.7', :ar, :da, :ja, :ro) # => :da
-AcceptLanguage.intersection('da, en-gb;q=0.8, en;q=0.7', :ar, :ja, :ro) # => nil
-AcceptLanguage.intersection('fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5', :en, :ja) # => :en
-AcceptLanguage.intersection('fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5', :ja) # => :ja
-AcceptLanguage.intersection('ko, fr-CH;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5', :fr, :de) # => :fr
-AcceptLanguage.intersection('ko, fr-CH;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5', :fr, :de, truncate: false) # => :de
-AcceptLanguage.intersection('*;q=0.5, zh;q=0.4', :ja, :zh) # => :ja
-AcceptLanguage.intersection('fr;q=0, zh;q=0.4', :fr) # => nil
+AcceptLanguage.intersection('da, en-gb;q=0.8, en;q=0.7', :ja, :ro, :da) # => :da
+AcceptLanguage.intersection('da, en-gb;q=0.8, en;q=0.7', :ja, :ro)      # => nil
+AcceptLanguage.intersection('fr-CH', :fr, two_letter_truncate: false)   # => nil
+AcceptLanguage.intersection('fr-CH', :fr, two_letter_truncate: true)    # => :fr
+AcceptLanguage.intersection('de, zh;q=0.4, fr;q=0', :fr)                # => nil
+AcceptLanguage.intersection('de, zh;q=0.4, *;q=0.5, fr;q=0', :fr)       # => nil
+AcceptLanguage.intersection('de, zh;q=0.4, *;q=0.5, fr;q=0', :ar)       # => :ar
 ```
 
 ### Rails integration example

data/VERSION.semver

@@ -1 +1 @@
-0.1.3
+1.0.0

data/accept_language.gemspec

@@ -7,9 +7,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['contact@cyril.email']
 
   spec.summary       = 'Parser for Accept-Language request HTTP header'
-  spec.description   = 'Parses the Accept-Language header from an HTTP '      \
-                       'request and produces a list of languages sorted by '  \
-                       'quality.'
+  spec.description   = 'Parses the Accept-Language header from an HTTP ' \
+                       'request and produces a hash of languages and qualities.'
   spec.homepage      = 'https://github.com/cyril/accept_language.rb'
   spec.license       = 'MIT'
 

data/lib/accept_language.rb

@@ -2,14 +2,17 @@
 
 # Tiny library for parsing the Accept-Language header.
 module AcceptLanguage
-  def self.intersection(raw_input, *supported_languages, truncate: true)
-    Intersection.new(raw_input, *supported_languages, truncate: truncate).call
+  # @example
+  #   AcceptLanguage.intersection('ja, en-gb;q=0.8, en;q=0.7', :ar, :ja) # => :ja
+  def self.intersection(raw_input, *supported_langs, two_letter_truncate: true)
+    Intersection.new(raw_input, *supported_langs, two_letter_truncate: two_letter_truncate).call
   end
 
-  def self.parse(raw_input)
-    Parser.new(raw_input).call
+  # @example
+  #   AcceptLanguage.parse('ja, en-gb;q=0.8, en;q=0.7') # => { ja: 1.0, "en-gb": 0.8, en: 0.7 }
+  def self.parse(raw_input, two_letter_truncate: false)
+    Parser.call(raw_input, two_letter_truncate: two_letter_truncate)
   end
 end
 
 require_relative 'accept_language/intersection'
-require_relative 'accept_language/parser'

data/lib/accept_language/intersection.rb

@@ -2,51 +2,57 @@
 
 module AcceptLanguage
   # @example
-  #   Intersection.new('da, en-gb;q=0.8, en;q=0.7', :ar, :ja, :ro).call
+  #   AcceptLanguage::Intersection.new('ja, en-gb;q=0.8, en;q=0.7', :ar, :ja).call # => :ja
   # @note Compare an Accept-Language header value with your application's
   #   supported languages to find the common languages that could be presented
   #   to a user.
   # @see https://tools.ietf.org/html/rfc2616#section-14.4
   class Intersection
-    attr_reader :accepted_languages, :default_supported_language, :other_supported_languages
+    attr_reader :preferences, :supported_langs
 
-    def initialize(accepted_languages, default_supported_language, *other_supported_languages, truncate: true)
-      @accepted_languages         = Parser.new(accepted_languages).call
-      @default_supported_language = default_supported_language.to_sym.downcase
-      @other_supported_languages  = other_supported_languages.map { |lang| lang.to_sym.downcase }.to_set
+    def initialize(raw_input, *supported_langs, two_letter_truncate: true)
+      @preferences = Parser.call(raw_input, two_letter_truncate: two_letter_truncate)
 
-      return unless truncate
-
-      @accepted_languages = @accepted_languages.map do |accepted_language|
-        accepted_language[0, 2].to_sym
-      end
-
-      @default_supported_language = @default_supported_language[0, 2].to_sym
-
-      @other_supported_languages = @other_supported_languages.map do |other_supported_language|
-        other_supported_language[0, 2].to_sym
-      end.to_set
+      @supported_langs = supported_langs.map do |lang|
+        lang = lang.downcase
+        lang = lang[0, 2] if two_letter_truncate
+        lang.to_sym
+      end.uniq
     end
 
     def call
-      accepted_languages.find do |accepted_language|
-        break default_supported_language if accepted_language.equal?(wildcard)
+      qualities_without_zero_in_desc_order.each do |quality|
+        tag = preferences.key(quality)
+
+        if wildcard?(tag)
+          lang = any_tag_not_matched_by_any_other_range
+          return lang unless lang.nil?
+        end
 
-        supported_languages.include?(accepted_language)
+        return tag if supported_langs.include?(tag)
       end
+
+      nil
     end
 
     protected
 
-    def supported_languages
-      other_supported_languages + Set[default_supported_language]
+    def any_tag_not_matched_by_any_other_range
+      every_tag_not_matched_by_any_other_range.first
+    end
+
+    def every_tag_not_matched_by_any_other_range
+      supported_langs - preferences.keys
+    end
+
+    def qualities_without_zero_in_desc_order
+      preferences.values.reject(&:zero?).uniq.sort.reverse
     end
 
-    def wildcard
-      :*
+    def wildcard?(value)
+      value.equal?(:*)
     end
   end
 end
 
 require_relative 'parser'
-require 'set'

data/lib/accept_language/parser.rb

@@ -2,29 +2,24 @@
 
 module AcceptLanguage
   # @example
-  #   Parser.new('da, en-gb;q=0.8, en;q=0.7').call
-  # @note Parse a raw Accept-Language header value into an ordered list of
-  #   language tags.
+  #   AcceptLanguage::Parser.call('da, en-gb;q=0.8, en;q=0.7') # => { da: 1.0, "en-gb": 0.8, en: 0.7 }
+  # @note Parse an Accept-Language header value into a hash of tag and quality.
   # @see https://tools.ietf.org/html/rfc2616#section-14.4
-  class Parser
-    def initialize(raw_input)
-      @string = raw_input.to_s
-    end
+  module Parser
+    def self.call(raw_input, two_letter_truncate: false)
+      raw_input.to_s.delete(' ').split(',').inject({}) do |hash, lang|
+        tag, quality = lang.split(/;q=/i)
+        next hash if tag.nil?
 
-    def call
-      preferences.sort { |lang_a, lang_b| lang_b.fetch(1) <=> lang_a.fetch(1) }
-                 .map(&:first)
-    end
+        tag = tag.downcase.to_sym
 
-    protected
+        if two_letter_truncate && tag.length > 2
+          tag = tag[0, 2].to_sym
+          next hash if hash.key?(tag)
+        end
 
-    def preferences
-      @string.delete(' ').split(',').inject({}) do |result, language|
-        tag, quality = language.split(/;q=/i)
         quality = quality.nil? ? 1.0 : quality.to_f
-        next result if quality.zero?
-
-        result.merge(tag.downcase.to_sym => quality)
+        hash.merge(tag => quality)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accept_language
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Parses the Accept-Language header from an HTTP request and produces a
-  list of languages sorted by quality.
+  hash of languages and qualities.
 email:
 - contact@cyril.email
 executables: []
@@ -139,7 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Parser for Accept-Language request HTTP header