al 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fa42cadb858988b7a7833de0e82584a1a396023
+  data.tar.gz: 9e455e216ad7176e2529ffff67a74d7f83efc3c2
+SHA512:
+  metadata.gz: 6f6bf956fe3dcd1b41cd41521eb04898631c5ab8252c86a1cf8c1abf33dbd7f9b2f317f5f9b8a9b7c806298a09bfca171f26185009c9f877f6f08cedf3f6a5ae
+  data.tar.gz: 6fbd3ad62290013dbd3216aed8112f5df4ac38fa65d4e0f5e1ed7dd2e5c0698837412183395f6d872c5a68d9ba4c5bd3ee1498def9b19bcbc7ef99e7f0119fcd

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2015 Jip van Reijsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Al
+
+Al stands for `Accept-Language`
+
+## What does Al do?
+
+Al picks the best match from an `Accept-Language` header given a set of 
+available languages.
+
+* Al respects quality values
+* Al respects language tag prefixes
+* Al ignores character case
+* Al ignores spaces (but not other whitespace)
+* Al makes an effort to put up with invalid `Accept-Language` headers
+* Al is fast!
+
+## Usage
+
+```ruby
+require "al"
+
+# Define the available languages and their values
+al          = Al.new("en", :greeting => "Hello")
+al["en-GB"] = { :greeting => "How do you do?" }
+al["en-US"] = { :greeting => "Howdy partner!" }
+
+# Let Al make a sensible match
+lang, match = al.pick("de-DE;q=0.5, de-AT;q=0.4, en-AU")
+puts lang # => "en"
+puts match # => { :greeting => "Hello" }
+
+lang, match = al.pick("en-AU;q=0.4, en-US;q=0.5")
+puts lang # => "en-us"
+puts match # => { :greeting => "Howdy partner!" }
+
+lang, match = al.pick("da")
+puts lang # => "en"
+puts match # => { :greeting => "Hello" }
+```
+
+The default language is optional. Without a default language Al returns `[nil, 
+nil]` if it can't find a match.
+
+## Al and [RFC 2616]
+
+RFC 2616 says a more specific language tag than the requested language tag can
+be used if an exactly matching language tag is not available. The reverse is
+illegal. This means that `en` is not a match when `en-GB` is requested, but 
+`en-GB` is a match when `en` is requested.
+
+Al thinks this is silly.
+
+The `#pick` method will ignore this rule and treat `en` as a valid match when
+`en-GB` is requested. It otherwise follows RFC 2616. A `#strict_pick` method is 
+provided which follows RFC 2616 exactly.
+
+[RFC 2616]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
+
+## Installation
+
+`gem install al`
+
+## Tests
+
+To be able to run the tests install Al with development dependencies (`gem
+install al --development`). Then run `rake test`.
+
+## License
+
+See the LICENSE file.

data/lib/al.rb

@@ -0,0 +1,119 @@
+class Al
+  def initialize(tag = nil, val = nil)
+    @languages = { DEFAULT => [tag, val] }
+
+    if tag && val
+      self[tag] = val
+    end
+  end
+
+  def []=(tag, val)
+    tag = preprocess(tag)
+
+    tag.split(DASH).each_with_object("") do |bit, key|
+      key.concat("-#{bit}")
+      @languages[key[1..-1]] ||= [tag, val]
+    end
+
+    @languages[tag] = [tag, val] # ensure xx overwrites a previous xx-yy
+  end
+
+  def [](tag)
+    @languages[preprocess(tag)][1]
+  end
+
+  def pick(header)
+    unless header
+      return @languages[DEFAULT]
+    end
+
+    high = 0.0
+    best = nil
+
+    preprocess(header).split(COMMA).each do |tag|
+      len = tag.size
+      sem = tag.index(SEMICOLON) || len
+      pos = sem
+      
+      while pos
+        attempt = tag[0, pos]
+        result  = @languages[attempt]
+
+        if result
+          quality = quality(tag, sem, len)
+
+          if quality > high
+            high = quality
+            best = result
+            
+            if high >= 1.0
+              return best
+            end
+
+            break
+          end
+        end
+
+        pos = tag.rindex(DASH, -(len - pos) - 1)
+      end
+    end
+
+    return best || @languages[DEFAULT]
+  end
+
+  def strict_pick(header)
+    unless header
+      return @languages[DEFAULT]
+    end
+
+    high = 0.0
+    best = nil
+
+    preprocess(header).split(COMMA).each do |tag|
+      sem    = tag.index(SEMICOLON) || tag.size
+      result = @languages[tag[0, sem]]
+
+      if result
+        len     = tag.size
+        sem     = tag.index(SEMICOLON) || len
+        quality = quality(tag, sem, len)
+
+        if quality > high
+          high = quality
+          best = result
+          
+          if high >= 1.0
+            return best
+          end
+        end
+      end
+    end
+
+    return best || @languages[DEFAULT]
+  end
+
+  private
+
+  SPACE = " ".freeze
+  EMPTY = "".freeze
+
+  def preprocess(s)
+    result = s.tr(SPACE, EMPTY)
+    result.downcase!
+
+    return result
+  end
+
+  def quality(tag, sem, len)
+    q = tag[sem + 3, 10]
+
+    return q ? Float(q) : 1.0
+  rescue ArgumentError
+    0.0
+  end
+
+  DEFAULT   = "*".freeze
+  COMMA     = ",".freeze
+  SEMICOLON = ";".freeze
+  DASH      = "-".freeze
+end

