elo_rankable 0.2.0 → 0.2.1

data/elo_rankable.gemspec

@@ -1,36 +1,36 @@
-# frozen_string_literal: true
-
-require_relative 'lib/elo_rankable/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'elo_rankable'
-  spec.version = EloRankable::VERSION
-  spec.authors = ['Aberen']
-  spec.email = ['nijoergensen@gmail.com']
-
-  spec.summary = 'Add ELO rating capabilities to any ActiveRecord model'
-  spec.description = 'Adds ELO rating to any ActiveRecord model via has_elo_ranking. It stores ratings in a separate EloRanking model to keep your host model clean, and provides domain-style methods for updating rankings after matches.'
-  spec.homepage = 'https://github.com/Aberen/elo_rankable'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  # Specify which files should be added to the gem when it is released.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Dependencies
-  spec.add_dependency 'activerecord', '>= 6.0', '< 8.0'
-  spec.add_dependency 'activesupport', '>= 6.0', '< 8.0'
-end
+# frozen_string_literal: true
+
+require_relative 'lib/elo_rankable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'elo_rankable'
+  spec.version = EloRankable::VERSION
+  spec.authors = ['Aberen']
+  spec.email = ['nijoergensen@gmail.com']
+
+  spec.summary = 'Add ELO rating capabilities to any ActiveRecord model'
+  spec.description = 'Adds ELO rating to any ActiveRecord model via has_elo_ranking. It stores ratings in a separate EloRanking model to keep your host model clean, and provides domain-style methods for updating rankings after matches.'
+  spec.homepage = 'https://github.com/Aberen/elo_rankable'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dependencies
+  spec.add_dependency 'activerecord', '>= 6.0', '< 9.0'
+  spec.add_dependency 'activesupport', '>= 6.0', '< 9.0'
+end

data/lib/elo_rankable/calculator.rb

