elo_rating_system 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0909a55bfa03184b3749b7541ab13e04ec8fb18046e91f3ca4195dc0d754df52'
+  data.tar.gz: e1e94e1e98ab97a7dfbd97711d3936a061d9118c24d8b27d3d2dc53ab2e67900
+SHA512:
+  metadata.gz: a45de5f13d7ca44c825e1ad33740a3b6959e305d12539a5c275892b29ef08807aa501c67644358ad432d8a583212cb5c5aee427565ba445f0ef044077db47f21
+  data.tar.gz: ddb80c8f9a831471682ccea378da95bbb08c9c50e24e2f991047fab22c2020a85b9d6a297701487656b92c20fb3a1f2197e5eb7c0b5c2fce8157ee7843dfd309

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    elo_rating_system (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aw (0.1.1)
+    defi (1.1.3)
+    fix (0.17.1)
+      aw (~> 0.1.1)
+      defi (~> 1.1.3)
+      spectus (~> 3.0.6)
+    matchi (1.0.2)
+    rake (12.3.1)
+    spectus (3.0.6)
+      aw (~> 0.1.1)
+      defi (~> 1.1.1)
+      matchi (~> 1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  elo_rating_system!
+  fix (~> 0.17)
+  rake (~> 12.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sashite
+
+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,52 @@
+# Elo rating system
+
+[![Inline docs](https://inch-ci.org/github/sashite/elo_rating_system.svg?branch=master)][inchpages]
+
+Very simple Ruby implementation of the Elo rating system, a method for calculating the relative skill levels of players in zero-sum games such as chess.
+
+It contains two functions: `expected(player_a, player_b)`, to calculate the expected score of `player_a` in a match against `player_b`; and `elo(old, exp, score, k_factor = 32)`, to calculate the new score for each player.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elo_rating_system'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elo_rating_system
+
+## Example
+
+In a five-round tournament, player A, with a rating of `1613`, plays against opponents with the following ratings: `1609`, `1477`, `1388`, `1586`, `1720`.
+
+The expected score is therefore:
+
+```ruby
+exp  = EloRatingSystem.expected(1613, 1609)
+exp += EloRatingSystem.expected(1613, 1477)
+exp += EloRatingSystem.expected(1613, 1388)
+exp += EloRatingSystem.expected(1613, 1586)
+exp += EloRatingSystem.expected(1613, 1720)
+
+exp.round(3) # => 2.867
+```
+
+Player A lost match #1, draw match #2, wins match #3 and #4, and loses match #5.
+Therefore the player's actual score is `(0 + 0.5 + 1 + 1 + 0) = 2.5`.
+
+We can now use this to calculate the new Elo rating for player A:
+
+```ruby
+EloRatingSystem.elo(1613, 2.867, 2.5).round # => 1601
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sashite/elo_rating_system.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+  t.pattern = File.join('fix', '**', '*_fix.rb')
+end
+
+task default: %i[test]

data/VERSION.semver

@@ -0,0 +1 @@
+1.0.0

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'elo_rating_system'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elo_rating_system.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'elo_rating_system'
+  spec.version       = File.read('VERSION.semver').chomp
+  spec.authors       = ['Cyril Kato']
+  spec.email         = ['contact@cyril.email']
+
+  spec.summary       = 'Elo rating system'
+  spec.description   = 'A method for calculating the relative skill levels ' \
+                       'of players in zero-sum games such as chess.'
+  spec.homepage      = 'https://github.com/sashite/elo_rating_system'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(fix)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',  '~> 1.16'
+  spec.add_development_dependency 'fix',      '~> 0.17'
+  spec.add_development_dependency 'rake',     '~> 12.3'
+end

data/lib/elo_rating_system.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Elo rating system
+#
+# @see https://en.wikipedia.org/wiki/Elo_rating_system
+module EloRatingSystem
+  def self.expected(player_a, player_b)
+    # @note Calculate expected score of A in a match against B.
+    #
+    # @param player_a [Integer] Elo rating for player a.
+    # @param player_b [Integer] Elo rating for player b.
+    1 / (1 + 10**((player_b - player_a.to_f) / 400))
+  end
+
+  def self.elo(old, exp, score, k_factor = 32)
+    # @note Calculate the new Elo rating for a player.
+    #
+    # @param old      [Integer] The previous Elo rating.
+    # @param exp      [Float]   The expected score for this match.
+    # @param score    [Float]   The actual score for this match.
+    # @param k_factor [Integer] The k-factor for Elo (default: 32).
+    old + k_factor * (score - exp)
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: elo_rating_system
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cyril Kato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: fix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: A method for calculating the relative skill levels of players in zero-sum
+  games such as chess.
+email:
+- contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION.semver
+- bin/console
+- bin/setup
+- elo_rating_system.gemspec
+- lib/elo_rating_system.rb
+homepage: https://github.com/sashite/elo_rating_system
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Elo rating system
+test_files: []