basketball 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ab0cd4aa4e2bb10d0a9640e18a756938fbe749842abdbbda9be9f2023be9cf
-  data.tar.gz: 5d216901cadb3c92d41a1e445956aef4a11fc1d3e418430003d050693c43d3be
+  metadata.gz: 262751c76037e2859937529aa23bdd456fd77779a090ed4e844830c428b09e75
+  data.tar.gz: 1a904f317fc3c1becfc381155a089d2ed0b041b60d358c1325459a363e6ce0ec
 SHA512:
-  metadata.gz: a3812684e58e97711745e31a8696c12c32c79e542661302db86eb7b0fecc3784ede1650ec2d0079b66a641f5e09da657f22f596583630d932e03e55ba7ed3514
-  data.tar.gz: f1edd69f31a2ff8ca4d5e53bab9bd59c74a091ab276db1a53901aa1e7de17202898ba01a917304f1e7018da1b3ad129fb012a3ac12516e832f4b8fa6cb8cd232
+  metadata.gz: 913504954c8c053fac3147468433d12b02ad5d6a7badc563587668c4d3943b898c49c951d69c393affc5f5e07d54257a5a004184e55a73f435af01344afa6baf
+  data.tar.gz: 791e48aa9711e33e29b994d0e811a735def017de757bc02c8f348b57f2ce0a42c1e5fbbd6737ed2525ddd9fbf3698c9fb77be991208a1b927e4b27063a2b9f04

data/CHANGELOG.md

@@ -1,8 +1,16 @@
+#### 0.0.6 - May 11th, 2023
+
+* Added Scheduling module that can generate full schedules for entire league.
+* Drafting::Event does not have identity anymore (no current tangible benefit).
+
+#### 0.0.5 - May 5th, 2023
+
+* Remove the notion of Team in favor of a flat front office.
 #### 0.0.4 - May 5th, 2023
 
 * Add ability to skip draft picks using `Basketball::Drafting::Engine#skip!`
-* Add ability to output event full drafting event log using CLI: `exe/basketball-draft -i tmp/draft-wip.json -l`
-* Add ability to skip draft picks using CLI: `exe/basketball-draft -i tmp/draft-wip.json -x 1`
+* Add ability to output event full drafting event log using CLI: `basketball-draft -i tmp/draft-wip.json -l`
+* Add ability to skip draft picks using CLI: `basketball-draft -i tmp/draft-wip.json -x 1`
 
 #### 0.0.3 - May 5th, 2023
 

data/CODE_OF_CONDUCT.md

@@ -56,7 +56,7 @@ further defined and clarified by project maintainers.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported. All complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
+is deemed necessary and appropriate to the circumstances. The project front_office is
 obligated to maintain confidentiality with regard to the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.
 

data/README.md

@@ -26,62 +26,164 @@ Install executable scripts:
 bundle binstubs basketball
 ````
 
-## Main Modules
+## Sub-Modules
 
 This library is broken down into several bounded contexts that can be consumed either via its Ruby API's or CLI through provided executable scripts:
 
-![Basketball Architecture - Overview.png](/docs/architecture/overview.png)
+![Basketball Architecture - Overview](/docs/architecture/overview.png)
 
 ## Drafting Module
 
 The drafting module is responsible for providing a turn-based iterator allowing the consumer to either manually pick or simulate picks.  Here is a cartoon showing the major components:
 
