elo_rankable 0.2.0 → 0.2.2

data/lib/elo_rankable.rb

@@ -1,96 +1,96 @@
-# frozen_string_literal: true
-
-require 'active_record'
-require 'active_support'
-
-require_relative 'elo_rankable/version'
-require_relative 'elo_rankable/configuration'
-require_relative 'elo_rankable/elo_ranking'
-require_relative 'elo_rankable/calculator'
-require_relative 'elo_rankable/has_elo_ranking'
-
-# EloRankable provides methods for recording Elo-based ranking results for multiplayer matches,
-# winner-vs-all matches, and draws between players. It expects player objects to respond to
-# `elo_ranking` and `beat!` methods, and includes configuration support.
-#
-# Example usage:
-#   EloRankable.record_multiplayer_match([player1, player2, player3])
-#   EloRankable.record_winner_vs_all(winner, [loser1, loser2])
-#   EloRankable.record_draw(player1, player2)
-#
-# Configuration can be customized via EloRankable.configure.
-#
-# Errors:
-#   EloRankable::InvalidMatchError - Raised for invalid match scenarios.
-#   ArgumentError - Raised for invalid arguments or player objects.
-module EloRankable
-  class Error < StandardError; end
-  class InvalidMatchError < Error; end
-
-  class << self
-    def config
-      @config ||= Configuration.new
-    end
-
-    def configure
-      yield(config) if block_given?
-    end
-
-    # Record a multiplayer match where players are ranked by their position in the array
-    # Higher-indexed players are treated as having lost to lower-indexed ones
-    def record_multiplayer_match(players)
-      raise InvalidMatchError, 'Need at least 2 players for a match' if players.length < 2
-
-      # Validate input array
-      raise ArgumentError, 'Players array cannot contain nil values' if players.any?(&:nil?)
-
-      # Check for duplicates
-      raise ArgumentError, 'Players array cannot contain duplicate players' if players.uniq.length != players.length
-
-      # Validate all players respond to elo_ranking
-      invalid_players = players.reject { |p| p.respond_to?(:elo_ranking) }
-      raise ArgumentError, 'All players must respond to elo_ranking' unless invalid_players.empty?
-
-      # Process all pairwise combinations
-      players.each_with_index do |player1, i|
-        players[(i + 1)..].each do |player2|
-          player1.beat!(player2)
-        end
-      end
-    end
-
-    # Record a single winner vs all others match
-    def record_winner_vs_all(winner, losers)
-      # Validate winner
-      raise ArgumentError, 'Winner cannot be nil' if winner.nil?
-      raise ArgumentError, 'Winner must respond to elo_ranking' unless winner.respond_to?(:elo_ranking)
-
-      # Validate losers array
-      raise InvalidMatchError, 'Need at least 1 loser' if losers.empty?
-      raise ArgumentError, 'Losers array cannot contain nil values' if losers.any?(&:nil?)
-      raise InvalidMatchError, 'Winner cannot be in losers list' if losers.include?(winner)
-
-      # Validate all losers respond to elo_ranking
-      invalid_losers = losers.reject { |p| p.respond_to?(:elo_ranking) }
-      raise ArgumentError, 'All losers must respond to elo_ranking' unless invalid_losers.empty?
-
-      losers.each do |loser|
-        winner.beat!(loser)
-      end
-    end
-
-    # Record a draw between two players
-    def record_draw(player1, player2)
-      raise ArgumentError, 'Player1 cannot be nil' if player1.nil?
-      raise ArgumentError, 'Player2 cannot be nil' if player2.nil?
-      raise ArgumentError, 'Cannot record draw with same player' if player1 == player2
-      raise ArgumentError, 'Player1 must respond to elo_ranking' unless player1.respond_to?(:elo_ranking)
-      raise ArgumentError, 'Player2 must respond to elo_ranking' unless player2.respond_to?(:elo_ranking)
-
-      Calculator.update_ratings_for_draw(player1, player2)
-    end
-  end
-end
-
-# Hook into ActiveRecord
-ActiveRecord::Base.extend(EloRankable::HasEloRanking) if defined?(ActiveRecord::Base)
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support'
+
+require_relative 'elo_rankable/version'
+require_relative 'elo_rankable/configuration'
+require_relative 'elo_rankable/elo_ranking'
+require_relative 'elo_rankable/calculator'
+require_relative 'elo_rankable/has_elo_ranking'
+
+# EloRankable provides methods for recording Elo-based ranking results for multiplayer matches,
+# winner-vs-all matches, and draws between players. It expects player objects to respond to
+# `elo_ranking` and `beat!` methods, and includes configuration support.
+#
+# Example usage:
+#   EloRankable.record_multiplayer_match([player1, player2, player3])
+#   EloRankable.record_winner_vs_all(winner, [loser1, loser2])
+#   EloRankable.record_draw(player1, player2)
+#
+# Configuration can be customized via EloRankable.configure.
+#
+# Errors:
+#   EloRankable::InvalidMatchError - Raised for invalid match scenarios.
+#   ArgumentError - Raised for invalid arguments or player objects.
+module EloRankable
+  class Error < StandardError; end
+  class InvalidMatchError < Error; end
+
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config) if block_given?
+    end
+
+    # Record a multiplayer match where players are ranked by their position in the array
+    # Higher-indexed players are treated as having lost to lower-indexed ones
+    def record_multiplayer_match(players)
+      raise InvalidMatchError, 'Need at least 2 players for a match' if players.length < 2
+
+      # Validate input array
+      raise ArgumentError, 'Players array cannot contain nil values' if players.any?(&:nil?)
+
+      # Check for duplicates
+      raise ArgumentError, 'Players array cannot contain duplicate players' if players.uniq.length != players.length
+
+      # Validate all players respond to elo_ranking
+      invalid_players = players.reject { |p| p.respond_to?(:elo_ranking) }
+      raise ArgumentError, 'All players must respond to elo_ranking' unless invalid_players.empty?
+
+      # Process all pairwise combinations
+      players.each_with_index do |player1, i|
+        players[(i + 1)..].each do |player2|
+          player1.beat!(player2)
+        end
+      end
+    end
+
+    # Record a single winner vs all others match
+    def record_winner_vs_all(winner, losers)
+      # Validate winner
+      raise ArgumentError, 'Winner cannot be nil' if winner.nil?
+      raise ArgumentError, 'Winner must respond to elo_ranking' unless winner.respond_to?(:elo_ranking)
+
+      # Validate losers array
+      raise InvalidMatchError, 'Need at least 1 loser' if losers.empty?
+      raise ArgumentError, 'Losers array cannot contain nil values' if losers.any?(&:nil?)
+      raise InvalidMatchError, 'Winner cannot be in losers list' if losers.include?(winner)
+
+      # Validate all losers respond to elo_ranking
+      invalid_losers = losers.reject { |p| p.respond_to?(:elo_ranking) }
+      raise ArgumentError, 'All losers must respond to elo_ranking' unless invalid_losers.empty?
+
+      losers.each do |loser|
+        winner.beat!(loser)
+      end
+    end
+
+    # Record a draw between two players
+    def record_draw(player1, player2)
+      raise ArgumentError, 'Player1 cannot be nil' if player1.nil?
+      raise ArgumentError, 'Player2 cannot be nil' if player2.nil?
+      raise ArgumentError, 'Cannot record draw with same player' if player1 == player2
+      raise ArgumentError, 'Player1 must respond to elo_ranking' unless player1.respond_to?(:elo_ranking)
+      raise ArgumentError, 'Player2 must respond to elo_ranking' unless player2.respond_to?(:elo_ranking)
+
+      Calculator.update_ratings_for_draw(player1, player2)
+    end
+  end
+end
+
+# Hook into ActiveRecord
+ActiveRecord::Base.extend(EloRankable::HasEloRanking) if defined?(ActiveRecord::Base)

