basketball 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 793bfe7afef52aa72d3f89c94541fc7d8f24b350d63cb7c75d7215c285695b74
-  data.tar.gz: 46a3ac7199fb534ff4827c8fe48bbe371c7f87bc623e579ffdce2310132a1263
+  metadata.gz: 00ac0278bb2e786c5a68b3cc7ac8fd5d49005f9f9a01fad32501c75a00880dce
+  data.tar.gz: 4b76f9d42a702a206c837346de20396c6948c9bcb071a4143610e8179ba93c64
 SHA512:
-  metadata.gz: cf8c46719f3669a31c932d7dc2742c287666fcb305c90c596c87b79c37d4fb95aafa446c70575ed4d8d3750a3f3672646e9ee49c6a0cf95e4dd7eb092831670e
-  data.tar.gz: db01d3bfc4a8c1448875c5a099d0a33fd60ad60471ae5cda5f9eeeaf8a1fb2daa3e52d5ca2d8138867e42aaf6f54d259cdad7d3628cfbaa2d7bcf134fe5dc4b9
+  metadata.gz: 806f800744de18f81e590cd712adf83592e372b8f1b19c3b8f9a6e702c7fbc04981380ba784b63436f2cc34d5f80238c0fce53366eed8a2a8a63eb9b64cb69c4
+  data.tar.gz: acffa65b0315e7d5ec6638cd92c217e9aa665787114935d0859a4b6b02cfb0c8afd6e66d7914de6b147d6878d83ca210b2d5f5bfbdeb748784f559300fe79d46

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+#### 0.0.7 - May 14th, 2023
+
+* Added #to_hash and #from_hash serializer methods to allow larger consumer json constructions more directly.
+* Opt for string keys during serialization/deserialization.
+
+#### 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.

data/Gemfile

@@ -3,3 +3,14 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'bundler-audit', '~>0.9'
+gem 'guard-rspec', '~>4.7'
+gem 'pry', '~>0.14'
+gem 'rake', '~>13.0'
+gem 'rspec', '~>3.12'
+gem 'rubocop', '~>1.49'
+gem 'rubocop-rake', '~>0.6'
+gem 'rubocop-rspec', '~>2.20'
+gem 'simplecov', '~>0.22'
+gem 'simplecov-console', '~>0.9'

data/README.md

@@ -30,13 +30,17 @@ bundle binstubs basketball
 
 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)
+
+#### Command Line Interfaces
+
+Each module is meant to be interfaced with using its Ruby API by consuming applications.  Each module also ships with a CLI script (backed by a module service) which a user can interact with to emulate different portions of the league management process.  Technically speaking, the CLI provides an example application built on top of the each individual core module. Each module section below should contain with it example CLI calls.
 
 ## 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
 :------------ | :-----------
@@ -47,70 +51,147 @@ Element      | Description
 **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.
-**Playe ** | Identitiable as a person able to be drafted.
+**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 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's main object: `Basketball::Drafting::Engine` is a stateful iterator. Each time a CLI command is executed, it's results will be re-saved to disk so the output file can then be used as the next command's input file to string together commands.
 
-#### Generate a Fresh Draft
+###### Generate a Fresh Draft
 
 ```zsh
 basketball-draft -o tmp/draft.json
 ```
 
-#### N Top Available Players
+###### N Top Available Players
 
 ```zsh
 basketball-draft -i tmp/draft.json -t 10
 ```
 
-#### N Top Available Players for a Position
+###### N Top Available Players for a Position
 
 ```zsh
 basketball-draft -i tmp/draft.json -t 10 -q PG
 ```
 
-#### Output Current Rosters
+###### Output Current Rosters
 
 ```zsh
 basketball-draft -i tmp/draft.json -r
 ```
 
-#### Output Event Log
+###### Output Event Log
 
 ```zsh
 basketball-draft -i tmp/draft.json -l
 ```
 
-#### Simulate N picks
+###### Simulate N Picks
 
 ```zsh
 basketball-draft -i tmp/draft.json -s 10
 ```
 
-#### Skip N picks
+###### Skip N Picks
 
 ```zsh
 basketball-draft -i tmp/draft.json -x 10
 ```
 
-#### Pick Players
+###### Pick Players
 
 ```zsh
 basketball-draft -i tmp/draft.json -p P-100,P-200,P-300
 ```
 
