arpad 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85bfb380bf16095e4eb27c6ca732ed9449aefb50
+  data.tar.gz: 8b6a4c264b3c84c4195a7b70f5fdb3e1d0fe2db8
+SHA512:
+  metadata.gz: 62afe56fcd8173bde808c19c0f2cda09a950e2d8a53e5c6df36804d2297d88be29e7d888918e957d60fe1de57b937ce579f6525dd0eead6a076dbcdf231e27bc
+  data.tar.gz: 193aa8d738ce6bbeed47f5b1b8066513e92a4792244e471316ad2ee4d636cede9b10fc07a1829bddcc46ec4bffa477aefca4fdf7ced05ee3a9deae35b1b72809

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arpad.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Elijah Kim
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Arpad
+
+A lightweight gem that calculates
+[Elo](http://en.wikipedia.org/wiki/Elo_rating_system)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'arpad'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arpad
+
+## Usage
+`require "arpad"` on the top of your ruby file
+
+To calculate elo: `Arpad::Calculator.calculate_elo(elo_player, elo_opponent,
+outcome)`
+
+i.e `Arpad::Calculator.calculate_elo(1400, 1500, "win")` returns 1410
+
+outcome inputs include `"win"`, `"lose"`, or `"tie"`
+
+`calculate_elo` can also take an optional hash `k_factor`. `k_factor` is defaulted
+to 16 unless otherwise stated.
+
+i.e `Arpad::Calculator.calculate_elo(1400, 1500, "win", k_factor: 32)` returns
+1420
+
+## Contributing
+
+1. Fork it ( https://github.com/elijahkim/arpad/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/arpad.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arpad/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arpad"
+  spec.version       = Arpad::VERSION
+  spec.authors       = ["Elijah Kim"]
+  spec.email         = ["kimelijah90@gmail.com"]
+  spec.summary       = %q{A lightweight gem that calculates elo}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/arpad.rb

@@ -0,0 +1,40 @@
+require "arpad/version"
+
+module Arpad
+  class Calculator
+    def self.calculate_elo(elo_one, elo_two, outcome, config = {})
+      k_factor = config[:k_factor] || 16
+      transformed_rating_one = calculate_transformed_rating(elo_one)
+      transformed_rating_two = calculate_transformed_rating(elo_two)
+      expected_score = calculate_expected_score(
+        transformed_rating_one,
+        transformed_rating_two
+      )
+      score_value = calculate_score_value(outcome)
+
+      (elo_one.to_i + (k_factor * (score_value - expected_score))).to_i
+    end
+
+    private
+
+    def self.calculate_transformed_rating(elo)
+      (10**(elo.to_f / 400))
+    end
+
+    def self.calculate_expected_score(t_rating_one, t_rating_two)
+      t_rating_one / (t_rating_one + t_rating_two)
+    end
+
+    def self.calculate_score_value(outcome)
+      if outcome == "win"
+        1
+      elsif outcome == "lose"
+        0
+      elsif outcome == "tie"
+        0.5
+      else
+        raise "user inputted #{outcome} which is not a valid outcome"
+      end
+    end
+  end
+end

data/lib/arpad/version.rb

@@ -0,0 +1,3 @@
+module Arpad
+  VERSION = "0.0.1"
+end

data/spec/arpad/calculator_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe Arpad::Calculator do
+  describe "#calcualte_elo" do
+    context "with a default k factor" do
+      context "if the player wins" do
+        it { expect(calculate_elo(1400, 1400, "win")).to be 1408 }
+        it { expect(calculate_elo(1400, 1500, "win")).to be 1410 }
+        it { expect(calculate_elo(1800, 1300, "win")).to be 1800 }
+        it { expect(calculate_elo(1300, 1800, "win")).to be 1315 }
+      end
+      context "if the player loses" do
+        it { expect(calculate_elo(1400, 1400, "lose")).to be 1392 }
+        it { expect(calculate_elo(1400, 1500, "lose")).to be 1394 }
+        it { expect(calculate_elo(1800, 1300, "lose")).to be 1784 }
+        it { expect(calculate_elo(1300, 1800, "lose")).to be 1299 }
+      end
+      context "if the player ties" do
+        it { expect(calculate_elo(1400, 1400, "tie")).to be 1400 }
+        it { expect(calculate_elo(1400, 1500, "tie")).to be 1402 }
+        it { expect(calculate_elo(1800, 1300, "tie")).to be 1792 }
+        it { expect(calculate_elo(1300, 1800, "tie")).to be 1307 }
+      end
+    end
+
+    context "win a k factor of 32" do
+      context "if the player wins" do
+        it { expect(calculate_elo(1400, 1400, "win", k_factor: 32)).to be 1416 }
+        it { expect(calculate_elo(1800, 1300, "win", k_factor: 32)).to be 1801 }
+        it { expect(calculate_elo(1400, 1500, "win", k_factor: 32)).to be 1420 }
+        it { expect(calculate_elo(1300, 1800, "win", k_factor: 32)).to be 1330 }
+      end
+      context "if the player loses" do
+        it { expect(calculate_elo(1400, 1400, "lose", k_factor: 32)).to be 1384 }
+        it { expect(calculate_elo(1400, 1500, "lose", k_factor: 32)).to be 1388 }
+        it { expect(calculate_elo(1800, 1300, "lose", k_factor: 32)).to be 1769 }
+        it { expect(calculate_elo(1300, 1800, "lose", k_factor: 32)).to be 1298 }
+      end
+      context "if the player ties" do
+        it { expect(calculate_elo(1400, 1400, "tie", k_factor: 32)).to be 1400 }
+        it { expect(calculate_elo(1400, 1500, "tie", k_factor: 32)).to be 1404 }
+        it { expect(calculate_elo(1800, 1300, "tie", k_factor: 32)).to be 1785 }
+        it { expect(calculate_elo(1300, 1800, "tie", k_factor: 32)).to be 1314 }
+      end
+    end
+
+    context "with an invalid outcome value" do
+      it { expect{calculate_elo(1300, 1800, "foo")}.to raise_error "user inputted foo which is not a valid outcome"}
+    end
+
+    context "if the elo input is non-integer" do
+      it "should try to force integer" do
+        expect(calculate_elo("1300", "1800", "win")).to be 1315
+      end
+    end
+  end
+
+  def calculate_elo(elo_one, elo_two, outcome, config = {})
+    Arpad::Calculator.calculate_elo(elo_one, elo_two, outcome, config)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "arpad"

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: arpad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elijah Kim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- kimelijah90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arpad.gemspec
+- lib/arpad.rb
+- lib/arpad/version.rb
+- spec/arpad/calculator_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A lightweight gem that calculates elo
+test_files:
+- spec/arpad/calculator_spec.rb
+- spec/spec_helper.rb