sorare-rewards 1.0.2 → 1.1.3.beta0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 503bd2bc5d9b16f6c2ba4e9209c14920dc000730dc3466eea88534abe97187c2
-  data.tar.gz: c03342737d6af15c514932029928fb26acd255700811e8bd9de53f62f7a5a91e
+  metadata.gz: bcb36662a381adcf213a5ab17ad97ae1d57f862f84e274679657a05d096476cb
+  data.tar.gz: 1d38e28d7fc1912cf14ae3dfa48546f1aa87b427e5025ac8e2896dd3dce6a117
 SHA512:
-  metadata.gz: 496c0f02f3c3735895c314d5f680a36fd3a2965a63d196f209efdd6cefcb6c9eaf5a8f5995c90a27ad36963cd68eb071f5467abf998738b856ca1a389dba87c6
-  data.tar.gz: 5386e7e1e7f95c9b703882e5623c0aeec9ce71b4d9d46e85f807601e2f918b76c095dbac01f26ccfacd2262a0384d4f83ec22857810629e5b29ff274bc6a2d66
+  metadata.gz: e66851acb6b951557c607e2ebf24552ea5b16d63d3faf260f344175bf674758dc5efe7549b96c6fa164f1bdfc263066234b0e09f79a66ccbbb1c5f7dc0df903e
+  data.tar.gz: 6a2a8979952b7446ac9470b360fae8e7c2d8c53dd4db4442da9e60472090c2bae881fcf625e9c5da5a19d8bcff9c0356f80c2acb3a1586b074bdeb87f2e0689c

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    sorare-rewards (1.0.2)
-      activesupport (~> 6.1)
-      interactor (~> 3.0)
+    sorare-rewards (1.1.3.beta0)
+      activesupport (~> 6.1.4)
+      interactor (~> 3.1.2)
       json (~> 2)
       net-http (~> 0.1.1)
