bowlero 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 737ad2515bd56b4e9b37717994cf16713b7300d514e5a686e9001e91264c652b
+  data.tar.gz: ee3ee76e6bb29599408847d9850a07a3ca145fa4c7cbe3e10067473664544c62
+SHA512:
+  metadata.gz: 76d854173c4c0420121ad8c5fa04ae6286aa68f12c5bb4021f8c074537156bdffbf8994e60b082a50f2dfa54b8400f5c41481a93b768c5fca613bfb812c703cc
+  data.tar.gz: eb8c6e242244f9e79d21cb3ea341c37c009250f0cae15c7465cb42793e14f2dc53ad646dac39bb36764a0a5001fad5a3e0a9b192ac42e0c70965b2613a9f9184

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-13
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mike Benner
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Mike Benner
+
+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,39 @@
+# Bowlero
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bowlero`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bowlero.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/bowlero/dice.rb

@@ -0,0 +1,27 @@
+module Bowlero
+  module Dice
+    # Rolls the Strike Die: returns 1-5 (pins) or :strike
+    def self.roll_strike_die
+      roll = rand(1..6)
+      roll == 6 ? :strike : roll
+    end
+
+    # Rolls the Split Die: returns 1-5 (pins) or :split
+    def self.roll_split_die
+      roll = rand(1..6)
+      roll == 6 ? :split : roll
+    end
+
+    # Rolls the Split Resolution Die: returns :open (1-4) or :spare (5-6)
+    def self.roll_split_resolution_die
+      roll = rand(1..6)
+      roll <= 4 ? :open : :spare
+    end
+
+    # Rolls the Spare Resolution Die: returns :spare (1-4) or :open (5-6)
+    def self.roll_spare_resolution_die
+      roll = rand(1..6)
+      roll <= 4 ? :spare : :open
+    end
+  end
+end 

data/lib/bowlero/frame.rb

@@ -0,0 +1,25 @@
+module Bowlero
+  class Frame
+    attr_accessor :frame_number, :first_roll, :second_roll, :third_roll, :split, :split_converted, :result, :pins, :score
+
+    def initialize(frame_number:,
+                   first_roll: nil,
+                   second_roll: nil,
+                   third_roll: nil,
+                   split: false,
+                   split_converted: nil,
+                   result: nil,
+                   pins: 0,
+                   score: nil)
+      @frame_number = frame_number
+      @first_roll = first_roll
+      @second_roll = second_roll
+      @third_roll = third_roll
+      @split = split
+      @split_converted = split_converted
+      @result = result
+      @pins = pins
+      @score = score
+    end
+  end
+end 

data/lib/bowlero/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bowlero
+  VERSION = "0.1.0"
+end

data/lib/bowlero.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "bowlero/version"
+require_relative 'bowlero/frame'
+require_relative 'bowlero/dice'
+
+module Bowlero
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/bowlero.rbs

@@ -0,0 +1,4 @@
+module Bowlero
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/stories/KOANI-300.md

@@ -0,0 +1,243 @@
+# Bowlero Ruby Gem (KOANI-300)
+
+> **Progress:**
+> _Awaiting initial implementation. Requirements and plan approved. Next step: begin development of v1 CLI gem._
+
+## Overview
+
+A single-player command-line bowling game Ruby gem that uses a custom dice mechanic to simulate bowling. The game features interactive play, emoji-rich output, and an ASCII table styled like a real bowling scorecard. The goal is to provide a fun, replayable bowling experience with future extensibility for multiplayer, leaderboards, and more.
+
+## Requirements
+
+- **Access:**  
+  Any user who can install Ruby gems and run commands in the terminal. No special permissions required.
+
+- **UI:**  
+  - Command-line interface (CLI) with interactive prompts.
+  - ASCII table styled like a real bowling scorecard.
+  - Emoji usage for pins, balls, strikes, spares, splits (e.g., 🎳, 🦃, 🍌, etc.).
+  - Menu with "Start Game" and "Exit" options.
+  - Prompt for player name, with a random fun bowling pun name as default (user can override).
+
+- **Data Model:**  
+  - Game session: player name, frames, rolls, scores.
+  - Dice logic: see "Dice Logic Specification" below.
+  - Logging: error logs (plain text or JSON, best practice).
+
+- **Navigation:**  
+  - User starts by running the gem (e.g., `bowlero`).
+  - Menu: Start Game, Exit.
+  - Prompts for name, then game begins.
+  - After game: show final score, prompt to play again or exit.
+  - Option to play a single game or a "series" of three games.
+
+- **Testing:**  
+  - Unit tests for dice logic, scoring, and CLI interactions.
+  - Manual testing for CLI flow and user experience.
+
+- **Other:**  
+  - Error handling: user-friendly messages, log errors to file.
+  - Confirmation prompt on mid-game exit.
+  - No platform-specific dependencies; should work on Mac, Linux, Windows.
+  - Future: multiplayer, save/load, leaderboards, autoplay, command-line flags, debug mode.
+
+## Dice Logic Specification
+
+The bowling game uses a set of custom dice to simulate the outcome of each frame. The dice and their logic are as follows:
+
+### Dice Used
+
+1. **Strike Die**
+   - Sides 1–5: Number of pins knocked down (1–5)
+   - Side 6: "Strike" (all 10 pins knocked down, frame ends)
+
+2. **Split Die**
+   - Sides 1–5: Number of pins knocked down (1–5)
+   - Side 6: "Split" (special split scenario, see below)
+
+3. **Split Resolution Die** (used only if "Split" is rolled on the Split Die)
+   - Sides 1–4: "Open" (split not converted, no spare)
+   - Sides 5–6: "Spare" (split converted, all pins knocked down)
+
+4. **Spare Resolution Die** (used if no Strike or Split is rolled)
+   - Sides 1–4: "Spare" (all remaining pins knocked down)
+   - Sides 5–6: "Open" (some pins left standing, no spare)
+
+### Roll Sequence (Per Frame)
+
+1. **First Roll:**
+   - Roll both the Strike Die and the Split Die together.
+   - If the Strike Die lands on "Strike," it's a strike (10 pins, frame ends).
+   - Otherwise, sum the pins from both dice:
+     - If the Split Die lands on 1–5, add that number to the Strike Die's result (total 2–10 pins).
+     - If the Split Die lands on "Split," add 6 pins to the Strike Die's result (total 7–11 pins).
+   - If the total pins knocked down is 10 or more, it's a strike (frame ends).
+   - If not a strike, proceed to the second roll.
+
+2. **Second Roll:**
+   - If the first roll resulted in a "Split," roll the Split Resolution Die:
+     - "Spare": All remaining pins knocked down (spare).
+     - "Open": Some pins left standing (open frame).
+   - If the first roll did NOT result in a "Split," roll the Spare Resolution Die:
+     - "Spare": All remaining pins knocked down (spare).
+     - "Open": Some pins left standing (open frame).
+
+### Special Notes
+
+- If the Strike Die is "Strike," ignore the Split Die result.
+- If the total pins from both dice (excluding "Strike" on Strike Die) is 10 or more, treat as a strike.
+- If the Split Die is "Split," always add 6 pins for that die, regardless of the Strike Die's value.
+- The second roll is always either the Split Resolution Die (if "Split" was rolled) or the Spare Resolution Die (otherwise).
+- All outcomes are described to the player in plain language (e.g., "You knocked down 5 pins and left a split."). Dice roll values are not shown unless a future debug mode is enabled.
+
+## User Journey
+
+- **How does a user get there?**  
+  Installs the gem, runs `bowlero` in the terminal. Sees a menu with options.
+
+- **What do they do when they are there?**  
+  Selects "Start Game," enters (or accepts) a player name, chooses single game or series, plays through 10 frames, rolling dice per frame, sees results and score updates after each roll.
+
+- **What happens if it goes right?**  
+  User completes the game, sees a final scorecard with emojis and summary, and is prompted to play again or exit.
+
+- **What happens if it goes wrong?**  
+  Any errors (e.g., invalid input, unexpected exceptions) are caught, a friendly message is shown, and the error is logged for debugging. If user tries to exit mid-game, a confirmation prompt appears.
+
+- **Where does it take them when they are done?**  
+  After the game, user can choose to play again (with same or new name) or exit to the terminal.
+
+## Implementation Phases
+
+### Phase 1: CLI Gem MVP [ ]
+- [x] Set up gem structure and CLI entry point
+- [x] Implement menu system (Start Game, Exit)
+- [x] Implement player name prompt with random pun defaults
+- [x] Implement dice logic and frame/roll mechanics (see Dice Logic Specification)
+- [x] Add Frame class to represent each frame's data
+- [x] Refactor CLI game loop to use Frame objects for each frame
+- [x] Implement bowling scoring logic (standard rules)
+- [x] Render ASCII bowling scorecard with emoji support (final: ASCII only for alignment; emojis in play-by-play)
+- [ ] Add confirmation prompt for mid-game exit
+- [ ] Implement error handling and logging (best practice)
+- [ ] Unit tests for core logic (dice, scoring, CLI)
+- [ ] Manual test for CLI flow
+
+### Phase 2: Polish & UX Enhancements [ ]
+- [ ] Refine emoji usage (pins, balls, strikes, spares, splits, turkey, etc.)
+- [ ] Improve scorecard styling to match real bowling cards
+- [ ] Add option for single game or series of three games
+- [ ] Add help/instructions (in-menu and `-h` flag)
+- [ ] Review and update documentation
+
+### Phase 3: Future Features (Not in v1) [ ]
+- [ ] Multiplayer support
+- [ ] Save/load game sessions
+- [ ] Local/global leaderboards
+- [ ] Autoplay/debug modes
+- [ ] Command-line flags for advanced options
+- [ ] Custom rules/equipment
+
+## Key Files Modified
+
+- bin/bowlero
+- lib/bowlero.rb
+- lib/bowlero/frame.rb
+- lib/bowlero/dice.rb
+
+## Current Status
+
+Requirements and plan approved. Ready for initial gem scaffolding and CLI implementation. No blockers.
+
+## Recent Progress
+
+- Requirements clarified and confirmed with stakeholder
+- User journey and dice mechanics defined
+- Plan and phases outlined
+- 2025-05-13: CLI entry point and interactive menu implemented. Player name prompt with pun names added.
+- 2025-05-13: Full 10-frame game flow with dice logic implemented in CLI.
+- 2025-05-13: Frame class (Bowlero::Frame) added for structured frame data.
+- 2025-05-13: Refactored CLI to use Bowlero::Frame objects for each frame. Added lib/bowlero.rb to require all submodules. CLI now tracks all frame data in Frame objects.
+- 2025-06-07: Implemented standard bowling scoring logic (including strike and spare bonuses) and running/final score display.
+- 2025-06-07: Implemented ASCII bowling scorecard for perfect alignment; emojis now reserved for play-by-play and summary.
+
+## Next Steps for Next Agent
+
+> ### Handoff Note for Next Agent
+> The game now fully implements correct bowling rules for all frames, including the 10th frame (extra rolls for strikes/spares, correct pin counting, and dice logic for all rolls). The dice logic is now accurate: both the Strike Die and Split Die are rolled together for the first roll in every frame, and the result is handled as per the Dice Logic Specification. The scorecard and running/final scores are displayed correctly. Remaining tasks include: adding a confirmation prompt for mid-game exit, implementing error handling and logging, adding series mode (option for 3 games), and further polish (emojis, UX, tests, documentation). The code is ready for these next steps.
+
+- [x] Refactor the CLI game loop to use Frame objects for each frame
+- [x] Implement standard bowling scoring logic using Frame data (including strike and spare bonuses)
+- [x] Update the game summary to show running and final scores for the player
+- [x] Render ASCII bowling scorecard (ASCII only for alignment; emojis in play-by-play)
+- [x] Implement correct 10th frame logic (extra rolls for strikes/spares, correct pin counting, dice logic applies to all rolls)
+- [x] Refactor dice rolling logic to roll both Strike Die and Split Die together for the first roll in all frames, as per Dice Logic Specification
+- [ ] Add confirmation prompt for mid-game exit
+- [ ] Implement error handling and logging
+- [ ] Add series mode (option for 3 games)
+
+## Technical Details & Decisions
+
+- Dice logic: See Dice Logic Specification above for full details.
+- Scorecard: ASCII table, styled after real bowling cards, with emoji overlays.
+- Logging: Use Ruby's Logger or similar, log to file in current directory, plain text for simplicity.
+- CLI: Use Thor or OptionParser for CLI entry, but keep initial version minimal and interactive.
+- Player names: Array of 10 bowling pun names, randomly assigned if user skips input.
+
+## Migration/Data Mapping (if applicable)
+
+| Old Field/Model | New Field/Model | Notes |
+|-----------------|-----------------|-------|
+| N/A             | N/A             | First version, no migration needed |
+
+## Success Criteria
+
+1. User can install gem, run `bowlero`, and play a full single-player game with correct scoring and dice logic.
+2. Output includes ASCII scorecard and emojis for key events.
+3. Errors are handled gracefully and logged.
+4. User can exit or replay at end of game, with confirmation on mid-game exit.
+
+## Task Checklist
+
+- [ ] Gem scaffolding and CLI entry
+- [ ] Menu and player name prompt
+- [ ] Dice and scoring logic
+- [ ] Scorecard rendering with emojis
+- [ ] Error handling and logging
+- [ ] Unit and manual tests
+
+## Known Issues / Next Steps
+
+- No multiplayer, save/load, or leaderboards in v1.
+- Emoji rendering may vary by terminal.
+- Future: add debug mode, custom rules, and more polish.
+
+## Future Considerations
+
+- Multiplayer support (local and online)
+- Save/load and resume games
+- Leaderboards (local and global)
+- Autoplay/debug modes
+- Command-line flags for advanced options
+- Custom rules/equipment
+- Accessibility improvements
+
+## Testing
+
+### Model Specs
+- [ ] Dice logic: correct mapping of rolls to bowling events
+- [ ] Scoring: standard bowling rules, including strikes/spares
+
+### Controller/Request Specs
+- [ ] CLI menu navigation
+- [ ] Player name prompt and defaults
+
+### Integration/Feature Specs
+- [ ] Full game flow: start, play, score, end, replay/exit
+- [ ] Error handling and logging
+
+---
+
+## Progress Log
+- 2024-06-07: Plan drafted and approved (by PM/Stakeholder)
+- 2024-06-07: Ready for initial implementation

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: bowlero
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Benner
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Bowlero is a single-player CLI bowling game with custom dice mechanics,
+  emoji-rich output, and an ASCII scorecard. Play a full game of bowling in your terminal!
+email:
+- mike.benner@strongmind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bowlero.rb
+- lib/bowlero/dice.rb
+- lib/bowlero/frame.rb
+- lib/bowlero/version.rb
+- sig/bowlero.rbs
+- stories/KOANI-300.md
+homepage: https://github.com/refriedchicken/bowlero
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/refriedchicken/bowlero
+  source_code_uri: https://github.com/refriedchicken/bowlero
+  changelog_uri: https://github.com/refriedchicken/bowlero/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: A fun, replayable command-line bowling game Ruby gem.
+test_files: []