basketball 0.0.14 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f115c20b1dfbaf07e291b7419481f55e089f416963b6edfb6a8d7ceab3d760d1
-  data.tar.gz: 821d8d53808e33a2ee8e47e022e4d6ff041dbd385350563e87ed365595419df5
+  metadata.gz: f5be10590a625ef061cb6f7a80379710013ec3625fe215fa65bfddeda35bb1f5
+  data.tar.gz: 5eff4fd535bddae0bf080f2fd0be83b4cdc8da7cc28c04667a1ec7cfd84f1f55
 SHA512:
-  metadata.gz: cd80e53d23a2379e009c2a554ddc99a807cd0e7e4069b4e69123ca1fccba14bf96d2b422d5f9d347ccd9be90c1a5b5e6d59b9235603f4fe5b9ab4f25ea218846
-  data.tar.gz: ad921f64b359ac4466c5a16cc69c3e989f75ebd0a2a477d81fd3dd5df6db8d8de713be2b56f281b912e5bc02a1b97e5e928b4e0c3cd53da27cb62b8999601282
+  metadata.gz: 41e8aac1b7270794a5557b9e94b3b23bd0f5f7169c5c38f87401eaf12e6865efd4a1b8293a8cf6b6a41813ecc476750f538abc511ae4554e94c3cc732c6a5872
+  data.tar.gz: fd0fcc3117888b9c475efce63e5947de6f66950b3af98af9f4c551403749ab34fc6f989d3b48964bc29180be19c3af55931e5bb4ef67377f05dd83994ab82284

data/.rubocop.yml

@@ -18,6 +18,9 @@ RSpec/ExampleLength:
 RSpec/NestedGroups:
   Max: 5
 
+RSpec/MultipleExpectations:
+  Max: 2
+
 Metrics/ParameterLists:
   Max: 6
 

data/README.md

@@ -12,12 +12,9 @@ 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-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 Repository** | Understands how to save and load Coordinator objects.
 **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.
@@ -25,7 +22,7 @@ Element      | Description
 **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.
+**File System** | Local operating system that repositories can use as their underlying persistence layer.
 **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 Repository** | Understands how to save and load League objects from JSON files on disk.
@@ -37,14 +34,14 @@ Element      | Description
 **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-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 Repository** | Understands how to save and load Room objects.
 **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.
+**Standings Repository** | Understands how to save and load Standings objects.
 **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.
