playoffs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1a073c8554e9f8e237a7d55bab24bd078671fd84464bcedca0e1ef557851286
+  data.tar.gz: 07ecbd52187a90afb8fbc3e27abadac5ecb4c2ffdc75cd5ae686f742eb7921b9
+SHA512:
+  metadata.gz: 867f0f7137c5e84349f7a1ee530eb7662a93f2782a6c0752908a0d26e0bcf2045c1857231f5e4bed0bafeb34e308a9a98751962709083cf7c8b1c746c3e7723a
+  data.tar.gz: 1a2c1debbbfddbcccabd9ebc38a6f568c0c6a1f7220ebfa678c0992de78701f6f78ce6e91c6328d4b551b4c1b0744c5cf2cf784afd485a9af43c97ab55d05077

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_BIN: "bin"

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/.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2.1']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Lint
+      run: bin/rubocop
+    - name: Sorbet
+      run: bin/srb
+    - name: Test
+      run: bin/rspec spec --format documentation
+    - name: Dependency Audit
+      run: bin/bundler-audit check --update

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg
+sorbet/rbi/hidden-definitions/errors.txt
+2024.yaml

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-sorbet
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  Exclude:
+    - bin/*
+    - vendor/bundle/**/*
+    - '*.gemspec'
+    - tmp/*
+
+Layout/LineLength:
+  Max: 125
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 150
+
+RSpec/ExampleLength:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 30
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10

data/.tool-versions

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

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "search.exclude": {
+    "sorbet/": true
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 1.0.0
+
+* Initial version.

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,17 @@
+# typed: ignore
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec 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,245 @@
+# Playoffs
+
+[![Gem Version](https://badge.fury.io/rb/playoffs.svg)](https://badge.fury.io/rb/playoffs) [![CI](https://github.com/mattruggio/playoffs/actions/workflows/ci.yaml/badge.svg)](https://github.com/mattruggio/playoffs/actions/workflows/ci.yaml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+I was looking to create a turn-based sports game which, inevitably, would include a playoffs simulator. This library provides a few, easy-to-use APIs to create, simulate, and complete a team & series-based tournament with one clear winner.
+
+### Installation
+
+To install through Rubygems:
+
+```zsh
+gem install playoffs
+```
+
+You can also add this to your Gemfile using:
+
+```zsh
+bundle add playoffs
+```
+
+Copy the executables locally:
+
+```zsh
+bundle binstubs playoffs
+```
+
+### CLI Usage
+
+This library comes with an executable which shows off the basics of consuming the underlying data structures. It is currently limited to supporting NBA-style playoffs (play-in games included). Let's say we are looking to model the 2024 NBA playoffs, we could run these commands to simulate step-by-step:
+
+#### Create New Tournament
+
+```zsh
+bin/playoffs 2024.yaml new BOS,NYK,MIL,CLE,ORL,IND,PHI,MIA,CHI,ATL,OKC,DEN,MIN,LAC,DAL,PHX,LAL,NO,SAC,GS
+```
+
+Note(s):
+
+* This will save a serialized tournament to `2024.yaml`
+* The last argument is a comma-separated list of teams in ranked order per conference.
+
+### View Bracket
+
+```zsh
+bin/playoffs 2024.yaml
+```
+
+This will output a tree-based text representation:
+
+```zsh
+TBD
+└ BestOf::7::Series::TBD::0::TBD::0
+  ├ BestOf::7::Series::TBD::0::TBD::0
+  │ ├ BestOf::7::Series::TBD::0::TBD::0
+  │ │ ├ BestOf::7::Series::BOS::0::TBD::0
+  │ │ │ └ BestOf::1::Series::TBD::0::TBD::0
+  │ │ │   ├ BestOf::1::Series::PHI::0::MIA::0::LoserAdvances
+  │ │ │   └ BestOf::1::Series::CHI::0::ATL::0
+  │ │ └ BestOf::7::Series::CLE::0::ORL::0
+  │ └ BestOf::7::Series::TBD::0::TBD::0
+  │   ├ BestOf::7::Series::MIL::0::IND::0
+  │   └ BestOf::7::Series::NYK::0::TBD::0
+  │     └ BestOf::1::Series::PHI::0::MIA::0::WinnerAdvances
+  └ BestOf::7::Series::TBD::0::TBD::0
+    ├ BestOf::7::Series::TBD::0::TBD::0
+    │ ├ BestOf::7::Series::OKC::0::TBD::0
+    │ │ └ BestOf::1::Series::TBD::0::TBD::0
+    │ │   ├ BestOf::1::Series::LAL::0::NO::0::LoserAdvances
+    │ │   └ BestOf::1::Series::SAC::0::GS::0::LoserAdvances
+    │ └ BestOf::7::Series::LAC::0::DAL::0
+    └ BestOf::7::Series::TBD::0::TBD::0
+      ├ BestOf::7::Series::MIN::0::PHX::0
+      └ BestOf::7::Series::DEN::0::TBD::0
+        └ BestOf::1::Series::LAL::0::NO::0::WinnerAdvances
+```
+
+### View Rounds
+
+```zsh
+bin/playoffs 2024.yaml rounds
+```
+
+This will output all series, grouped by round:
+
+```zsh
+BestOf::1::Series::PHI::0::MIA::0
+BestOf::1::Series::CHI::0::ATL::0
+BestOf::1::Series::LAL::0::NO::0
+BestOf::1::Series::SAC::0::GS::0
+
+BestOf::1::Series::TBD::0::TBD::0
+BestOf::1::Series::PHI::0::MIA::0
+BestOf::1::Series::TBD::0::TBD::0
+BestOf::1::Series::LAL::0::NO::0
+
+BestOf::7::Series::BOS::0::TBD::0
+BestOf::7::Series::CLE::0::ORL::0
+BestOf::7::Series::MIL::0::IND::0
+BestOf::7::Series::NYK::0::TBD::0
+BestOf::7::Series::OKC::0::TBD::0
+BestOf::7::Series::LAC::0::DAL::0
+BestOf::7::Series::MIN::0::PHX::0
+BestOf::7::Series::DEN::0::TBD::0
+
+BestOf::7::Series::TBD::0::TBD::0
+BestOf::7::Series::TBD::0::TBD::0
+BestOf::7::Series::TBD::0::TBD::0
+BestOf::7::Series::TBD::0::TBD::0
+
+BestOf::7::Series::TBD::0::TBD::0
+BestOf::7::Series::TBD::0::TBD::0
+
+BestOf::7::Series::TBD::0::TBD::0
+```
+
+#### View Up Next
+
+```zsh
+bin/playoffs 2024.yaml up
+```
+
+This will output the current round number and series (nothing if the tournament is over):
+
+```zsh
+1
+BestOf::1::Series::PHI::0::MIA::0
+```
+
+#### Log a Win
+
+Once you know which series is currently up, use this command to pick a winner:
+
+```zsh
+bin/playoffs 2024.yaml win PHI
+```
+
+This will output the current series after the win:
+
+```zsh
+BestOf::1::Series::PHI::1::MIA::0::Done
+```
+
+#### Simulate
+
+The CLI example executable comes with a randomized simulator. This is where this library stops and the application should start: the consumer is responsible to actually deciding winners while this library is only focused on providing the state machine. Run this command to simulate the rest of the games and series:
+
+```zsh
+bin/playoffs 2024.yaml sim
+```
+
+This will output the number of games simulated and the winner:
+
+```zsh
+97
+DAL
+```
+
+#### View Winner
+
+```zsh
+bin/playoffs 2024.yaml winner
+```
+
+Will output the winner (nothing if the tournament is not over):
+
+```zsh
+DAL
+```
+
+### Ruby API Usage
+
+While the CLI executable exemplifies building a consumer app using the data structures provided here, the real power is extending yourself to fit your needs, specifically:
+
+1. Subclassing `Playoffs::Team` to customize per your domain-specific needs
+2. Constructing your own tournament using the main `Playoffs::Series` data structure. View `Playoffs::Basketball#tournament_for` to see how an NBA tournament is constructed.
+3. Interact with the tournament state machine directly, such as:
+
+   * `Playoffs::Tournament#up_next`: Get the current series which needs a winner.
+   * `Playoffs::Series#win`: Log a winner for the current series.
+   *  `Playoffs::Tournament#winner`: Get the winning team once there is no current series (series is over).
+
+## 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 playoffs.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:mattruggio/playoffs.git)
+4. Navigate to the root folder (cd playoffs)
+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
+```
+
+And Sorbet:
+
+```zsh
+bin/srb
+```
+
+### 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/playoffs/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,11 @@
+# typed: ignore
+# 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/bin/_guard-core

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/bundle

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../Gemfile", __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/bundle-audit

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle-audit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler-audit", "bundle-audit")

data/bin/bundler-audit

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler-audit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler-audit", "bundler-audit")