hlockey 6 → 7

data/lib/hlockey/message.rb

@@ -1,24 +1,28 @@
-require("hlockey/version")
+require("hlockey/data")
+require("hlockey/team")
 
 module Hlockey
   ##
   # Can be sent by a Game (in Game#stream) or a commonly used text
   class Message
-    private_class_method(:new)
-
     @colorize = ->(_color, string) { string }
 
     # @return [Symbol] an action or event the message represents
     attr_reader(:event)
 
     # @param event [Symbol]
-    # @param fields [Array<Symbol>] fields used in string interpolation in #to_s
-    # @param data [Array<Object>] data corresponding to the fields
-    def initialize(event, fields, data)
-      self.class.attr_reader(*fields)
-
+    # @param data [Hash<Symbol => Object>] data for the message
+    def initialize(event, **data)
       @event = event
-      fields.zip(data) { |f, d| instance_variable_set("@#{f}", d) }
+      @data = data
+    end
+
+    def to_s(do_color: true)
+      return format(Data.messages[@event], **@data) unless do_color
+
+      colorized_data = @data.transform_values { self.class.color(_1, do_color:) }
+
+      format(Data.messages[@event], **colorized_data)
     end
 
     class << self
@@ -33,150 +37,18 @@ module Hlockey
       # To control how this colors things, see #colorize=
       # @param obj [Team, Team::Player, Team::Stadium]
       # @return String
-      def color(obj) =
-        @colorize.call(obj.instance_of?(Team) ? obj.color : obj.team.color, obj.to_s)
-
-      # These are messages logged to game streams / league alerts
-      [
-        # Game stream messages
-        %i[StartOfGame],
-        %i[EndOfGame winning_team],
-        %i[StartOfPeriod period],
-        %i[EndOfPeriod period home away home_score away_score],
-        %i[FaceOff winning_player new_puck_team],
-        %i[Hit puck_holder defender puck_taken new_puck_team shooting_chance],
-        %i[Pass sender receiver shooting_chance interceptor new_puck_team],
-        %i[ShootScore shooter home away home_score away_score audacity],
-        %i[ShootBlock shooter blocker puck_taken new_puck_team shooting_chance audacity],
-        %i[Partying player],
-        %i[FightStarted home_player away_player],
-        %i[FightAttack attacking_player defending_player blocked],
-        %i[PlayerJoinedFight player],
-        %i[FightEnded],
-        %i[MoraleChange team amount],
-        %i[ChickenedOut prev_player next_player],
-        %i[InclineFavors team],
-        %i[StarsAlign team],
-        %i[WavesWashedAway prev_player next_player],
-        %i[ImmaterialDodge player hitting_player],
-        # League alert messages
-        %i[SeasonChampion team]
-      ].each do |event, *fields|
-        define_method(event) { |*data| new(event, fields, data) }
-      end
-
-      # These are messages used elsewhere
-
-      def SeasonDay(day) = "Season #{VERSION} day #{day}"
-
-      def SeasonStarts(time) =
-        time.strftime("Season #{VERSION} starts at %H:%M, %A, %B %d (%Z).")
-
-      def NoGames =
-        "no games right now. it is the offseason. join the Hlockey Discord for updates"
-    end
-
-    def to_s(do_color: true)
-      c = -> { color(_1, do_color:) }
-
-      case @event
-      when :StartOfGame
-        "Hocky!"
-      when :EndOfGame
-        "Game over.\n#{c.call(@winning_team)} win!"
-      when :StartOfPeriod
-        "Start#{of_period}"
-      when :EndOfPeriod
-        "End#{of_period}#{score(do_color:)}"
-      when :FaceOff
-        "#{c.call(@winning_player)} wins the faceoff!#{possession_change(do_color:)}"
-      when :Hit
-        str = "#{c.call(@defender)} hits #{c.call(@puck_holder)}"
-        str += takes(do_color:) + score_chance if @puck_taken
-        str
-      when :Pass
-        str = "#{c.call(@sender)} passes to #{c.call(@receiver)}."
-        unless @interceptor.nil?
-          str += "..\nIntercepted by #{c.call(@interceptor)}!" +
-                 possession_change(do_color:)
+      def color(obj, do_color: true)
+        return obj.to_s unless do_color
+
+        case obj
+        when Team
+          @colorize.call(obj.color, obj.to_s)
+        when Team::Player, Team::Stadium
+          @colorize.call(obj.team.color, obj.to_s)
+        else
+          obj.to_s
         end
