icu_ratings 0.2.6 → 0.2.7

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 6
+:patch: 7
 :build: 
 :major: 0
 :minor: 2

data/lib/icu_ratings/player.rb

@@ -71,7 +71,7 @@ _rating_, _kfactor_ or _games_.
 
   p = t.add_player(5)
   p.type             # :unrated
-  
+
 == Invalid Combinations
 
 The above four types of players (_rated_, _provisional_, _unrated_, _foreign_) are the only
@@ -142,7 +142,7 @@ method.
     def expected_score
       @results.inject(0.0) { |e, r| e + (r.expected_score || 0.0) }
     end
-    
+
     # After the tournament has been rated, this returns the tournament rating performance for
     # rated, unrated and foreign players. For provisional players it returns a weighted average
     # of the player's tournament performance and their previous games. For provisional and
@@ -150,7 +150,7 @@ method.
     def performance
       @performance
     end
-    
+
     # Returns an array of the player's results (ICU::RatedResult) in round order.
     def results
       @results
@@ -160,12 +160,12 @@ method.
     def score
       @results.inject(0.0) { |e, r| e + r.score }
     end
-    
+
     # Returns the type of player as a symbol: one of _rated_, _provisional_, _unrated_ or _foreign_.
     def type
       @type
     end
-    
+
     def add_result(result) # :nodoc:
       raise "invalid result (#{result.class})" unless result.is_a? ICU::RatedResult
       raise "players cannot score results against themselves" if self == result.opponent
@@ -180,7 +180,7 @@ method.
       @results << result
       @results.sort!{ |a,b| a.round <=> b.round }
     end
-   
+
     def rate! # :nodoc:
       @results.each { |r| r.rate!(self) }
     end

data/lib/icu_ratings/result.rb

@@ -98,24 +98,24 @@ _expected_score_, _rating_change_.
     def round
       @round
     end
-    
+
     # The player's opponent (an instance of ICU::RatedPlayer).
     def opponent
       @opponent
     end
-    
+
     # The player's score in this game (1.0, 0.5 or 0.0).
     def score
       @score
     end
-    
+
     # After the tournament has been rated, this returns the expected score (between 0 and 1)
     # for the player based on the rating difference with the opponent scaled by 400.
     # The standard Elo formula is used: 1/(1 + 10^(diff/400)).
     def expected_score
       @expected_score
     end
-    
+
     # After the tournament has been rated, returns the change in rating due to this particular
     # result. Only for rated players (returns _nil_ for other types of players). Computed from
     # the difference between actual and expected scores multiplied by the player's K-factor.
@@ -123,7 +123,7 @@ _expected_score_, _rating_change_.
     def rating_change
       @rating_change
     end
-    
+
     def rate!(player) # :nodoc:
       player_rating   = player.full_rating?   ? player.rating   : player.performance
       opponent_rating = opponent.full_rating? ? opponent.rating : opponent.performance

data/lib/icu_ratings/tournament.rb

@@ -10,11 +10,20 @@ ICU::RatedTournament object are created directly.
 
   t = ICU::RatedTournament.new
 
-They have one optional parameter called _:desc_ (short for description) the value of which can be
+They have two optional parameters. One is called _desc_ (short for description) the value of which can be
 any object but will, if utilized, typically be the name of the tournament as a string.
 
-  t = ICU::RatedTournament.new(:desc => "Irish Championships 2008")
-  puts t.desc                         # "Irish Championships 2008"
+  t = ICU::RatedTournament.new(:desc => "Irish Championships 2010")
+  puts t.desc                         # "Irish Championships 2010"
+
+The other optional parameter is _start_ for the start date. A Date object or a string that can be
+parsed as a string can be used to set it. The European convention is preferred for dates like
+"03/06/2013" (3rd of June, not 6th of March). Attempting to set an invalid date will raise an
+exception.
+
+  t = ICU::RatedTournament.new(:start => "01/07/2010")
+  puts t.start.class                  # Date
+  puts t.start.to_s                   # "2010-07-01"
 
 == Rating Tournaments
 
@@ -55,6 +64,7 @@ to be caught and handled in some suitable place in your code.
 
   class RatedTournament
     attr_accessor :desc
+    attr_reader :start
 
     # Add a new player to the tournament. Returns the instance of ICU::RatedPlayer created.
     # See ICU::RatedPlayer for details.
@@ -94,14 +104,19 @@ to be caught and handled in some suitable place in your code.
       @player[num]
     end
 
+    # Set the start date. Raises exception on error.
+    def start=(date)
+      @start = ICU::Util.parsedate!(date)
+    end
+
     private
 
     # Create a new, empty (no players, no results) tournament.
     def initialize(opt={})