@@ -1,67 +1,67 @@
-# frozen_string_literal: true
-
-module EloRankable
-  class Calculator
-    class << self
-      # Calculate expected score for player A against player B
-      def expected_score(rating_a, rating_b)
-        1.0 / (1.0 + (10.0**((rating_b - rating_a) / 400.0)))
-      end
-
-      # Update ratings after a match where player1 beats player2
-      def update_ratings_for_win(winner, loser)
-        winner_rating = winner.elo_ranking
-        loser_rating = loser.elo_ranking
-
-        # Defensive validation - these should be caught earlier but just in case
-        raise ArgumentError, "Winner's elo_ranking is nil" if winner_rating.nil?
-        raise ArgumentError, "Loser's elo_ranking is nil" if loser_rating.nil?
-
-        winner_expected = expected_score(winner_rating.rating, loser_rating.rating)
-        loser_expected = expected_score(loser_rating.rating, winner_rating.rating)
-
-        winner_k = winner_rating.k_factor
-        loser_k = loser_rating.k_factor
-
-        # Winner gets 1 point, loser gets 0 points
-        winner_new_rating = winner_rating.rating + (winner_k * (1 - winner_expected))
-        loser_new_rating = loser_rating.rating + (loser_k * (0 - loser_expected))
-
-        update_ranking(winner_rating, winner_new_rating)
-        update_ranking(loser_rating, loser_new_rating)
-      end
-
-      # Update ratings after a draw
-      def update_ratings_for_draw(player1, player2)
-        player1_rating = player1.elo_ranking
-        player2_rating = player2.elo_ranking
-
-        # Defensive validation - these should be caught earlier but just in case
-        raise ArgumentError, "Player1's elo_ranking is nil" if player1_rating.nil?
-        raise ArgumentError, "Player2's elo_ranking is nil" if player2_rating.nil?
-
-        player1_expected = expected_score(player1_rating.rating, player2_rating.rating)
-        player2_expected = expected_score(player2_rating.rating, player1_rating.rating)
-
-        player1_k = player1_rating.k_factor
-        player2_k = player2_rating.k_factor
-
-        # Both players get 0.5 points in a draw
-        player1_new_rating = player1_rating.rating + (player1_k * (0.5 - player1_expected))
-        player2_new_rating = player2_rating.rating + (player2_k * (0.5 - player2_expected))
-
-        update_ranking(player1_rating, player1_new_rating)
-        update_ranking(player2_rating, player2_new_rating)
-      end
-
-      private
-
-      def update_ranking(elo_ranking, new_rating)
-        elo_ranking.update!(
-          rating: new_rating.round,
-          games_played: elo_ranking.games_played + 1
-        )
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module EloRankable
+  class Calculator
+    class << self
+      # Calculate expected score for player A against player B
+      def expected_score(rating_a, rating_b)
+        1.0 / (1.0 + (10.0**((rating_b - rating_a) / 400.0)))
+      end
+
+      # Update ratings after a match where player1 beats player2
+      def update_ratings_for_win(winner, loser)
+        winner_rating = winner.elo_ranking
+        loser_rating = loser.elo_ranking
+
+        # Defensive validation - these should be caught earlier but just in case
+        raise ArgumentError, "Winner's elo_ranking is nil" if winner_rating.nil?
+        raise ArgumentError, "Loser's elo_ranking is nil" if loser_rating.nil?
+
+        winner_expected = expected_score(winner_rating.rating, loser_rating.rating)
+        loser_expected = expected_score(loser_rating.rating, winner_rating.rating)
+
+        winner_k = winner_rating.k_factor
+        loser_k = loser_rating.k_factor
+
+        # Winner gets 1 point, loser gets 0 points
+        winner_new_rating = winner_rating.rating + (winner_k * (1 - winner_expected))
+        loser_new_rating = loser_rating.rating + (loser_k * (0 - loser_expected))
+
+        update_ranking(winner_rating, winner_new_rating)
+        update_ranking(loser_rating, loser_new_rating)
+      end
+
+      # Update ratings after a draw
+      def update_ratings_for_draw(player1, player2)
+        player1_rating = player1.elo_ranking
+        player2_rating = player2.elo_ranking
+
+        # Defensive validation - these should be caught earlier but just in case
+        raise ArgumentError, "Player1's elo_ranking is nil" if player1_rating.nil?
+        raise ArgumentError, "Player2's elo_ranking is nil" if player2_rating.nil?
+
+        player1_expected = expected_score(player1_rating.rating, player2_rating.rating)
+        player2_expected = expected_score(player2_rating.rating, player1_rating.rating)
+
+        player1_k = player1_rating.k_factor
+        player2_k = player2_rating.k_factor
+
+        # Both players get 0.5 points in a draw
+        player1_new_rating = player1_rating.rating + (player1_k * (0.5 - player1_expected))
+        player2_new_rating = player2_rating.rating + (player2_k * (0.5 - player2_expected))
+
+        update_ranking(player1_rating, player1_new_rating)
+        update_ranking(player2_rating, player2_new_rating)
+      end
+
+      private
+
+      def update_ranking(elo_ranking, new_rating)
+        elo_ranking.update!(
+          rating: new_rating.round,
+          games_played: elo_ranking.games_played + 1
+        )
+      end
+    end
+  end
+end

data/lib/elo_rankable/configuration.rb