-        str += score_chance
-        str
-      when :ShootScore
-        "#{shot(do_color:)} and scores!#{score(do_color:)}"
-      when :ShootBlock
-        "#{shot(do_color:)}...\n#{c.call(@blocker)} blocks the shot" +
-          takes(do_color:) + score_chance
-      when :Partying
-        "#{c.call(@player)} is partying!"
-      when :FightStarted
-        "#{c.call(@home_player)} and #{c.call(@away_player)} " \
-          "start fighting!"
-      when :FightAttack
-        def_player = c.call(@defending_player)
-        str = "#{c.call(@attacking_player)} punches #{def_player}!"
-        str += "\n#{def_player} blocks the punch!" if @blocked
-        str
-      when :PlayerJoinedFight
-        "#{c.call(@player)} from #{c.call(@player.team)} joins the fight!"
-      when :FightEnded
-        "The fight has ended."
-      when :MoraleChange
-        "#{c.call(@team)} #{@amount.negative? ? "loses" : "gains"} #{@amount.abs} morale."
-      when :ChickenedOut
-        "#{c.call(@prev_player)} chickened out!#{replaces("game", do_color:)}"
-      when :InclineFavors
-        "The incline favors #{c.call(@team)}."
-      when :StarsAlign
-        "The stars align for #{c.call(@team)}. They get half a goal."
-      when :WavesWashedAway
-        "#{c.call(@prev_player)} is washed away by the waves...#{replaces(do_color:)}"
-      when :ImmaterialDodge
-        "#{c.call(@hitting_player)} goes right through #{c.call(@player)}!"
-      when :SeasonChampion
-        "Your season #{VERSION} champions are the #{c.call(@team)}!"
       end
     end
-
-    private
-
-    def color(obj, do_color: true) = do_color ? self.class.color(obj) : obj.to_s
-
-    def score_chance
-      return "" if @shooting_chance.nil?
-
-      chance_str = case @shooting_chance
-                   when 0..2
-                     "none"
-                   when 3, 4
-                     "low"
-                   when 5, 6
-                     "medium"
-                   else
-                     "high"
-                   end
-      "\nChance of scoring: #{chance_str} (#{@shooting_chance})"
-    end
-
-    def of_period = " of period #{@period}."
-
-    def score(do_color: true) =
-      "\n#{color(@home, do_color:)} #{@home_score.round(2)}, " \
-      "#{color(@away, do_color:)} #{@away_score.round(2)}"
-
-    def shot(do_color: true) =
-      "#{color(@shooter, do_color:)} takes a#{"n audacious" if @audacity} shot"
-
-    def takes(do_color: true) =
-      @puck_taken ? " and takes the puck!#{possession_change(do_color:)}" : "!"
-
-    def possession_change(do_color: true) =
-      "\n#{color(@new_puck_team, do_color:)} have possession."
-
-    def replaces(period = nil, do_color: true)
-      str = "\n#{color(@next_player, do_color:)} replaces them"
-      str += " for the rest of the #{period}." unless period.nil?
-      str
-    end
   end
 end

data/lib/hlockey/mod/fencebuilder.rb

@@ -9,8 +9,7 @@ module Hlockey
 
       DESCRIPTION = "This player can only play offense.".freeze
 
-      def on_swap(into_roster, pos, prev_pos, _prng) =
-        fence_swap(into_roster, pos, prev_pos)
+      def on_swap(...) = fence_swap(...)
     end
   end
 end

data/lib/hlockey/mod/fencedestroyer.rb

@@ -9,7 +9,7 @@ module Hlockey
 
       DESCRIPTION = "This player can only play defense.".freeze
 
-      def on_swap(into_roster, pos, prev_pos, _prng) =
+      def on_swap(into_roster, pos, prev_pos) =
         fence_swap(into_roster, pos, prev_pos, type: :destroyer)
     end
   end

data/lib/hlockey/mod/handholding.rb

@@ -18,38 +18,40 @@ module Hlockey
 
       def to_data = [to_s, @other_player.to_s]
 