-      [:desc].each { |atr| self.send("#{atr}=", opt[atr]) unless opt[atr].nil? }
+      [:desc, :start].each { |atr| self.send("#{atr}=", opt[atr]) unless opt[atr].nil? }
       @player = Hash.new
     end
-    
+
     def performance_ratings
       @player.values.each { |p| p.init_performance }
       stable, count = false, 0

data/lib/icu_ratings/util.rb

@@ -0,0 +1,35 @@
+require 'date' # needed for 1.9.1
+
+module ICU
+  class Util
+
+=begin rdoc
+
+== Parsing dates
+
+Parse strings into date objects, interpreting nn/nn/nnnn as dd/mm/yyyy. Raises exception on error.
+
+  Util.parsedate!('1955-11-09')       # => Date (1955-11-09)
+  Util.parsedate!('02/03/2009')       # => Date (2009-03-02)
+  Util.parsedate!('02/23/2009')       # => Date (2009-02-23)
+  Util.parsedate!('16th June 1986')   # => Date (1986-06-16)
+  Util.parsedate!('not a date')       # exception raised
+
+Note that the parse method of the Date class behaves differently in Ruby 1.8.7 and 1.9.1.
+In 1.8.7 it assumes American dates and will raise ArgumentError on "30/03/2003".
+In 1.9.1 it assumes European dates and will raise ArgumentError on "03/30/2003".
+
+=end
+
+    def self.parsedate!(date)
+      string = date.to_s.strip
+      raise "invalid date (#{date})" unless string.match(/[1-9]/)
+      string = [$3].concat($2.to_i > 12 ? [$1, $2] : [$2, $1]).join('-') if string.match(/^(\d{1,2}).(\d{1,2}).(\d{4})$/)
+      begin
+        Date.parse(string, true)
+      rescue
+        raise "invalid date (#{date})"
+      end
+    end
+  end
+end

data/lib/icu_ratings.rb

@@ -1,8 +1,3 @@
 # :enddoc:
-
-icu_ratings_files = Array.new
-icu_ratings_files.concat %w{tournament player result}
-
 dir = File.dirname(__FILE__)
-
-icu_ratings_files.each { |file| require "#{dir}/icu_ratings/#{file}" }
+%w{tournament player result util}.each { |f| require "#{dir}/icu_ratings/#{f}" }

data/spec/player_spec.rb

@@ -10,7 +10,7 @@ module ICU
         @f = ICU::RatedPlayer.new(3, :rating => 2500)
         @u = ICU::RatedPlayer.new(4)
       end
-      
+
       it "rated players have a rating and k-factor" do
         @r.num.should     == 1
         @r.rating.should  == 2000
@@ -19,7 +19,7 @@ module ICU
         @r.type.should    == :rated
         @r.full_rating?.should be_true
       end
-      
+
       it "provisionally rated players have a rating and number of games" do
         @p.num.should     == 2
         @p.rating.should  == 1500
@@ -28,7 +28,7 @@ module ICU
         @p.type.should    == :provisional
         @p.full_rating?.should be_false
       end
-      
+
       it "foreign players just have a rating" do
         @f.num.should     == 3
         @f.rating.should  == 2500
@@ -37,7 +37,7 @@ module ICU
         @f.type.should    == :foreign
         @f.full_rating?.should be_true
       end
-      
+
       it "unrated players just have nothing other than their number" do
         @u.num.should     == 4
         @u.rating.should  be_nil
@@ -46,7 +46,7 @@ module ICU
         @u.type.should    == :unrated
         @u.full_rating?.should be_false
       end
-      
+
       it "other combinations are invalid" do
         [
           { :games => 10 },
@@ -56,7 +56,7 @@ module ICU
         ].each { |opts| lambda { ICU::RatedPlayer.new(1, opts) }.should raise_error(/invalid.*combination/i) }
       end
     end
-    
+
     context "#new - miscellaneous" do
       it "attribute values can be given by strings, even when space padded" do
         p = ICU::RatedPlayer.new(' 1 ', :kfactor => ' 10.0 ', :rating => ' 1000 ')
@@ -81,19 +81,19 @@ module ICU
         lambda { ICU::RatedPlayer.new(1, :rating =>  0) }.should_not raise_error
         lambda { ICU::RatedPlayer.new(1, :rating => -1) }.should_not raise_error
       end
-      
+
       it "ratings are stored as floats but can be specified with an integer" do
         ICU::RatedPlayer.new(1, :rating => 1234.5).rating.should == 1234.5
         ICU::RatedPlayer.new(1, :rating => 1234.0).rating.should == 1234
         ICU::RatedPlayer.new(1, :rating =>   1234).rating.should == 1234
       end