-      yaml (~> 0.1.1)
+      yaml (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     interactor (3.1.2)
     io-wait (0.1.0)
-    json (2.5.1)
+    json (2.6.0)
     minitest (5.14.4)
     net-http (0.1.1)
       net-protocol
@@ -32,9 +32,9 @@ GEM
     net-protocol (0.1.1)
       io-wait
       timeout
-    ostruct (0.2.0)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    ostruct (0.4.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (12.3.3)
@@ -53,42 +53,41 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.12.1)
+    rubocop (1.22.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    timeout (0.1.1)
+    timeout (0.2.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     uri (0.10.1)
-    yaml (0.1.1)
-    zeitwerk (2.4.2)
+    yaml (0.2.0)
+    zeitwerk (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  ostruct (~> 0.2.0)
+  ostruct (~> 0.4.0)
   rake (~> 12.0)
   rspec (~> 3.10)
-  rubocop (~> 1.12.1)
-  rubocop-rake (~> 0.5.1)
-  rubocop-rspec (~> 2.2.0)
+  rubocop (~> 1.22.1)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.5.0)
   sorare-rewards!
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/lib/sorare/rewards/concerns/with_analytics.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Sorare
+  module Rewards
+    # WithAnalytics defines analytics methods
+    module WithAnalytics
+      extend ActiveSupport::Concern
+
+      def analytics
+        @analytics ||= each_league.each_with_object({}) do |league, stats|
+          stats[league.name] = league_analytics(league)
+        end
+      end
+
+      private
+
+      def reward_distributed
+        @reward_distributed ||= reward_allocations.card_allocations.transform_values do |league|
+          league.transform_values do |rarity|
+            rarity.sum { |_, divisions| divisions.values.sum }
+          end
+        end
+      end
+
+      def league_analytics(league)
+        {
+          playing_players_with_supply: nb_of_playing_players(league),
+          available_cards: nb_of_available_cards(league),
+          cooldown_players: nb_of_fully_cooldown_players(league),
+          rewarded: reward_distributed[league.name]
+        }
+      end
+
+      def nb_of_playing_players(league)
+        supply_for(league.name).keys.index_with do |rarity|
+          (supply_for(league.name, rarity: rarity).keys & playing_players.keys).count
+        end
+      end
+
+      def nb_of_available_cards(league)
+        supply_for(league.name).keys.index_with do |rarity|
+          supply_for(league.name, rarity: rarity).sum { |_, data| data['supply'] }
+        end
+      end
+
+      def nb_of_fully_cooldown_players(league)
+        supply_for(league.name).keys.index_with do |rarity|
+          supply_for(league.name, rarity: rarity).filter do |player_slug|
+            player(player_slug).available_during_cooldown(league, rarity).zero?
+          end.count
+        end
+      end
+    end
+  end
+end

data/lib/sorare/rewards/game_week.rb

@@ -8,6 +8,8 @@ module Sorare
   module Rewards
     # GameWeek stores the reward data of a game week
     class GameWeek
+      include WithAnalytics
+
       attr_reader :salt
 
       delegate :card_allocations, :prize_pools, to: :reward_allocations
@@ -69,6 +71,10 @@ module Sorare
       def player(slug)
         Player.new(slug, self)
       end
+
+      def inspect
+        super.splice(:version)
+      end
     end
   end
 end

data/lib/sorare/rewards/game_week_config.rb

@@ -12,7 +12,7 @@ module Sorare
         @config = config
       end
 
-      %w[cooldown limits prize_pool_currency].each do |key|
+      %w[cooldown limits prize_pool_currency rewards_ratio_per_cards_in_circulation].each do |key|
         define_method(key) do
           config[key]
         end

data/lib/sorare/rewards/interactors/allocations/compute_for_league.rb

@@ -17,10 +17,8 @@ module Sorare
         end
 
         def allocate_and_format!
-          allocations = allocate!
-
-          allocations.keys.index_with do |rarity|
-            allocations[rarity].first.keys.index_with do |division|
+          each_rarity_allocation do |rarity|
+            (allocations[rarity].first || {}).keys.index_with do |division|
               allocations[rarity].each_with_index.map do |qualified_allocations, tier|
                 [Sorare::Rewards.configuration.transform_tier.call(tier), qualified_allocations[division]]
               end.to_h
@@ -28,8 +26,12 @@ module Sorare
           end
         end
 
-        def allocate!
-          (config || {}).keys.index_with do |rarity|
+        def each_rarity_allocation(&block)
+          allocations.keys.index_with(&block)
+        end
+
+        def allocations
+          @allocations ||= (config || {}).keys.index_with do |rarity|
             ComputeForRarity.call!(**context.to_h, supply: supply[rarity], config: config[rarity]).rarity_allocations
           end
         end

data/lib/sorare/rewards/interactors/allocations/compute_for_rarity.rb

@@ -15,7 +15,13 @@ module Sorare
         def call
           context.fail!(error: 'Invalid config') unless config
 
-          context.rarity_allocations = supply.each_with_index.map do |tier_supply, tier|
+          context.rarity_allocations = allocations
+        end
+
+        def allocations
+          return [] unless supply
+
+          supply.each_with_index.map do |tier_supply, tier|
             ComputeForQuality.call!(
               **context.to_h,
               supply: tier_supply,

data/lib/sorare/rewards/interactors/supply/compute_for_rarity.rb

@@ -16,39 +16,49 @@ module Sorare
         def call
           context.rarity_supply = []
 
-          context.rewardable = compute_rewardable_supply!
+          context.rewardable = rewardable_supply
           distribute_in_tiers!
         end
 
-        def compute_rewardable_supply!
-          total_supply = supply.keys.sum do |player|
-            player_supply(player)
-          end
+        def rewardable_supply
+          total_float_supply = supply.keys.sum { |player| player_contribution(player) }
 
-          rounded_supply(total_supply)
+          round_and_cap_league_supply(total_float_supply)
         end
 
         def distribute_in_tiers!
           ctx = Tiers::QualifySupply.call!(sorted_supply: supply)
-          ctx.supply.each do |tier_supply|
+          qualified_players = Tiers::QualifyPlayers.call!(sorted_supply: supply).players
+          ctx.supply.each_with_index do |tier_supply, index|
             rarity_supply.push(
-              ComputeForQuality.call!(
-                randomizer: randomizer,
-                total_supply: ctx.count,
-                tier_supply: tier_supply,
-                rewardable: rewardable,
-                rewarded: rarity_supply
-              ).quality_supply
+              capped_tier_supply(ctx.count, tier_supply, rewardable, qualified_players[index])
             )
           end
         end
 
-        def player_supply(slug)
+        # Cap with the actual pickable supply for the tier
+        def capped_tier_supply(total_supply, tier_supply, rewardable, tier_players)
+          target = ComputeForQuality.call!(
+            randomizer: randomizer, total_supply: total_supply,
+            tier_supply: tier_supply, rewardable: rewardable, rewarded: rarity_supply
+          ).quality_supply
+
+          [target, tier_players.sum { |player| player_pickable_supply(player) }].min
+        end
+
+        def round_and_cap_league_supply(float_supply)
+          [
+            float_supply.floor + remaining_supply(float_supply.modulo(1)), # Supply limit
+            league.cards_in_circulation_limit(rarity) # Circulation limit
+          ].compact.min
+        end
+
+        def player_contribution(slug)
           game_week.player(slug).reward_pool_supply_contribution(league, rarity)
         end
 
-        def rounded_supply(float_supply)
-          float_supply.floor + remaining_supply(float_supply.modulo(1))
+        def player_pickable_supply(slug)
+          game_week.player(slug).pickable_supply(league, rarity)
         end
 
         def remaining_supply(reward_probability)

data/lib/sorare/rewards/interactors/tiers/qualify_players.rb

@@ -33,13 +33,13 @@ module Sorare
         end
 
         def tier_depth
-          @tier_depth ||= sorted_supply.keys.length / (nb_of_tiers**2 - 1)
+          @tier_depth ||= sorted_supply.keys.length / ((nb_of_tiers**2) - 1)
         end
 
         def nb_of_tiers
           @nb_of_tiers ||= begin
             default = Sorare::Rewards.configuration.tiers
-            default -= 1 while (default**2 - 1) > sorted_supply.keys.length
+            default -= 1 while ((default**2) - 1) > sorted_supply.keys.length
 
             default
           end
@@ -49,7 +49,7 @@ module Sorare
           return 0 unless tier.positive?
           return sorted_supply.keys.length if tier == nb_of_tiers
 
-          tier_index(tier - 1) + tier_depth * tier_size(tier - 1)
+          tier_index(tier - 1) + (tier_depth * tier_size(tier - 1))
         end
 
         def tier_size(tier)

data/lib/sorare/rewards/league.rb

@@ -17,12 +17,18 @@ module Sorare
         @game_week = game_week
       end
 
-      %w[playing_rate prize_pools].each do |key|
+      %w[playing_rate prize_pools cards_in_circulation].each do |key|
         define_method(key) do
           config[key]
         end
       end
 
+      def cards_in_circulation_limit(rarity)
+        return unless cards_in_circulation&.dig(rarity) && game_week.config.rewards_ratio_per_cards_in_circulation
+
+        (cards_in_circulation[rarity] * game_week.config.rewards_ratio_per_cards_in_circulation).floor
+      end
+
       def each_division_prize_pools
         prize_pools.each_with_index do |prize_pool, index|
           return to_enum(:each_division_prize_pools) unless block_given?

data/lib/sorare/rewards/version.rb

@@ -2,6 +2,6 @@
 
 module Sorare
   module Rewards
-    VERSION = '1.0.2'
+    VERSION = '1.1.3.beta0'
   end
 end

data/sorare-rewards.gemspec

@@ -30,15 +30,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '~> 6.1'
-  spec.add_dependency 'interactor', '~> 3.0'
+  spec.add_dependency 'activesupport', '~> 6.1.4'
+  spec.add_dependency 'interactor', '~> 3.1.2'
   spec.add_dependency 'json', '~> 2'
   spec.add_dependency 'net-http', '~> 0.1.1'
-  spec.add_dependency 'yaml', '~> 0.1.1'
-  spec.add_development_dependency 'ostruct', '~> 0.2.0'
+  spec.add_dependency 'yaml', '~> 0.2.0'
+  spec.add_development_dependency 'ostruct', '~> 0.4.0'
   spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.12.1'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.5.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.2.0'
+  spec.add_development_dependency 'rubocop', '~> 1.22.1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.5.0'
 end
 # rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorare-rewards
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.3.beta0
 platform: ruby
 authors:
 - pierre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 6.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: interactor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +114,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.22.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.22.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.5.0
 description: 
 email:
 - pierre@sorare.com
@@ -171,6 +171,7 @@ files:
 - data.patch
 - lib/sorare/rewards.rb
 - lib/sorare/rewards/allocation_configuration.yml
+- lib/sorare/rewards/concerns/with_analytics.rb
 - lib/sorare/rewards/configuration.rb
 - lib/sorare/rewards/game_week.rb
 - lib/sorare/rewards/game_week_allocations.rb
@@ -220,11 +221,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: '["Sorare", "reward", "allocation", "algorithm"]'