data/test/parse_test.rb

@@ -0,0 +1,62 @@
+require "al"
+require "cutest"
+
+test "no input" do
+  al = Al.new("en-gb", "british english")
+
+  assert_equal al.pick(nil), ["en-gb", "british english"]
+end
+
+test "case sensitivity" do |al|
+  al = Al.new
+  al["dA"]    = 1
+  al["en-GB"] = 2
+  al["En"]    = 3
+  
+  assert_equal al.pick("da, en-gb;q=0.8, en;q=0.7"), ["da", 1]
+  assert_equal al.pick("Da;Q=0.1, EN-gb;q=0.3, eN;q=0.2"), ["en-gb", 2]
+end
+
+test "spaces" do
+  al = Al.new
+  al["da"]    = 1
+  al["en-gb"] = 2
+  al["en"]    = 3
+
+  assert_equal al.pick("da,en-gb;q=0.8,en;q=0.7"), ["da", 1]
+  assert_equal al.pick("da;q=0.1,en-gb;q=0.3,en;q=0.2"), ["en-gb", 2]
+
+  al = Al.new
+  al["da"]    = 1
+  al["en-gb"] = 2
+  al["en"]    = 3
+
+  assert_equal al.pick("da, en-gb;q =0.8,en ;   q= 0.7"), ["da", 1]
+  assert_equal al.pick("da;q=0.1,en - gb ;q= 0. 3, e n;q=0.2"), ["en-gb", 2]
+end
+
+test "no language tags" do
+  al = Al.new
+  al["da"] = 2
+
+  assert_equal al.pick(";q=0.8, da;q=0.7"), ["da", 2]
+end
+
+test "numeric sub tags" do
+  al = Al.new
+  al["es-419"] = "latin american spanish"
+
+  assert_equal al.pick("es-419;q=0.7"), ["es-419", "latin american spanish"]
+end
+
+test "invalid quality values" do
+  al = Al.new
+  al["en-gb"] = "british english"
+  al["en-us"] = "american english"
+
+  assert_equal al.pick("en-gb;q, en-us;q=0.8"), ["en-gb", "british english"]
+  assert_equal al.pick("en-gb;q=, en-us;q=0.8"), ["en-us", "american english"]
+  assert_equal al.pick("en-gb;q=., en-us;q=0.8"), ["en-us", "american english"]
+  assert_equal al.pick("en-gb;q=.9, en-us;q=0.8"), ["en-gb", "british english"]
+  assert_equal al.pick("en-gb;q=aaa, en-us;q=0.8"), ["en-us", "american english"]
+end

data/test/pick_test.rb

@@ -0,0 +1,50 @@
+require "al"
+require "cutest"
+
+test "exact match" do
+  al = Al.new
+  al["en-gb"] = "british english"
+
+  assert_equal al.pick("en-gb"), ["en-gb", "british english"]
+end
+
+test "less specific match" do
+  al = Al.new
+  al["en"] = "english"
+
+  assert_equal al.pick("en-gb"), ["en", "english"]
+end
+
+test "more specific match" do
+  al = Al.new
+  al["en-gb"] = "british english"
+
+  assert_equal al.pick("en"), ["en-gb", "british english"]
+end
+
+test "quality values" do |al|
+  al = Al.new
+  al["da"]    = "danish"
+  al["en-gb"] = "british english"
+  al["en"]    = "english"
+
+  assert_equal al.pick("da, en-gb;q=0.8, en;q=0.7"), ["da", "danish"]
+  assert_equal al.pick("da;q=0.1, en-gb;q=0.3, en;q=0.2"), ["en-gb", "british english"]
+end
+
+test "default value" do
+  al = Al.new
+
+  assert_equal al.pick("*"), [nil, nil]
+  assert_equal al.pick("da"), [nil, nil]
+  
+  al = Al.new("en", "english")
+
+  assert_equal al.pick("*"), ["en", "english"]
+  assert_equal al.pick("da"), ["en", "english"]
+
+  al = Al.new("en", "english")
+  al["en-GB"] = "british english"
+
+  assert_equal al.pick("en-us"), ["en", "english"]
+end