-      
+
       it "the number of games shoud not exceed 20" do
         lambda { ICU::RatedPlayer.new(1, :rating => 1000, :games => 19) }.should_not raise_error
         lambda { ICU::RatedPlayer.new(1, :rating => 1000, :games => 20) }.should raise_error
         lambda { ICU::RatedPlayer.new(1, :rating => 1000, :games => 21) }.should raise_error
       end
-      
+
       it "a description, such as a name, but can be any object, is optional" do
         ICU::RatedPlayer.new(1, :desc => 'Fischer, Robert').desc.should == 'Fischer, Robert'
         ICU::RatedPlayer.new(1, :desc => 1).desc.should be_an_instance_of(Fixnum)
@@ -124,7 +124,7 @@ module ICU
         @p.results[1].should == @r2
         @p.results[2].should == @r3
       end
-      
+
       it "the total score should stay consistent with results as they are added" do
         @p.score.should == 0.0
         @p.add_result(@r1)
@@ -135,18 +135,18 @@ module ICU
         @p.score.should == 1.5
       end
     end
-    
+
     context "Rdoc examples" do
       before(:each) do
         @t = ICU::RatedTournament.new
         @t.add_player(1)
       end
-      
+
       it "the same player number can't be added twice" do
         lambda { @t.add_player(2) }.should_not raise_error
         lambda { @t.add_player(2) }.should raise_error
       end
-      
+
       it "parameters can be specified using strings, even with whitespace padding" do
         p = @t.add_player("  0  ", :rating => "  2000.5  ", :kfactor => "  20.5  ")
         p.num.should == 0
@@ -159,11 +159,11 @@ module ICU
         p.games.should == 15
         p.games.should be_an_instance_of(Fixnum)
       end
-      
+
       it "the games parameter should not exceed 20" do
         lambda { @t.add_player(2, :rating => 1500, :games => 20 ) }.should raise_error
       end
-      
+
       it "adding different player types" do
         p = @t.add_player(3, :rating => 2000, :kfactor => 16)
         p.type.should == :rated

data/spec/result_spec.rb

@@ -7,7 +7,7 @@ module ICU
       before(:all) do
         @o = ICU::RatedPlayer.new(2)
       end
-      
+
       it "needs a round, opponent and score (win, loss or draw)" do
         r = ICU::RatedResult.new(1, @o, 'W')
         r.round.should == 1
@@ -20,7 +20,7 @@ module ICU
       before(:each) do
         @p = ICU::RatedPlayer.new(2)
       end
-      
+
       it "round numbers must be positive" do
         lambda { ICU::RatedResult.new(0, 1, 'W') }.should raise_error(/invalid.*round number/i)
         lambda { ICU::RatedResult.new(-1, 1, 'W') }.should raise_error(/invalid.*round number/i)
@@ -43,7 +43,7 @@ module ICU
       before(:each) do
         @p = ICU::RatedPlayer.new(2)
       end
-      
+
       it "should give the score from the opponent's perspective" do
         ICU::RatedResult.new(1, @p, 'W').opponents_score.should == 0.0
         ICU::RatedResult.new(1, @p, 'L').opponents_score.should == 1.0
@@ -69,7 +69,7 @@ module ICU
         (@r1 == @r5).should be_false
       end
     end
-    
+
     context "Rdoc examples" do
       before(:each) do
         @t = ICU::RatedTournament.new
@@ -89,16 +89,16 @@ module ICU
         @t.player(10).results.size.should == 1
         @t.player(20).results.size.should == 1
       end
-      
+
       it "adding results against other players in the same round will cause an exception" do
         lambda { @t.add_result(1, 10, 30, 'W') }.should raise_error(/inconsistent/i)
         lambda { @t.add_result(1, 10, 20, 'L') }.should raise_error(/inconsistent/i)
       end
-      
+
       it "a player cannot have a result against himself/herself" do
         lambda { @t.add_result(2, 10, 10, 'D') }.should raise_error(/players.*cannot.*sel[fv]/i)
       end
-      
+
       it "results are returned in score order irrespecive of the order they're added in" do
         @t.player(0).results.map{ |r| r.round }.join(',').should == "1,2,3,4"
       end

data/spec/spec_helper.rb

@@ -1,3 +1,3 @@
 require 'rubygems'
 require 'spec'
-require File.dirname(__FILE__) + '/../lib/icu_ratings'
+require File.dirname(__FILE__) + '/../lib/icu_ratings'

data/spec/tournament_spec.rb

@@ -9,6 +9,22 @@ module ICU
         ICU::RatedTournament.new(:desc => 1.0).desc.should be_an_instance_of(Float)
         ICU::RatedTournament.new.desc.should be_nil
       end
