basketball 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab187320b9735e8bc6ace40a171cbc9fecd27058e78e5ee18ab1b663b6ea3d54
-  data.tar.gz: 6173d1bfdb1b531d54763d369f248944c532916e5fecac89698ac4f49a72e4d9
+  metadata.gz: 95fd9cb9bb1c51ed7a76e5640f5297ea463b412803bcfacf8c47ea8b9abc5b21
+  data.tar.gz: 726e72b88fd8c81a30bfb4e47742e07fd97ba88fd86d9695852b0733ee6c0e5f
 SHA512:
-  metadata.gz: df618bc45b196219e9f607a1842f5fda8513ea4dc7bce54756c98a327b87c9905bf41ded2c3dbf04cc70459d06ea4ab76864ff02713ecc2cf400e959cda081a6
-  data.tar.gz: 536c2f5fff03419da03604302743b6ec0fccde9957238a0ae4c71c8b560b1709e3460afbc18e0fc377f239c20f4fb82fbb5e2d184b45f60c05d974d4f8615894
+  metadata.gz: b00a86aca794ea7b1ccbba172bc0fd63cfbbf4b8ff5eee2a7763f3877d8669a2b23141109fbf78461d9bd5b475e6a758381cc24c3a5d0e8b2e6dcb17f69e97bf
+  data.tar.gz: 5b8d75ca8cb88dc6733d1453d485a9fe8842a2e98d601f3870837bf3197718d181b77a475960202320be2d92a651ed5d741719e1d90882984d6286f629d2cd6d

data/README.md

@@ -12,30 +12,40 @@ Element      | Description
 :------------ | :-----------
 **Arena** | Determines exhibition and regular season game outcomes.
 **Assessment** | When the Room needs to know who a Front Office wants to select, the Room will send the Front Office an Assessment. The Assessment is a report of where the team currently stands: players picked, players available, and round information.
-**basketball-room** | Command-line executable script illustrating an example of how to subclass and consume the drafting module.
-**Calendar** | Stores important boundary dates (preseason start, preseason end, season start, and season end).
-**Coordinator CLI** | Underlying Ruby class that powers the `basketball-coordinator` script. Basically a terminal wrapper over the Coordinator object.
+**basketball-draft-room** | Command-line executable script showing an example of how to consume the draft room aggregate root.
+**basketball-season-coordinator** | Command-line executable script showing an example of how to consume the season coordinator aggregate root.
+**Calendar** | Stores important boundary dates (exhibition start, exhibition end, season start, and season end).
+**Conference** | A collection of Divisions.
+**Coordinator CLI** | Underlying Ruby class that powers the `basketball-season-coordinator` script. Basically a terminal wrapper over the Coordinator object.
 **Coordinator Repository** | Understands how to save and load Coordinator objects from JSON files on disk.
 **Coordinator** | Object which can take a League, Calendar, Games, and an Arena and provide an iterable interface to enumerate through days and simulate games as results.
+**Detail** | Re-representation of a Result object but from a specific team's perspective.
+**Division** | A collection of teams.
 **Draft** | Bounded context (sub-module) dealing with running a round-robin player draft for teams.
 **Exhibition** | Pre-season game which has no impact to team record.
 **External Dependency** | Some outside system which this library or portions of this library are dependent on.
+**File Store** | Implements a store that can interact with the underlying File System.
 **File System** | Local operating system that the CLI will use for persistence.
 **Front Office** | Identifiable as a team, contains logic for how to auto-pick draft selections.  Meant to be subclassed and extended to include more intricate player selection logic as the base will simply randomly select a player.
 **Game** | Matches up a date with two teams (home and away) to represent a coordinatord match-up.