data/test/strict_parse_test.rb

@@ -0,0 +1,62 @@
+require "al"
+require "cutest"
+
+test "no input" do
+  al = Al.new("en-gb", "british english")
+
+  assert_equal al.strict_pick(nil), ["en-gb", "british english"]
+end
+
+test "case sensitivity" do |al|
+  al = Al.new
+  al["dA"]    = 1
+  al["en-GB"] = 2
+  al["En"]    = 3
+  
+  assert_equal al.strict_pick("da, en-gb;q=0.8, en;q=0.7"), ["da", 1]
+  assert_equal al.strict_pick("Da;Q=0.1, EN-gb;q=0.3, eN;q=0.2"), ["en-gb", 2]
+end
+
+test "spaces" do
+  al = Al.new
+  al["da"]    = 1
+  al["en-gb"] = 2
+  al["en"]    = 3
+
+  assert_equal al.strict_pick("da,en-gb;q=0.8,en;q=0.7"), ["da", 1]
+  assert_equal al.strict_pick("da;q=0.1,en-gb;q=0.3,en;q=0.2"), ["en-gb", 2]
+
+  al = Al.new
+  al["da"]    = 1
+  al["en-gb"] = 2
+  al["en"]    = 3
+
+  assert_equal al.strict_pick("da, en-gb;q =0.8,en ;   q= 0.7"), ["da", 1]
+  assert_equal al.strict_pick("da;q=0.1,en - gb ;q= 0. 3, e n;q=0.2"), ["en-gb", 2]
+end
+
+test "no language tags" do
+  al = Al.new
+  al["da"] = 2
+
+  assert_equal al.strict_pick(";q=0.8, da;q=0.7"), ["da", 2]
+end
+
+test "numeric sub tags" do
+  al = Al.new
+  al["es-419"] = "latin american spanish"
+
+  assert_equal al.strict_pick("es-419;q=0.7"), ["es-419", "latin american spanish"]
+end
+
+test "invalid quality values" do
+  al = Al.new
+  al["en-gb"] = "british english"
+  al["en-us"] = "american english"
+
+  assert_equal al.strict_pick("en-gb;q, en-us;q=0.8"), ["en-gb", "british english"]
+  assert_equal al.strict_pick("en-gb;q=, en-us;q=0.8"), ["en-us", "american english"]
+  assert_equal al.strict_pick("en-gb;q=., en-us;q=0.8"), ["en-us", "american english"]
+  assert_equal al.strict_pick("en-gb;q=.9, en-us;q=0.8"), ["en-gb", "british english"]
+  assert_equal al.strict_pick("en-gb;q=aaa, en-us;q=0.8"), ["en-us", "american english"]
+end

data/test/strict_pick_test.rb

@@ -0,0 +1,50 @@
+require "al"
+require "cutest"
+
+test "exact match" do
+  al = Al.new
+  al["en-gb"] = "british english"
+
+  assert_equal al.strict_pick("en-gb"), ["en-gb", "british english"]
+end
+
+test "less specific match" do
+  al = Al.new
+  al["en"] = "english"
+
+  assert_equal al.strict_pick("en-gb"), [nil, nil]
+end
+
+test "more specific match" do
+  al = Al.new
+  al["en-gb"] = "british english"
+
+  assert_equal al.strict_pick("en"), ["en-gb", "british english"]
+end
+
+test "quality values" do |al|
+  al = Al.new
+  al["da"]    = "danish"
+  al["en-gb"] = "british english"
+  al["en"]    = "english"
+
+  assert_equal al.strict_pick("da, en-gb;q=0.8, en;q=0.7"), ["da", "danish"]
+  assert_equal al.strict_pick("da;q=0.1, en-gb;q=0.3, en;q=0.2"), ["en-gb", "british english"]
+end
+
+test "default value" do
+  al = Al.new
+
+  assert_equal al.strict_pick("*"), [nil, nil]
+  assert_equal al.strict_pick("da"), [nil, nil]
+  
+  al = Al.new("en", "english")
+
+  assert_equal al.strict_pick("*"), ["en", "english"]
+  assert_equal al.strict_pick("da"), ["en", "english"]
+
+  al = Al.new("en", "english")
+  al["en-GB"] = "british english"
+
+  assert_equal al.pick("en-us"), ["en", "english"]
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: al
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jip van Reijsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: Al picks the best match from an `Accept-Language` header given a set
+  of available languages.
+email: jipvanreijsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/al.rb
+- test/parse_test.rb
+- test/pick_test.rb
+- test/strict_parse_test.rb
+- test/strict_pick_test.rb
+homepage: https://github.com/britishtea/al
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Al stands for Accept-Language
+test_files:
+- test/parse_test.rb
+- test/pick_test.rb
+- test/strict_parse_test.rb
+- test/strict_pick_test.rb
+has_rdoc: