sanichi-chess_icu 0.4.8 → 0.4.9

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 4
-:patch: 8
+:patch: 9

data/lib/federation.rb

@@ -33,14 +33,35 @@ 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 more than one federation.
+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 come above the "top" option if both are specified.
+
 =end
 
   class Federation
@@ -66,6 +87,16 @@ The method is not fooled by irrelevant white space.
       matches[0]
     end
     
+    def self.menu(opts = {})
+      compile unless @@objects;
+      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
+    
     def initialize(code, name) # :nodoc: because new is private
       @code = code
       @name = name

data/spec/federation_spec.rb

@@ -101,16 +101,75 @@ module ICU
     
     context "documentation examples" do
       it "should all be correct for valid input" do
-        ICU::Federation.find('IRL').name.should == 'Ireland'
-        ICU::Federation.find('IRL').code.should == 'IRL'
-        ICU::Federation.find('rUs').code.should == 'RUS'
-        ICU::Federation.find('ongoli').name.should == 'Mongolia'
-        ICU::Federation.find('  united   states   ').code.should == 'USA'
+        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
-        ICU::Federation.find('ZYX').should be_nil
-        ICU::Federation.find('land').should be_nil
+        Federation.find('ZYX').should be_nil
+        Federation.find('land').should be_nil
+      end
+    end
+    
+    context "#menu" do
+      before(:all) do
+        @total = 173
+      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
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanichi-chess_icu
 version: !ruby/object:Gem::Version 
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors: 
 - Mark Orr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-26 00:00:00 -07:00
+date: 2009-08-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - spec/util_spec.rb
 has_rdoc: true
 homepage: http://github.com/sanichi/chess_icu
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: For parsing files of chess tournament data into ruby classes.