-**League** | Describes a league in terms of structure composed of teams and players.
+**League Repository** | Understands how to save and load League objects from JSON files on disk.
+**League** | Describes a league in terms of structure composed of conferences, divisions, teams, and players.
 **Match** | When the Coordinator needs an Arena instance to select a game winner, it will send the Arena a Match. A match is Game but also includes the active roster (players) for both teams that will participate in the game.
 **Org** | Bounded context (sub-module) dealing with overall organizational structure of a sports assocation.
 **Pick** | Result event emitted when a player is automatically or manually selected.
 **Player** | Identitiable as a person able to be drafted.  Meant to be subclassed and extended to include more intricate descriptions of a specific sport player, such as abilities, ratings, and statistics.  Right now it has none of these types of traits and it meant to only serve as the base with only an overall attribute.
+**Record** | Represents a team's overall record.
 **Regular** | Game that counts towards regular season record.
 **Result** | The outcome of a game (typically with a home and away score).
-**Room CLI** | Underlying Ruby class that powers the `basketball-room` script. Basically a terminal wrapper for the Room object.
+**Room CLI** | Underlying Ruby class that powers the `basketball-draft-room` script. Basically a terminal wrapper for the Room object.
 **Room Repository** | Understands how to save and load Room objects from JSON files on disk.
 **Room** | Main object responsible for providing an iterable interface capable of executing a draft, pick by pick.
+**Scheduler** | Knows how to take a League and a year and generate a game-populated calendar.
 **Scout** | Knows how to stack rank lists of players.
 **Season** | Bounded context (sub-module) dealing with calendar and matchup generation.
 **Skip** | Result event emitted when a front office decides to skip a round.
+**Standings** | Synthesizes teams and results into team standings with win/loss records and more.
+**Store** | Interface for the underlying Repository persistence layer.  While a Document Repository is mainly responsible for serialization/de-serialization, the store actually knows how to read/write the data.
 **Team Group** | Set of rosters that together form a cohesive league.
 **Team** | Member of a league and signs players.  Has games assigned and played.
 
@@ -69,61 +79,61 @@ This library ships with an example of how the Draft module could be used impleme
 ###### Generate a Fresh Draft
 
 ```zsh
-basketball-room -o tmp/draft.json
+basketball-draft-room -o tmp/draft.json
 ```
 
 ###### N Top Available Players
 
 ```zsh
-basketball-room -i tmp/draft.json -t 10
+basketball-draft-room -i tmp/draft.json -t 10
 ```
 
 ###### N Top Available Players for a Position
 
 ```zsh
-basketball-room -i tmp/draft.json -t 10 -q PG
+basketball-draft-room -i tmp/draft.json -t 10 -q PG
 ```
 
 ###### Output League
 
 ```zsh
-basketball-room -i tmp/draft.json -l
+basketball-draft-room -i tmp/draft.json -l
 ```
 
 ###### Output Event Log
 
 ```zsh
-basketball-room -i tmp/draft.json -e
+basketball-draft-room -i tmp/draft.json -e
 ```
 
 ###### Simulate N Picks
 
 ```zsh
-basketball-room -i tmp/draft.json -s 10
+basketball-draft-room -i tmp/draft.json -s 10
 ```
 
 ###### Skip N Picks
 
 ```zsh
-basketball-room -i tmp/draft.json -x 10
+basketball-draft-room -i tmp/draft.json -x 10
 ```
 
 ###### Pick Players
 
 ```zsh
-basketball-room -i tmp/draft.json -p P-100,P-200,P-300
+basketball-draft-room -i tmp/draft.json -p P-100,P-200,P-300
 ```
 
 ###### Simulate the Rest of the Draft
 
 ```zsh
-basketball-room -i tmp/draft.json -a
+basketball-draft-room -i tmp/draft.json -a
 ```
 
 ###### Help Menu
 
 ```zsh
-basketball-room -h
+basketball-draft-room -h
 ```
 
 ### Season Module
