tarzan 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d1f8f241b3d98808dd495d75bc8ccfcb8967e39
-  data.tar.gz: 6f297af38489451bb3876e22b888bcfb84edf0eb
+  metadata.gz: f31aa1899f9fbf7f76718daf62b6cd37ceda35b1
+  data.tar.gz: dce2d1f47a6cdaa2205c8816a261afb84d8374ad
 SHA512:
-  metadata.gz: c63d52815b50dbf9ad537a39fa5ed99f50bfbf3c85037c2d115977b7778943b342c7eb387b8dcab616fcad1a31baf0b766054387de52ee2c9a71273f643b13f3
-  data.tar.gz: 28bcfd412957d457c90a81275d1a5ee124303a2d0fffd7b5a5a67e6ac57298798c54928b7cad81e0cb2a125bdf431ce7496abbe765ac5d85c6c315cf56b74b2a
+  metadata.gz: f5b39f5e860d52b9b4390ae3e322720f307a56c40eace5a0e42178c37e928588563915d8e5b3355e3ff55b2b23fcefc67644dd524b67692c9a480c0365733564
+  data.tar.gz: c26ad5145f86c11cf6de78d836afbd570fb915c88d31ed01c9c51aeb2e75a9777983a6e0a74d59532327be69bfbb4e274e043bed4a522067fd4e105215566fc9

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'debugger'
+
 # Specify your gem's dependencies in tarzan.gemspec
 gemspec

data/HISTORY.md

@@ -0,0 +1,9 @@
+v0.0.3  - 2014/02/05
+
+* Add Odd Or Evens game
+* Separate interface, game and moves into modules
+* Integrate Campfire with Nico gem
+
+v0.0.2  - 2014/02/05
+
+* Shell-only Rock Paper Scissors game

data/README.md

@@ -22,6 +22,8 @@ From the command line run:
 
     $ tarzan
 
