elo 0.0.2.alpha

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -0,0 +1,124 @@
+= Elo
+
+From {Wikipedia}[http://en.wikipedia.org/wiki/Elo_rating_system]:
+
+The Elo rating system is a method for calculating the relative skill levels of
+players in two-player games such as chess and Go. It is named after its creator
+Arpad Elo, a Hungarian-born American physics professor.
+
+The Elo system was invented as an improved chess rating system, but today it is
+also used in many other games. It is also used as a rating system for multiplayer
+competition in a number of computer games, and has been adapted to team sports
+including association football, American college football and basketball, and
+Major League Baseball.
+
+== Links
+
+* {API documentation}[http://iain.github.com/elo/doc]
+* {Source Code}[http://github.com/iain/elo]
+
+== Usage
+
+You need to have at least to players that can play a game (duh).
+
+  bob  = Elo::Player.new
+  jane = Elo::Player.new(:rating => 1500)
+
+Once you have players, you can register games in a variaty of ways.
+There is more than one way to do it, choose whatever works from your other code:
+
+  game1 = bob.wins_from(jane)
+  game2 = bob.loses_from(jane)
+  game3 = bob.plays_draw(jane)
+
+  game4 = bob.versus(jane)
+  game4.winner = jane
+
+  game5 = bob.versus(jane)
+  game5.loser = jane
+
+  game6 = bob.versus(jane)
+  game6.draw
+
+  game7 = bob.versus(jane)
+  game7.result = 1 # result is in perspective of bob, so bob wins
+
+You can get all kinds of info from a player:
+
+  bob.rating
+  bob.pro?
+  bob.starter?
+  bob.pro_rating?
+  bob.games_played
+  bob.games
+
+Or get a list of players:
+
+  Elo::Player.all
+
+
+== Configuration
+
+You can configure Elo in many ways. In it's default configuration, it is configured
+in the same way as the {FIDE}[http://www.fide.com/] (World Chess Foundation).
+
+Altering settings to your liking is very easy and very flexible. You can even specify
+your own K-factor rules. Have a look at the Rdoc in the code for a complete reference.
+
+Here is an example:
+
+  Elo.configure do |config|
+
+    # Every player starts with a rating of 1000
+    config.default_rating = 1000
+
+    # A player is considered a pro, when he/she has more than 2400 points
+    config.pro_rating_boundry = 2400
+
+    # A player is considered a new, when he/she has played less than 30 games
+    config.starter_boundry = 30
+
+  end
+
+== About the K-factor
+
+The Elo rating system knows a variable called the "K-factor". The K-factor is used
+to reward new talent and stableize the rating once a player is participating longer.
+
+FIDE (the World Chess Foundation), gives players with less than 30 played games a
+K-factor of 25. Normal players get a K-factor of 15 and pro's get a K-factor of 10.
+Once you reach a pro status, you're K-factor never changes, even if your rating drops.
+
+You need to provide Elo the amount of games played, their rating and their pro-status.
+
+  bob = Elo::Player.new(:games_played => 29, :rating => 2300, :pro => true)
+
+You can define your own K-factors by adding K-factor rules.
+This code will change the K-factor to 12, for every player who's name starts with a B,
+and 16 for everybody else.
+
+  Elo.configure do |config|
+    config.k_factor(12) { name =~ /^b/i }
+    config.default_k_factor = 16
+    config.use_FIDE_settings = false
+  end
+
+
+
+== Installation
+
+  gem install elo
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Iain Hecker. Released under the MIT License

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "elo"
+    gem.summary = %Q{The Elo rating system is a method for calculating the relative skill levels of players in two-player games such as cess and Go.}
+    gem.description = %Q{The Elo rating system is a method for calculating the relative skill levels of players in two-player games such as cess and Go.}
+    gem.email = "iain@iain.nl"
+    gem.homepage = "http://github.com/iain/elo"
+    gem.authors = ["Iain Hecker"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "elo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2.alpha

data/doc/classes/Elo.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang='en'>
+  <head>
+    <title>: Elo [elo ]</title>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+    <link href='../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
+    <script type='text/javascript'>
+      //<![CDATA[
+        function popupCode(url) {
+          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+        }
+        
+        function toggleCode(id) {
+          var code = document.getElementById(id)
+        
+          code.style.display = code.style.display != 'block' ? 'block' : 'none'
+          return true
+        }
+        
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+      //]]>
+    </script>
+  </head>
+  <body class='page'>
+    <div class='class' id='wrapper'>
+      <div class='header'>
+        <h1 class='name'>
+          <span class='type'>Module</span>
+          Elo
+        </h1>
+        <ol class='paths'>
+          <li>
+            <a href="../files/lib/elo_rb.html">lib/elo.rb</a>
+          </li>
+        </ol>
+      </div>
+      <div id='content'>
+        <div id='text'>
+          <div id='description'>
+            <p>
+            The configuration of <a href="Elo.html">Elo</a> is done here.
+            </p>
+            <p>
+            See <a href="../files/README_rdoc.html">README.rdoc</a> for general
+            information about <a href="Elo.html">Elo</a>.
+            </p>
+          </div>
+          <div id='section'>
+            <div id='class-list'>
+              <h2>Classes and Modules</h2>
+              Module <a href="Elo/Configuration.html" class="link">Elo::Configuration</a><br />
+              Module <a href="Elo/EloHelper.html" class="link">Elo::EloHelper</a><br />
+              Class <a href="Elo/Game.html" class="link">Elo::Game</a><br />
+              Class <a href="Elo/Player.html" class="link">Elo::Player</a><br />
+              Class <a href="Elo/Rating.html" class="link">Elo::Rating</a><br />
+            </div>
+          </div>
+        </div>
+      </div>
+      <div id='footer-push'></div>
+    </div>
+    <div id='footer'>
+      <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
+    </div>
+  </body>
+</html>

data/doc/classes/Elo/Configuration.html

@@ -0,0 +1,184 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang='en'>
+  <head>
+    <title>: Elo::Configuration [elo ]</title>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+    <link href='../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
+    <script type='text/javascript'>
+      //<![CDATA[
+        function popupCode(url) {
+          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+        }
+        
+        function toggleCode(id) {
+          var code = document.getElementById(id)
+        
+          code.style.display = code.style.display != 'block' ? 'block' : 'none'
+          return true
+        }
+        
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+      //]]>
+    </script>
+  </head>
+  <body class='page'>
+    <div class='class' id='wrapper'>
+      <div class='header'>
+        <h1 class='name'>
+          <span class='type'>Module</span>
+          Elo::Configuration
+        </h1>
+        <ol class='paths'>
+          <li>
+            <a href="../../files/lib/elo_rb.html">lib/elo.rb</a>
+          </li>
+        </ol>
+      </div>
+      <div id='content'>
+        <div id='text'>
+          <div id='method-list'>
+            <h2>Methods</h2>
+            <h3>public instance</h3>
+            <ol>
+              <li><a href="#M000006">configure</a></li>
+              <li><a href="#M000005">k_factor</a></li>
+            </ol>
+          </div>
+          <div id='section'>
+            <div id='attribute-list'>
+              <h2 class='section-bar'>Attributes</h2>
+              <div class='name-list'>
+                <table>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>default_k_factor</td>
+                    <td class='context-item-value'>[RW]</td>
+                    <td class='context-item-desc'>
+                      
+                      The default k-factor is chosen when no k-factor rules apply. K-factor rules
+                      can be added by using the <tt><a
+                      href="Configuration.html#M000005">k_factor</a></tt>-method. (default = 15)
+                    </td>
+                  </tr>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>default_rating</td>
+                    <td class='context-item-value'>[RW]</td>
+                    <td class='context-item-desc'>
+                      
+                      This is the rating every player starts out with. (default = 1000)
+                    </td>
+                  </tr>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>pro_rating_boundry</td>
+                    <td class='context-item-value'>[RW]</td>
+                    <td class='context-item-desc'>
+                      
+                      This is the lower boundry of the rating you need to be a pro player. This
+                      setting is used in the FIDE k-factor rules. (default = 2400)
+                    </td>
+                  </tr>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>starter_boundry</td>
+                    <td class='context-item-value'>[RW]</td>
+                    <td class='context-item-desc'>
+                      
+                      This is the lower boundry in the amount of games played to be a starting
+                      player This setting is used in the FIDE k-factor rules. (default = 30)
+                    </td>
+                  </tr>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>use_FIDE_settings</td>
+                    <td class='context-item-value'>[RW]</td>
+                    <td class='context-item-desc'>
+                      
+                      Use the settings that FIDE use for determening the K-factor. This is the
+                      case when all settings are unaltered. (default = true)
+                      
+                      <p>
+                      In short:
+                      </p>
+                      <ul>
+                      <li>K-factor is 25 when a player is a starter (less than 30 games played)
+                      
+                      </li>
+                      <li>K-factor is 10 when a player is a pro (rating above 2400, now or in the
+                      past)
+                      
+                      </li>
+                      <li>K-factor is 15 when a player in other cases
+                      
+                      </li>
+                      </ul>
+                      <p>
+                      If you want to use your own settings, either change the boundry settings,
+                      or set this setting to false and add you&#8217;re own k-factor rules.
+                      K-factor rules can be added by using the <tt><a
+                      href="Configuration.html#M000005">k_factor</a></tt>-method.
+                      </p>
+                    </td>
+                  </tr>
+                </table>
+              </div>
+            </div>
+            <div id='methods'>
+              <h2>Public instance methods</h2>
+              <div class='method public-instance' id='method-M000006'>
+                <a name='M000006'></a>
+                <div class='synopsis'>
+                  <span class='name'>configure</span>
+                  <span class='arguments'>() {|self| ...}</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Configure <a href="../Elo.html">Elo</a> in a block style.
+                  </p>
+                  <pre>Elo.configure do |config|&#x000A;  config.setting = value&#x000A;end</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000006-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000006-source'><span class="ruby-comment cmt"># File lib/elo.rb, line 68</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A;      <span class="ruby-keyword kw">yield</span>(<span class="ruby-keyword kw">self</span>)&#x000A;    <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='method public-instance' id='method-M000005'>
+                <a name='M000005'></a>
+                <div class='synopsis'>
+                  <span class='name'>k_factor</span>
+                  <span class='arguments'>(factor, &amp;rule)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Add a K-factor rule. The first argument is the k-factor value. The block
+                  should return a boolean that determines if this K-factor rule applies. The
+                  first rule that applies is the one determining the K-factor.
+                  </p>
+                  <p>
+                  The block is instance_eval&#8216;ed into the player, so you can access all
+                  it&#8217;s properties directly. The K-factor is recalculated every time a
+                  match is played.
+                  </p>
+                  <p>
+                  By default, the FIDE settings are used (see: <tt>use_FIDE_settings</tt>).
+                  To implement that yourself, you could write:
+                  </p>
+                  <pre>Elo.configure do |config|&#x000A;  config.k_factor(10) { pro? or pro_rating? }&#x000A;  config.k_factor(25) { starter? }&#x000A;  config.default_k_factor = 15&#x000A;end</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000005-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000005-source'><span class="ruby-comment cmt"># File lib/elo.rb, line 30</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">k_factor</span>(<span class="ruby-identifier">factor</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">rule</span>)&#x000A;      <span class="ruby-identifier">k_factors</span> <span class="ruby-operator">&lt;&lt;</span> { <span class="ruby-identifier">:factor</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">factor</span>, <span class="ruby-identifier">:rule</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">rule</span> }&#x000A;    <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div id='footer-push'></div>
+    </div>
+    <div id='footer'>
+      <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
+    </div>
+  </body>
+</html>