accept_language 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b2ef71586c1b52c839323443779e12b8feff9b54aa818b11d427762b1fac5ae
-  data.tar.gz: 99f4391638e32daa51aac44ca008cef6bfaf37a4a40a3ffdab10959dcb023753
+  metadata.gz: b1b6659d931a56171b880e543a4364fdd0212cf1664d9fa32d04f29c9142b1a6
+  data.tar.gz: 259ddc12dc7ef62325a5fe634dd0bcb284f1dce0d9629d929858751dcc8cd936
 SHA512:
-  metadata.gz: 6b61d1f98342c9e8e90bd72c9b3c906a9b52c01f8adb7a1edd7165a6303c61dbd8e202cfdc45eb9d8f1d57ab855052bc2d8c6bfac4e73c2b4a3df95be70bed24
-  data.tar.gz: 2cd335536235546b9c95b2ebcca1f6cfadfa9a0c9d03b5d33f3cc1a6b8965bec958ada7a79c78248ca7f8d7aa083ee42d3e5181b1496f717d99f9768c1c94213
+  metadata.gz: c1566e1af8e2cd77e96eebebf25e7f694237f1562396d42ee001349d6fb75503fe022a8325e208db9cd24e354d90253496e11af66f1bd5b7704e8b54ac347263
+  data.tar.gz: 0d7d2c59183e9eae327e61f4ccae25c050f5a82eb511041b2c86c4478548c7144ea10fa78f9c9a4d4b501fdbf8375b72e001e77f73d0820272c139fa9dad5972

data/README.md

@@ -28,25 +28,24 @@ Or install it yourself as:
 
 It's intended to be used in a Web server that supports some level of internationalization (i18n), but can be used anytime an `Accept-Language` header string is available.
 
-Examples:
+In order to help facilitate better i18n, the lib try to find the intersection of the languages the user prefers and the languages your application supports.
 
-```ruby
-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.
-
-Examples:
+Some examples:
 
 ```ruby
-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
+AcceptLanguage.parse("da, en-GB;q=0.8, en;q=0.7").match(:en, :da)       # => :da
+AcceptLanguage.parse("da, en;q=0.8, ug;q=0.9").match("en-GB", "ug-CN")  # => "ug-CN"
+AcceptLanguage.parse("da, en-GB;q=0.8, en;q=0.7").match(:ja)            # => nil
+AcceptLanguage.parse("fr-CH").match(:fr)                                # => nil
+AcceptLanguage.parse("de, zh;q=0.4, fr;q=0").match(:fr)                 # => nil
+AcceptLanguage.parse("de, zh;q=0.4, *;q=0.5, fr;q=0").match(:ar)        # => :ar
+AcceptLanguage.parse("uz-latn-uz").match("uz-Latn-UZ")                  # => "uz-Latn-UZ"
+AcceptLanguage.parse("foo;q=0.1").match(:FoO)                           # => :FoO
+AcceptLanguage.parse("foo").match("bar")                                # => nil
+AcceptLanguage.parse("*").match("BaZ")                                  # => "BaZ"
+AcceptLanguage.parse("*;q=0").match("foobar")                           # => nil
+AcceptLanguage.parse("en, en;q=0").match("en")                          # => nil
+AcceptLanguage.parse("*, en;q=0").match("en")                           # => nil
 ```
 
 ### Rails integration example
@@ -64,7 +63,7 @@ class ApplicationController < ActionController::Base
     return I18n.default_locale unless request.headers.key?("HTTP_ACCEPT_LANGUAGE")
 
     string = request.headers.fetch("HTTP_ACCEPT_LANGUAGE")
-    locale = AcceptLanguage.intersection(string, I18n.default_locale, *I18n.available_locales)
+    locale = AcceptLanguage.parse(string).match(*I18n.available_locales)
 
     # If the server cannot serve any matching language,
     # it can theoretically send back a 406 (Not Acceptable) error code.

data/lib/accept_language.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 # Tiny library for parsing the Accept-Language header.
+# @example
+#   AcceptLanguage.parse("da, en-GB;q=0.8, en;q=0.7") # => #<AcceptLanguage::Parser:0x00007 @languages_range={"da"=>0.1e1, "en-GB"=>0.8e0, "en"=>0.7e0}>
+# @see https://tools.ietf.org/html/rfc2616#section-14.4
 module AcceptLanguage
+  # @note Parse an Accept-Language header field into a language range.
   # @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
-
-  # @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)
+  #   parse("da, en-GB;q=0.8, en;q=0.7") # => #<AcceptLanguage::Parser:0x00007 @languages_range={"da"=>0.1e1, "en-GB"=>0.8e0, "en"=>0.7e0}>
+  # @return [#match] a parser that responds to #match.
+  def self.parse(field)
+    Parser.new(field)
   end
 end
 
-require_relative "accept_language/intersection"
+require_relative "accept_language/parser"

data/lib/accept_language/matcher.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module AcceptLanguage
+  # @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.
+  # @example
+  #   Matcher.new("da" => 1.0, "en-GB" => 0.8, "en" => 0.7).call(:ug, :kk, :ru, :en) # => :en
+  #   Matcher.new("da" => 1.0, "en-GB" => 0.8, "en" => 0.7).call(:fr, :en, :"en-GB") # => :"en-GB"
+  class Matcher
+    attr_reader :excluded_langtags, :preferred_langtags
+
+    # @param [Hash<String, BigDecimal>] languages_range A list of accepted
+    #   languages with their respective qualities.
+    def initialize(**languages_range)
+      @excluded_langtags = Set[]
+      langtags = []
+
+      languages_range.select do |langtag, quality|
+        if quality.zero?
+          @excluded_langtags << langtag unless langtag.eql?("*")
+        else
+          level = (quality * 1_000).to_i
+          langtags[level] = langtag
+        end
+      end
+
+      @preferred_langtags = langtags.compact.reverse
+    end
+
+    # @param [Array<String, Symbol>] available_langtags The list of available
+    #   languages.
+    # @example Uyghur, Kazakh, Russian and English languages are available.
+    #   call(:ug, :kk, :ru, :en)
+    # @return [String, Symbol, nil] The language that best matches.
+    def call(*available_langtags)
+      available_langtags = drop_unacceptable(*available_langtags)
+
+      preferred_langtags.each do |preferred_tag|
+        if preferred_tag.eql?("*")
+          langtag = any_other_langtag(*available_langtags)
+          return langtag unless langtag.nil?
+        else
+          available_langtags.each do |available_langtag|
+            return available_langtag if available_langtag.match?(/\A#{preferred_tag}/i)
+          end
+        end
+      end
+
+      nil
+    end
+
+    private
+
+    def any_other_langtag(*available_langtags)
+      available_langtags.find do |available_langtag|
+        langtags = preferred_langtags - ["*"]
+
+        langtags.none? do |langtag|
+          available_langtag.match?(/\A#{langtag}/i)
+        end
+      end
+    end
+
+    def drop_unacceptable(*available_langtags)
+      available_langtags.inject(Set[]) do |langtags, available_langtag|
+        next langtags if unacceptable?(available_langtag)
+
+        langtags + Set[available_langtag]
+      end
+    end
+
+    def unacceptable?(langtag)
+      excluded_langtags.any? do |excluded_langtag|
+        langtag.match?(/\A#{excluded_langtag}/i)
+      end
+    end
+  end
+end
+
+require "set"

data/lib/accept_language/parser.rb

@@ -1,26 +1,45 @@
 # frozen_string_literal: true
 
 module AcceptLanguage
+  # @note Parser for Accept-Language header fields.
   # @example
-  #   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.
+  #   Parser.new("da, en-GB;q=0.8, en;q=0.7") # => #<AcceptLanguage::Parser:0x00007 @languages_range={"da"=>0.1e1, "en-GB"=>0.8e0, "en"=>0.7e0}>
   # @see https://tools.ietf.org/html/rfc2616#section-14.4
-  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?
+  class Parser
+    attr_reader :languages_range
 
-        tag = tag.downcase.to_sym
+    # @param [String] field The Accept-Language header field to parse.
+    # @see https://tools.ietf.org/html/rfc2616#section-14.4
+    def initialize(field)
+      @languages_range = import(field)
+    end
+
+    # @param [Array<String, Symbol>] available_langtags The list of available
+    #   languages.
+    # @example Uyghur, Kazakh, Russian and English languages are available.
+    #   match(:ug, :kk, :ru, :en)
+    # @return [String, Symbol, nil] The language that best matches.
+    def match(*available_langtags)
+      Matcher.new(**languages_range).call(*available_langtags)
+    end
 
-        if two_letter_truncate && tag.length > 2
-          tag = tag[0, 2].to_sym
-          next hash if hash.key?(tag)
-        end
+    private
 
-        quality = quality.nil? ? 1.0 : quality.to_f
+    # @example
+    #   import('da, en-GB;q=0.8, en;q=0.7') # => {"da"=>0.1e1, "en-GB"=>0.8e0, "en"=>0.7e0}
+    # @return [Hash<String, BigDecimal>] A list of accepted languages with their
+    #   respective qualities.
+    def import(field)
+      field.delete(" ").split(",").inject({}) do |hash, lang|
+        tag, quality = lang.split(/;q=/i)
+        next hash if tag.nil?
+
+        quality = quality.nil? ? BigDecimal("1") : BigDecimal(quality)
         hash.merge(tag => quality)
       end
     end
   end
 end
+
+require "bigdecimal"
+require_relative "matcher"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accept_language
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,7 +160,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/accept_language.rb
-- lib/accept_language/intersection.rb
+- lib/accept_language/matcher.rb
 - lib/accept_language/parser.rb
 homepage: https://github.com/cyril/accept_language.rb
 licenses:
@@ -174,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/accept_language/intersection.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module AcceptLanguage
-  # @example
-  #   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 :preferences, :supported_langs
-
-    def initialize(raw_input, *supported_langs, two_letter_truncate: true)
-      @preferences = Parser.call(raw_input, two_letter_truncate: two_letter_truncate)
-
-      @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
-      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
-
-        return tag if supported_langs.include?(tag)
-      end
-
-      nil
-    end
-
-    protected
-
-    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?(value)
-      value.equal?(:*)
-    end
-  end
-end
-
-require_relative "parser"