-      def on_swap(into_roster, pos, _prev_pos, prng)
+      def on_swap(into_roster, pos, _prev_pos)
         unless @other_player.is_a?(Team::Player)
           @other_player = @team.players.find { _1.name == @other_player }
         end
 
+        swap_player = nil
         if into_roster
           prev_pos = @team.shadows.index(@other_player)
           return if prev_pos.nil?
 
-          other_pos = with_deleted(@team.roster.keys, pos).sample(random: prng)
+          swap_pos = sample_with_deleted(@team.roster.keys, pos)
+          swap_player = @team.roster[swap_pos]
 
-          @team.shadows[prev_pos] = @team.roster[other_pos]
-          @team.roster[other_pos] = @other_player
-          return
-        end
+          @team.shadows[prev_pos] = swap_player
+          @team.roster[swap_pos] = @other_player
+        else
+          prev_pos = @team.roster.key(@other_player)
+          return if prev_pos.nil?
 
-        prev_pos = @team.roster.key(@other_player)
-        return if prev_pos.nil?
+          swap_pos = sample_with_deleted(@team.shadows.each_index.to_a, pos)
+          swap_player = @team.shadows[swap_pos]
 
-        other_pos = with_deleted(@team.shadows.each_index.to_a, pos).sample(random: prng)
+          @team.roster[prev_pos] = swap_player
+          @team.shadows[swap_pos] = @other_player
+        end
 
-        @team.roster[prev_pos] = @team.shadows[other_pos]
-        @team.shadows[other_pos] = @other_player
+        send_game_message(:mod_handholding_event,
+                          player: @player, other_player: @other_player, swap_player:)
       end
 
       private
 
-      # For `on_swap`, because array.delete doesn't return the array for no reason
-      def with_deleted(array, object)
-        array.delete(object)
-        array
-      end
+      def sample_with_deleted(array, object) =
+        array.tap { _1.delete(object) }.sample(random: prng)
     end
   end
 end

data/lib/hlockey/mod/immaterial.rb

@@ -11,15 +11,17 @@ module Hlockey
 
       DESCRIPTION = "This player may be a hallucination.".freeze
 
-      def on_got_hit(game, hitting_player)
-        return if game.prng.rand(3).zero?
+      def on_got_hit(hitting_player)
+        return false if prng.rand(3).zero?
 
-        if game.pre_tmp_change_stats[@player].nil?
-          game.pre_tmp_change_stats[@player] = @player.stats.clone
+        if @game.pre_tmp_change_stats[@player].nil?
+          @game.pre_tmp_change_stats[@player] = @player.stats.clone
         end
         @player.stats[:defense] += 0.5
 
-        Message.ImmaterialDodge(@player, hitting_player)
+        send_game_message(:mod_immaterial_event, hitting_player:, player: @player)
+
+        true # Other player shouldn't take puck
       end
     end
   end

data/lib/hlockey/mod/locked.rb

@@ -9,14 +9,20 @@ module Hlockey
 
       DESCRIPTION = "This player can not swap positions.".freeze
 
-      def on_swap(into_roster, pos, prev_pos, _prng) =
+      def on_swap(into_roster, pos, prev_pos)
+        swap_player = nil
         if into_roster
-          @team.roster[pos] = @team.shadows[prev_pos]
+          swap_player = @team.shadows[prev_pos]
+          @team.roster[pos] = swap_player
           @team.shadows[prev_pos] = @player
         else
-          @team.shadows[pos] = @team.roster[prev_pos]
+          swap_player = @team.roster[prev_pos]
+          @team.shadows[pos] = swap_player
           @team.roster[prev_pos] = @player
         end
+
+        send_game_message(:mod_locked_event, player: @player, swap_player:)
+      end
     end
   end
 end

data/lib/hlockey/mod/moddable.rb

@@ -1,3 +1,4 @@
+require("hlockey/message")
 require("hlockey/selfdescribable")
 
 module Hlockey
@@ -8,6 +9,8 @@ module Hlockey
     module Moddable
       include(SelfDescribable)
 
+      attr_writer(:game)
+
       DESCRIPTION = "A mod with no description.".freeze # Default description
 
       # If the mod has no extra parameters, same as #to_s
@@ -22,16 +25,28 @@ module Hlockey
         @team = player.team
       end
 
