acts_as_elo 0.1.0 → 0.2.0

data/README.md

@@ -2,17 +2,18 @@
 
 ### What is it?
 
-Provides sophisticated yet easy to understand ranking system with minimum changes to the system. 
-Elo ranking system is heavily used in tournaments, player rankings in chess, sports, leader boards, multiplayer games, ranking of test questions, tasks etc. 
+Provides sophisticated yet easy to understand ranking system with minimum changes to the system.
+Elo ranking system is heavily used in tournaments, player rankings in chess, sports, leader boards, multiplayer games, ranking of test questions, tasks etc.
 
 Read more about it on [wiki](http://en.wikipedia.org/wiki/Elo_rating_system)
 
 ### Usage
- 
+
 `acts_as_elo` is very easy to use
 
 1. Install: `gem install acts_as_elo`
-2. Add `include Acts::Elo` and `acts_as_elo` to your model/record
+2. Add `include Acts::Elo` and `acts_as_elo`
+3. Call any of the 3 methods: `elo_win!`, `elo_lose!` and `elo_draw!`
 
 ### Example
 
@@ -30,6 +31,4 @@ jack.elo_rank # => 1200
 bob.elo_win!(jack)
 bob.elo_rank # => 1205
 jack.elo_rank # => 1995
-```
-
-That's it. No additional classes are involved.
+```

data/acts_as_elo.gemspec

@@ -2,12 +2,12 @@
 $:.push File.expand_path('../lib', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'acts_as_elo'
-  s.version     = '0.1.0'
+  s.version     = '0.2.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['tjbladez']
   s.email       = ['nick@tjbladez.net']
   s.homepage    = 'http://github.com/tjbladez/acts_as_elo'
-  s.summary     = %q{Elo ranking made easy}
+  s.summary     = %q{Sophisticated ranking made easy}
   s.description = %q{Provides sophisticated yet easy to understand ranking system with minimum changes to the system}
 
   # Load Paths...

data/lib/acts_as_elo/acts/elo.rb

@@ -3,10 +3,15 @@ module Acts
     def self.included(base)
       base.extend(ClassMethods)
     end
-    
+
     module ClassMethods
+      # `acts_as_elo` hooks into your object to provide you with the ability to
+      # set and get `elo_rank` attribute
+      # Available options are:
+      # * default_rank - change the starting rank
+      # * one_way - limits update of the rank to only self
       def acts_as_elo(opts = {})
-        default_rank =  opts[:default_rank] || 1200 
+        default_rank =  opts[:default_rank] || 1200
 
         unless opts.empty?
           class << self
@@ -15,42 +20,53 @@ module Acts
           @acts_as_elo_options = opts
         end
 
-        class_eval do  
-          attr_writer :elo_rank
-          
-          define_method(:elo_rank) do
-            @elo_rank ||= default_rank
+        class_eval do
+          if Object::const_defined?("ActiveRecord") && self.ancestors.include?(ActiveRecord::Base)
+
+            define_method(:elo_rank) do
+              self[:elo_rank] ||= default_rank
+            end
+
+          else
+
+            attr_writer :elo_rank
+            define_method(:elo_rank) do
+              @elo_rank ||= default_rank
+            end
+
           end
         end
 
-        include Acts::Elo::InstanceMethods unless self.included_modules.include?(Acts::Elo::InstanceMethods)        
+        include Acts::Elo::InstanceMethods unless self.included_modules.include?(Acts::Elo::InstanceMethods)
       end
-    end   
-    
+    end
+
     module InstanceMethods
       def elo_win!(opponent, opts={})
         elo_update(opponent, opts.merge!(:result => :win))
       end
-      
+
       def elo_lose!(opponent, opts={})
         elo_update(opponent, opts.merge!(:result => :lose))
       end
-      
+
       def elo_draw!(opponent, opts={})
         elo_update(opponent, opts.merge!(:result => :draw))
       end
-      
+
       def elo_update(opponent, opts={})
         begin
           if self.class.respond_to?(:acts_as_elo_options) && self.class.acts_as_elo_options[:one_way]
             one_way = true
           end
           one_way   ||= opts[:one_way]
+          send_opts = {one_way: true}
+
+          # Formula from: http://en.wikipedia.org/wiki/Elo_rating_system
           diff      = (opponent.elo_rank.to_f - elo_rank.to_f).abs
           expected  = 1 / (1 + 10 ** (diff / 400))
-          send_opts = {one_way: true}
 
-          if opts[:result] == :win 
+          if opts[:result] == :win
             points = 1
             send_opts.merge!(result: :lose)
           elsif opts[:result] == :lose
@@ -60,14 +76,14 @@ module Acts
             points = 0.5
             send_opts.merge!(result: :draw)
           end
-                    
+
           opponent.elo_update(self, send_opts) unless one_way
 
-          @elo_rank = (elo_rank + 10*(points-expected)).round          
+          self.elo_rank = (elo_rank + 10*(points-expected)).round
         rescue Exception => e
           puts "Exception: #{e.message}"
         end
       end
-    end 
+    end
   end
 end

data/test/advance_test.rb

@@ -1,19 +1,18 @@
 require 'pathname'
 require Pathname.new('.') + 'helper'
 
-# When user answers the question based on the on current rank of the user 
+# When user answers the question based on the on current rank of the user
 # and current rank of the question both user and question ranks will be updated
 class User
   include Acts::Elo
-  
+
   attr_accessor :questions
-  
-  acts_as_elo :one_way => true
+  acts_as_elo
 end
 
 class Question
   include Acts::Elo
-  
+
   attr_accessor :user
   acts_as_elo
 end
@@ -21,25 +20,25 @@ end
 
 context "User with many questions" do
   helper(:question) { |user| Question.new.tap {|q| q.user = user} }
-  
+
   setup  { User.new }
   hookup { topic.questions = [question(topic), question(topic)] }
-  
+
   asserts(:elo_rank).equals(1200)
   asserts("questions have default ranks"){ topic.questions.map(&:elo_rank)}.equals([1200, 1200])
-  
+
   context "when question is answered correctly" do
     hookup { topic.questions.each {|q| q.elo_rank = 1200 }}
     hookup { topic.questions.first.elo_lose!(topic)}
-    
+
     asserts(:elo_rank).equals(1205)
     asserts("questions have their ranks updated"){ topic.questions.map(&:elo_rank)}.equals([1195, 1200])
   end
-  
+
   context "when question is answered incorrectly" do
     hookup { topic.questions.each {|q| q.elo_rank = 1200 }}
     hookup { topic.questions.first.elo_win!(topic) }
-        
+
     asserts(:elo_rank).equals(1195)
     asserts("questions have their ranks updated"){ topic.questions.map(&:elo_rank)}.equals([1205, 1200])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_elo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-11 00:00:00.000000000Z
+date: 2012-03-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70308114821680 !ruby/object:Gem::Requirement
+  requirement: &70327763632440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70308114821680
+  version_requirements: *70327763632440
 - !ruby/object:Gem::Dependency
   name: riot
-  requirement: &70308114821280 !ruby/object:Gem::Requirement
+  requirement: &70327763631380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70308114821280
+  version_requirements: *70327763631380
 description: Provides sophisticated yet easy to understand ranking system with minimum
   changes to the system
 email:
@@ -75,7 +75,7 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Elo ranking made easy
+summary: Sophisticated ranking made easy
 test_files:
 - test/advance_test.rb
 - test/basic_test.rb