basketball 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f2ba6492b8cb72e11f8a9ea3da6a5be5aa99964e706ab789798906d9ea1a98a
+  data.tar.gz: 6fc3fc8ba538c95bb36fdbfc0f764b6bcfeda45436964718fae20043fa7468ca
+SHA512:
+  metadata.gz: 9182a915019659912848e06b9201b27b984bd1a13693fe5aed59c936a0e65b2a316de8cdeb4e7c2bb2ffbaea12fc5127109733dd09079165c0c33c73ad442095
+  data.tar.gz: be794d98881e00893212660a94312ee79748d3bd6016fa758b223bc08a4a287389eefc92d7cdac10b7484b126d92a352e7cc42d0fd2fa28d1f3ab6e8559551b1

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg
+/data
+/vendor

data/.rubocop.yml

@@ -0,0 +1,41 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - bin/*
+    - lib/basketball/draft/cli.rb
+    - tmp/**/*
+    - vendor/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 35
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+Metrics/ParameterLists:
+  Max: 6
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 9

data/.tool-versions

@@ -0,0 +1 @@
+3.2.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+#### 0.0.1 - May 4th, 2023
+
+* Initial release with Drafting module only

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+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
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bin/rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,144 @@
+# :basketball: Basketball
+
+[![Gem Version](https://badge.fury.io/rb/basketball.svg)](https://badge.fury.io/rb/basketball) [![CI](https://github.com/mattruggio/basketball/actions/workflows/ci.yaml/badge.svg)](https://github.com/mattruggio/basketball/actions/workflows/ci.yaml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+#### Basketball League Game Engine
+
+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.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install basketball
+````
+
+You can also add this to your Gemfile using:
+
+````
+bundle add basketball
+````
+
+Install executable scripts:
+
+````
+bundle binstubs basketball
+````
+
+## Main 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)
+
+## 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)
+
+### 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:
+
+#### Generate a Fresh Draft
+
+```zsh
+exe/basketball-draft -o tmp/draft.json
+```
+
+#### N Top Available Players
+
+```zsh
+exe/basketball-draft -i tmp/draft.json -t 10
+```
+
+#### N Top Available Players for a Position
+
+```zsh
+exe/basketball-draft -i tmp/draft.json -t 10 -q PG
+```
+
+#### Output Current Rosters
+
+```zsh
+exe/basketball-draft -i tmp/draft.json -r
+```
+
+#### Simulate N picks
+
+```zsh
+exe/basketball-draft -i tmp/draft.json -s 10
+```
+
+#### Pick Players
+
+```zsh
+exe/basketball-draft -i tmp/draft.json -p P-100,P-200,P-300
+```
+
+#### Simulate the Rest of the Draft
+
+```zsh
+exe/basketball-draft -i tmp/draft.json -a
+```
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check basketball.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:mattruggio/basketball.git)
+4. Navigate to the root folder (cd basketball)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````zsh
+bin/rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````zsh
+bin/guard
+````
+
+Also, do not forget to run Rubocop:
+
+````zsh
+bin/rubocop
+````
+
+And auditing the dependencies:
+
+````zsh
+bin/bundler-audit check --update
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into main
+2. Update `version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push main to remote and ensure CI builds main successfully
+6. Run `bin/rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattruggio/basketball/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/basketball.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require './lib/basketball/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'basketball'
+  s.version     = Basketball::VERSION
+  s.summary     = 'Basketball League Game Engine'
+
+  s.description = <<-DESC
+    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-draft]
+  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',
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => s.homepage,
+    'rubygems_mfa_required' => 'true'
+  }
+
+  s.required_ruby_version = '>= 3.2.1'
+
+  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-draft

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