-      def on_swap(into_roster, pos, prev_pos, prng) end
+      def on_swap(into_roster, pos, prev_pos) end
 
-      def on_action(game) end
+      def on_action() end
 
-      def on_got_hit(game, hitting_player) end
+      # May return truthy value to signal that hitting player should not try to take puck
+      def on_got_hit(hitting_player) end
 
+      # May return a different player to join the fight instead of this one
       def on_join_fight() end
 
       private
 
+      # Makes a new message from params, adds it to the game stream if there is a game
+      def send_game_message(...)
+        @game.stream << Message.new(...) unless @game.nil?
+      end
+
+      # Handles the on_swap event for Fencebuilder, Fencedestroyer mods
+      # @param into_roster [Boolean]
+      # @param pos [Symbol]
+      # @param prev_pos [Symbol]
+      # @param type [:builder | :destroyer]
       def fence_swap(into_roster, pos, prev_pos, type: :builder)
         return unless into_roster
 
@@ -40,10 +55,16 @@ module Hlockey
         new_pos = new_pos_hash[pos]
         return if new_pos.nil?
 
+        swap_player = @team.roster[new_pos]
         @team.roster[pos] = @team.shadows[prev_pos]
-        @team.shadows[prev_pos] = @team.roster[new_pos]
+        @team.shadows[prev_pos] = swap_player
         @team.roster[new_pos] = @player
+
+        send_game_message(:mod_fence_event, type:, player: @player, swap_player:)
       end
+
+      # @return [Utils::Rng, Random] the object to use for RNG
+      def prng = @game&.prng || Random.new
     end
   end
 end

data/lib/hlockey/mod/powernapper.rb

@@ -4,7 +4,8 @@ require("hlockey/actions")
 module Hlockey
   module Mod
     ##
-    # Player has James stats added to their own at random
+    # Player has James stats added to their own at random for 5 actions
+    # These 5 actions carry over between games
     class Powernapper
       include(Moddable)
       include(Actions)
@@ -16,30 +17,33 @@ module Hlockey
         @currently_boosted_for = -1
       end
 
-      def on_action(game)
+      def on_action
         if @currently_boosted_for.negative?
-          return unless random_event_occurs?(prng: game.prng)
+          return unless random_event_occurs?(prng:)
 
-          change_stats(game)
+          change_stats
         end
         @currently_boosted_for += 1
         return if @currently_boosted_for < 5
 
-        change_stats(game, reset: true)
+        change_stats(reset: true)
         @currently_boosted_for = -1
       end
 
       private
 
-      def change_stats(game, reset: false)
+      def change_stats(reset: false)
         stat_change = { offense: 0.5, defense: 1.0 } # James stats (excluding 0 agility)
         stat_change.transform_values!(&:-@) if reset
 
-        pre_tmp_change_stats = game.pre_tmp_change_stats[@player]
+        pre_tmp_change_stats = @game.pre_tmp_change_stats[@player]
         stat_change.each do |stat, change|
           @player.stats[stat] += change
           pre_tmp_change_stats[stat] += change unless pre_tmp_change_stats.nil?
         end
+
+        send_game_message(reset ? :mod_powernap_end : :mod_powernap_start,
+                          player: @player)
       end
     end
   end

data/lib/hlockey/mod/punchy.rb

@@ -10,8 +10,12 @@ module Hlockey
 
       DESCRIPTION = "This player may randomly start fights.".freeze
 
-      def on_action(game) =
-        random_event_occurs?(prng: game.prng) && game.start_fight(@player)
+      def on_action
+        return unless random_event_occurs?(prng:)
+
+        send_game_message(:mod_punchy_event, player: @player)
+        @game.start_fight(@player)
+      end
     end
   end
 end

data/lib/hlockey/selfdescribable.rb

@@ -2,8 +2,6 @@ module Hlockey
   ##
   # For things that name themselves by class name
   module SelfDescribable
-    def to_s
-      self.class.to_s.split("::").last
-    end
+    def to_s = self.class.to_s.split("::").last
   end
 end

data/lib/hlockey/team/player.rb

@@ -47,7 +47,10 @@ module Hlockey
           @stats.transform_values { _1.round(2).to_s.ljust(4, "0") }
         )
 
+      # Calls a method on every mod this player has
       # @param action [Symbol] method to call on each mod