+
+      it "a tournament can have an optional start date" do
+        ICU::RatedTournament.new(:start => '2010-01-01').start.should be_a(Date)
+        ICU::RatedTournament.new(:start => '03/06/2013').start.to_s.should == '2013-06-03'
+        ICU::RatedTournament.new(:start => Date.parse('1955-11-09')).start.to_s.should == '1955-11-09'
+        ICU::RatedTournament.new.start.should be_nil
+        lambda { ICU::RatedTournament.new(:start => 'error') }.should raise_error
+      end
+
+      it "should have setters for the optional arguments" do
+        t = ICU::RatedTournament.new
+        t.desc=("Championship")
+        t.start=("2010-07-01")
+        t.desc.should == "Championship"
+        t.start.should == Date.parse("2010-07-01")
+      end
     end
 
     context "#players and #player" do
@@ -79,7 +95,7 @@ module ICU
         lambda { @t.add_result(1, @p1, @p3, 'W') }.should raise_error(/inconsistent/)
         lambda { @t.add_result(1, @p3, @p2, 'W') }.should raise_error(/inconsistent/)
       end
-      
+
       it "players cannot have results against themselves" do
         lambda { @t.add_result(1, @p1, @p1, 'W') }.should raise_error(/against.*themsel(f|ves)/)
       end
@@ -191,7 +207,7 @@ module ICU
           p.new_rating.should be_close(new_rating, 0.5)
         end
       end
-      
+
       it "tournament performances are not the same as ICU year-to-date performances" do
         [
           [1, 1867, 1761],
@@ -306,7 +322,7 @@ module ICU
           end
         end
       end
-      
+
       it "foreign players should have tournament performnce ratings" do
         [
           [3,  2505.0],
@@ -571,7 +587,7 @@ module ICU
         end
       end
     end
-    
+
     context "#rate - a made-up tournament that includes a group of unrateable players" do
       #   1   Orr, Mark               1350    2      2:W   3:W   0:-
       #   2   Coughlan, Anne          251     1      1:L   0:-   3:W
@@ -610,7 +626,7 @@ module ICU
           p.new_rating.should be_close(new_rating, 0.5)
         end
       end
-      
+
       it "should not rate players that have no rateable games" do
         [4, 5, 6].each do |num|
           p = @t.player(num)

data/spec/util_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module ICU
+  describe Util do
+    context "#parsedate!" do
+      it "should return instances of class Date" do
+        Util.parsedate!('2001-01-01').should be_a(Date)
+      end
+
+      it "should parse standard dates" do
+        Util.parsedate!('2001-01-01').to_s.should == '2001-01-01'
+        Util.parsedate!('1955-11-09').to_s.should == '1955-11-09'
+      end
+
+      it "should handle US format" do
+        Util.parsedate!('03/30/2009').to_s.should == '2009-03-30'
+      end
+
+      it "should handle European format" do
+        Util.parsedate!('30/03/2009').to_s.should == '2009-03-30'
+      end
+
+      it "should prefer European format" do
+        Util.parsedate!('02/03/2009').to_s.should == '2009-03-02'
+      end
+
+      it "should handle US style when there's no alternative" do
+        Util.parsedate!('02/23/2009').to_s.should == '2009-02-23'
+      end
+
+      it "should handle single digits" do
+        Util.parsedate!('9/8/2006').to_s.should == '2006-08-09'
+      end
+
+      it "should handle names of months" do
+        Util.parsedate!('9th Nov 1955').to_s.should == '1955-11-09'
+        Util.parsedate!('16th June 1986').to_s.should == '1986-06-16'
+      end
+
+      it "should raise exception on error" do
+        lambda { Util.parsedate!('2010-13-32') }.should raise_error(/invalid date/)
+      end
+
+      it "should accept Date objects as well as strings" do
+        Util.parsedate!(Date.parse('2013-07-01')).should == Date.parse('2013-07-01')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: icu_ratings
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors: 
 - Mark Orr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-16 00:00:00 +00:00
+date: 2010-01-17 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -30,10 +30,12 @@ files:
 - lib/icu_ratings/player.rb
 - lib/icu_ratings/result.rb
 - lib/icu_ratings/tournament.rb
+- lib/icu_ratings/util.rb
 - spec/player_spec.rb
 - spec/result_spec.rb
 - spec/spec_helper.rb
 - spec/tournament_spec.rb
+- spec/util_spec.rb
 has_rdoc: true
 homepage: http://github.com/sanichi/icu_ratings
 licenses: []
@@ -67,3 +69,4 @@ test_files:
 - spec/result_spec.rb
 - spec/spec_helper.rb
 - spec/tournament_spec.rb
+- spec/util_spec.rb