elo_brain 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e3657744394997f59bff6c65d5695715b8ab1424f788d9bfffd071ff71f60df
-  data.tar.gz: 4e2e3f6e6e445febcdf6bbe3039bf103c289a3e7e484630065072010dc6170ec
+  metadata.gz: a32b22a6cbdf961ca4c101bbd3962939883667ebcc2c43a08683d73a3d2f0d66
+  data.tar.gz: 9d8bc552630782cda26267ce1f000f815fed06261766ed37a70d82b1ade256b1
 SHA512:
-  metadata.gz: b309e48aff347e9c6ddf1b032842db19f550497ce41a2ffeaae858cc7db8736aa95a1c2009fa44e87b82237c7583b55a8877a0afc454af7b8c61a1c1e5df990d
-  data.tar.gz: eccc65a71e75f5e448b5d0c567a9b6fd8fc3d245ee56dc9ab404307ee34a49f6f7024306928cd8ea4c6517129942698c83832f66f9c9d16659e8150ef287b97a
+  metadata.gz: d852aff35686edde6146734b9c549215e8a7f00c2de96cab273c8b7f48c7b26d1ce751639fce39485edfcfc60afb385d2fa2ec29c604c76b8a8dbe6ff1481e06
+  data.tar.gz: f8bcddffd2df41f796e72b72685bc0330bb94f0a78c5e6de78e357e5136a58deb69f2de3a2c510836dc447e91762b196c79e22a55f51637128384a58cf0130af

data/.overcommit.yml

@@ -16,9 +16,9 @@
 # Uncomment the following lines to make the configuration take effect.
 
 PreCommit:
-#  RuboCop:
-#    enabled: true
-#    command: ['bundle', 'exec', 'rubocop', '-P']
+  RuboCop:
+    enabled: true
+    command: ['bundle', 'exec', 'rubocop', '-P']
   BundleOutdated:
     enabled: true
   BundleAudit:
@@ -29,6 +29,6 @@ PrePush:
     enabled: true
     command: ['bundle', 'exec', 'rspec', '-f', 'p']
     quiet: false
-#  Rubocop:
-#    enabled: true
+  Rubocop:
+    enabled: true
 

data/.rubocop-http---relaxed-ruby-style-rubocop-yml

@@ -0,0 +1,153 @@
+# Relaxed.Ruby.Style
+## Version 2.5
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+Style/NumericPredicate:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+Style/SymbolArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+

data/.rubocop.yml

@@ -0,0 +1,65 @@
+inherit_from:
+  - http://relaxed.ruby.style/rubocop.yml
+
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+    - "Guardfile"
+    - "vendor/bundle"
+    - "*.gemspec"
+
+Layout/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+  AutoCorrect: true
+  Exclude:
+    - Gemfile
+    - Guardfile

data/.travis.yml

@@ -2,5 +2,5 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
+  - 2.6.6
 before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.0] - 2021-02-06
+### Changed
+- **BREAKING** Change entity naming : Elo => Match
+- Update required ruby version : From 2.3 to 2.6
+- Create changelog
+
+[1.1.0]: https://github.com/MatthieuLPro/elo_brain/releases/tag/v1.1.0

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in elo_brain.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elo_brain (1.0.0)
+    elo_brain (1.1.0)
       dry-struct
       dry-validation
       zeitwerk (~> 2)
@@ -113,4 +113,4 @@ DEPENDENCIES
   rubocop-performance
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -1,8 +1,10 @@
 # EloBrain