-![Basketball Architecture - Drafting.png](/docs/architecture/drafting.png)
+![Basketball Architecture - Drafting](/docs/architecture/drafting.png)
+
+Element      | Description
+:------------ | :-----------
+**Drafting** | Bounded context (sub-module) dealing with executing an asynchronous draft.
+**Engine** | Aggregate root responsible for providing an iterable interface capable of executing a draft, pick by pick.
+**Event** | Represents one cycle execution result from the Engine.
+**External Ruby App** | An example consumer for the Drafting context.
+**Front Office** | Identifiable as a team, contains configuration for how to auto-pick draft selections.
+**League** | Set of rosters that together form a cohesive league.
+**Pick Event** | Result event emitted when a player is manually selected.
+**Player** | Identitiable as a person able to be drafted.
+**Position** | Value object based on position code: PG, SG, SF, PF, and C.
+**Roster** | Identifiable as a team, set of players that make up a single team.
+**Sim Event** | Result event emitted when a player is automatically selected by a front office.
+**Skip Event** | Result event emitted when a front office decides to skip a round.
 
 ### The Drafting CLI
 
-The drafting module is meant to be interfaces using its Ruby API by consuming applications.  It also ships with a CLI which a user can interact with to emulate "the draft process".  Technically speaking, the CLI provides an example application built on top of the Drafting module.  Each time a CLI command is executed, its results will be resaved, so the output file can then be used as the next command's input file to string together commands.  The following sections are example CLI interactions:
+The drafting module is meant to be interfaced with using its Ruby API by consuming applications.  It also ships with a CLI which a user can interact with to emulate "the draft process".  Technically speaking, the CLI provides an example application built on top of the Drafting module.  Each time a CLI command is executed, its results will be resaved, so the output file can then be used as the next command's input file to string together commands.  The following sections are example CLI interactions:
 
-#### Generate a Fresh Draft
+##### Generate a Fresh Draft
 
 ```zsh
-exe/basketball-draft -o tmp/draft.json
+basketball-draft -o tmp/draft.json
 ```
 
-#### N Top Available Players
+##### N Top Available Players
 
 ```zsh
-exe/basketball-draft -i tmp/draft.json -t 10
+basketball-draft -i tmp/draft.json -t 10
 ```
 
-#### N Top Available Players for a Position
+##### N Top Available Players for a Position
 
 ```zsh
-exe/basketball-draft -i tmp/draft.json -t 10 -q PG
+basketball-draft -i tmp/draft.json -t 10 -q PG
 ```
 
-#### Output Current Rosters
+##### Output Current Rosters
 
 ```zsh
-exe/basketball-draft -i tmp/draft.json -r
+basketball-draft -i tmp/draft.json -r
 ```
 
-#### Simulate N picks
+##### Output Event Log
 
 ```zsh
-exe/basketball-draft -i tmp/draft.json -s 10
+basketball-draft -i tmp/draft.json -l
 ```
 
-#### Pick Players
+##### Simulate N Picks
 
 ```zsh
-exe/basketball-draft -i tmp/draft.json -p P-100,P-200,P-300
+basketball-draft -i tmp/draft.json -s 10
 ```
 