+To use Campfire as an interface, define the following environment variables: `CAMPFIRE_SUBDOMAIN`, `CAMPFIRE_ROOM_ID` and `CAMPFIRE_TOKEN`.
+
 ## Contributing
 
 1. Fork it ( http://github.com/claudiob/tarzan/fork )

data/bin/tarzan

@@ -7,4 +7,10 @@ rescue LoadError
   require 'tarzan'
 end
 
-Tarzan.play!
+puts %{Pick [S]hell or [C]ampfire: }
+interface = case gets.strip
+  when 'S' then Tarzan::Interfaces::Shell::Interface.new
+  when 'C' then Tarzan::Interfaces::Campfire::Interface.new subdomain: ENV['CAMPFIRE_SUBDOMAIN'], room_id: ENV['CAMPFIRE_ROOM_ID'], token: ENV['CAMPFIRE_TOKEN']
+end
+
+interface.play

data/lib/tarzan.rb

@@ -1,22 +1,2 @@
-module Tarzan
-  def self.play!
-    puts %{Welcome to the Game Hall}
-
-    puts %{Let’s play Rock Paper Scissors}
-
-    puts %{Pick [R]ock, [P]aper, or [S]cissors: }
-
-    move_p1 = gets.strip
-    move_p2 = ['R', 'P', 'S'].sample
-
-    puts %{You played #{move_p1} - I played #{move_p2}}
-
-    case "#{move_p1}#{move_p2}"
-      when 'RS', 'SP', 'PR' then puts %{You win!}
-      when 'RP', 'SR', 'PS' then puts %{You lose!}
-      when 'RR', 'SS', 'PP' then puts %{It’s a tie!}
-    end
-
-    puts %{Goodbye, and come back to the Game Hall}
-  end
-end
+require 'tarzan/interfaces/shell/interface'
+require 'tarzan/interfaces/campfire/interface'

data/lib/tarzan/games/base/game.rb

@@ -0,0 +1,42 @@
+module Tarzan
+  module Games
+    module Base
+      class Game
+        def initialize(options = {})
+          @interface = options[:interface]
+        end
+
+        def play
+          @interface.say %{Rules: #{rules}}
+
+          move_p1 = prompt_move
+          move_p2 = random_move
+
+          @interface.say %{You played #{move_p1} - I played #{move_p2}}
+
+          outcome = case move_p1 <=> move_p2
+            when 1  then %{You win!}
+            when -1 then %{You lose!}
+            when 0  then %{It’s a tie!}
+          end
+
+          @interface.say outcome
+        end
+
+      private
+
+        def rules
+          # Subclasses are expected to define rules
+        end
+
+        def prompt_move
+          # Subclasses are expected to define how to prompt the user for a move
+        end
+
+        def random_move
+          # Subclasses are expected to define how to get a random move
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/games/odds_and_evens/game.rb

@@ -0,0 +1,27 @@
+require 'tarzan/games/base/game'
+require 'tarzan/games/odds_and_evens/move'
+
+module Tarzan
+  module Games
+    module OddsAndEvens
+      class Game < Base::Game
+
+      private
+
+        def rules
+          'Odd sum wins, even sum loses'
+        end
+
+        def prompt_move
+          choice = @interface.prompt(Move.valid).to_i
+          Move.new choice: choice, wins_on_odds: true
+        end
+
+        def random_move
+          choice = Move.valid.sample
+          Move.new choice: choice, wins_on_odds: false
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/games/odds_and_evens/move.rb

@@ -0,0 +1,36 @@
+module Tarzan
+  module Games
+    module OddsAndEvens
+      class Move
+        attr_reader :choice
+
+        def self.valid
+          ('1'..'5').to_a
+        end
+
+        def initialize(options = {})
+          @wins_on_odds = options[:wins_on_odds]
+          @choice = options[:choice]
+        end
+
+        def <=>(another)
+          case choice.to_i + another.choice.to_i + finger_offset
+            when ->(sum) { sum.odd? } then 1
+            when ->(sum) { sum.even? } then -1
+            else 0 # impossible :)
+          end
+        end
+
+        def to_s
+          "#{@choice}"
+        end
+
+      private
+
+        def finger_offset
+          @wins_on_odds ? 0 : 1
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/games/rock_paper_scissors/game.rb

@@ -0,0 +1,27 @@
+require 'tarzan/games/base/game'
+require 'tarzan/games/rock_paper_scissors/move'
+
+module Tarzan
+  module Games
+    module RockPaperScissors
+      class Game < Base::Game
+
+      private
+
+        def rules
+          'Rock beats Scissors beats Paper beats Rock'
+        end
+
+        def prompt_move
+          choice = @interface.prompt Move.valid
+          Move.new choice: choice
+        end
+
+        def random_move
+          choice = Move.valid.sample
+          Move.new choice: choice
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/games/rock_paper_scissors/move.rb

@@ -0,0 +1,29 @@
+module Tarzan
+  module Games
+    module RockPaperScissors
+      class Move
+        attr_reader :choice
+
+        def self.valid
+          ['R', 'P', 'S']
+        end
+
+        def initialize(options = {})
+          @choice = options[:choice]
+        end
+
+        def <=>(another)
+          case "#{choice}#{another.choice}"
+            when 'RS', 'SP', 'PR' then 1
+            when 'RP', 'SR', 'PS' then -1
+            else 0
+          end
+        end
+
+        def to_s
+          "#{@choice}"
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/interfaces/base/interface.rb

@@ -0,0 +1,33 @@
+require 'tarzan/games/rock_paper_scissors/game'
+require 'tarzan/games/odds_and_evens/game'
+
+module Tarzan
+  module Interfaces
+    module Base
+      class Interface
+        def play
+          say %{Welcome to the Game Hall}
+
+          say %{Pick [R]ockPaperScissors or [O]ddsAndEvens: }
+
+          game = case prompt(['R', 'O'])
+            when 'R' then Tarzan::Games::RockPaperScissors::Game.new interface: self
+            when 'O' then Tarzan::Games::OddsAndEvens::Game.new interface: self
+          end
+
+          game.play
+
+          say %{Goodbye, and come back to the Game Hall}
+        end
+
+        def say(message)
+          # Subclasses are expected to define how to say messages
+        end
+
+        def prompt(valid_choices = [])
+          # Subclasses are expected to define how to prompt messages
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/interfaces/campfire/interface.rb

@@ -0,0 +1,26 @@
+require 'tarzan/interfaces/base/interface'
+require 'nico'
+
+module Tarzan
+  module Interfaces
+    module Campfire
+      class Interface < Base::Interface
+
+        def initialize(options = {})
+          @room = Nico::Room.new options
+        end
+
+        def say(message)
+          @room.say message
+        end
+
+        def prompt(valid_choices = [])
+          say %{Pick one: #{valid_choices.join ' - '} }
+          @room.each_message do |message|
+            return message if valid_choices.include?(message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/interfaces/shell/interface.rb

@@ -0,0 +1,20 @@
+require 'tarzan/interfaces/base/interface'
+
+module Tarzan
+  module Interfaces
+    module Shell
+      class Interface < Base::Interface
+
+        def say(message)
+          puts message
+        end
+
+        def prompt(valid_choices = [])
+          say %{Pick one: #{valid_choices.join ' - '} }
+          choice = gets.strip
+          valid_choices.include?(choice) ? choice : prompt(valid_choices)
+        end
+      end
+    end
+  end
+end

data/lib/tarzan/version.rb

@@ -1,3 +1,3 @@
 module Tarzan
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/tarzan/games/odds_and_evens/move_spec.rb

@@ -0,0 +1,25 @@
+require 'tarzan/games/odds_and_evens/move'
+
+module Tarzan
+  module Games
+    module OddsAndEvens
+      describe Move do
+        describe '<=>' do
+          context 'given that victory is on odds and a hand of 3 fingers' do
+            let (:move_p1) { Move.new wins_on_odds: true, fingers: 3 }
+
+            context 'versus a hand of 4 fingers' do
+              let (:move_p2) { Move.new wins_on_odds: false, fingers: 4 }
+              it { expect(move_p1 <=> move_p2).to eq 1}
+            end
+
+            context 'versus a hand of 5 fingers' do
+              let (:move_p2) { Move.new wins_on_odds: false, fingers: 5 }
+              it { expect(move_p1 <=> move_p2).to eq -1}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/tarzan/games/rock_paper_scissors/move_spec.rb

@@ -0,0 +1,30 @@
+require 'tarzan/games/rock_paper_scissors/move'
+
+module Tarzan
+  module Games
+    module RockPaperScissors
+      describe Move do
+        describe '<=>' do
+          context 'given a hand of Rock' do
+            let (:move_p1) { Move.new hand: 'R' }
+
+            context 'versus a hand of Scissors' do
+              let (:move_p2) { Move.new hand: 'S'}
+              it { expect(move_p1 <=> move_p2).to eq 1}
+            end
+
+            context 'versus a hand of Paper' do
+              let (:move_p2) { Move.new hand: 'P'}
+              it { expect(move_p1 <=> move_p2).to eq -1}
+            end
+
+            context 'versus a hand of Rock' do
+              let (:move_p2) { Move.new hand: 'R'}
+              it { expect(move_p1 <=> move_p2).to eq 0}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/tarzan.gemspec

@@ -4,20 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tarzan/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "tarzan"
+  spec.name          = 'tarzan'
   spec.version       = Tarzan::VERSION
-  spec.authors       = ["claudiob"]
-  spec.email         = ["claudiob@gmail.com"]
+  spec.authors       = ['claudiob']
+  spec.email         = ['claudiob@gmail.com']
   spec.summary       = %q{King of the Game Jungle.}
   spec.description   = %q{Step-by-step tutorial to modular games in Ruby}
-  spec.homepage      = "https://github.com/claudiob/tarzan"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/claudiob/tarzan'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 0"
+  spec.add_dependency 'nico', '>= 0.1.0' # Campfire integration
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tarzan
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - claudiob
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nico
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Step-by-step tutorial to modular games in Ruby
 email:
 - claudiob@gmail.com
@@ -47,13 +75,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/tarzan
 - lib/tarzan.rb
+- lib/tarzan/games/base/game.rb
+- lib/tarzan/games/odds_and_evens/game.rb
+- lib/tarzan/games/odds_and_evens/move.rb
+- lib/tarzan/games/rock_paper_scissors/game.rb
+- lib/tarzan/games/rock_paper_scissors/move.rb
+- lib/tarzan/interfaces/base/interface.rb
+- lib/tarzan/interfaces/campfire/interface.rb
+- lib/tarzan/interfaces/shell/interface.rb
 - lib/tarzan/version.rb
+- spec/tarzan/games/odds_and_evens/move_spec.rb
+- spec/tarzan/games/rock_paper_scissors/move_spec.rb
 - tarzan.gemspec
 homepage: https://github.com/claudiob/tarzan
 licenses:
@@ -79,4 +119,6 @@ rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: King of the Game Jungle.
-test_files: []
+test_files:
+- spec/tarzan/games/odds_and_evens/move_spec.rb
+- spec/tarzan/games/rock_paper_scissors/move_spec.rb