+      # @param *args [Object] any arguments to pass to the mods
+      # @return [Object] the first non-nil return value given from a mod, if any
       def mods_do(action, *args)
         res = nil
         @mods.each { res ||= _1.send(action, *args) }

data/lib/hlockey/team.rb

@@ -28,8 +28,8 @@ module Hlockey
 
       @stadium = Stadium.new(team: self, **stadium)
 
-      @roster = roster.transform_values { Player.new(team: self, **_1) }
-      @shadows = shadows.map { Player.new(team: self, **_1) }
+      @roster = roster.transform_values { Player.new(**_1, team: self) }
+      @shadows = shadows.map { Player.new(**_1, team: self) }
 
       @status = :in_contention
       @wins = @losses = 0
@@ -70,7 +70,7 @@ module Hlockey
 
     # @return [Symbol] the position of the worst player on the roster
     def worst_player_pos =
-      @roster.transform_values { _1.stats.values.sum }.min_by { _2 }.first
+      @roster.transform_values { |v| v.stats.values.sum }.min_by { |_, v| v }.first
 
     # @return [Hash<String => Player>] #roster, but with keys better for displaying
     def roster_display = @roster.transform_keys(&self.class.method(:pos_name))

data/lib/hlockey/utils.rb

@@ -1,13 +1,45 @@
 module Hlockey
   ##
-  # Utility methods to help with various Hlockey related tasks
+  # Utilities to help with various Hlockey related tasks
   module Utils
+    ##
+    # Lehmer random number generator,
+    # to avoid incompatabilities in RNG between Ruby implementations.
+    # From https://en.wikipedia.org/wiki/Lehmer_random_number_generator#Sample_C99_code.
+    class Rng
+      MOD_VAL = 0x7fffffff
+
+      # @return [Integer]
+      attr_reader(:state)
+
+      # @param seed [Integer]
+      def initialize(seed)
+        seed = seed.zero? ? 1 : seed.abs
+        seed %= MOD_VAL if seed >= MOD_VAL
+
+        @state = seed
+      end
+
+      # @param upper_bound [Numeric, Range, nil] max value from RNG
+      # @return [Numeric]
+      def rand(bound = nil)
+        if bound.is_a?(Range)
+          start = bound.begin || 0
+          return rand(bound.end.nil? ? nil : bound.end - start) + start
+        end
+
+        @state = @state * 48_271 % MOD_VAL
+        return @state if bound.nil? || bound.zero?
+
+        @state % bound
+      end
+    end
+
     # Transforms hash keys to be better for displaying the information in the hash
     # @param hash [Hash<#to_s => Object>]
     # @return [Hash<String => Object>] the new hash
-    def self.hash_display_keys(hash)
-      hash.transform_keys { |key| key.to_s.capitalize.gsub("_", " ") }
-    end
+    def self.hash_display_keys(hash) =
+      hash.transform_keys { |key| key.to_s.capitalize.gsub("_", " ") }.compact
 
     # Does a weighted random with a hash,
     # where the keys are elements being randomly selected and the values are the weights

data/lib/hlockey/version.rb

@@ -1,3 +1,3 @@
 module Hlockey
-  VERSION = "6".freeze
+  VERSION = "7".freeze
 end

data/lib/hlockey.rb

@@ -1 +1,16 @@
 require("hlockey/league")
+
+##
+# All Hlockey library code lives here.
+module Hlockey
+  # @return [League]
+  def self.new_current_league
+    league_hash = Data.league
+    league_start_time = Time.utc(*league_hash[:start_time])
+    one_week = 604_800 # In seconds, to add/subtract with Time objects
+
+    return League.new(**Data.infinileague) if Time.now < league_start_time - one_week
+
+    League.new(**league_hash)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hlockey
 version: !ruby/object:Gem::Version
-  version: '6'
+  version: '7'
 platform: ruby
 authors:
 - Lavender Perry
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-30 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -31,9 +31,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - data/election.json
+- data/infinileague.json
 - data/information.json
 - data/league.json
 - data/links.json
+- data/messages.json
 - data/previous_election_results.json
 - lib/hlockey.rb
 - lib/hlockey/actions.rb
@@ -87,8 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Hlockey season 6.
+summary: Hlockey season 7.
 test_files: []