icu_utils 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmI4OGJlNjg3MjJkZjEwNDFlMmMyZTViNmExY2RmYTczN2Q3YWI0Yw==
+  data.tar.gz: !binary |-
+    YzUzYTA0ZDlhN2IxZGVmYWZlNjc1NjQ1NTNkMjFjMTI1NDVhOTk4ZA==
+SHA512:
+  metadata.gz: !binary |-
+    ZmQ1Y2EyNzFlZWZiZjNiODhjMDM2Nzc4NWEyOTFlYjY3OGU4NTZjYjgwYWNi
+    MmRmNTI1ZTYwOTNhMDg2YmFkMzlhZDc2MWI5MWU3NWFmYzdmMzQ5M2EzMDdm
+    Njg5YjcwMDRkOThkMTFjNTZiNjM2MTZkOTEwODU4MzI3ODA5NTU=
+  data.tar.gz: !binary |-
+    NmFlZTU2YjNmZWM4NzM2YWE2ODJkNDM5Yzc5MWYzZjVlM2MwNTA1MDcwMThi
+    MDk1MDgxZTNlMTliOGYzZThlNWM4OWQxMzM2NTlhNDZjM2RkZTZhY2FmMzFl
+    ODM2ZGE4YTJjOGE3ZjA2NTI1MGFiNjcwZGEwMjQ0MWFiNWQxMGM=

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.rbc
+.bundle
+.config
+doc/
+pkg
+rdoc
+tmp
+NOTES
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    icu_utils (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rdoc (3.9.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  icu_utils!
+  rake
+  rdoc
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Orr
+
+MIT License
+
+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,19 @@
+# IcuUtils
+
+A place for utilities shared across the various ICU apps and gems.
+
+So far just includes a class to handle FIDE federations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'icu_utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install icu_utils

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/ri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'ri')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/icu_utils.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'icu_utils/version'
+
+Gem::Specification.new do |s|
+  s.name             = "icu_utils"
+  s.version          = IcuUtils::VERSION
+  s.authors          = ["Mark Orr"]
+  s.email            = ["mark.j.l.orr@googlemail.com"]
+  s.description      = %q{A place for shared utilities for sharing between the various ICU apps and gems}
+  s.summary          = %q{Shared ICU utilities}
+  s.homepage         = "http://github.com/sanichi/icu_utils"
+  s.license          = "MIT"
+
+  s.extra_rdoc_files = %w(LICENSE.txt README.md)
+  s.files            = `git ls-files`.split($/)
+  s.test_files       = s.files.grep(%r{^(spec)/})
+  s.require_paths    = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rdoc"
+end

data/lib/icu_utils/federation.rb

@@ -0,0 +1,309 @@
+module ICU
+  #
+  # This class can be used to map a string into an object representing a chess federation.
+  # In FIDE, chess federations are generally either referred to by their full names such as
+  # _Ireland_ or _Russia_ or by three letter codes such as _IRL_ or _RUS_. The three letter
+  # codes are mostly the same as those found in the international standard known as
+  # {ISO 3166-1 alpha-3}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3], but with
+  # some differences (e.g. for England, Scotland and Wales).
+  #
+  # You cannot directly create instances of this class using _new_. Instead, you supply
+  # a string to the class method _find_ and, if the string supplied uniguely identifies a
+  # federation, an instance is returned which responds to _name_ and _code_.
+  #
+  #   fed = ICU::Federation.find('IRL')
+  #   fed.name                                           # => "Ireland"
+  #   fed.code                                           # => "IRL"
+  #
+  # If the string is not sufficient to identify a federation, the _find_ method returns _nil_.
+  #
+  #   fed = ICU::Federation.find('ZYX')                  # => nil
+  #
+  # If the string is three letters long and matches (case insenstively) one of the unique
+  # federation codes, then the instance corresponding to that federation is returned.
+  #
+  #   ICU::Federation.find('rUs').code                   # => "RUS"
+  #
+  # If the string is more than three letters long and if it is a substring (case insensitive)
+  # of exactly one federation name, then that federation is returned.
+  #
+  #   ICU::Federation.find('ongoli').name                # => "Mongolia"
+  #
+  # In all other cases, nil is returned. In the following example, the string matches more than one federation.
+  #
+  #   ICU::Federation.find('land')                       # => nil
+  #
+  # The method is not fooled by irrelevant white space.
+  #
+  #   ICU::Federation.find('  united   states   ').code  # => 'USA'
+  #
+  # The class method _menu_ will return an array of two-element arrays each of which contain a name
+  # and a code.
+  #
+  #   ICU::Federation.menu                               # => [['Afghanistan', 'AFG'], ['Albania', 'ALB], ...]
+  #
+  # Such an array could be used, for example, as the basis of a selection menu in a web application.
+  # Various options are available to alter the array returned. Use the _:order_ option to order by code
+  # instead of the default (by country name).
+  #
+  #   ICU::Federation.menu(:order => 'code')             # => [..., ['Ireland', 'IRL'], ['Iraq', 'IRQ], ...]
+  #
+  # To put one country at the top (followed by the rest, in order) supply the country's code with the _:top_ option:
+  #
+  #   ICU::Federation.menu(:top => 'IRL')                # => [['Ireland', 'IRL'], ['Afghanistan', 'AFG], ...]
+  #
+  # To supply an extra "None" item at the top, specify its label with the _:none_ option:
+  #
+  #   ICU::Federation.menu(:none => 'None')              # => [['None', ''], ['Afghanistan', 'AFG], ...]
+  #
+  # The "None" option's code is the empty string and it comes above the "top" option if both are specified.
+  #
+  class Federation
+    attr_reader :code, :name
+    private_class_method :new
+
+    # Given a code, name or part of a name, return the corresponding federation instance.
+    # If there is no match or more than one match, _nil_ is returned.
+    def self.find(str=nil)
+      return nil unless str
+      str = str.to_s
+      return nil if str.length < 3
+      compile
+      str = str.strip.squeeze(' ').downcase
+      return @@codes[str] if str.length == 3
+      return @@names[str] if @@names[str]
+      matches = Array.new
+      @@names.each_key do |name|
+        matches << @@names[name] if name.index(str)
+      end
+      matches.uniq!
+      return nil unless matches.length == 1
+      matches[0]
+    end
+
+    # Return an array of codes and names suitable for creating a federation menu in Rails.
+    #   ICU::Federation.menu(:order => 'code')     # order federations by code (instead of by name)
+    #   ICU::Federation.menu(:top => 'IRL')        # make this federation come first
+    #   ICU::Federation.menu(:none => 'None')      # add a dummy top entry with name "None" and blank code
+    def self.menu(opts = {})
+      compile
+      top, menu = nil, []
+      @@objects.each {|o| opts[:top] == o.code ? top = [o.name, o.code] : menu.push([o.name, o.code]) }
+      opts[:order] == 'code' ? menu.sort!{|a,b| a.last <=> b.last} : menu.sort!{|a,b| a.first <=> b.first}
+      menu.unshift(top) if top
+      menu.unshift([opts[:none], '']) if opts[:none]
+      menu
+    end
+    
+    # Return an array of sorted federation codes.
+    def self.codes
+      compile
+      @@objects.map(&:code).sort
+    end
+
+    def initialize(code, name) # :nodoc: because new is private
+      @code = code
+      @name = name
+    end
+
+    # :enddoc:
+    private
+
+    def self.compile
+      return if @@objects
+      @@names = Hash.new
+      @@codes = Hash.new
+      @@objects = Array.new
+      @@data.each do |d|
+        object = new(d[0], d[1])
+        @@objects << object
+        @@codes[d[0].downcase] = object
+        (1..d.length-1).each do |i|
+          @@names[d[i].downcase] = object
+        end
+      end
+    end
+
+    # The data structures compiled.
+    @@objects, @@codes, @@names = nil, nil, nil
+
+    # An array of data that gets compiled into other data structures.
+    @@data =
+    [
+      ['AFG', 'Afghanistan'],
+      ['ALB', 'Albania'],
+      ['ALG', 'Algeria'],
+      ['AND', 'Andorra'],
+      ['ANG', 'Angola'],
+      ['ANT', 'Antigua'],
+      ['ARG', 'Argentina'],
+      ['ARM', 'Armenia'],
+      ['ARU', 'Aruba'],
+      ['AUS', 'Australia'],
+      ['AUT', 'Austria'],
+      ['AZE', 'Azerbaijan'],
+      ['BAH', 'Bahamas'],
+      ['BRN', 'Bahrain'],
+      ['BAN', 'Bangladesh'],
+      ['BAR', 'Barbados'],
+      ['BLR', 'Belarus'],
+      ['BEL', 'Belgium'],
+      ['BIZ', 'Belize'],
+      ['BEN', 'Benin Republic'],
+      ['BER', 'Bermuda'],
+      ['BHU', 'Bhutan'],
+      ['BOL', 'Bolivia'],
+      ['BIH', 'Bosnia and Herzegovina'],
+      ['BOT', 'Botswana'],
+      ['BRA', 'Brazil'],
+      ['IVB', 'British Virgin Islands'],
+      ['BRU', 'Brunei Darussalam'],
+      ['BUL', 'Bulgaria'],
+      ['BUR', 'Burkina Faso'],
+      ['BDI', 'Burundi'],
+      ['CAM', 'Cambodia'],
+      ['CMR', 'Cameroon'],
+      ['CAN', 'Canada'],
+      ['CHA', 'Chad'],
+      ['CHI', 'Chile'],
+      ['CHN', 'China'],
+      ['TPE', 'Chinese Taipei'],
+      ['COL', 'Colombia'],
+      ['CRC', 'Costa Rica'],
+      ['CRO', 'Croatia'],
+      ['CUB', 'Cuba'],
+      ['CYP', 'Cyprus'],
+      ['CZE', 'Czech Republic'],
+      ['DEN', 'Denmark'],
+      ['DJI', 'Djibouti'],
+      ['DOM', 'Dominican Republic'],
+      ['ECU', 'Ecuador'],
+      ['EGY', 'Egypt'],
+      ['ESA', 'El Salvador'],
+      ['ENG', 'England'],
+      ['EST', 'Estonia'],
+      ['ETH', 'Ethiopia'],
+      ['FAI', 'Faroe Islands'],
+      ['FIJ', 'Fiji'],
+      ['FIN', 'Finland'],
+      ['FRA', 'France'],
+      ['GAB', 'Gabon'],
+      ['GAM', 'Gambia'],
+      ['GEO', 'Georgia'],
+      ['GER', 'Germany'],
+      ['GHA', 'Ghana'],
+      ['GRE', 'Greece'],
+      ['GUA', 'Guatemala'],
+      ['GCI', 'Guernsey'],
+      ['GUY', 'Guyana'],
+      ['HAI', 'Haiti'],
+      ['HON', 'Honduras'],
+      ['HKG', 'Hong Kong'],
+      ['HUN', 'Hungary'],
+      ['ISL', 'Iceland'],
+      ['IND', 'India'],
+      ['INA', 'Indonesia'],
+      ['IRI', 'Iran'],
+      ['IRQ', 'Iraq'],
+      ['IRL', 'Ireland'],
+      ['ISR', 'Israel'],
+      ['ITA', 'Italy'],
+      ['CIV', 'Ivory Coast'],
+      ['JAM', 'Jamaica'],
+      ['JPN', 'Japan'],
+      ['JCI', 'Jersey'],
+      ['JOR', 'Jordan'],
+      ['KAZ', 'Kazakhstan'],
+      ['KEN', 'Kenya'],
+      ['KUW', 'Kuwait'],
+      ['KGZ', 'Kyrgyzstan'],
+      ['LAT', 'Latvia'],
+      ['LIB', 'Lebanon'],
+      ['LBA', 'Libya'],
+      ['LIE', 'Liechtenstein'],
+      ['LTU', 'Lithuania'],
+      ['LUX', 'Luxembourg'],
+      ['MAC', 'Macau'],
+      ['MKD', 'Macedonia', 'Former YUG Rep of Macedonia', 'Former Yugoslav Republic of Macedonia', 'FYROM'],
+      ['MAD', 'Madagascar'],
+      ['MAW', 'Malawi'],
+      ['MAS', 'Malaysia'],
+      ['MDV', 'Maldives'],
+      ['MLI', 'Mali'],
+      ['MLT', 'Malta'],
+      ['MAU', 'Mauritania'],
+      ['MRI', 'Mauritius'],
+      ['MEX', 'Mexico'],
+      ['MDA', 'Moldova'],
+      ['MNC', 'Monaco'],
+      ['MGL', 'Mongolia'],
+      ['MNE', 'Montenegro'],
+      ['MAR', 'Morocco'],
+      ['MOZ', 'Mozambique'],
+      ['MYA', 'Myanmar'],
+      ['NAM', 'Namibia'],
+      ['NEP', 'Nepal'],
+      ['NED', 'Netherlands'],
+      ['AHO', 'Netherlands Antilles'],
+      ['NZL', 'New Zealand'],
+      ['NCA', 'Nicaragua'],
+      ['NGR', 'Nigeria'],
+      ['NOR', 'Norway'],
+      ['PAK', 'Pakistan'],
+      ['PLW', 'Palau'],
+      ['PLE', 'Palestine'],
+      ['PAN', 'Panama'],
+      ['PNG', 'Papua New Guinea'],
+      ['PAR', 'Paraguay'],
+      ['PER', 'Peru'],
+      ['PHI', 'Philippines'],
+      ['POL', 'Poland'],
+      ['POR', 'Portugal'],
+      ['PUR', 'Puerto Rico'],
+      ['QAT', 'Qatar'],
+      ['ROU', 'Romania'],
+      ['RUS', 'Russia'],
+      ['RWA', 'Rwanda'],
+      ['SMR', 'San Marino'],
+      ['STP', 'Sao Tome and Principe'],
+      ['SCO', 'Scotland'],
+      ['SEN', 'Senegal'],
+      ['SRB', 'Serbia'],
+      ['SEY', 'Seychelles'],
+      ['SLE', 'Siera Leone'],
+      ['SIN', 'Singapore'],
+      ['SVK', 'Slovakia'],
+      ['SLO', 'Slovenia'],
+      ['SOM', 'Somalia'],
+      ['RSA', 'South Africa'],
+      ['KOR', 'South Korea'],
+      ['ESP', 'Spain'],
+      ['SRI', 'Sri Lanka'],
+      ['SUD', 'Sudan'],
+      ['SUR', 'Surinam'],
+      ['SWE', 'Sweden'],
+      ['SUI', 'Switzerland'],
+      ['SYR', 'Syria'],
+      ['TJK', 'Tajikistan'],
+      ['TAN', 'Tanzania'],
+      ['THA', 'Thailand'],
+      ['TRI', 'Trinidad and Tobago'],
+      ['TUN', 'Tunisia'],
+      ['TUR', 'Turkey'],
+      ['TKM', 'Turkmenistan'],
+      ['UGA', 'Uganda'],
+      ['UKR', 'Ukraine'],
+      ['UAE', 'United Arab Emirates'],
+      ['USA', 'United States of America'],
+      ['URU', 'Uruguay'],
+      ['ISV', 'US Virgin Islands'],
+      ['UZB', 'Uzbekistan'],
+      ['VEN', 'Venezuela'],
+      ['VIE', 'Vietnam'],
+      ['WLS', 'Wales'],
+      ['YEM', 'Yemen'],
+      ['ZAM', 'Zambia'],
+      ['ZIM', 'Zimbabwe'],
+    ]
+  end
+end

data/lib/icu_utils/version.rb

@@ -0,0 +1,3 @@
+module IcuUtils
+  VERSION = "1.0.0"
+end

data/lib/icu_utils.rb

@@ -0,0 +1,2 @@
+require 'icu_utils/version'
+require 'icu_utils/federation'

data/spec/federation_spec.rb

@@ -0,0 +1,190 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module ICU
+  describe Federation do
+    context "#find using codes" do
+      it "should find a federation given a valid code" do
+        fed = Federation.find('IRL')
+        fed.code.should == 'IRL'
+        fed.name.should == 'Ireland'
+      end
+
+      it "should find a federation from code case insensitively" do
+        fed = Federation.find('rUs')
+        fed.code.should == 'RUS'
+        fed.name.should == 'Russia'
+      end
+
+      it "should find a federation despite irrelevant whitespace" do
+        fed = Federation.find('  mex    ')
+        fed.code.should == 'MEX'
+        fed.name.should == 'Mexico'
+      end
+
+      it "should return nil for an invalid code" do
+        Federation.find('XYZ').should be_nil
+      end
+    end
+
+    context "#find using names" do
+      it "should find a federation given a valid name" do
+        fed = Federation.find('England')
+        fed.code.should == 'ENG'
+        fed.name.should == 'England'
+      end
+
+      it "should find a federation from name case insensitively" do
+        fed = Federation.find('franCE')
+        fed.code.should == 'FRA'
+        fed.name.should == 'France'
+      end
+
+      it "should not be fooled by irrelevant whitespace" do
+        fed = Federation.find(' united  states  of  america ')
+        fed.code.should == 'USA'
+        fed.name.should == 'United States of America'
+      end
+
+      it "should return nil for an invalid name" do
+        Federation.find('Mordor').should be_nil
+      end
+    end
+
+    context "#find using parts of names" do
+      it "should find a federation given a substring which is unique and at least 4 characters" do
+        fed = Federation.find('bosni')
+        fed.code.should == 'BIH'
+        fed.name.should == 'Bosnia and Herzegovina'
+      end
+
+      it "should not be fooled by irrelevant whitespace" do
+        fed = Federation.find('  arab    EMIRATES   ')
+        fed.code.should == 'UAE'
+        fed.name.should == 'United Arab Emirates'
+      end
+
+      it "should not find a federation if the substring matches more than one" do
+        Federation.find('land').should be_nil
+      end
+
+      it "should return nil for any string smaller in length than 3" do
+        Federation.find('ze').should be_nil
+      end
+    end
+
+    context "#find federations with alternative names" do
+      it "should find Macedonia multiple ways" do
+        Federation.find('MKD').name.should == 'Macedonia'
+        Federation.find('FYROM').name.should == 'Macedonia'
+        Federation.find('macedoni').name.should == 'Macedonia'
+        Federation.find('Macedonia').name.should == 'Macedonia'
+        Federation.find('former YUG Rep').name.should == 'Macedonia'
+        Federation.find('Republic of Macedonia').name.should == 'Macedonia'
+        Federation.find('former yugoslav republic').name.should == 'Macedonia'
+      end
+    end
+
+    context "#find with alternative inputs" do
+      it "should behave robustly with completely invalid inputs" do
+        Federation.find().should be_nil
+        Federation.find(nil).should be_nil
+        Federation.find('').should be_nil
+        Federation.find(1).should be_nil
+      end
+    end
+
+    context "#new is private" do
+      it "#new cannot be called directly" do
+        lambda { Federation.new('IRL', 'Ireland') }.should raise_error(/private method/)
+      end
+    end
+
+    context "documentation examples" do
+      it "should all be correct for valid input" do
+        Federation.find('IRL').name.should == 'Ireland'
+        Federation.find('IRL').code.should == 'IRL'
+        Federation.find('rUs').code.should == 'RUS'
+        Federation.find('ongoli').name.should == 'Mongolia'
+        Federation.find('  united   states   ').code.should == 'USA'
+      end
+
+      it "should return nil for invalid input" do
+        Federation.find('ZYX').should be_nil
+        Federation.find('land').should be_nil
+      end
+    end
+
+    context "#menu" do
+      before(:all) do
+        @total = 174
+      end
+
+      it "should return array of name-code pairs in order of name by default" do
+        menu = Federation.menu
+        menu.should have(@total).items
+        names = menu.map{|m| m.first}.join(',')
+        codes = menu.map{|m| m.last}.join(',')
+        names.index('Afghanistan').should == 0
+        names.index('Iraq,Ireland,Israel').should_not be_nil
+        codes.index('AFG').should == 0
+        codes.index('IRQ,IRL,ISR').should_not be_nil
+      end
+
+      it "should be configuarble to order the list by codes" do
+        menu = Federation.menu(:order => "code")
+        menu.should have(@total).items
+        names = menu.map{|m| m.first}.join(',')
+        codes = menu.map{|m| m.last}.join(',')
+        names.index('Afghanistan').should == 0
+        names.index('Ireland,Iraq,Iceland').should_not be_nil
+        codes.index('AFG').should == 0
+        codes.index('IRL,IRQ,ISL').should_not be_nil
+      end
+
+      it "should be configuarble to have a selected country at the top" do
+        menu = Federation.menu(:top => 'IRL')
+        menu.should have(@total).items
+        names = menu.map{|m| m.first}.join(',')
+        codes = menu.map{|m| m.last}.join(',')
+        names.index('Ireland,Afghanistan').should == 0
+        names.index('Iraq,Israel').should_not be_nil
+        codes.index('IRL,AFG').should == 0
+        codes.index('IRQ,ISR').should_not be_nil
+      end
+
+      it "should be configuarble to have 'None' entry at the top" do
+        menu = Federation.menu(:none => 'None')
+        menu.should have(@total + 1).items
+        names = menu.map{|m| m.first}.join(',')
+        codes = menu.map{|m| m.last}.join(',')
+        names.index('None,Afghanistan').should == 0
+        codes.index(',AFG').should == 0
+      end
+
+      it "should be able to handle multiple configuarations" do
+        menu = Federation.menu(:top => 'IRL', :order => 'code', :none => 'None')
+        menu.should have(@total + 1).items
+        names = menu.map{|m| m.first}.join(',')
+        codes = menu.map{|m| m.last}.join(',')
+        names.index('None,Ireland,Afghanistan').should == 0
+        names.index('Iraq,Iceland').should_not be_nil
+        codes.index(',IRL,AFG').should == 0
+        codes.index('IRQ,ISL').should_not be_nil
+      end
+    end
+
+    context "#codes" do
+      before(:all) do
+        @total = 174
+      end
+
+      it "should return array of codes ordered alphabetically" do
+        codes = Federation.codes
+        codes.should have(@total).items
+        all = codes.join(',')
+        all.index('AFG').should == 0
+        all.index('INA,IND,IRI,IRL,IRQ,ISL,ISR,ISV,ITA,IVB').should_not be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/icu_utils')

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: icu_utils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Orr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A place for shared utilities for sharing between the various ICU apps
+  and gems
+email:
+- mark.j.l.orr@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Icon.png
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/autospec
+- bin/rake
+- bin/ri
+- bin/rspec
+- icu_utils.gemspec
+- lib/icu_utils.rb
+- lib/icu_utils/federation.rb
+- lib/icu_utils/version.rb
+- spec/federation_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/sanichi/icu_utils
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Shared ICU utilities
+test_files:
+- spec/federation_spec.rb
+- spec/spec_helper.rb