acts_as_elo 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+*.tmproj
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "rake"
+gem "riot"
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+## ActsAsElo
+
+### 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. 
+
+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
+
+### Example
+
+```ruby
+
+class Player
+  include Acts::Elo
+  acts_as_elo
+end
+
+bob, jack = Player.new, Player.new
+bob.elo_rank # => 1200
+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/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+#require 'rake'
+require 'rake/testtask'
+
+# Run the test with 'rake' or 'rake test'
+desc 'Default: run acts_as_elo unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_list plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/acts_as_elo.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+Gem::Specification.new do |s|
+  s.name        = 'acts_as_elo'
+  s.version     = '0.1.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.description = %q{Provides sophisticated yet easy to understand ranking system with minimum changes to the system}
+
+  # Load Paths...
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  # Dependencies (installed via 'bundle install')...
+  s.add_development_dependency("bundler", ["~> 1.0.0"])
+  s.add_development_dependency("riot")
+end

data/init.rb

@@ -0,0 +1,2 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+require 'acts_as_elo'

data/lib/acts_as_elo/acts/elo.rb

@@ -0,0 +1,73 @@
+module Acts
+  module Elo
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def acts_as_elo(opts = {})
+        default_rank =  opts[:default_rank] || 1200 
+
+        unless opts.empty?
+          class << self
+            attr_accessor :acts_as_elo_options
+          end
+          @acts_as_elo_options = opts
+        end
+
+        class_eval do  
+          attr_writer :elo_rank
+          
+          define_method(:elo_rank) do
+            @elo_rank ||= default_rank
+          end
+        end
+
+        include Acts::Elo::InstanceMethods unless self.included_modules.include?(Acts::Elo::InstanceMethods)        
+      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]
+          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 
+            points = 1
+            send_opts.merge!(result: :lose)
+          elsif opts[:result] == :lose
+            points = 0
+            send_opts.merge!(result: :win)
+          elsif opts[:result] == :draw
+            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          
+        rescue Exception => e
+          puts "Exception: #{e.message}"
+        end
+      end
+    end 
+  end
+end

data/lib/acts_as_elo.rb

@@ -0,0 +1 @@
+require 'acts_as_elo/acts/elo'

data/test/advance_test.rb

@@ -0,0 +1,46 @@
+require 'pathname'
+require Pathname.new('.') + 'helper'
+
+# 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
+end
+
+class Question
+  include Acts::Elo
+  
+  attr_accessor :user
+  acts_as_elo
+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
+end

data/test/basic_test.rb

@@ -0,0 +1,51 @@
+require 'pathname'
+require Pathname.new('.') + 'helper'
+
+class Player
+  include Acts::Elo
+  
+  acts_as_elo
+end
+
+
+context "Two players are opponents of each other" do
+  setup { [Player.new, Player.new] }
+  
+  asserts("default ranks are 1200") {
+    topic.map(&:elo_rank)
+  }.equals([1200, 1200])
+
+  context "when first one wins" do
+    hookup {topic.each {|pl| pl.elo_rank = 1200 }}
+    hookup {topic.first.elo_win!(topic.last)}
+    
+    asserts("ranks are updated") {topic.map(&:elo_rank)}.equals([1205, 1195])
+  end
+
+  context "when first one loses" do
+    hookup {topic.each {|pl| pl.elo_rank = 1200 }}    
+    hookup {topic.first.elo_lose!(topic.last)}
+    
+    asserts("ranks are updated") {topic.map(&:elo_rank)}.equals([1195, 1205])
+  end
+
+  context "when they draw" do
+    hookup {topic.each {|pl| pl.elo_rank = 1200 }}    
+    hookup {topic.first.elo_draw!(topic.last)}
+    
+    asserts("ranks are updated") {topic.map(&:elo_rank)}.equals([1200, 1200])
+  end
+
+end
+
+class PlayerWithDefaultRank
+  include Acts::Elo
+  acts_as_elo :default_rank => 1300
+end
+
+context "Testing default for elo rank" do
+  setup { PlayerWithDefaultRank.new }
+  asserts(:elo_rank).equals(1300)
+end
+
+

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'riot'
+require "#{File.dirname(__FILE__)}/../init"

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_elo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- tjbladez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70308114821680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70308114821680
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: &70308114821280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70308114821280
+description: Provides sophisticated yet easy to understand ranking system with minimum
+  changes to the system
+email:
+- nick@tjbladez.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- acts_as_elo.gemspec
+- init.rb
+- lib/acts_as_elo.rb
+- lib/acts_as_elo/acts/elo.rb
+- test/advance_test.rb
+- test/basic_test.rb
+- test/helper.rb
+homepage: http://github.com/tjbladez/acts_as_elo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Elo ranking made easy
+test_files:
+- test/advance_test.rb
+- test/basic_test.rb
+- test/helper.rb