ro_sham_bo 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce77bcab61a9ae0943e2c524ce9db8549f2f655fe0c94b232459af086332416e
-  data.tar.gz: '0692f563d97e79eedbf2e52d9d06c5b26cafbe7cb4c8f1472b2325ffe2066f69'
+  metadata.gz: 18c5694e6c976138f96301fba33a604a8bdea019c83a0a9877aac0dde5d4930a
+  data.tar.gz: 00b2827afb8f3e2809b70b884292a2edae559f8518cea936c291b585ab374e31
 SHA512:
-  metadata.gz: d777b31737a483305adc350b97a5fd3983b15f1ba64905c667bbe3862c60ef2f72e458b3cccea258b36e904dccbd956fbecbbe1b3f5720fcdb30e1329a837d7f
-  data.tar.gz: 3598e5ce1fbbbea18391fa235994b7e364eeccdd7780465c0f27386baa60e0953e471b605fe6fa608ccf01477fca70254698fb819e7735584541347e283c29b8
+  metadata.gz: 9fbc808f35951ea2d74fcdc896266cecf27d1083a5710119f94a7818779d3f615a0e31a262cdfc1ad682bfaacf1e0f9f4b0fab035ddc33d5df6d0e898d2c74fc
+  data.tar.gz: 0e494de6e32c446478d73567e0eb48c5ab7fb99e366727276175645e1cf0371a5864f9d68033bc27d22ec3e3137dde1dfb46e83f2a9f64643cd03510bb5bab40

data/.github/workflows/ruby.yml

@@ -1,4 +1,4 @@
-name: Ruby
+name: Ruby CI
 
 on:
   push:
