weighted_list_rank 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801eb04183d7dec5f99bfbcb76a902a920dcfee105f83f0c0c9a98667b73e6e4
-  data.tar.gz: c5c5665b7205bc0fd52c4c7d23f34103ba2dfd764579e0a575897f8ce36e95af
+  metadata.gz: bf34a6c62fda7d3038b31da0d7c8d9ec0b9a86a1b0204308e44d950e599f95b7
+  data.tar.gz: 3ed6316fa225185f79afa58899f2b0d29c0abb072c7835492be8dc14b1151b39
 SHA512:
-  metadata.gz: 210d7a10b0978195b26a0fd3cbdfd068b93e09066ac332984e165d011170abb544837fc4aafd6cb410055bd7b412199733ca2d37e1190630aa5bd650f8f5df9a
-  data.tar.gz: 65adb83584d5b1ec5d2282a0f8411edb147eb700f3030e9ab4c80def5ca8d2d7963166091cda87e8ea8a603a1c7f7168d28b661c2cbf0a4c6807b3617c47551c
+  metadata.gz: ff08f7f218c00bd592e6c54a8862df527fb8c75cbfdf28ec4ccad44221c73b3fb699f590b0e8cb82c7b9e023e42f0fd285dab907a766864b88360cfb622dcdc2
+  data.tar.gz: 760b3d89d47fce1c4fa48899bdd9f58ee925bbe90937988028b1162f19b6afb4f157b37a7ff68b4964d6581f288834e9a065c372f68ca22bf0d31f572cda9806

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.1] - 2024-05-026
+
+- Fixed issue with lists with only a single item getting bonus points
+
+## [0.3.0] - 2024-02-03
+
+- added bonus_pool_percentage feature to expoential
+
 ## [0.2.0] - 2024-02-03
 
 - refactored the exponential algorithm to only add bonus points out of a pool of 50% of a list's weight

data/Gemfile.lock

@@ -1,59 +1,61 @@
 PATH
   remote: .
   specs:
-    weighted_list_rank (0.1.1)
+    weighted_list_rank (0.3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
-    minitest (5.21.2)
+    minitest (5.23.1)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.59.0)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rubocop (1.63.5)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-minitest (0.34.5)
-      rubocop (>= 1.39, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    rubocop-performance (1.20.2)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.35.0)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
-    standard (1.33.0)
+    standard (1.36.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.59.0)
+      rubocop (~> 1.63.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.4)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.4.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
+      rubocop-performance (~> 1.21.0)
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS

data/lib/weighted_list_rank/strategies/exponential.rb

@@ -1,28 +1,52 @@
 module WeightedListRank
   module Strategies
+    # The Exponential strategy calculates the score of an item within a list using an exponential formula.
+    # This strategy emphasizes the significance of an item's rank within the list, where items with higher
+    # ranks (closer to 1) are exponentially more valuable than those with lower ranks. The magnitude of the bonus
+    # applied to each item's score is determined by the bonus pool percentage of the list's total weight.
+    #
+    # The exponential nature of the calculation is controlled by the +exponent+ attribute, allowing for
+    # flexible adjustment of how steeply the score decreases as rank increases. The +bonus_pool_percentage+
+    # attribute determines the size of the bonus pool as a percentage of the list's total weight, allowing
+    # customization of the bonus impact on the final scores.
     class Exponential < WeightedListRank::Strategy
+      # The exponent used in the score calculation formula. Higher values increase the rate at which
+      # scores decrease as item rank increases.
+      #
+      # @return [Float] the exponent value
       attr_reader :exponent
 
-      # Initializes a new instance of the Exponential strategy with an optional exponent.
+      # The percentage of the list's total weight that constitutes the bonus pool. This value determines
+      # how the total bonus pool is calculated as a percentage of the list's weight.
+      #
+      # @return [Float] the bonus pool percentage, defaulting to 1.0 (100% of the list's weight).
+      attr_reader :bonus_pool_percentage
+
+      # Initializes a new instance of the Exponential strategy with optional parameters for exponent and
+      # bonus pool percentage.
       # @param exponent [Float] the exponent to use in the score calculation formula, defaults to 1.5.
-      def initialize(exponent: 1.5)
+      # @param bonus_pool_percentage [Float] the percentage of the list's weight to be used as the bonus pool,
+      # defaults to 1.0 (100%).
+      def initialize(exponent: 1.5, bonus_pool_percentage: 1.0)
         @exponent = exponent
+        @bonus_pool_percentage = bonus_pool_percentage
       end
 
       # Calculates the score of an item within a list based on its rank position, the total number of items,
-      # and the list's weight, using an exponential formula.
-      # The bonus pool is set to 50% of the list's weight.
+      # and the list's weight, using an exponential formula. The bonus pool for score adjustments is determined
+      # by the specified bonus pool percentage of the list's total weight.
       #
       # @param list [WeightedListRank::List] the list containing the item being scored.
       # @param item [WeightedListRank::Item] the item for which to calculate the score.
       #
-      # @return [Float] the calculated score for the item, adjusted by the list's weight and the specified exponent.
+      # @return [Float] the calculated score for the item, adjusted by the list's weight, the specified exponent,
+      # and the bonus pool percentage.
       def calculate_score(list, item)
         # Return the list weight if there are no positions
-        return list.weight if item.position.nil?
+        return list.weight if item.position.nil? || list.items.count == 1
 
         num_items = list.items.count
-        total_bonus_pool = list.weight * 0.5  # Bonus pool is 50% of the list's weight
+        total_bonus_pool = list.weight * bonus_pool_percentage
 
         # Calculate the exponential factor for the item's rank position
         exponential_factor = (num_items + 1 - item.position)**exponent

data/lib/weighted_list_rank/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WeightedListRank
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weighted_list_rank
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Shane Sherman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-04 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -89,7 +89,6 @@ files:
 - lib/weighted_list_rank/strategy.rb
 - lib/weighted_list_rank/version.rb
 - sig/weighted_list_rank.rbs
-- weighted_list_rank.gemspec
 homepage: https://github.com/ssherman/weighted_list_rank
 licenses:
 - MIT

data/weighted_list_rank.gemspec

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/weighted_list_rank/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "weighted_list_rank"
-  spec.version = WeightedListRank::VERSION
-  spec.authors = ["Shane Sherman"]
-  spec.email = ["shane.sherman@gmail.com"]
-
-  spec.summary = "generate ranks of items from weighted lists"
-  spec.description = "generate ranks of items from weighted lists"
-  spec.homepage = "https://github.com/ssherman/weighted_list_rank"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/ssherman/weighted_list_rank"
-  spec.metadata["changelog_uri"] = "https://github.com/ssherman/weighted_list_rank/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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_development_dependency "rubocop", "~> 1.0"
-  spec.add_development_dependency "standard", "~> 1.0"
-  spec.add_development_dependency "rubocop-minitest", "~> 0.3"
-  spec.add_development_dependency "rubocop-rake", "~> 0.6"
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end