ro_sham_bo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6ebceb13a58c7ff84e66be32d08b422a57f41b37d361d591c69d88fbfbc9898
+  data.tar.gz: b574f3923921bce52e828b177b950277c8983ec3eb12b2d83f2948e8010963c4
+SHA512:
+  metadata.gz: '084251e4644082549a1526be1a9d827b0aca60f7fa739b1db62258f5d31a4f4c259f4baea97f421ef1313ebbc6e8a1ca309764dbac3231c2e7ca86f1708d30e8'
+  data.tar.gz: 264a793620438584bbe4ef70f7641a6aa287d43cd571baaaade783175a17f31ec35bcd07f654497289afeb1236184c9b2a330d5586c8c10870b7be90f8ffbf16

data/.gitignore

@@ -0,0 +1,2 @@
+ro_sham_bo-*.gem
+coverage/*

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Evan Gray
+
+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,46 @@
+# RoShamBo
+Simple Rock, Paper, Scissors game for the command-line, implemented in ruby.
+
+## Installation
+Just install the gem!
+```
+gem install ro_sham_bo
+```
+Alternatively, build from source.
+```
+git clone https://github.com/evanthegrayt/ro_sham_bo.git
+cd ro_sham_bo
+rake install
+```
+
+## Usage
+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
+a list of all available options, run with `-h`.
+```
+ro_sham_bo [OPTIONS]
+```
+After calling the executable, you'll be asked to enter 'rock', 'paper', or
+'scissors' (entering the first letters of the options is also accepted for
+brevity's sake). The program will also randomly choose one of these options.
+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.
+
+### Rules
+The rules are standard rock, paper, scissors rules.
+- Rock beats Scissors
+- Scissors beats Paper
+- Paper beats Rock
+
+## Reporting Bugs
+This was just a fun project for me to work on, but if you find problems, please
+[create an
+issue](https://github.com/evanthegrayt/ro_sham_bo/issues/new).
+
+## Self-Promotion
+I do these projects for fun, and I enjoy knowing that they're helpful to people.
+Consider starring [the
+repository](https://github.com/evanthegrayt/ro_sham_bo) if you like it!
+If you love it, follow me [on github](https://github.com/evanthegrayt)!

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ro_sham_bo'
+require 'bundler/gem_tasks'
+# require 'rdoc/task'
+# require 'rake/testtask'
+
+# TODO: Add tests.
+# Rake::TestTask.new do |t|
+#   t.libs = ['lib']
+#   t.warning = true
+#   t.verbose = true
+#   t.test_files = FileList['test/**/*_test.rb']
+# end
+
+# TODO: Add documentation.
+# RDoc::Task.new do |rdoc|
+#   rdoc.main = 'README.md'
+#   rdoc.rdoc_dir = 'doc'
+#   rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+# end
+
+# task default: :test

data/bin/ro_sham_bo

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require_relative '../lib/ro_sham_bo.rb'
+
+options = {rounds: 3}
+OptionParser.new do |o|
+  o.on('-c', '--[no-]clear', "Clear screen after every turn") do |f|
+    options[:clear] = f
+  end
+  o.on('-r', '--rounds=N', Integer, "Best of N rounds", "Default is 3") do |f|
+    abort("Please use an odd number") if f.even?
+    options[:rounds] = f
+  end
+end.parse!(ARGV)
+
+game = RoShamBo.new(options)
+
+system('clear') if options[:clear]
+
+puts ">> FIRST TO #{game.points_to_win} WINS! <<"
+
+until game.game_winner?
+  puts "\nCurrent score: #{game.score.inspect}"
+  print "What is your choice? (r)ock, (p)aper, or (s)cissors?: "
+  u_choice = game.user_choice($stdin.gets.chomp.downcase)
+  c_choice = game.computer_choice
+
+  if u_choice == :exit
+    break
+  elsif !u_choice
+    puts "Please enter a valid choice!"
+    next
+  end
+
+  {user: u_choice, computer: c_choice}.each { |k,v| puts "> #{k} chose #{v}" }
+  system('clear') if options[:clear]
+
+  puts "Round winner: #{game.round_winner(u_choice, c_choice)}"
+end
+
+puts game.game_winner ? "\nGame over! #{game.game_winner} won!" :
+  "\nGame was quit. Score was #{game.score.inspect}"

data/lib/ro_sham_bo.rb

@@ -0,0 +1,47 @@
+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,
+  }.freeze
+
+  attr_reader :score, :points_to_win
+
+  def initialize(options = {rounds: 3})
+    @options = options
+    @score = {user: 0, computer: 0}
+    @points_to_win = (options[:rounds].to_f / 2).ceil
+  end
+
+  def user_choice(user_input)
+    case user_input
+    when 'r', 'rock'              then :rock
+    when 'p', 'paper'             then :paper
+    when 's', 'scissors'          then :scissors
+    when 'x', 'exit', 'q', 'quit' then :exit
+    end
+  end
+
+  def computer_choice
+    RULES.keys.sample
+  end
+
+  def 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
+  end
+
+  def game_winner
+    score.key(points_to_win).capitalize if score.value?(points_to_win)
+  end
+
+  def game_winner?
+    !game_winner.nil?
+  end
+end

data/lib/ro_sham_bo/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class RoShamBo
+  ##
+  # Module that contains all gem version information. Follows semantic
+  # versioning. Read: https://semver.org/
+  module Version
+
+    ##
+    # Major version.
+    MAJOR = 0
+
+    ##
+    # Minor version.
+    MINOR = 0
+
+    ##
+    # Patch version.
+    PATCH = 1
+
+    ##
+    # Version as +MAJOR.MINOR.PATCH+
+    def self.to_s
+      "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/ro_sham_bo.gemspec

@@ -0,0 +1,32 @@
+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.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/'
+
+  unless spec.respond_to?(:metadata)
+    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.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'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: ro_sham_bo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Gray
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+description: Play rock paper scissors from the command line
+email: evanthegrayt@vivaldi.net
+executables:
+- ro_sham_bo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- bin/ro_sham_bo
+- lib/ro_sham_bo.rb
+- lib/ro_sham_bo/version.rb
+- ro_sham_bo.gemspec
+homepage: https://evanthegrayt.github.io/ro_sham_bo/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://evanthegrayt.github.io/ro_sham_bo/
+  source_code_uri: https://github.com/evanthegrayt/ro_sham_bo
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Rock Paper Scissors in Ruby
+test_files: []