rodders 0.1.1 → 0.1.2

data/Gemfile

@@ -9,6 +9,7 @@ gem "money"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"

data/Gemfile.lock

@@ -22,6 +22,7 @@ GEM
     rspec-expectations (2.3.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.3.0)
+    yard (0.6.8)
 
 PLATFORMS
   ruby
@@ -32,3 +33,4 @@ DEPENDENCIES
   money
   rcov
   rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/Rakefile

@@ -38,12 +38,5 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rodders #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/FixedOdds.rb

@@ -10,7 +10,9 @@ class FixedOdds
   attr_reader :fractional_odds
 
   # creates a new FixedOdds from a string which can be in fractional, 
-  # moneyline or decimal format. 
+  # moneyline or decimal format
+  # @param [String] odds the odds in fractional, moneyline or decimal form
+  # @return [FixedOdds]
   def FixedOdds.from_s(odds)
     case
     when FixedOdds.fractional_odds?(odds) then FixedOdds.fractional_odds odds
@@ -21,16 +23,22 @@ class FixedOdds
   end
 
   # tells if the odds are in fractional form
+  # @param [String] odds the odds representation
+  # @return [Boolean] to indicate if it matches
   def FixedOdds.fractional_odds?(odds)
     odds =~ /\d+\/\d+|\d+-to-\d+|evens|even money/
   end
 
   # tells if the odds are in moneyline form
+  # @param (see FixedOdds.fractional_odds?)
+  # @return (see FixedOdds.fractional_odds?)
   def FixedOdds.moneyline_odds?(odds)
     odds =~ /[+-]\d+/ 
   end
 
   # tells if the odds are in decimal form
+  # @param (see FixedOdds.fractional_odds?)
+  # @return (see FixedOdds.fractional_odds?)
   def FixedOdds.decimal_odds?(odds)
     odds =~ /^(\d+|\d+\.\d+|\.\d+)/ 
   end
@@ -44,6 +52,8 @@ class FixedOdds
   # * 4/1 on
   # * evens
   # * even money
+  # @param [String] fractional odds in fractional form
+  # @return (see FixedOdds.from_s)
   def FixedOdds.fractional_odds(fractional)
     raise %{could not parse "#{fractional}" as fractional odds} unless FixedOdds.fractional_odds?(fractional)
     return new(Rational('1/1')) if fractional == 'evens' || fractional == 'even money' 
@@ -53,6 +63,7 @@ class FixedOdds
   end
 
   # creates a new FixedOdds from a Rational
+  # @param [Rational] fractional_odds the odds
   def initialize(fractional_odds)
     @fractional_odds = fractional_odds
   end
@@ -60,6 +71,8 @@ class FixedOdds
   # creates a new FixedOdds from moneyline form. Examples are
   # * +400
   # * -500
+  # @param [String] moneyline odds in moneyline form
+  # @return (see FixedOdds.from_s)
   def FixedOdds.moneyline_odds(moneyline)
     raise %{could not parse "#{moneyline}" as moneyline odds} unless FixedOdds.moneyline_odds?(moneyline)
     sign = moneyline[0]
@@ -71,33 +84,42 @@ class FixedOdds
   # creates a new FixedOdds from decimal form. Examples are
   # * 1.25
   # * 2
+  # @param [String] decimal odds in decimal form
+  # @return (see FixedOdds.from_s)
   def FixedOdds.decimal_odds(decimal)
     raise %{could not parse "#{decimal}" as decimal odds} unless FixedOdds.decimal_odds?(decimal)
     new(Rational(decimal.to_f - 1))
   end
 
-  # calculates the profit won on a winning _stake_
+  # calculates the profit won on a winning bet
+  # @param [String] stake the stake
+  # @return [Money] the profit
   def profit_on_winning_stake(stake)
     stake.to_money * @fractional_odds
   end
 
-  # calculates the total return on a winning _stake_ 
+  # calculates the total return on a winning bet
   # (which is the profit plus the initial stake)
+  # @param (see #profit_on_winning_stake)
+  # @return [Money] the total winnings
   def total_return_on_winning_stake(stake)
     profit_on_winning_stake(stake) + stake.to_money
   end
 
-  # string representation in fractional form such as '4/1'
+  # string representation in fractional form like '4/1'
+  # @return [String] fractional form representation
   def to_s
     to_s_fractional
   end
 
-  # string representation in fractional form such as '4/1'
+  # string representation in fractional form like '4/1'
+  # @return (see #to_s)
   def to_s_fractional
     @fractional_odds.to_s
   end
 
   # string representation in moneyline form
+  # @return [String] moneyline form representation
   def to_s_moneyline
     integral_number_with_sign_regex = "%+d"
 
@@ -109,10 +131,12 @@ class FixedOdds
   end
 
   # string representation in decimal form
+  # @return [String] decimal form representation
   def to_s_decimal
     "%g" % (fractional_odds + 1)
   end
 
+  # equality method
   def ==(other)
     other.fractional_odds == @fractional_odds
   end

data/lib/MutuallyExclusiveCollection.rb

@@ -1,30 +1,31 @@
 # A collection of mutually exclusive events.
-#--
-# The events are not currently enforced as being
-# mutually exclusive so are really just plain
-# old events right now.
 class MutuallyExclusiveCollection
   # create a new collection with the given events
+  # @param [Array<FixedOdds>] events the events
   def initialize(events)
     @events = events.sort
   end
 
   # the least likely of the events to occur
+  # @return [FixedOdds] the least likely event
   def underdog
     @events.first
   end
 
   # the most likely of the events to occur
+  # @return [FixedOdds] the most likely event
   def favorite
     @events.last
   end  
 
   # the events in ascending order of probability
+  # @return [Array<FixedOdds>] events in ascending probability
   def in_ascending_probability
     @events
   end
 
   # the events in descending order of probability
+  # @return [Array<FixedOdds>] events in descending probability
   def in_descending_probability
     @events.reverse
   end

data/lib/Rational.rb

@@ -1,7 +1,8 @@
 class Rational
-  # calculates the reciprocal of the rational number
-  #--
-  # Would be better if wrote reciprocal! method instead
+  # calculates the reciprocal
+  # @example
+  #   Rational(2/3).reciprocal #=> Rational(3/2)
+  # @return [Rational] the reciprocal
   def reciprocal
     1 / self
   end

data/rodders.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rodders"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nigel Lowry"]
@@ -46,12 +46,14 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<money>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<money>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
@@ -59,6 +61,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<money>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodders
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
-  requirement: &70307249687580 !ruby/object:Gem::Requirement
+  requirement: &70323280330880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70307249687580
+  version_requirements: *70323280330880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70307249686980 !ruby/object:Gem::Requirement
+  requirement: &70323280330380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,21 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70307249686980
+  version_requirements: *70323280330380
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70323280329900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70323280329900
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70307249686400 !ruby/object:Gem::Requirement
+  requirement: &70323280329400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70307249686400
+  version_requirements: *70323280329400
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70307249685800 !ruby/object:Gem::Requirement
+  requirement: &70323280328780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70307249685800
+  version_requirements: *70323280328780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70307249685200 !ruby/object:Gem::Requirement
+  requirement: &70323280328260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70307249685200
+  version_requirements: *70323280328260
 description: Converts between fractional, decimal and moneyline odds for betting and
   gambling. Calculates how much can be won on a given stake.
 email: nigel-lowry@ultra.eclipse.co.uk
@@ -106,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 922005000090340067
+      hash: 2782545268239026614
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: