elo4m 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b674afae937af9be30bd785e2599a8ae39cf5851
-  data.tar.gz: 15de3862089257038b5373a6eeeecc4fecae9f3e
+  metadata.gz: cf144583804ad9b8e92f3aa5c69bb9a0662ca2d7
+  data.tar.gz: d8e5ce8612eee672f95f13057cfb1a483e1ed204
 SHA512:
-  metadata.gz: 2b206cf3720564da2889244f32dc94ae6f51c8eb931c6f54ac629c267c4a831c338cf0fd1f67a55357f6190471d17876e8b24239e91606c6c53be6ab4a4ec19c
-  data.tar.gz: 7a5b3c4b7fa98a3c0b71a50979d8f9153c72e0c153f4a5c951680dbeaa4259419a5b13c9f017fe17c475142603bafd5db5f42a13827feff1b79d998359d032ac
+  metadata.gz: 4a4a94d10ca69e2eed3f6f7841a9a4e860d30b0f6e2da6c1951b9c3d2dd95002bcb452fe566583a1819179a1487777e614bb577a16ded50b2b1c2c730632bef4
+  data.tar.gz: 7fdf4732b4fc622c90d1349d70f3f0ccbb10183e05a53b3943669c15c04dc93f25eb5d4c67740de9f4d40afc0e071dcf12934e35e8bbf8baf46972ce126e04f8

data/README.md

@@ -59,6 +59,18 @@ game.run
   #=> [1601, 1646, 1499, 1350, 1533, 1762]  
 ```
 
+## K-factor
+
+Set your config if you want.
+
+`config/initializers/elo4m.rb.`
+
+```ruby
+Elo4m.configure do |c|
+  c.k_factor = <K-FACTOR>
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/kidach1/elo4m/fork )

data/lib/elo4m.rb

@@ -1,5 +1,4 @@
 require "elo4m/version"
-require "elo4m/helper"
 require "elo4m/configuration"
 require "elo4m/game"
 require "elo4m/player"
@@ -10,7 +9,7 @@ module Elo4m
     @config ||= Configuration.new
   end
 
-  def self.configure(&block)
-    yield(config)
+  def self.configure
+    yield config
   end
 end

data/lib/elo4m/configuration.rb

@@ -1,50 +1,9 @@
 module Elo4m
   class Configuration
-    attr_accessor :default_k_factor
-    attr_accessor :default_rating
+    attr_accessor :k_factor
 
-    def initialize #:nodoc:
-      @default_rating     = 1000
-      @default_k_factor   = 15
-    end
-
-    # 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.
-    #
-    # The block is instance_eval'ed into the player, so you can access all it's
-    # properties directly. The K-factor is recalculated every time a match is played.
-    #
-    # By default, the FIDE settings are used (see: +use_FIDE_settings+). To implement
-    # that yourself, you could write:
-    #
-    #   Elo.configure do |config|
-    #     config.k_factor(10) { pro? or pro_rating? }
-    #     config.k_factor(25) { starter? }
-    #     config.default_k_factor = 15
-    #   end
-    #
-    def k_factor(factor, &rule)
-      k_factors << { :factor => factor, :rule => rule }
-    end
-
-    def applied_k_factors #:nodoc:
-      apply_fide_k_factors if use_FIDE_settings
-      k_factors
-    end
-
-    private
-
-    def k_factors
-      @k_factors ||= []
-    end
-
-    def apply_fide_k_factors
-      unless @applied_fide_k_factors
-        k_factor(10) { pro? or pro_rating? }
-        k_factor(25) { starter? }
-        @applied_fide_k_factors = true
-      end
+    def initialize
+      @k_factor = 32
     end
   end
 end

data/lib/elo4m/game.rb

@@ -1,10 +1,7 @@
 module Elo4m
   class Game
     # http://en.wikipedia.org/wiki/Elo_rating_system#Mathematical_details
-
-    include Helper
     attr_accessor :player_cnt
-    K_FACTOR = 32
 
     def initialize(players)
       self.player_cnt = players.length
@@ -19,8 +16,7 @@ module Elo4m
         Rating.new(
           result: score_sum(i),
           old_rating: instance_variable_get("@player#{i}").rating,
-          expected: expected_sum(i),
-          k_factor: K_FACTOR
+          expected: expected_sum(i)
         ).new_rating
       end
     end

data/lib/elo4m/player.rb

@@ -1,6 +1,5 @@
 module Elo4m
   class Player
-    include Helper
     attr_accessor :rating
     attr_accessor :ranking
 

data/lib/elo4m/rating.rb

@@ -1,11 +1,14 @@
 module Elo4m
   class Rating
-    include Helper
-
     attr_reader :other_rating
     attr_reader :old_rating
-    attr_reader :k_factor
-    attr_reader  :expected
+    attr_reader :expected
+
+    def initialize(args = {})
+      args.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
 
     def new_rating
       (old_rating.to_f + change).to_i
@@ -29,7 +32,7 @@ module Elo4m
 
     def change
       expected = self.expected.nil? ? expected_al : self.expected
-      k_factor.to_f * ( result.to_f - expected )
+      Elo4m.config.k_factor.to_f * ( result.to_f - expected )
     end
   end
 end

data/lib/elo4m/version.rb

@@ -1,3 +1,3 @@
 module Elo4m
-  VERSION = "0.0.1"
+  VERSION = "1.0.1"
 end

data/spec/elo_spec.rb

@@ -2,24 +2,17 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require "elo4m"
 
 describe "Elo" do
-  after do
-    Elo4m.instance_eval { @config = nil }
-  end
-
-=begin
-
-Elo rating system - Wikipedia, the free encyclopedia
-http://en.wikipedia.org/wiki/Elo_rating_system#Mathematical_details
-
-  R_A^' = R_A + K(S_A - E_A).
-  This update can be performed after each game or each tournament, or after any suitable rating period.
-  An example may help clarify. Suppose Player A has a rating of 1613, and plays in a five-round tournament.
-  He or she loses to a player rated 1609, draws with a player rated 1477, defeats a player rated 1388,
-  defeats a player rated 1586, and loses to a player rated 1720. The player's actual score is (0 + 0.5 + 1 + 1 + 0) = 2.5.
-  The expected score, calculated according to the formula above, was (0.506 + 0.686 + 0.785 + 0.539 + 0.351) = 2.867.
-  Therefore the player's new rating is (1613 + 32×(2.5 − 2.867)) = 1601, assuming that a K-factor of 32 is used.
+  # Elo rating system - Wikipedia, the free encyclopedia
+  # http://en.wikipedia.org/wiki/Elo_rating_system#Mathematical_details
+  #
+  # R_A^' = R_A + K(S_A - E_A).
+  # This update can be performed after each game or each tournament, or after any suitable rating period.
+  # An example may help clarify. Suppose Player A has a rating of 1613, and plays in a five-round tournament.
+  # He or she loses to a player rated 1609, draws with a player rated 1477, defeats a player rated 1388,
+  # defeats a player rated 1586, and loses to a player rated 1720. The player's actual score is (0 + 0.5 + 1 + 1 + 0) = 2.5.
+  # The expected score, calculated according to the formula above, was (0.506 + 0.686 + 0.785 + 0.539 + 0.351) = 2.867.
+  # Therefore the player's new rating is (1613 + 32×(2.5 − 2.867)) = 1601, assuming that a K-factor of 32 is used.
 
-=end
   describe 'wikipedia-way' do
     let(:players) do [
       Elo4m::Player.new(1613, 4),
@@ -29,10 +22,18 @@ http://en.wikipedia.org/wiki/Elo_rating_system#Mathematical_details
       Elo4m::Player.new(1586, 6),
       Elo4m::Player.new(1720, 2) ]
     end
+    subject { Elo4m::Game.new(players).run.first }
 
-    it do
-      game = Elo4m::Game.new(players)
-      expect(game.run.first).to eq(1601)
+    context 'K-factor is 32'do
+      it { expect(subject).to eq(1601) }
+    end
+    context 'K-factor is 16'do
+      before do
+        Elo4m.configure do |cfg|
+          cfg.k_factor = 16
+        end
+      end
+      it { expect(subject).to eq(1607) }
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elo4m
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - kidach1
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,6 @@ files:
 - lib/elo4m.rb
 - lib/elo4m/configuration.rb
 - lib/elo4m/game.rb
-- lib/elo4m/helper.rb
 - lib/elo4m/player.rb
 - lib/elo4m/rating.rb
 - lib/elo4m/version.rb

data/lib/elo4m/helper.rb

@@ -1,23 +0,0 @@
-module Elo4m
-  module Helper
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    # Every object can be initialized with a hash,
-    # almost, but not quite, entirely unlike ActiveRecord.
-    def initialize(attributes = {})
-      attributes.each do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-      self.class.all << self
-    end
-
-    module ClassMethods
-      # Provides a list of all instantiated objects of the class.
-      def all
-        @all ||= []
-      end
-    end
-  end
-end