data/lib/basketball/drafting/cli.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Basketball
+  module Drafting
+    # Example:
+    #   exe/basketball-draft -o tmp/draft.json
+    #   exe/basketball-draft -i tmp/draft.json -o tmp/draft-wip.json -s 28 -p ONEALSH01,ONEALJE01 -t 10 -q PG
+    #   exe/basketball-draft -i tmp/draft-wip.json -r -t 10
+    #   exe/basketball-draft -i tmp/draft-wip.json -t 10 -q SG
+    #   exe/basketball-draft -i tmp/draft-wip.json -s 30 -t 10
+    #   exe/basketball-draft -i tmp/draft-wip.json -a -r
+    class CLI
+      attr_reader :opts, :serializer, :io
+
+      def initialize(args:, io: $stdout)
+        @io         = io
+        @serializer = EngineSerializer.new
+        @opts       = slop_parse(args)
+
+        if opts[:input].to_s.empty? && opts[:output].to_s.empty?
+          io.puts('Input and/or output paths are required.')
+
+          exit
+        end
+
+        freeze
+      end
+
+      def invoke!
+        engine = load_engine
+
+        execute(engine)
+
+        io.puts
+        io.puts('Status')
+
+        if engine.done?
+          io.puts('Draft is complete!')
+        else
+          io.puts("#{engine.remaining_picks} Remaining pick(s)")
+          io.puts("Round #{engine.current_round} pick #{engine.current_round_pick} for #{engine.current_team}")
+        end
+
+        write(engine)
+
+        rosters(engine)
+
+        query(engine)
+
+        self
+      end
+
+      private
+
+      def slop_parse(args)
+        Slop.parse(args) do |o|
+          o.banner = 'Usage: draft [options] ...'
+
+          o.string  '-i', '--input',
+                    'Path to load the engine from. If omitted then a new draft will be generated.'
+          o.string  '-o', '--output',       'Path to write the engine to (if omitted then input path will be used)'
+          o.integer '-s', '--simulate',     'Number of picks to simulate (default is 0).', default: 0
+          o.bool    '-a', '--simulate-all', 'Simulate the rest of the draft', default: false
+          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.on '-h', '--help', 'Print out help, like this is doing right now.' do
+            io.puts(o)
+            exit
+          end
+        end.to_h
+      end
+
+      def load_engine
+        if opts[:input].to_s.empty?
+          io.puts('Input path was not provided, generating fresh teams and players')
+
+          generate_draft
+        else
+          io.puts("Draft loaded from: #{opts[:input]}")
+
+          read
+        end
+      end
+
+      def generate_draft
+        teams = 30.times.map do |i|
+          Team.new(
+            id: "T-#{i + 1}", name: Faker::Team.name
+          )
+        end
+
+        players = 450.times.map do |i|
+          Player.new(
+            id: "P-#{i + 1}",
+            first_name: Faker::Name.first_name,
+            last_name: Faker::Name.last_name,
+            position: Position.random,
+            overall: (0..100).to_a.sample
+          )
+        end
+
+        Engine.new(players:, teams:)
+      end
+
+      def rosters(engine)
+        return unless opts[:rosters]
+
+        io.puts
+        io.puts('Rosters')
+
+        engine.rosters.each do |roster|
+          io.puts(roster)
+        end
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def query(engine)
+        top = opts[:top]
+
+        return if top <= 0
+
+        search   = PlayerSearch.new(engine.undrafted_players)
+        position = opts[:query].to_s.empty? ? nil : Position.new(opts[:query])
+        players  = search.query(position:).take(opts[:top])
+
+        io.puts
+        io.print("Top #{top} available players")
+
+        if position
+          io.puts(" for #{position} position:")
+        else
+          io.puts(' for all positions:')
+        end
+
+        io.puts(players)
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def read
+        contents = File.read(opts[:input])
+        serializer.deserialize(contents)
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def execute(engine)
+        event_count = 0
+
+        io.puts
+        io.puts('New Events')
+
+        (opts[:picks] || []).each do |id|
+          break if engine.done?
+
+          player = engine.players.find { |p| p.id == id.to_s.upcase }
+
+          event = engine.pick!(player)
+
+          io.puts(event)
+
+          event_count += 1
+        end
+
+        engine.sim!(opts[:simulate]) do |event|
+          io.puts(event)
+
+          event_count += 1
+        end
+
+        if opts[:simulate_all]
+          engine.sim! do |event|
+            io.puts(event)
+
+            event_count += 1
+          end
+        end
+
+        io.puts("Generated #{event_count} new event(s)")
+
+        nil
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def write(engine)
+        output = opts[:output].to_s.empty? ? opts[:input] : opts[:output]
+
+        contents = serializer.serialize(engine)
+        out_dir  = File.dirname(output)
+
+        FileUtils.mkdir_p(out_dir)
+
+        File.write(output, contents)
+
+        io.puts
+        io.puts("Draft written to: #{output}")
+
+        nil
+      end
+    end
+  end
+end