@@ -1,42 +1,42 @@
-# frozen_string_literal: true
-
-module EloRankable
-  class Configuration
-    attr_accessor :base_rating
-    attr_reader :k_factor_strategy
-
-    def initialize
-      @base_rating = 1200
-      @k_factor_strategy = default_k_factor_strategy
-    end
-
-    def k_factor_for=(strategy)
-      @k_factor_strategy = strategy
-    end
-
-    def k_factor_for(rating)
-      case @k_factor_strategy
-      when Proc
-        @k_factor_strategy.call(rating)
-      when Numeric
-        @k_factor_strategy
-      else
-        raise ArgumentError, 'K-factor strategy must be a Proc or Numeric'
-      end
-    end
-
-    private
-
-    def default_k_factor_strategy
-      lambda do |rating|
-        if rating > 2400
-          10
-        elsif rating > 2000
-          20
-        else
-          32
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module EloRankable
+  class Configuration
+    attr_accessor :base_rating
+    attr_reader :k_factor_strategy
+
+    def initialize
+      @base_rating = 1200
+      @k_factor_strategy = default_k_factor_strategy
+    end
+
+    def k_factor_for=(strategy)
+      @k_factor_strategy = strategy
+    end
+
+    def k_factor_for(rating)
+      case @k_factor_strategy
+      when Proc
+        @k_factor_strategy.call(rating)
+      when Numeric
+        @k_factor_strategy
+      else
+        raise ArgumentError, 'K-factor strategy must be a Proc or Numeric'
+      end
+    end
+
+    private
+
+    def default_k_factor_strategy
+      lambda do |rating|
+        if rating > 2400
+          10
+        elsif rating > 2000
+          20
+        else
+          32
+        end
+      end
+    end
+  end
+end

data/lib/elo_rankable/elo_ranking.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-module EloRankable
-  class EloRanking < ActiveRecord::Base
-    belongs_to :rankable, polymorphic: true
-
-    validates :rating, presence: true, numericality: { greater_than: 0 }
-    validates :games_played, presence: true, numericality: { greater_than_or_equal_to: 0 }
-
-    scope :by_rating, -> { order(rating: :desc) }
-    scope :top, ->(limit = 10) { by_rating.limit(limit) }
-
-    def initialize(attributes = nil)
-      super
-      self.rating ||= EloRankable.config.base_rating
-      self.games_played ||= 0
-    end
-
-    def k_factor
-      EloRankable.config.k_factor_for(rating)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module EloRankable
+  class EloRanking < ActiveRecord::Base
+    belongs_to :rankable, polymorphic: true
+
+    validates :rating, presence: true, numericality: { greater_than: 0 }
+    validates :games_played, presence: true, numericality: { greater_than_or_equal_to: 0 }
+
+    scope :by_rating, -> { order(rating: :desc) }
+    scope :top, ->(limit = 10) { by_rating.limit(limit) }
+
+    def initialize(attributes = nil)
+      super
+      self.rating ||= EloRankable.config.base_rating
+      self.games_played ||= 0
+    end
+
+    def k_factor
+      EloRankable.config.k_factor_for(rating)
+    end
+  end
+end

data/lib/elo_rankable/has_elo_ranking.rb