-#### Simulate the Rest of the Draft
+###### 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.
+
+#### The Scheduling CLI
+
+###### 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
 
 ### Development Environment Configuration

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    = {
@@ -33,15 +33,4 @@ Gem::Specification.new do |s|
 
   s.add_dependency('faker', '~>3.2')
   s.add_dependency('slop', '~>4.10')
-
-  s.add_development_dependency('bundler-audit', '~>0.9')
-  s.add_development_dependency('guard-rspec', '~>4.7')
-  s.add_development_dependency('pry', '~>0.14')
-  s.add_development_dependency('rake', '~>13.0')
-  s.add_development_dependency('rspec', '~>3.12')
-  s.add_development_dependency('rubocop', '~>1.49')
-  s.add_development_dependency('rubocop-rake', '~>0.6')
-  s.add_development_dependency('rubocop-rspec', '~>2.20')
-  s.add_development_dependency('simplecov', '~>0.22')
-  s.add_development_dependency('simplecov-console', '~>0.9')
 end

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
@@ -69,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.'

data/lib/basketball/drafting/engine.rb

@@ -100,7 +100,6 @@ module Basketball
         return if done?
 
         event = SkipEvent.new(
-          id: SecureRandom.uuid,
           front_office: current_front_office,
           pick: current_pick,
           round: current_round,
@@ -126,7 +125,6 @@ module Basketball
           )
 
           event = SimEvent.new(
-            id: SecureRandom.uuid,
             front_office:,
             player:,
             pick: current_pick,
@@ -149,7 +147,6 @@ module Basketball
         return nil if done?
 
         event = PickEvent.new(
-          id: SecureRandom.uuid,
           front_office: current_front_office,
           player:,
           pick: current_pick,
@@ -206,11 +203,11 @@ module Basketball
 
         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
+        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
 

data/lib/basketball/drafting/engine_serializer.rb

@@ -17,8 +17,15 @@ module Basketball
 
       private_constant :EVENT_CLASSES
 
-      def deserialize(string)
-        json          = JSON.parse(string, symbolize_names: true)
+      def to_hash(engine)
+        {
+          'info' => serialize_info(engine),
+          'engine' => serialize_engine(engine),
+          'league' => serialize_league(engine)
+        }
+      end
+
+      def from_hash(json)
         front_offices = deserialize_front_offices(json)
         players       = deserialize_players(json)
         events        = deserialize_events(json, players, front_offices)
@@ -29,39 +36,41 @@ module Basketball
           events:
         }
 
-        engine_opts[:rounds] = json.dig(:engine, :rounds) if json.dig(:engine, :rounds)
+        engine_opts[:rounds] = json.dig('engine', 'rounds') if json.dig('engine', 'rounds')
 
         Engine.new(**engine_opts)
       end
 
+      def deserialize(string)
+        json = JSON.parse(string)
+
+        from_hash(json)
+      end
+
       def serialize(engine)
-        {
-          info: serialize_info(engine),
-          engine: serialize_engine(engine),
-          league: serialize_league(engine)
-        }.to_json
+        to_hash(engine).to_json
       end
 
       private
 
       def serialize_engine(engine)
         {
-          rounds: engine.rounds,
-          front_offices: serialize_front_offices(engine),
-          players: serialize_players(engine),
-          events: serialize_events(engine.events)
+          'rounds' => engine.rounds,
+          'front_offices' => serialize_front_offices(engine),
+          'players' => serialize_players(engine),
+          'events' => serialize_events(engine.events)
         }
       end
 
       def serialize_info(engine)
         {
-          total_picks: engine.total_picks,
-          current_round: engine.current_round,
-          current_round_pick: engine.current_round_pick,
-          current_front_office: engine.current_front_office&.id,
-          current_pick: engine.current_pick,
-          remaining_picks: engine.remaining_picks,
-          done: engine.done?
+          'total_picks' => engine.total_picks,
+          'current_round' => engine.current_round,
+          'current_round_pick' => engine.current_round_pick,
+          'current_front_office' => engine.current_front_office&.id,
+          'current_pick' => engine.current_pick,
+          'remaining_picks' => engine.remaining_picks,
+          'done' => engine.done?
         }
       end
 
@@ -72,14 +81,14 @@ module Basketball
           [
             roster.id,
             {
-              players: roster.players.map(&:id)
+              'players' => roster.players.map(&:id)
             }
           ]
         end
 
         {
-          free_agents: league.free_agents.map(&:id),
-          rosters:
+          'free_agents' => league.free_agents.map(&:id),
+          'rosters' => rosters
         }
       end
 
@@ -88,10 +97,10 @@ module Basketball
           [
             front_office.id,
             {
-              name: front_office.name,
-              fuzz: front_office.fuzz,
-              depth: front_office.depth,
-              prioritized_positions: front_office.prioritized_positions.map(&:code)
+              'name' => front_office.name,
+              'fuzz' => front_office.fuzz,
+              'depth' => front_office.depth,
+              'prioritized_positions' => front_office.prioritized_positions.map(&:code)
             }
           ]
         end
@@ -102,10 +111,10 @@ module Basketball
           [
             player.id,
             {
-              first_name: player.first_name,
-              last_name: player.last_name,
-              overall: player.overall,
-              position: player.position.code
+              'first_name' => player.first_name,
+              'last_name' => player.last_name,
+              'overall' => player.overall,
+              'position' => player.position.code
             }
           ]
         end
@@ -114,30 +123,29 @@ module Basketball
       def serialize_events(events)
         events.map do |event|
           {
-            type: event.class.name.split('::').last,
-            id: event.id,
-            front_office: event.front_office.id,
-            pick: event.pick,
-            round: event.round,
-            round_pick: event.round_pick
+            'type' => event.class.name.split('::').last,
+            'front_office' => event.front_office.id,
+            'pick' => event.pick,
+            'round' => event.round,
+            'round_pick' => event.round_pick
           }.tap do |hash|
-            hash[:player] = event.player.id if event.respond_to?(:player)
+            hash['player'] = event.player.id if event.respond_to?(:player)
           end
         end
       end
 
       def deserialize_front_offices(json)
-        (json.dig(:engine, :front_offices) || []).map do |id, front_office_hash|
-          prioritized_positions = (front_office_hash[:prioritized_positions] || []).map do |v|
+        (json.dig('engine', 'front_offices') || []).map do |id, front_office_hash|
+          prioritized_positions = (front_office_hash['prioritized_positions'] || []).map do |v|
             Position.new(v)
           end
 
           front_office_opts = {
             id:,
-            name: front_office_hash[:name],
+            name: front_office_hash['name'],
             prioritized_positions:,
-            fuzz: front_office_hash[:fuzz],
-            depth: front_office_hash[:depth]
+            fuzz: front_office_hash['fuzz'],
+            depth: front_office_hash['depth']
           }
 
           FrontOffice.new(**front_office_opts)
@@ -145,26 +153,29 @@ module Basketball
       end
 
       def deserialize_players(json)
-        (json.dig(:engine, :players) || []).map do |id, player_hash|
-          player_opts = player_hash.merge(
+        (json.dig('engine', 'players') || []).map do |id, player_hash|
+          player_opts = {
             id:,
-            position: Position.new(player_hash[:position])
-          )
+            first_name: player_hash['first_name'],
+            last_name: player_hash['last_name'],
+            overall: player_hash['overall'],
+            position: Position.new(player_hash['position'])
+          }
 
           Player.new(**player_opts)
         end
       end
 
       def deserialize_events(json, players, front_offices)
-        (json.dig(:engine, :events) || []).map do |event_hash|
-          event_opts = event_hash.slice(:id, :pick, :round, :round_pick).merge(
-            front_office: front_offices.find { |t| t.id == event_hash[:front_office] }
+        (json.dig('engine', 'events') || []).map do |event_hash|
+          event_opts = event_hash.slice('pick', 'round', 'round_pick').merge(
+            front_office: front_offices.find { |t| t.id == event_hash['front_office'] }
           )
 
-          class_constant = EVENT_CLASSES.fetch(event_hash[:type])
+          class_constant = EVENT_CLASSES.fetch(event_hash['type'])
 
           if [PickEvent, SimEvent].include?(class_constant)
-            event_opts[:player] = players.find { |p| p.id == event_hash[:player] }
+            event_opts[:player] = players.find { |p| p.id == event_hash['player'] }
           end
 
           class_constant.new(**event_opts)

data/lib/basketball/drafting/event.rb

@@ -2,11 +2,11 @@
 
 module Basketball
   module Drafting
-    class Event < Entity
-      attr_reader :pick, :round, :round_pick, :front_office
+    class Event < ValueObject
+      attr_reader_value :pick, :round, :round_pick, :front_office
 
-      def initialize(id:, front_office:, pick:, round:, round_pick:)
-        super(id)
+      def initialize(front_office:, pick:, round:, round_pick:)
+        super()
 
         raise ArgumentError, 'front_office required' unless front_office
 

data/lib/basketball/drafting/league.rb

@@ -5,7 +5,6 @@ require_relative 'roster'
 module Basketball
   module Drafting
     class League
-      class PlayerAlreadyRegisteredError < StandardError; end
       class RosterNotFoundError < StandardError; end
       class RosterAlreadyAddedError < StandardError; end
 

data/lib/basketball/drafting/pick_event.rb

@@ -5,10 +5,10 @@ require_relative 'event'
 module Basketball
   module Drafting
     class PickEvent < Event
-      attr_reader :player
+      attr_reader_value :player
 
-      def initialize(id:, front_office:, player:, pick:, round:, round_pick:)
-        super(id:, front_office:, pick:, round:, round_pick:)
+      def initialize(front_office:, player:, pick:, round:, round_pick:)
+        super(front_office:, pick:, round:, round_pick:)
 
         raise ArgumentError, 'player required' unless player
 

data/lib/basketball/drafting/roster.rb

@@ -3,7 +3,6 @@
 module Basketball
   module Drafting
     class Roster < Entity
-      class PlayerAlreadyRegisteredError < StandardError; end
       class PlayerRequiredError < StandardError; end
 
       attr_reader :name, :players

data/lib/basketball/drafting/sim_event.rb

@@ -3,10 +3,10 @@
 module Basketball
   module Drafting
     class SimEvent < Event
-      attr_reader :player
+      attr_reader_value :player
 
-      def initialize(id:, front_office:, player:, pick:, round:, round_pick:)
-        super(id:, front_office:, pick:, round:, round_pick:)
+      def initialize(front_office:, player:, pick:, round:, round_pick:)
+        super(front_office:, pick:, round:, round_pick:)
 
         raise ArgumentError, 'player required' unless player
 

data/lib/basketball/drafting.rb

@@ -1,3 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'drafting/cli'
+
+module Basketball
+  module Drafting
+    class PlayerAlreadyRegisteredError < StandardError; end
+  end
+end