@@ -11,14 +11,17 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.1', '3.0']
+
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install
-        bundle exec rake test
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ro_sham_bo (0.1.0)
+    ro_sham_bo (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -19,6 +19,7 @@ GEM
       power_assert
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES

data/README.md

@@ -18,6 +18,7 @@ rake install
 ```
 
 ## Usage
+### Command Line
 Just call the `ro_sham_bo` executable, which should now be in your `$PATH`.
 The default number of rounds is best-of `3`. This can be altered with the
 `-r [NUMBER OF ROUNDS]` option. The number passed must be an odd number. To see
@@ -32,11 +33,77 @@ Once you hit `[return]`, your choice will be compared to the computer's choice,
 and a winner for that round will be chosen based off the classic rules of the
 game.
 
+```
+$ ro_sham_bo
+>> FIRST TO 2 WINS! <<
+
+Current score: {:user=>0, :computer=>0}
+What is your choice? (r)ock, (p)aper, or (s)cissors?: p
+> user chose paper
+> computer chose paper
+Round winner: draw
+
+Current score: {:user=>0, :computer=>0}
+What is your choice? (r)ock, (p)aper, or (s)cissors?: s
+> user chose scissors
+> computer chose rock
+Round winner: computer
+
+Current score: {:user=>0, :computer=>1}
+What is your choice? (r)ock, (p)aper, or (s)cissors?: r
+> user chose rock
+> computer chose paper
+Round winner: computer
+
+Game over! Computer won!
+Score was {:user=>0, :computer=>2}
+```
+
 Cheating is possible, both for the user and the computer. Pass `-c` (or `-c
 user`) for the user to always win. Pass `-c computer` to make the computer win.
-It will still look real; cheating only actually happens when the non-cheater has
-one less point than is needed to win. Even then, it can still return a draw for
-that round.
+It will still look real; cheating only actually happens when the non-cheater
+only needs one more point to win. Even then, it can still return a draw for that
+round.
+
+### Console
+You can play via an IRB/Pry console via the gem's API.
+
+```ruby
+require 'ro_sham_bo'
+# => true
+
+game = RoShamBo.new
+# => #<RoShamBo:0x00007f7ffa99a5a8
+#  @cheater=nil,
+#  @draws=0,
+#  @points_to_win=2,
+#  @rounds=3,
+#  @score={:user=>0, :computer=>0}>
+
+game.play(:rock)
+#=> #<RoShamBo:0x00007f7ffa99a5a8
+# @cheater=nil,
+# @computer_choice=:rock,
+# @draws=1,
+# @points_to_win=2,
+# @round_winner=:draw,
+# @rounds=3,
+# @score={:user=>0, :computer=>0},
+# @user_choice=:rock>
+
+game.play(%i[rock paper scissors].sample) until game.over?
+game
+# => #<RoShamBo:0x00007f7ffa99a5a8
+#  @cheater=nil,
+#  @computer_choice=:paper,
+#  @draws=3,
+#  @points_to_win=2,
+#  @round_winner=:user,
+#  @rounds=3,
+#  @score={:user=>2, :computer=>0},
+#  @user_choice=:scissors,
+#  @winner=:user>
+```
 
 ### Rules
 The rules are standard rock, paper, scissors rules.

data/Rakefile

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative 'lib/ro_sham_bo'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-# require 'rdoc/task'
+require_relative "lib/ro_sham_bo"
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
 
 Rake::TestTask.new do |t|
-  t.libs = ['lib']
+  t.libs = ["lib"]
   t.warning = true
   t.verbose = true
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 # TODO: Add documentation.

data/bin/ro_sham_bo

@@ -12,7 +12,7 @@ OptionParser.new do |o|
     abort("Please use an odd number") if f.even?
     options[:rounds] = f
   end
-  o.on('-c', '--cheater [USER]', 'Choose who wins', 'user/computer') do |f|
+  o.on('-C', '--cheater [USER]', 'Choose who wins', 'user/computer') do |f|
     options[:cheater] =
       if f.nil?
         :user

data/lib/ro_sham_bo/version.rb

@@ -5,23 +5,54 @@ class RoShamBo
   # Module that contains all gem version information. Follows semantic
   # versioning. Read: https://semver.org/
   module Version
-
     ##
     # Major version.
+    #
+    # @return [Integer]
     MAJOR = 0
 
     ##
     # Minor version.
+    #
+    # @return [Integer]
     MINOR = 1
 
     ##
     # Patch version.
-    PATCH = 0
+    #
+    # @return [Integer]
+    PATCH = 2
+
+    module_function
+
+    ##
+    # Version as +[MAJOR, MINOR, PATCH]+
+    #
+    # @return [Array<Integer>]
+    def to_a
+      [MAJOR, MINOR, PATCH]
+    end
 
     ##
     # Version as +MAJOR.MINOR.PATCH+
-    def self.to_s
-      "#{MAJOR}.#{MINOR}.#{PATCH}"
+    #
+    # @return [String]
+    def to_s
+      to_a.join(".")
+    end
+
+    ##
+    # Version as +{major: MAJOR, minor: MINOR, patch: PATCH}+
+    #
+    # @return [Hash]
+    def to_h
+      %i[major minor patch].zip(to_a).to_h
     end
   end
+
+  ##
+  # The version, as a string.
+  #
+  # @return [String]
+  VERSION = Version.to_s
 end

data/lib/ro_sham_bo.rb

@@ -1,15 +1,16 @@
-require_relative 'ro_sham_bo/version'
+require_relative "ro_sham_bo/version"
 
 class RoShamBo
   RULES = {
-    rock:     {rock: :draw, paper: :lose, scissors: :win}.freeze,
-    paper:    {rock: :win,  paper: :draw, scissors: :lose}.freeze,
-    scissors: {rock: :lose, paper: :win,  scissors: :draw}.freeze,
+    rock: {rock: :draw, paper: :lose, scissors: :win}.freeze,
+    paper: {rock: :win, paper: :draw, scissors: :lose}.freeze,
+    scissors: {rock: :lose, paper: :win, scissors: :draw}.freeze
   }.freeze
 
   attr_reader :cheater
   attr_reader :rounds
   attr_reader :score
+  attr_reader :draws
   attr_reader :points_to_win
   attr_reader :user_choice
   attr_reader :computer_choice
@@ -18,19 +19,20 @@ class RoShamBo
 
   def initialize(cheater: nil, rounds: 3)
     if rounds.even?
-      raise ArgumentError, 'rounds must be odd'
+      raise ArgumentError, "rounds must be odd"
     elsif ![nil, :user, :computer].include?(cheater)
-      raise ArgumentError, 'cheater must be :computer or :user'
+      raise ArgumentError, "cheater must be :computer or :user"
     end
 
     @cheater = cheater
     @rounds = rounds
     @score = {user: 0, computer: 0}
+    @draws = 0
     @points_to_win = (rounds.to_f / 2).ceil
   end
 
   def play(input)
-    raise RuntimeError, 'Game Over!' if over?
+    raise "Game Over!" if over?
 
     @user_choice = sanitized_choice(input)
     @computer_choice = computer_turn(user_choice)
@@ -47,22 +49,19 @@ class RoShamBo
   private
 
   def determine_round_winner(u_choice, c_choice)
-    winner =
-      case RULES[u_choice][c_choice]
-      when :win  then :user
-      when :lose then :computer
-      else :draw
-      end
-    score[winner] += 1 unless winner == :draw
-    winner
+    case RULES.dig(u_choice, c_choice)
+    when :win then :user
+    when :lose then :computer
+    else :draw
+    end.tap { |winner| (winner == :draw) ? @draws += 1 : score[winner] += 1 }
   end
 
   def sanitized_choice(input)
     case input
-    when 'r', 'rock', :r, :rock then :rock
-    when 'p', 'paper', :p, :paper then :paper
-    when 's', 'scissors', :s, :scissors then :scissors
-    else raise ArgumentError, 'Invalid choice [rpsx]'
+    when "r", "rock", :r, :rock then :rock
+    when "p", "paper", :p, :paper then :paper
+    when "s", "scissors", :s, :scissors then :scissors
+    else raise ArgumentError, "Invalid choice [rpsx]"
     end
   end
 
@@ -77,7 +76,7 @@ class RoShamBo
   end
 
   def cheat(input, win_or_lose)
-    rand >= 0.33 ? RULES[input].key(win_or_lose) : RULES[input].key(:draw)
+    (rand >= 0.33) ? RULES[input].key(win_or_lose) : RULES[input].key(:draw)
   end
 
   def about_to_win?(user)

data/ro_sham_bo.gemspec

@@ -1,34 +1,33 @@
-require_relative 'lib/ro_sham_bo/version'
+require_relative "lib/ro_sham_bo/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ro_sham_bo'
-  spec.version       = RoShamBo::Version.to_s
-  spec.authors       = ['Evan Gray']
-  spec.email         = 'evanthegrayt@vivaldi.net'
-  spec.license       = 'MIT'
-  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.name = "ro_sham_bo"
+  spec.version = RoShamBo::VERSION
+  spec.authors = ["Evan Gray"]
+  spec.email = "evanthegrayt@vivaldi.net"
+  spec.license = "MIT"
 
-  spec.summary       = %q{Rock Paper Scissors in Ruby}
-  spec.description   = %q{Play rock paper scissors from the command line}
-  spec.homepage      = 'https://evanthegrayt.github.io/ro_sham_bo/'
+  spec.summary = %(Rock Paper Scissors in Ruby)
+  spec.description = %(Play rock paper scissors from the command line)
+  spec.homepage = "https://evanthegrayt.github.io/ro_sham_bo/"
 
   unless spec.respond_to?(:metadata)
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
   end
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] =
-    'https://github.com/evanthegrayt/ro_sham_bo'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] =
+    "https://github.com/evanthegrayt/ro_sham_bo"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
-  spec.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.5'
-  spec.add_development_dependency 'simplecov'
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  spec.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.5"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ro_sham_bo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Rock Paper Scissors in Ruby