data/lib/generators/elo_rankable/install/install_generator.rb

@@ -1,21 +1,29 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_record'
-
-module EloRankable
-  module Generators
-    class InstallGenerator < ActiveRecord::Generators::Base
-      desc 'Create migration for EloRankable'
-
-      source_root File.expand_path('templates', __dir__)
-
-      def self.default_generator_root
-        File.dirname(__FILE__)
-      end
-
-      def create_migration_file
-        migration_template 'create_elo_rankings.rb', 'db/migrate/create_elo_rankings.rb'
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module EloRankable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Create migration for EloRankable'
+
+      source_root File.expand_path('templates', __dir__)
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def self.default_generator_root
+        File.dirname(__FILE__)
+      end
+
+      def create_migration_file
+        migration_template 'create_elo_rankings.rb', 'db/migrate/create_elo_rankings.rb'
+      end
+    end
+  end
+end

data/lib/generators/elo_rankable/install/templates/create_elo_rankings.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-
-class CreateEloRankings < ActiveRecord::Migration[6.0]
-  def change
-    create_table :elo_rankings do |t|
-      t.references :rankable, polymorphic: true, null: false, index: true
-      t.integer :rating, null: false, default: 1200
-      t.integer :games_played, null: false, default: 0
-
-      t.timestamps
-    end
-
-    add_index :elo_rankings, :rating
-    add_index :elo_rankings, %i[rankable_type rankable_id], unique: true
-  end
-end
+# frozen_string_literal: true
+
+class CreateEloRankings < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :elo_rankings do |t|
+      t.references :rankable, polymorphic: true, null: false, index: true
+      t.integer :rating, null: false, default: 1200
+      t.integer :games_played, null: false, default: 0
+
+      t.timestamps
+    end
+
+    add_index :elo_rankings, :rating
+    add_index :elo_rankings, %i[rankable_type rankable_id], unique: true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elo_rankable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Aberen
@@ -19,7 +19,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,8 +49,8 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
-description: Adds ELO rating to any ActiveRecord model via has_elo_ranking. It stores
+        version: '9.0'
+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.
 email:
@@ -100,5 +100,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
-summary: Add ELO rating capabilities to any ActiveRecord model
+summary: Add Elo rating capabilities to any ActiveRecord model
 test_files: []