@@ -140,37 +150,37 @@ This library ships with an example of how the Season module could be used implem
 ###### Generate Random coordinator
 
 ```zsh
-exe/basketball-coordinator -o tmp/coordinator.json
+exe/basketball-season-coordinator -o tmp/coordinator.json
 ```
 
 ###### Sim One Day and Save to New File
 
 ```zsh
-exe/basketball-coordinator -i tmp/coordinator.json -o tmp/coordinator2.json -d 1
+exe/basketball-season-coordinator -i tmp/coordinator.json -o tmp/coordinator2.json -d 1
 ```
 
 ###### Output Event Log
 
 ```zsh
-exe/basketball-coordinator -i tmp/coordinator.json -e
+exe/basketball-season-coordinator -i tmp/coordinator.json -e
 ```
 
 ###### Sim Two Days and Save To Input File
 
 ```zsh
-exe/basketball-coordinator -i tmp/coordinator.json -d 2
+exe/basketball-season-coordinator -i tmp/coordinator.json -d 2
 ```
 
 ###### Sim Rest of Calendar
 
 ```zsh
-exe/basketball-coordinator -i tmp/coordinator.json -a
+exe/basketball-season-coordinator -i tmp/coordinator.json -a
 ```
 
 ###### Help Menu
 
 ```zsh
-basketball-coordinator -h
+basketball-season-coordinator -h
 ```
 
 ## Contributing

data/basketball.gemspec

@@ -11,14 +11,20 @@ Gem::Specification.new do |s|
     This library is meant to serve as the domain for a basketball league/season simulator/turn-based game. It models core ideas such as: players, general managers, draft strategy, drafting, season generation, season simultation, playoff generation, playoff simulation, and more.
   DESC
 