-#### Simulate the Rest of the Draft
+##### Skip N Picks
 
 ```zsh
-exe/basketball-draft -i tmp/draft.json -a
+basketball-draft -i tmp/draft.json -x 10
+```
+
+##### Pick Players
+
+```zsh
+basketball-draft -i tmp/draft.json -p P-100,P-200,P-300
+```
+
+##### Simulate the Rest of the Draft
+
+```zsh
+basketball-draft -i tmp/draft.json -a
+```
+
+##### Help Menu
+
+```zsh
+basketball-draft -h
+```
+
+## Scheduling Module
+
+The Scheduling module is meant to take a League (conferences/divisions/teams) and turn it into a Calendar.  This Calendar creation is atomic - the full calendar will be generated completely all in one call.  Here is a cartoon showing the major components:
+
+![Basketball Architecture - Scheduling](/docs/architecture/scheduling.png)
+
+Element      | Description
+:------------ | :-----------
+**Away Team** | Team object designated as the away team for a Game.
+**Calendar Serializer** | Understands how to serialize and deserialize a Calendar object.
+**Calendar** | Hold a calendar for a year season.  Pass in a year and the Calendar will know how to mark important boundary dates (preseason start, preseason end, season start, and season end) and it knows how to ensure Calendar correctness regarding dates.
+**Conference** | Describes a conference in terms of structure; composed of an array of divisions (there can only 3).
+**Coordinator** | Service which can generate a Calendar from a League.
+**Division** | Describes a division in terms of structure; composed of an array of teams (there can only 5).
+**Game** | Matches up a date with two teams (home and away) to represent a scheduled matchup.
+**Home Team** | Team object designated as the home team for a Game.
+**League Serializer** | Understands how to serialize and deserialize a League object.
+**League** | Describes a league in terms of structure; composed of an array conferences (there can only be 2).
+**Scheduling** | Bounded context (sub-module) dealing with matchup and calendar generation.
+**Team** | Identified by an ID and described by a name: represents a basketball team that can be scheduled.
+
+##### Generate League
+
+```zsh
+basketball-schedule -o tmp/league.json
+```
+
+##### Generate Calendar From League
+
+```zsh
+basketball-schedule -i tmp/league.json -o tmp/calendar.json
+```
+
+##### Generate Calendar From League For a Specific Year
+
+```zsh
+basketball-schedule -i tmp/league.json -o tmp/calendar.json -y 2005
+```
+
+##### Output a Generated Calendar's Matchups
+
+```zsh
+basketball-schedule -c tmp/calendar.json
+```
+
+##### Output a Generated Calendar's Matchups For a Specific Team
+
+```zsh
+basketball-schedule -c tmp/calendar.json -t C0-D0-T0
+```
+
+##### Output a Generated Calendar's Matchups For a Specific Date
+
+```zsh
+basketball-schedule -c tmp/calendar.json -d 2005-02-03
+```
+
+##### Output a Generated Calendar's Matchups For a Specific Team and Date
+
+```zsh
+basketball-schedule -c tmp/calendar.json -d 2005-02-03 -t C0-D0-T0
+```
+
+##### Help Menu
+
+```zsh
+basketball-schedule -h
 ```
 
 ## Contributing

data/basketball.gemspec

