weighted_list_rank 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2d9ea8239b54fa7d9423a36ae922c9de54a4bee54d8df0fdc17847b98eb60d
-  data.tar.gz: '03808fac0b2fd206b726734eeca8f3a62ad9b3aeab51f58237f22561775d4dbf'
+  metadata.gz: afae67c4e97dd094fb6de0be3fd5dd0886372ae2edd873f61fdbc12f9c4b9e87
+  data.tar.gz: 8c12da106e959044d21a6889f35c959d91a637ae69ada9113744ce61ceed21fc
 SHA512:
-  metadata.gz: 590693e2ea27c84cf861ba36dacfc50f97374f5b12c47b1b6f72693f6652a92d875c5d9a56090809ffeefc2b91e17e76e2288586d3bbd01baa408c3cbbcb91a4
-  data.tar.gz: 462ed842d02c3a5aa70103b2e9d7dfa40e496eb7f3bc2cd9946a518319e3b72610bfed43007d4b80a71c4927d5d39867e638e4325dace2c6e9bf5f6d680bb2d9
+  metadata.gz: 1c3c9b95c5ff8416938a36b8c04d6b066948284e0e2e414f7f037871ae88432441f3f617e32cc50d60d2cd7fad7cb5462735eae1ebacab8a4041c06e4c516b28
+  data.tar.gz: 9449fbe8419cb5a25ad1c1d5bdeae92831a14d95f81a43371755f1f369c59c53cbb01f3aefcd24fed8ad31a6de12b76d4bf81a219bf18d1bde0d7f01510b0950

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.5.1] - 2024-07-23
+- Updated the `Exponential` strategy to prevent unranked items from receiving bonus points if the list contains both ranked and unranked items. In such cases, unranked items will now only receive the base weight of the list, ensuring ranked items are always prioritized.
+
 ## [0.5.0] - 2024-07-23
 - Added `average_list_length` feature to the `Exponential` strategy to adjust the bonus pool based on the average number of items across all lists. This helps prevent smaller lists from receiving disproportionately large bonuses.
 - Introduced a new configuration option `include_unranked_items` in the `Exponential` strategy. When enabled, unranked items will receive an equal share of the bonus pool, while ranked items will receive an exponential bonus.

data/lib/weighted_list_rank/strategies/exponential.rb

@@ -36,32 +36,38 @@ module WeightedListRank
         # Default score to the list's weight
         score = list.weight
 
-        # Determine the number of ranked and unranked items
+        # Total number of items in the list
+        total_items = list.items.count
+
+        # Separate ranked and unranked items
         ranked_items = list.items.select { |i| i.position }
-        unranked_items = list.items.reject { |i| i.position }
         num_ranked_items = ranked_items.count
-        num_unranked_items = unranked_items.count
+
+        if num_ranked_items > 0 && item.position.nil?
+          # If there are ranked items, unranked items get no bonus, only the list's weight
+          return score
+        end
 
         # Calculate the total bonus pool
         total_bonus_pool = list.weight * bonus_pool_percentage
 
         # Adjust the bonus pool based on the average list length
         adjusted_bonus_pool = if average_list_length && average_list_length > 0
-          total_bonus_pool * (list.items.count / average_list_length.to_f)
+          total_bonus_pool * (total_items / average_list_length.to_f)
         else
           total_bonus_pool
         end
 
         if item.position.nil?
-          # If the item is unranked, give it an equal share of the remaining bonus pool
-          if include_unranked_items && num_unranked_items > 0
-            unranked_bonus = adjusted_bonus_pool / list.items.count
+          # Unranked items get no bonus if there are ranked items
+          if include_unranked_items && num_ranked_items == 0
+            unranked_bonus = adjusted_bonus_pool / total_items
             score += unranked_bonus
           end
         else
-          # If the item is ranked, calculate its bonus using the exponential formula
-          exponential_factor = (num_ranked_items + 1 - item.position)**exponent
-          total_exponential_factor = (1..num_ranked_items).sum { |pos| (num_ranked_items + 1 - pos)**exponent }
+          # Ranked items receive a bonus calculated using the exponential formula
+          exponential_factor = (total_items + 1 - item.position)**exponent
+          total_exponential_factor = (1..total_items).sum { |pos| (total_items + 1 - pos)**exponent }
 
           # Allocate a portion of the adjusted bonus pool based on the item's exponential factor
           item_bonus = (exponential_factor / total_exponential_factor) * adjusted_bonus_pool

data/lib/weighted_list_rank/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weighted_list_rank
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Shane Sherman