@@ -72,70 +69,6 @@ The input for the main object `Basketball::Draft::Room` is an array of teams (`B
 * **Basketball::Draft::Room#pick!(player)**: Pick an exact player for the current front office.
 * **Basketball::Draft::Room#sim_rest!**: Simulate the rest of the picks.
 
-#### Command Line Interface
-
-This library ships with an example of how the Draft module could be used implemented as a command-line executable script. The script is file-based and will de-serialize into a Room object, execute operations, then serialize and write it back to disk.
-
-###### Generate a Fresh Draft
-
-```zsh
-basketball-draft-room -o tmp/draft.json
-```
-
-###### N Top Available Players
-
-```zsh
-basketball-draft-room -i tmp/draft.json -t 10
-```
-
-###### N Top Available Players for a Position
-
-```zsh
-basketball-draft-room -i tmp/draft.json -t 10 -q PG
-```
-
-###### Output League
-
-```zsh
-basketball-draft-room -i tmp/draft.json -l
-```
-
-###### Output Event Log
-
-```zsh
-basketball-draft-room -i tmp/draft.json -e
-```
-
-###### Simulate N Picks
-
-```zsh
-basketball-draft-room -i tmp/draft.json -s 10
-```
-
-###### Skip N Picks
-
-```zsh
-basketball-draft-room -i tmp/draft.json -x 10
-```
-
-###### Pick Players
-
-```zsh
-basketball-draft-room -i tmp/draft.json -p P-100,P-200,P-300
-```
-
-###### Simulate the Rest of the Draft
-
-```zsh
-basketball-draft-room -i tmp/draft.json -a
-```
-
-###### Help Menu
-
-```zsh
-basketball-draft-room -h
-```
-
 ### Season Module
 
 The Season module knows how to execute a calendar of games for a League and generate results. The main object is the `Basketball::Season::Coordinator` class. Once instantiated there are four main methods:
@@ -143,46 +76,6 @@ The Season module knows how to execute a calendar of games for a League and gene
 * **Basketball::Season::Coordinator#sim!**: Simulate the next day of games.
 * **Basketball::Season::Coordinator#sim_rest!**: Simulate the rest of the games.
 
-#### Command Line Interface
-
-This library ships with an example of how the Season module could be used implemented as a command-line executable script.  The script is file-based and will de-serialize into a Coordinator object, execute operations, then serialize and write it back to disk.
-
-###### Generate Random coordinator
-
-```zsh
-exe/basketball-season-coordinator -o tmp/coordinator.json
-```
-
-###### Sim One Day and Save to New File
-
-```zsh
-exe/basketball-season-coordinator -i tmp/coordinator.json -o tmp/coordinator2.json -d 1
-```
-
-###### Output Event Log
-
-```zsh
-exe/basketball-season-coordinator -i tmp/coordinator.json -e
-```
-
-###### Sim Two Days and Save To Input File
-
-```zsh
-exe/basketball-season-coordinator -i tmp/coordinator.json -d 2
-```
-
-###### Sim Rest of Calendar
-
-```zsh
-exe/basketball-season-coordinator -i tmp/coordinator.json -a
-```
-
-###### Help Menu
-
-```zsh
-basketball-season-coordinator -h
-```
-
 ## Contributing
 
 ### Development Environment Configuration

data/basketball.gemspec

@@ -15,13 +15,7 @@ Gem::Specification.new do |s|
   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.executables = %w[]
   s.homepage = 'https://github.com/mattruggio/basketball'
   s.license  = 'MIT'
   s.metadata = {
@@ -34,6 +28,4 @@ Gem::Specification.new do |s|
   }
 
   s.required_ruby_version = '>= 3.2.1'
-
-  s.add_dependency('slop', '~>4.10')
 end

data/lib/basketball/app/coordinator_repository.rb

@@ -4,8 +4,6 @@ module Basketball
   module App
     # Knows how to flatten a Coordinator instance and rehydrate one from JSON and/or a Ruby hash.
     class CoordinatorRepository < DocumentRepository
-      include LeagueSerializable
-
       GAME_CLASSES = {
         'Exhibition' => Season::Exhibition,
         'Regular' => Season::Regular
@@ -19,8 +17,7 @@ module Basketball
         Season::Coordinator.new(
           calendar: deserialize_calendar(hash[:calendar]),
           current_date: Date.parse(hash[:current_date]),
-          results: deserialize_results(hash[:results]),
-          league: deserialize_league(hash[:league])
+          results: deserialize_results(hash[:results])
         )
       end
 
@@ -29,8 +26,7 @@ module Basketball
           id: coordinator.id,
           calendar: serialize_calendar(coordinator.calendar),
           current_date: coordinator.current_date.to_s,
-          results: serialize_results(coordinator.results),
-          league: serialize_league(coordinator.league)
+          results: serialize_results(coordinator.results)
         }
       end
 

data/lib/basketball/app/league_repository.rb

@@ -2,10 +2,8 @@
 
 module Basketball
   module App
-    # Knows how to flatten a League instance and rehydrate one from JSON and/or a Ruby hash.
+    # Knows how to flatten a League instances and rehydrate one from JSON and/or a Ruby hash.
     class LeagueRepository < DocumentRepository
-      include LeagueSerializable
-
       private
 
       def from_h(hash)
@@ -15,6 +13,97 @@ module Basketball
       def to_h(league)
         serialize_league(league)
       end
+
+      # Serialization
+
+      def serialize_league(league)
+        {
+          id: league.id,
+          conferences: serialize_conferences(league.conferences)
+        }
+      end
+
+      def serialize_conferences(conferences)
+        conferences.map do |conference|
+          {
+            id: conference.id,
+            divisions: serialize_divisions(conference.divisions)
+          }
+        end
+      end
+
+      def serialize_divisions(divisions)
+        divisions.map do |division|
+          {
+            id: division.id,
+            teams: serialize_teams(division.teams)
+          }
+        end
+      end
+
+      def serialize_teams(teams)
+        teams.map do |team|
+          {
+            id: team.id,
+            players: serialize_players(team.players)
+          }
+        end
+      end
+
+      def serialize_players(players)
+        players.map do |player|
+          {
+            id: player.id,
+            overall: player.overall,
+            position: player.position&.code
+          }
+        end
+      end
+
+      # Deserialization
+
+      def deserialize_league(league_hash)
+        Org::League.new(
+          conferences: deserialize_conferences(league_hash[:conferences])
+        )
+      end
+
+      def deserialize_conferences(conference_hashes)
+        (conference_hashes || []).map do |conference_hash|
+          Org::Conference.new(
+            id: conference_hash[:id],
+            divisions: deserialize_divisions(conference_hash[:divisions])
+          )
+        end
+      end
+
+      def deserialize_divisions(division_hashes)
+        (division_hashes || []).map do |division_hash|
+          Org::Division.new(
+            id: division_hash[:id],
+            teams: deserialize_teams(division_hash[:teams])
+          )
+        end
+      end
+
+      def deserialize_teams(team_hashes)
+        (team_hashes || []).map do |team_hash|
+          Org::Team.new(
+            id: team_hash[:id],
+            players: deserialize_players(team_hash[:players])
+          )
+        end
+      end
+
+      def deserialize_players(player_hashes)
+        (player_hashes || []).map do |player_hash|
+          Org::Player.new(
+            id: player_hash[:id],
+            overall: player_hash[:overall],
+            position: Org::Position.new(player_hash[:position])
+          )
+        end
+      end
     end
   end
 end

data/lib/basketball/app/room_repository.rb

@@ -2,7 +2,7 @@
 
 module Basketball
   module App
-    # Can load and save Room objects to JSON files.
+    # Can load and save Room objects as JSON Documents.
     class RoomRepository < DocumentRepository
       PICK_EVENT = 'Pick'
       SKIP_EVENT = 'Skip'
@@ -26,6 +26,7 @@ module Basketball
 
       def to_h(room)
         {
+          id: room.id,
           rounds: room.rounds,
           front_offices: room.front_offices.map { |fo| serialize_front_office(fo) },
           players: room.players.map { |p| serialize_player(p) },

data/lib/basketball/app/standings_repository.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Basketball
+  module App
+    # Can load and save Standings objects as JSON Documents.
+    class StandingsRepository < DocumentRepository
+      private
+
+      def from_h(hash)
+        Season::Standings.new(
+          records: deserialize_records(hash[:records])
+        )
+      end
+
+      def to_h(standings)
+        {
+          id: standings.id,
+          records: serialize_records(standings.records)
+        }
+      end
+
+      # Serialization
+
+      def serialize_records(records)
+        (records || []).map do |record|
+          {
+            id: record.id,
+            details: serialize_details(record.details)
+          }
+        end
+      end
+
+      def serialize_details(details)
+        (details || []).map do |detail|
+          {
+            date: detail.date.to_s,
+            home: detail.home,
+            opponent: detail.opponent.id,
+            opponent_score: detail.opponent_score,
+            score: detail.score
+          }
+        end
+      end
+
+      # Deserialization
+
+      def deserialize_records(record_hashes)
+        (record_hashes || []).map do |record_hash|
+          Season::Record.new(
+            id: record_hash[:id],
+            details: deserialize_details(record_hash[:details])
+          )
+        end
+      end
+
+      def deserialize_details(detail_hashes)
+        (detail_hashes || []).map do |detail_hash|
+          Season::Detail.new(
+            date: Date.parse(detail_hash[:date]),
+            home: detail_hash[:home],
+            opponent: Season::Opponent.new(id: detail_hash[:opponent]),
+            opponent_score: detail_hash[:opponent_score].to_i,
+            score: detail_hash[:score].to_i
+          )
+        end
+      end
+    end
+  end
+end

data/lib/basketball/app.rb

@@ -4,9 +4,6 @@
 require_relative 'app/file_store'
 require_relative 'app/in_memory_store'
 
-# Serialization
-require_relative 'app/league_serializable'
-
 # Repositories / Common
 require_relative 'app/document_repository'
 
@@ -14,7 +11,4 @@ require_relative 'app/document_repository'
 require_relative 'app/coordinator_repository'
 require_relative 'app/league_repository'
 require_relative 'app/room_repository'
-
-# Controllers
-require_relative 'app/coordinator_cli'
-require_relative 'app/room_cli'
+require_relative 'app/standings_repository'

data/lib/basketball/org/league.rb

@@ -90,8 +90,6 @@ module Basketball
         other_divisions.flat_map(&:teams)
       end
 
-      private
-
       def team_for(id)
         teams.find { |team| team.id == id }
       end

data/lib/basketball/season/coordinator.rb

@@ -11,14 +11,12 @@ module Basketball
       class OutOfBoundsError < StandardError; end
       class PlayedGamesError < StandardError; end
       class UnknownGameError < StandardError; end
-      class UnknownTeamError < StandardError; end
       class UnplayedGamesError < StandardError; end
 
       attr_reader :calendar,
                   :current_date,
                   :arena,
-                  :results,
-                  :league
+                  :results
 
       def_delegators :calendar,
                      :exhibition_start_date,
@@ -30,37 +28,29 @@ module Basketball
                      :regulars_for,
                      :games_for
 
-      def initialize(
-        calendar:,
-        current_date:,
-        results: [],
-        league: Org::League.new
-      )
+      def initialize(calendar:, current_date:, results: [])
         super()
 
         raise ArgumentError, 'calendar is required' unless calendar
         raise ArgumentError, 'current_date is required' if current_date.to_s.empty?
-        raise ArgumentError, 'league is required' unless league
 
         @calendar     = calendar
         @current_date = current_date
         @arena        = Arena.new
         @results      = []
-        @league       = league
 
         results.each { |result| replay!(result) }
 
         assert_current_date
         assert_all_past_dates_are_played
         assert_all_future_dates_arent_played
-        assert_all_known_teams
       end
 
-      def sim_rest!(&)
+      def sim_rest!(league, &)
         events = []
 
         while not_done?
-          new_events = sim!(&)
+          new_events = sim!(league, &)
 
           events += new_events
         end
@@ -78,15 +68,17 @@ module Basketball
         raise OutOfBoundsError, "current date #{current_date} should be on or after #{exhibition_start_date}"
       end
 
-      def sim!
+      def sim!(league)
+        raise ArgumentError, 'league is required' unless league
+
         return [] if done?
 
         events = []
         games  = games_for(date: current_date)
 
         games.each do |game|
-          home_players = opponent_team(game.home_opponent).players
-          away_players = opponent_team(game.away_opponent).players
+          home_players = opponent_team(league, game.home_opponent).players
+          away_players = opponent_team(league, game.away_opponent).players
           matchup      = Matchup.new(game:, home_players:, away_players:)
           event        = arena.play(matchup)
 
@@ -140,7 +132,6 @@ module Basketball
 
       def add!(game)
         assert_today_or_in_future(game)
-        assert_known_teams(game)
 
         calendar.add!(game)
 
@@ -165,7 +156,7 @@ module Basketball
 
       attr_writer :arena
 
-      def opponent_team(opponent)
+      def opponent_team(league, opponent)
         league.teams.find { |t| t == opponent }
       end
 
@@ -191,14 +182,6 @@ module Basketball
         raise OutOfBoundsError, "#{game.date} is on or before the current date (#{current_date})"
       end
 
-      def assert_known_teams(game)
-        raise UnknownTeamError, "unknown opponent: #{game.home_opponent}" unless league.team?(game.home_opponent)
-
-        return if league.team?(game.away_opponent)
-
-        raise UnknownTeamError, "unknown opponent: #{game.away_opponent}"
-      end
-
       def assert_all_past_dates_are_played
         games_that_should_be_played = games.select { |game| game.date < current_date }
 
@@ -237,10 +220,6 @@ module Basketball
 
         result
       end
-
-      def assert_all_known_teams
-        calendar.games.each { |game| assert_known_teams(game) }
-      end
     end
   end
 end

data/lib/basketball/season/record.rb

@@ -8,7 +8,7 @@ module Basketball
       class DetailAlreadyAddedError < StandardError; end
       class OpponentNotFoundError < StandardError; end
 
-      def initialize(id:)
+      def initialize(id:, details: [])
         super(id)
 
         @details_by_date = {}
@@ -53,9 +53,15 @@ module Basketball
       end
 
       def win_percentage
+        return 0 unless game_count.positive?
+
         (win_count.to_f / game_count).round(3)
       end
 
+      def win_percentage_display
+        format('%.3f', win_percentage)
+      end
+
       def game_count
         details.length
       end
@@ -69,17 +75,13 @@ module Basketball
       end
 
       def to_s
-        "[#{super}] #{win_count}-#{loss_count} (#{win_percentage})"
+        "[#{super}] #{win_count}-#{loss_count} (#{win_percentage_display})"
       end
 
       def <=>(other)
         [win_count, win_percentage] <=> [other.win_count, other.win_percentage]
       end
 
-      private
-
-      attr_reader :details_by_date
-
       def add!(detail)
         raise DetailAlreadyAddedError, "#{detail} already added for date" if detail_for(detail.date)
 
@@ -87,6 +89,10 @@ module Basketball
 
         self
       end
+
+      private
+
+      attr_reader :details_by_date
     end
   end
 end

data/lib/basketball/season/standings.rb

@@ -3,18 +3,29 @@
 module Basketball
   module Season
     # Represents a League with each team's win/loss details.
-    class Standings
+    class Standings < Entity
       class TeamAlreadyRegisteredError < StandardError; end
       class TeamNotRegisteredError < StandardError; end
 
-      def initialize
+      def initialize(records: [])
+        super()
+
         @records_by_id = {}
+
+        records.each { |record| add!(record) }
       end
 
-      def register!(team)
-        raise TeamAlreadyRegisteredError, "#{team} already registered!" if team?(team)
+      def add!(record)
+        raise ArgumentError, 'record is required' unless record
+        raise TeamAlreadyRegisteredError, "#{team} already registered!" if team?(record)
+
+        records_by_id[record.id] = record
 
-        records_by_id[team.id] = Record.new(id: team.id)
+        self
+      end
+
+      def register!(team)
+        add!(Record.new(id: team.id))
 
         self
       end

data/lib/basketball/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Basketball
-  VERSION = '0.0.14'
+  VERSION = '0.0.16'
 end

data/lib/basketball.rb

@@ -4,7 +4,6 @@ require 'date'
 require 'fileutils'
 require 'forwardable'
 require 'json'
-require 'slop'
 
 # Generic
 require_relative 'basketball/entity'