+![Gem](https://img.shields.io/gem/v/elo_brain?color=Green&label=Gem&logo=rubygems)
+[![Build Status](https://travis-ci.org/MatthieuLPro/elo_brain.svg?branch=master)](https://travis-ci.org/MatthieuLPro/elo_brain)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/elo_brain`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is an easy way to calculate new elos after a match between 2 players.
 
-TODO: Delete this and the text above, and describe your gem
+The calculation's logic is based on : [Wikipedia](https://fr.wikipedia.org/wiki/Classement_Elo#Th%C3%A9orie_math%C3%A9matique)
 
 ## Installation
 
@@ -22,11 +24,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First we need to create 2 players :
+```ruby
+player1 = EloBrain::Players::Player.from(elo: 1_200, nb_matches: 10, situation: 'winner')
+player2 = EloBrain::Players::Player.from(elo: 1_400, nb_matches: 15, situation: 'looser')
+```
+Then we can calculate the new elo of both players by creating a match :
+```ruby
+match = EloBrain::Matches::Match.from(player1: player1, player2: player2)
+match.calculate_new_elos # => { player1_new_elo: 1230.3898770659184, player2_new_elo: 1390.3898770659184 }
+```
+The result of the calculation is a <b>Hash</b>.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/elo_brain.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/elo_brain/version'
 
 Gem::Specification.new do |spec|
@@ -8,21 +10,22 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Simple elo calculation."
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = "https://github.com/MatthieuLPro/elo_brain"
+  spec.homepage      = "https://rubygems.org/gems/elo_brain"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/MatthieuLPro/elo_brain"
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["changelog_uri"] = "https://github.com/MatthieuLPro/elo_brain/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/lib/elo_brain/elo_calculations/strategies.rb

@@ -5,7 +5,7 @@ module EloBrain
     class Strategies
       STRATEGIES_COLLECTION = {
         winner: Winner,
-        looser: Looser
+        looser: Looser,
       }.freeze
 
       def call(strategy:)

data/lib/elo_brain/{elos → matches}/contract.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module EloBrain
-  module Elos
+  module Matches
     class Contract < Dry::Validation::Contract
       params do
         required(:player1).value(Types::Player)

data/lib/elo_brain/matches/match.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module EloBrain
+  module Matches
+    class Match < Dry::Struct
+      attribute :player1, Types::Player
+      attribute :player2, Types::Player
+
+      def self.from(player1:, player2:)
+        new(
+          player1: player1,
+          player2: player2
+        )
+      end
+
+      def self.from_contract(contract:)
+        new(
+          player1: contract[:player1],
+          player2: contract[:player2]
+        )
+      end
+
+      def calculate_new_elos
+        {
+          player1_new_elo: EloBrain::Matches::Services::LaunchNewEloCalculation.new.call(
+            strategy: player1.situation,
+            nb_matches: player1.nb_matches,
+            player_elo: player1.elo,
+            opponent_elo: player2.elo
+          ),
+          player2_new_elo: EloBrain::Matches::Services::LaunchNewEloCalculation.new.call(
+            strategy: player2.situation,
+            nb_matches: player2.nb_matches,
+            player_elo: player2.elo,
+            opponent_elo: player1.elo
+          ),
+        }
+      end
+    end
+  end
+end

data/lib/elo_brain/{elos → matches}/services/launch_new_elo_calculation.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
 module EloBrain
-  module Elos
+  module Matches
     module Services
       class LaunchNewEloCalculation
         def call(strategy:, nb_matches:, player_elo:, opponent_elo:)
           coefficient = development_coefficient(nb_matches, player_elo)
           probability = win_probability(player_elo - opponent_elo)
-          calculation_strategy(strategy).new_elo(elo: player_elo, development_coefficient: coefficient,
-                                                 win_probability: probability)
+          calculation_strategy(strategy).new_elo(
+            elo: player_elo,
+            development_coefficient: coefficient,
+            win_probability: probability
+          )
         end
 
         private

data/lib/elo_brain/{elos → matches}/types.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module EloBrain
-  module Elos
+  module Matches
     module Types
       include Dry.Types()
 

data/lib/elo_brain/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EloBrain
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elo_brain
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthieu <Malus> Lu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundle-audit
@@ -125,7 +125,10 @@ files:
 - ".idea/vcs.xml"
 - ".overcommit.yml"
 - ".rspec"
+- ".rubocop-http---relaxed-ruby-style-rubocop-yml"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -146,21 +149,22 @@ files:
 - lib/elo_brain/elo_calculations/strategies.rb
 - lib/elo_brain/elo_calculations/variation.rb
 - lib/elo_brain/elo_calculations/winner.rb
-- lib/elo_brain/elos/contract.rb
-- lib/elo_brain/elos/elo.rb
-- lib/elo_brain/elos/services/launch_new_elo_calculation.rb
-- lib/elo_brain/elos/types.rb
+- lib/elo_brain/matches/contract.rb
+- lib/elo_brain/matches/match.rb
+- lib/elo_brain/matches/services/launch_new_elo_calculation.rb
+- lib/elo_brain/matches/types.rb
 - lib/elo_brain/players/contract.rb
 - lib/elo_brain/players/player.rb
 - lib/elo_brain/players/types.rb
 - lib/elo_brain/version.rb
 - lib/elo_brain/win_probability/probability_calculation.rb
-homepage: https://github.com/MatthieuLPro/elo_brain
+homepage: https://rubygems.org/gems/elo_brain
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/MatthieuLPro/elo_brain
+  homepage_uri: https://rubygems.org/gems/elo_brain
   source_code_uri: https://github.com/MatthieuLPro/elo_brain
+  changelog_uri: https://github.com/MatthieuLPro/elo_brain/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -169,14 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple elo calculation.

data/lib/elo_brain/elos/elo.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module EloBrain
-  module Elos
-    class Elo < Dry::Struct
-      attribute :player1, Types::Player
-      attribute :player2, Types::Player
-
-      def self.from(player1:, player2:)
-        new(
-          player1: player1,
-          player2: player2
-        )
-      end
-
-      def self.from_contract(contract:)
-        new(
-          player1: contract[:player1],
-          player2: contract[:player2]
-        )
-      end
-
-      def calculate_new_elos
-        {
-          player1_new_elo: EloBrain::Elos::Services::LaunchNewEloCalculation.new.call(strategy: player1.situation,
-                                                                                      nb_matches: player1.nb_matches, player_elo: player1.elo, opponent_elo: player2.elo),
-          player2_new_elo: EloBrain::Elos::Services::LaunchNewEloCalculation.new.call(strategy: player2.situation,
-                                                                                      nb_matches: player2.nb_matches, player_elo: player2.elo, opponent_elo: player1.elo)
-        }
-      end
-    end
-  end
-end