-  s.authors     = ['Matthew Ruggio']
-  s.email       = ['mattruggio@icloud.com']
-  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|bin|docs|spec)/}) }
-  s.bindir      = 'exe'
-  s.executables = %w[basketball-coordinator basketball-room]
-  s.homepage    = 'https://github.com/mattruggio/basketball'
-  s.license     = 'MIT'
-  s.metadata    = {
+  s.authors = ['Matthew Ruggio']
+  s.email   = ['mattruggio@icloud.com']
+  s.files   = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|bin|docs|spec)/}) }
+  s.bindir  = 'exe'
+
+  s.executables = %w[
+    basketball
+    basketball-season-coordinator
+    basketball-draft-room
+  ]
+
+  s.homepage = 'https://github.com/mattruggio/basketball'
+  s.license  = 'MIT'
+  s.metadata = {
     'bug_tracker_uri' => 'https://github.com/mattruggio/basketball/issues',
     'changelog_uri' => 'https://github.com/mattruggio/basketball/blob/main/CHANGELOG.md',
     'documentation_uri' => 'https://www.rubydoc.info/gems/basketball',

data/exe/basketball

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'basketball'
+
+# This is an example integration script tying all the contexts together.
+# This is definitely subject to change as this library gets extended further.
+
+store                  = Basketball::App::FileStore.new
+room_repository        = Basketball::App::RoomRepository.new(store)
+league_repository      = Basketball::App::LeagueRepository.new(store)
+coordinator_repository = Basketball::App::CoordinatorRepository.new(store)
+scheduler              = Basketball::Season::Scheduler.new
+
+seed_path  = ARGV[0].to_s.empty? ? File.join('spec', 'fixtures', 'seed.json') : ARGV[0]
+output_dir = ARGV[1].to_s.empty? ? 'tmp' : ARGV[1]
+seed       = JSON.parse(File.read(seed_path), symbolize_names: true)
+
+league_path = File.join(output_dir, '00-league.json')
+
+File.write(league_path, seed[:league].to_json)
+
+front_offices = seed.dig(:league, :conferences).flat_map do |c|
+  c[:divisions].flat_map do |d|
+    d[:teams].flat_map do |t|
+      { id: t[:id] }
+    end
+  end
+end
+
+room = {
+  rounds: 12,
+  front_offices:,
+  players: seed[:players]
+}
+
+room_input_path = File.join(output_dir, '01-room-input.json')
+
+File.write(room_input_path, room.to_json)
+
+room = room_repository.load(room_input_path)
+
+room.sim_rest!
+
+room_output_path = File.join(output_dir, '02-room-output.json')
+
+room_repository.save(room_output_path, room)
+
+league = league_repository.load(league_path)
+
+room.teams.each do |team|
+  team.players.each do |player|
+    league.sign!(team:, player:)
+  end
+end
+
+scheduler_input_path = File.join(output_dir, '03-scheduler-input.json')
+
+league_repository.save(scheduler_input_path, league)
+
+calendar     = scheduler.schedule(league:)
+current_date = calendar.exhibition_start_date
+coordinator  = Basketball::Season::Coordinator.new(league:, calendar:, current_date:)
+
+coordinator_input_path = File.join(output_dir, '04-coordinator-input.json')
+
+coordinator_repository.save(coordinator_input_path, coordinator)
+
+coordinator.sim_rest!
+
+coordinator_output_path = File.join(output_dir, '05-coordinator-output.json')
+
+coordinator_repository.save(coordinator_output_path, coordinator)
+
+preseason_standings = Basketball::Season::Standings.new
+season_standings = Basketball::Season::Standings.new
+
+league.teams.each do |team|
+  preseason_standings.register!(team)
+  season_standings.register!(team)
+end
+
+coordinator.exhibition_results.each { |result| preseason_standings.accept!(result) }
+coordinator.regular_results.each    { |result| season_standings.accept!(result) }
+
+puts 'Preseason Standings'
+puts preseason_standings
+puts '--------------------------------------------'
+puts 'Season Standings'
+puts season_standings

data/lib/basketball/app/coordinator_cli.rb

@@ -3,20 +3,27 @@
 module Basketball
   module App
     # Examples:
-    #   exe/basketball-coordinator -o tmp/coordinator.json
-    #   exe/basketball-coordinator -i tmp/coordinator.json -o tmp/coordinator2.json -d 1
-    #   exe/basketball-coordinator -i tmp/coordinator2.json -e
-    #   exe/basketball-coordinator -i tmp/coordinator2.json -o tmp/coordinator2.json -d 2
-    #   exe/basketball-coordinator -i tmp/coordinator2.json -a
+    #   exe/basketball-season-coordinator -o tmp/coordinator.json
+    #   exe/basketball-season-coordinator -i tmp/coordinator.json -o tmp/coordinator2.json -d 1
+    #   exe/basketball-season-coordinator -i tmp/coordinator2.json -e
+    #   exe/basketball-season-coordinator -i tmp/coordinator2.json -o tmp/coordinator2.json -d 2
+    #   exe/basketball-season-coordinator -i tmp/coordinator2.json -a
     #
-    #   exe/basketball-coordinator -o tmp/coordinator.json -ae
+    #   exe/basketball-season-coordinator -o tmp/coordinator.json -ae
     class CoordinatorCLI
-      attr_reader :opts, :io, :repository
+      attr_reader :opts, :io, :coordinator_repository
 
-      def initialize(args:, io: $stdout)
-        @io         = io
-        @opts       = slop_parse(args)
-        @repository = CoordinatorRepository.new
+      def initialize(
+        args:,
+        io: $stdout,
+        coordinator_repository: CoordinatorRepository.new(FileStore.new)
+      )
+        raise ArgumentError, 'coordinator_repository is required' unless coordinator_repository
+        raise ArgumentError, 'io is required'                     unless io
+
+        @io                     = io
+        @opts                   = slop_parse(args)
+        @coordinator_repository = coordinator_repository
 
         if no_input? && no_output?
           io.puts('Input and/or output paths are required.')
@@ -49,7 +56,7 @@ module Basketball
         else
           io.puts("#{coordinator.days_left} Remaining day(s) (#{coordinator.total_days} total)")
           io.puts("Currently on: #{coordinator.current_date}")
-          io.puts("#{coordinator.exhibitions_left} Remaining preseason (#{coordinator.total_exhibitions} total)")
+          io.puts("#{coordinator.exhibitions_left} Remaining exhibition (#{coordinator.total_exhibitions} total)")
           io.puts("#{coordinator.regulars_left} Remaining season (#{coordinator.total_regulars} total)")
         end
       end
@@ -92,74 +99,51 @@ module Basketball
       def write(coordinator)
         path = output? ? output : input
 
-        repository.save(path, coordinator)
+        coordinator_repository.save(path, coordinator)
 
         path
       end
 
-      def make_league(team_count: 2, players_per_team_count: 4)
-        Org::League.new.tap do |league|
-          team_count.times do |i|
-            team = Org::Team.new(id: "T-#{i}")
-
-            players_per_team_count.times do |j|
-              player = Org::Player.new(
-                id: "T-#{i}-P-#{j}",
-                overall: rand(20..100),
-                position: Org::Position.random
-              )
-
-              team.sign!(player)
-            end
-
-            league.register!(team)
+      def make_league
+        Org::League.new(
+          conferences: 2.times.map do |i|
+            conference_id = "C#{i}"
+
+            Org::Conference.new(
+              id: conference_id,
+              divisions: 3.times.map do |j|
+                division_id = "#{conference_id}-D#{j}"
+
+                Org::Division.new(
+                  id: division_id,
+                  teams: 5.times.map do |k|
+                    team_id = "#{division_id}-T#{k}"
+
+                    Org::Team.new(
+                      id: team_id,
+                      players: 12.times.map do |l|
+                        player_id = "#{team_id}-P#{l}"
+
+                        Org::Player.new(
+                          id: player_id,
+                          overall: rand(20..100),
+                          position: Org::Position.random
+                        )
+                      end
+                    )
+                  end
+                )
+              end
+            )
           end
-        end
-      end
-
-      def make_calendar(league:)
-        preseason_start_date = Date.new(2000, 1, 1)
-        season_start_date = Date.new(2000, 1, 11)
-
-        exhibitions = make_games(
-          start_date: preseason_start_date,
-          count: 10,
-          league:,
-          game_class: Season::Exhibition
         )
-
-        regulars = make_games(
-          start_date: season_start_date,
-          count: 10,
-          league:,
-          game_class: Season::Regular
-        )
-
-        Season::Calendar.new(
-          preseason_start_date:,
-          preseason_end_date: Date.new(2000, 1, 10),
-          season_start_date:,
-          season_end_date: Date.new(2000, 1, 20),
-          games: exhibitions + regulars
-        )
-      end
-
-      def make_games(start_date:, count:, league:, game_class:)
-        count.times.map do |i|
-          home_team, away_team = league.teams.sample(2)
-
-          game_class.new(
-            date: start_date + i,
-            home_opponent: Season::Opponent.new(id: home_team.id),
-            away_opponent: Season::Opponent.new(id: away_team.id)
-          )
-        end
       end
 
       def make_coordinator
         league       = make_league
-        current_date = Date.new(2000, 1, 1)
-        calendar     = make_calendar(league:)
+        year         = Time.now.year
+        calendar     = Season::Scheduler.new.schedule(league:, year:)
+        current_date = calendar.games.min_by(&:date).date
 
         Season::Coordinator.new(
           calendar:,
@@ -173,7 +157,7 @@ module Basketball
           if input?
             io.puts("Coordinator loaded from: #{input}")
 
-            repository.load(input)
+            coordinator_repository.load(input)
           else
             io.puts('Input path was not provided, generating fresh coordinator')
 
@@ -220,7 +204,7 @@ module Basketball
 
       def slop_parse(args)
         Slop.parse(args) do |o|
-          o.banner = 'Usage: basketball-coordinator [options] ...'
+          o.banner = 'Usage: basketball-season-coordinator [options] ...'
 
           input_description = <<~DESC
             Path to load the Coordinator from. If omitted then a new coordinator will be created.

data/lib/basketball/app/coordinator_repository.rb

@@ -3,7 +3,9 @@
 module Basketball
   module App
     # Knows how to flatten a Coordinator instance and rehydrate one from JSON and/or a Ruby hash.
-    class CoordinatorRepository
+    class CoordinatorRepository < DocumentRepository
+      include LeagueSerializable
+
       GAME_CLASSES = {
         'Exhibition' => Season::Exhibition,
         'Regular' => Season::Regular
@@ -11,46 +13,8 @@ module Basketball
 
       private_constant :GAME_CLASSES
 
-      attr_reader :store
-
-      def initialize(store: FileStore.new)
-        super()
-
-        @store = store
-
-        freeze
-      end
-
-      def load(path)
-        contents = store.read(path)
-
-        deserialize(contents).tap do |coordinator|
-          coordinator.send('id=', path)
-        end
-      end
-
-      def save(path, coordinator)
-        contents = serialize(coordinator)
-
-        store.write(path, contents)
-
-        coordinator.send('id=', path)
-
-        coordinator
-      end
-
       private
 
-      def deserialize(string)
-        hash = JSON.parse(string, symbolize_names: true)
-
-        from_h(hash)
-      end
-
-      def serialize(object)
-        to_h(object).to_json
-      end
-
       def from_h(hash)
         Season::Coordinator.new(
           calendar: deserialize_calendar(hash[:calendar]),
@@ -62,6 +26,7 @@ module Basketball
 
       def to_h(coordinator)
         {
+          id: coordinator.id,
           calendar: serialize_calendar(coordinator.calendar),
           current_date: coordinator.current_date.to_s,
           results: serialize_results(coordinator.results),
@@ -71,24 +36,16 @@ module Basketball
 
       # Serialization
 
-      def serialize_player(player)
-        {
-          id: player.id,
-          overall: player.overall,
-          position: player.position&.code
-        }
-      end
-
       def serialize_games(games)
         games.map { |game| serialize_game(game) }
       end
 
       def serialize_calendar(calendar)
         {
-          preseason_start_date: calendar.preseason_start_date.to_s,
-          preseason_end_date: calendar.preseason_end_date.to_s,
-          season_start_date: calendar.season_start_date.to_s,
-          season_end_date: calendar.season_end_date.to_s,
+          exhibition_start_date: calendar.exhibition_start_date.to_s,
+          exhibition_end_date: calendar.exhibition_end_date.to_s,
+          regular_start_date: calendar.regular_start_date.to_s,
+          regular_end_date: calendar.regular_end_date.to_s,
           games: serialize_games(calendar.games)
         }
       end
@@ -110,19 +67,6 @@ module Basketball
         }
       end
 
-      def serialize_league(league)
-        {
-          teams: league.teams.map { |team| serialize_team(team) }
-        }
-      end
-
-      def serialize_team(team)
-        {
-          id: team.id,
-          players: team.players.map { |player| serialize_player(player) }
-        }
-      end
-
       def serialize_results(results)
         results.map do |result|
           serialize_result(result)
@@ -131,32 +75,12 @@ module Basketball
 
       # Deserialization
 
-      def deserialize_player(player_hash)
-        Org::Player.new(
-          id: player_hash[:id],
-          overall: player_hash[:overall],
-          position: Org::Position.new(player_hash[:position])
-        )
-      end
-
-      def deserialize_league(league_hash)
-        team_hashes = league_hash[:teams] || []
-
-        teams = team_hashes.map do |team_hash|
-          players = (team_hash[:players] || []).map { |player_hash| deserialize_player(player_hash) }
-
-          Org::Team.new(id: team_hash[:id], players:)
-        end
-
-        Org::League.new(teams:)
-      end
-
       def deserialize_calendar(calendar_hash)
         Season::Calendar.new(
-          preseason_start_date: Date.parse(calendar_hash[:preseason_start_date]),
-          preseason_end_date: Date.parse(calendar_hash[:preseason_end_date]),
-          season_start_date: Date.parse(calendar_hash[:season_start_date]),
-          season_end_date: Date.parse(calendar_hash[:season_end_date]),
+          exhibition_start_date: Date.parse(calendar_hash[:exhibition_start_date]),
+          exhibition_end_date: Date.parse(calendar_hash[:exhibition_end_date]),
+          regular_start_date: Date.parse(calendar_hash[:regular_start_date]),
+          regular_end_date: Date.parse(calendar_hash[:regular_end_date]),
           games: deserialize_games(calendar_hash[:games])
         )
       end