elo_rating 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72c73870b99ccb9fa0eb8d5ada07c4104af74f33
-  data.tar.gz: f60fde89bad3ca68a36baf083dca5fa112da4a57
+  metadata.gz: ff2c8b533bcb1d0c0f97f9808ad584caa6f9ade1
+  data.tar.gz: 33e45431d2db490023b0171abd6871d6de086bb2
 SHA512:
-  metadata.gz: 059f1564f4fbbc9064660f6ae6be567faed7e3c0787f3340a62718923b4b9f224e69cb6bc8f5281d0834c7559490aa16370f0d45c2119d347fb37bca8eb893a3
-  data.tar.gz: f2c8fea968c72d13c49f00e77fb7a3934c3afe2f3c05d714ace015f7fbf5c3c113447772ef67cff9c3f92330d53d3cac4ce4dd172d0404349991c7f7a794595b
+  metadata.gz: f1d83200efa29b3365cbac274eedfc0b88a16337341b869d848730315b30ddd2d2fa83a88d2711280fcc91faab0cd0ac46afdfa92662434a88f487d1bf1836b1
+  data.tar.gz: 4e7834dadbaf1306d954cd6fe4e6a1914ed74057c89f200464fd4ada7af4729579e11d44e4f3430c837233e0a3043294681debbbd44548cadfd437ec7dc4da12

data/.document

@@ -0,0 +1,3 @@
+README.md
+lib/**/*.rb
+LICENSE

data/README.md

@@ -75,7 +75,7 @@ match = EloRating::Match.new
 match.add_player(rating: 1900, place: 1)
 match.add_player(rating: 2000, place: 2)
 match.add_player(rating: 2000, place: 3)
-match.updated_ratings # => [1973, 1997, 1931]
+match.updated_ratings # => [1931, 1997, 1973]
 ```
 
 This is calculated as if the first player beat both of the other players and the second player beat the third.
@@ -184,7 +184,7 @@ Thanks to:
 
 * Divergent Informatics for their [multiplayer Elo
 calculator](http://elo.divergentinformatics.com/) used to verify calculations used in the development of this gem
-* [Ian Hecker](https://github.com/iain) for the original [Elo](https://github.com/iain/elo).
+* [Ian Hecker](https://github.com/iain) for the original [Elo](https://github.com/iain/elo) gem.
 
 ## License
 

data/lib/elo_rating.rb

@@ -1,4 +1,4 @@
-require "elo_rating/version"
+require 'elo_rating/version'
 require 'elo_rating/match'
 # :main: README.md
 

data/lib/elo_rating/version.rb

@@ -1,3 +1,4 @@
 module EloRating
-  VERSION = "0.4.0"
+  # Gem version
+  VERSION = "1.0.0"
 end

data/spec/elo_rating_spec.rb

@@ -4,19 +4,22 @@ describe EloRating do
   after(:each) do
     EloRating::k_factor = 24
   end
+
   describe '::k_factor' do
     it 'defaults to 24' do
       expect(EloRating::k_factor).to eql(24)
     end
   end
+
   describe '::k_factor=' do
     it 'sets the K-factor to an integer' do
       EloRating::k_factor = 10
       expect(EloRating::k_factor).to eql(10)
     end
   end
+
   describe '::set_k_factor' do
-    it 'takes a block to determine the K-factor based on a player\'s rating' do
+    it "takes a block to determine the K-factor based on a player's rating" do
       EloRating::set_k_factor do |rating|
         if rating && rating > 1000
           15
@@ -26,7 +29,8 @@ describe EloRating do
       end
       expect(EloRating::k_factor(1001)).to eql 15
     end
-    context 'given a block that doesn\'t handle nil ratings' do
+
+    context "given a block that doesn't handle nil ratings" do
       it 'raises an error' do
         expect do
           EloRating::set_k_factor do |rating|
@@ -36,20 +40,24 @@ describe EloRating do
       end
     end
   end
+
   describe '.expected_score' do
-    it 'returns the odds of a player winning given their rating and their opponent\'s rating' do
+    it "returns the odds of a player winning given their rating and their opponent's rating" do
       expect(EloRating.expected_score(1200, 1000)).to be_within(0.0001).of(0.7597)
     end
   end
+
   describe '.rating_adjustment' do
     it 'returns the amount a rating should change given an expected score and an actual score' do
       expect(EloRating.rating_adjustment(0.75, 0)).to be_within(0.0001).of(-18.0)
     end
+
     it 'uses the K-factor' do
       expect(EloRating).to receive(:k_factor).and_return(24)
 
       EloRating.rating_adjustment(0.75, 0)
     end
+
     context 'custom numeric k-factor' do
       it 'uses the custom k-factor' do
         EloRating::k_factor = 10
@@ -57,6 +65,7 @@ describe EloRating do
         expect(EloRating.rating_adjustment(0.75, 0)).to be_within(0.0001).of(-7.5)
       end
     end
+
     context 'custom k-factor function' do
       it 'calls the function with the provided rating to determine the k-factor' do
         EloRating::set_k_factor do |rating|
@@ -75,6 +84,7 @@ describe EloRating do
         expect(EloRating.rating_adjustment(0.75, 0, rating: 2500)).to be_within(0.0001).of(-12.0)
       end
     end
+
     context 'provided with a nonce numeric k-factor' do
       it 'uses the provided k-factor' do
         expect(EloRating.rating_adjustment(0.75, 0, k_factor: 24)).to be_within(0.0001).of(-18.0)

data/spec/match_spec.rb

@@ -10,6 +10,7 @@ describe EloRating::Match do
         expect(match.updated_ratings).to eql [1988, 2012]
       end
     end
+
     context 'match with 3 players and one winner' do
       it 'returns the updated ratings of all the players' do
         match = EloRating::Match.new
@@ -19,6 +20,7 @@ describe EloRating::Match do
         expect(match.updated_ratings).to eql [1931, 1985, 1985]
       end
     end
+
     context 'ranked game with 3 players' do
       it 'returns the updated ratings of all the players' do
         match = EloRating::Match.new
@@ -28,6 +30,7 @@ describe EloRating::Match do
         expect(match.updated_ratings).to eql [1931, 1997, 1973]
       end
     end
+
     context 'custom K-factor function' do
       it 'uses the custom K-factor function' do
         EloRating::set_k_factor do |rating|
@@ -42,6 +45,7 @@ describe EloRating::Match do
         EloRating::k_factor = 24
       end
     end
+
     context 'multiple winners specified' do
       it 'raises an error' do
         match = EloRating::Match.new
@@ -50,6 +54,7 @@ describe EloRating::Match do
         expect { match.updated_ratings }.to raise_error ArgumentError
       end
     end
+
     context 'place specified for one player but not all' do
       it 'raises an error' do
         match = EloRating::Match.new
@@ -68,12 +73,14 @@ describe EloRating::Match do
 
         match.add_player(rating: 2000)
       end
-      it 'appends the new player to the match\'s player' do
+
+      it "appends the new player to the match's player" do
         match = EloRating::Match.new
         match.add_player(rating: 2000)
 
         expect(match.players.size).to eql 1
       end
+
       it 'returns the match itself so multiple calls can be chained' do
         match = EloRating::Match.new
         match.add_player(rating: 1000).add_player(rating: 2000)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elo_rating
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Max Holder
@@ -88,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
 - ".gitignore"
 - Gemfile
 - LICENSE