@@ -17,7 +17,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-draft]
+  s.executables = %w[basketball-draft basketball-schedule]
   s.homepage    = 'https://github.com/mattruggio/basketball'
   s.license     = 'MIT'
   s.metadata    = {

data/exe/basketball-schedule

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'basketball'
+
+Basketball::Scheduling::CLI.new(args: ARGV).invoke!

data/lib/basketball/drafting/cli.rb

@@ -7,7 +7,7 @@ require_relative 'position'
 
 module Basketball
   module Drafting
-    # Example:
+    # Examples:
     #   exe/basketball-draft -o tmp/draft.json
     #   exe/basketball-draft -i tmp/draft.json -o tmp/draft-wip.json -s 26 -p P-5,P-10 -t 10 -q PG
     #   exe/basketball-draft -i tmp/draft-wip.json -x 2
@@ -46,15 +46,19 @@ module Basketball
         if engine.done?
           io.puts('Draft is complete!')
         else
+          current_round        = engine.current_round
+          current_round_pick   = engine.current_round_pick
+          current_front_office = engine.current_front_office
+
           io.puts("#{engine.remaining_picks} Remaining pick(s)")
-          io.puts("Up Next: Round #{engine.current_round} pick #{engine.current_round_pick} for #{engine.current_team}")
+          io.puts("Up Next: Round #{current_round} pick #{current_round_pick} for #{current_front_office}")
         end
 
         write(engine)
 
         log(engine)
 
-        rosters(engine)
+        league(engine)
 
         query(engine)
 
@@ -65,7 +69,7 @@ module Basketball
 
       def slop_parse(args)
         Slop.parse(args) do |o|
-          o.banner = 'Usage: draft [options] ...'
+          o.banner = 'Usage: basketball-draft [options] ...'
 
           o.string  '-i', '--input',
                     'Path to load the engine from. If omitted then a new draft will be generated.'
@@ -75,7 +79,7 @@ module Basketball
           o.array   '-p', '--picks',        'Comma-separated list of ordered player IDs to pick.', delimiter: ','
           o.integer '-t', '--top',          'Output the top rated available players (default is 0).', default: 0
           o.string  '-q', '--query',        "Filter TOP by position: #{Position::ALL_VALUES.join(', ')}."
-          o.bool    '-r', '--rosters',      'Output all team rosters.', default: false
+          o.bool    '-r', '--rosters',      'Output all front_office rosters.', default: false
           o.integer '-x', '--skip',         'Number of picks to skip (default is 0).', default: 0
           o.bool    '-l', '--log',          'Output event log.', default: false
 
@@ -88,7 +92,7 @@ module Basketball
 
       def load_engine
         if opts[:input].to_s.empty?
-          io.puts('Input path was not provided, generating fresh teams and players')
+          io.puts('Input path was not provided, generating fresh front_offices and players')
 
           generate_draft
         else
@@ -99,8 +103,8 @@ module Basketball
       end
 
       def generate_draft
-        teams = 30.times.map do |i|
-          Team.new(
+        front_offices = 30.times.map do |i|
+          FrontOffice.new(
             id: "T-#{i + 1}", name: Faker::Team.name
           )
         end
@@ -115,18 +119,14 @@ module Basketball
           )
         end
 
-        Engine.new(players:, teams:)
+        Engine.new(players:, front_offices:)
       end
 
-      def rosters(engine)
+      def league(engine)
         return unless opts[:rosters]
 
         io.puts
-        io.puts('Rosters')
-
-        engine.rosters.each do |roster|
-          io.puts(roster)
-        end
+        io.puts(engine.to_league)
       end
 
       def log(engine)

data/lib/basketball/drafting/engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'roster'
+require_relative 'league'
 
 module Basketball
   module Drafting
@@ -9,7 +9,7 @@ module Basketball
       class DupeEventError < StandardError; end
       class EventOutOfOrderError < StandardError; end
       class UnknownPlayerError < StandardError; end
-      class UnknownTeamError < StandardError; end
+      class UnknownFrontOfficeError < StandardError; end
       class EndOfDraftError < StandardError; end
 
       DEFAULT_ROUNDS = 12
@@ -18,11 +18,11 @@ module Basketball
 
       attr_reader :events, :rounds
 
-      def initialize(players: [], teams: [], events: [], rounds: DEFAULT_ROUNDS)
-        @players_by_id = players.to_h { |p| [p.id, p] }
-        @teams_by_id   = teams.to_h { |t| [t.id, t] }
-        @events        = []
-        @rounds        = rounds.to_i
+      def initialize(players: [], front_offices: [], events: [], rounds: DEFAULT_ROUNDS)
+        @players_by_id       = players.to_h { |p| [p.id, p] }
+        @front_offices_by_id = front_offices.to_h { |fo| [fo.id, fo] }
+        @events              = []
+        @rounds              = rounds.to_i
 
         # Each one will be validated for correctness.
         events.each { |e| play!(e) }
@@ -30,15 +30,15 @@ module Basketball
         freeze
       end
 
-      def rosters
-        events_by_team = teams.to_h { |t| [t, []] }
+      def to_league
+        League.new(front_offices:).tap do |league|
+          player_events.each do |event|
+            league.register!(player: event.player, front_office: event.front_office)
+          end
 
-        events.each do |event|
-          events_by_team.fetch(event.team) << event
-        end
-
-        events_by_team.map do |team, events|
-          Roster.new(team:, events:)
+          undrafted_players.each do |player|
+            league.register!(player:)
+          end
         end
       end
 
@@ -46,8 +46,8 @@ module Basketball
         events.join("\n")
       end
 
-      def teams
-        teams_by_id.values
+      def front_offices
+        front_offices_by_id.values
       end
 
       def players
@@ -55,27 +55,27 @@ module Basketball
       end
 
       def total_picks
-        rounds * teams.length
+        rounds * front_offices.length
       end
 
       def current_round
         return if done?
 
-        (current_pick / teams.length.to_f).ceil
+        (current_pick / front_offices.length.to_f).ceil
       end
 
       def current_round_pick
         return if done?
 
-        mod = current_pick % teams.length
+        mod = current_pick % front_offices.length
 
-        mod.positive? ? mod : teams.length
+        mod.positive? ? mod : front_offices.length
       end
 
-      def current_team
+      def current_front_office
         return if done?
 
-        teams[current_round_pick - 1]
+        front_offices[current_round_pick - 1]
       end
 
       def current_pick
@@ -100,8 +100,7 @@ module Basketball
         return if done?
 
         event = SkipEvent.new(
-          id: SecureRandom.uuid,
-          team: current_team,
+          front_office: current_front_office,
           pick: current_pick,
           round: current_round,
           round_pick: current_round_pick
@@ -117,17 +116,16 @@ module Basketball
         events  = []
 
         until done? || (times && counter >= times)
-          team = current_team
+          front_office = current_front_office
 
-          player = team.pick(
+          player = front_office.pick(
             undrafted_player_search:,
-            drafted_players: drafted_players(team),
+            drafted_players: drafted_players(front_office),
             round: current_round
           )
 
           event = SimEvent.new(
-            id: SecureRandom.uuid,
-            team:,
+            front_office:,
             player:,
             pick: current_pick,
             round: current_round,
@@ -149,8 +147,7 @@ module Basketball
         return nil if done?
 
         event = PickEvent.new(
-          id: SecureRandom.uuid,
-          team: current_team,
+          front_office: current_front_office,
           player:,
           pick: current_pick,
           round: current_round,
@@ -170,7 +167,7 @@ module Basketball
 
       private
 
-      attr_reader :players_by_id, :teams_by_id
+      attr_reader :players_by_id, :front_offices_by_id
 
       def player_events
         events.select { |e| e.respond_to?(:player) }
@@ -180,9 +177,9 @@ module Basketball
         events.length + 1
       end
 
-      def drafted_players(team = nil)
+      def drafted_players(front_office = nil)
         player_events.each_with_object([]) do |e, memo|
-          next unless team.nil? || e.team == team
+          next unless front_office.nil? || e.front_office == front_office
 
           memo << e.player
         end
@@ -200,13 +197,17 @@ module Basketball
           raise UnknownPlayerError, "#{event.player} doesnt exist"
         end
 
-        raise DupeEventError,   "#{event} is a dupe"                if events.include?(event)
-        raise EventOutOfOrder,  "#{event} team cant pick right now" if event.team != current_team
-        raise EventOutOfOrder,  "#{event} has wrong pick"           if event.pick != current_pick
-        raise EventOutOfOrder,  "#{event} has wrong round"          if event.round != current_round
-        raise EventOutOfOrder,  "#{event} has wrong round_pick"     if event.round_pick != current_round_pick
-        raise UnknownTeamError, "#{team} doesnt exist"              unless teams.include?(event.team)
-        raise EndOfDraftError,  "#{total_picks} pick limit reached" if events.length > total_picks + 1
+        if event.front_office != current_front_office
+          raise EventOutOfOrder, "#{event} #{event.front_office} cant pick right now"
+        end
+
+        raise UnknownFrontOfficeError, "#{front_office} doesnt exist" unless front_offices.include?(event.front_office)
+
+        raise DupeEventError,  "#{event} is a dupe"                if events.include?(event)
+        raise EventOutOfOrder, "#{event} has wrong pick"           if event.pick != current_pick
+        raise EventOutOfOrder, "#{event} has wrong round"          if event.round != current_round
+        raise EventOutOfOrder, "#{event} has wrong round_pick"     if event.round_pick != current_round_pick
+        raise EndOfDraftError, "#{total_picks} pick limit reached" if events.length > total_picks + 1
 
         events << event