@@ -1,71 +1,71 @@
-# frozen_string_literal: true
-
-module EloRankable
-  module HasEloRanking
-    def has_elo_ranking
-      # Set up the polymorphic association
-      has_one :elo_ranking, as: :rankable, class_name: 'EloRankable::EloRanking', dependent: :destroy
-
-      # Include instance methods
-      include InstanceMethods
-
-      # Add scopes for leaderboards
-      scope :by_elo_rating, -> { joins(:elo_ranking).order('elo_rankings.rating DESC') }
-      scope :top_rated, ->(limit = 10) { by_elo_rating.limit(limit) }
-    end
-
-    module InstanceMethods
-      def elo_ranking
-        super || create_elo_ranking!(
-          rating: EloRankable.config.base_rating,
-          games_played: 0
-        )
-      end
-
-      def elo_rating
-        elo_ranking.rating
-      end
-
-      def games_played
-        elo_ranking.games_played
-      end
-
-      # Domain-style DSL methods
-      def beat!(other_player)
-        validate_opponent!(other_player)
-        EloRankable::Calculator.update_ratings_for_win(self, other_player)
-      end
-
-      def lost_to!(other_player)
-        validate_opponent!(other_player)
-        EloRankable::Calculator.update_ratings_for_win(other_player, self)
-      end
-
-      def draw_with!(other_player)
-        validate_opponent!(other_player)
-        EloRankable::Calculator.update_ratings_for_draw(self, other_player)
-      end
-
-      # Aliases for clarity
-      alias elo_beat! beat!
-      alias elo_lost_to! lost_to!
-      alias elo_draw_with! draw_with!
-
-      private
-
-      def validate_opponent!(other_player)
-        raise ArgumentError, 'Cannot play against nil' if other_player.nil?
-        raise ArgumentError, 'Cannot play against yourself' if other_player == self
-        raise ArgumentError, 'Opponent must respond to elo_ranking' unless other_player.respond_to?(:elo_ranking)
-
-        # Check if the opponent is destroyed/deleted
-        raise ArgumentError, 'Cannot play against a destroyed record' if other_player.respond_to?(:destroyed?) && other_player.destroyed?
-
-        # Get the elo_ranking once and validate it
-        opponent_ranking = other_player.elo_ranking
-        raise ArgumentError, "Opponent's elo_ranking is not initialized" if opponent_ranking.nil?
-        raise ArgumentError, "Opponent's elo_ranking is not saved" unless opponent_ranking.persisted?
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module EloRankable
+  module HasEloRanking
+    def has_elo_ranking
+      # Set up the polymorphic association
+      has_one :elo_ranking, as: :rankable, class_name: 'EloRankable::EloRanking', dependent: :destroy
+
+      # Include instance methods
+      include InstanceMethods
+
+      # Add scopes for leaderboards
+      scope :by_elo_rating, -> { joins(:elo_ranking).order('elo_rankings.rating DESC') }
+      scope :top_rated, ->(limit = 10) { by_elo_rating.limit(limit) }
+    end
+
+    module InstanceMethods
+      def elo_ranking
+        super || create_elo_ranking!(
+          rating: EloRankable.config.base_rating,
+          games_played: 0
+        )
+      end
+
+      def elo_rating
+        elo_ranking.rating
+      end
+
+      def games_played
+        elo_ranking.games_played
+      end
+
+      # Domain-style DSL methods
+      def beat!(other_player)
+        validate_opponent!(other_player)
+        EloRankable::Calculator.update_ratings_for_win(self, other_player)
+      end
+
+      def lost_to!(other_player)
+        validate_opponent!(other_player)
+        EloRankable::Calculator.update_ratings_for_win(other_player, self)
+      end
+
+      def draw_with!(other_player)
+        validate_opponent!(other_player)
+        EloRankable::Calculator.update_ratings_for_draw(self, other_player)
+      end
+
+      # Aliases for clarity
+      alias elo_beat! beat!
+      alias elo_lost_to! lost_to!
+      alias elo_draw_with! draw_with!
+
+      private
+
+      def validate_opponent!(other_player)
+        raise ArgumentError, 'Cannot play against nil' if other_player.nil?
+        raise ArgumentError, 'Cannot play against yourself' if other_player == self
+        raise ArgumentError, 'Opponent must respond to elo_ranking' unless other_player.respond_to?(:elo_ranking)
+
+        # Check if the opponent is destroyed/deleted
+        raise ArgumentError, 'Cannot play against a destroyed record' if other_player.respond_to?(:destroyed?) && other_player.destroyed?
+
+        # Get the elo_ranking once and validate it
+        opponent_ranking = other_player.elo_ranking
+        raise ArgumentError, "Opponent's elo_ranking is not initialized" if opponent_ranking.nil?
+        raise ArgumentError, "Opponent's elo_ranking is not saved" unless opponent_ranking.persisted?
+      end
+    end
+  end
+end

data/lib/elo_rankable/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module EloRankable
-  VERSION = '0.2.0'
-end
+# frozen_string_literal: true
+
+module EloRankable
+  VERSION = '0.2.1'
+end