hangman-game 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a907fa8db46ea202a1e0b8bcb3830035579b940
+  data.tar.gz: 88e11f52932a137d6b863c41779b82bc00c4b5af
+SHA512:
+  metadata.gz: 82fcce2312f4b45bd73474b9a8dbbf494f4259380d551211f9493d2653d1ee496ac1fa66b859372b9e06704848be0d0d3fdfb7d8e8207c858e8c701689c7fbc5
+  data.tar.gz: b7a1c6517175ba0f4740badd51a4a37efb63511b8313c6fe8eeae261cd23cc9a850a673f782248d4c37ce04dcd471a0a957c3dd5580e2324033059c22e3ea6ed

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Austin Schneider
+
+MIT License
+
+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,29 @@
+# Hangman
+
+Hangman engine
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hangman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hangman
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hangman.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hangman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hangman-game"
+  spec.version       = Hangman::VERSION
+  spec.authors       = ["Austin Schneider"]
+  spec.email         = ["austinthecoder@gmail.com"]
+  spec.description   = "Hangman engine"
+  spec.summary       = "Hangman engine"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 2.14'
+end

data/lib/hangman/game.rb

@@ -0,0 +1,43 @@
+require 'hangman'
+
+module Hangman
+  class Game
+    def initialize(word)
+      @word = word
+      @guesses = Set.new
+    end
+
+    attr_reader :guesses, :word
+
+    def guess(letter)
+      raise GameOverError, 'Cannot guess: game is over' if status != :in_progress
+      guesses << letter
+    end
+
+    def incorrect_guesses
+      guesses.select { |l| !word_letters.include? l }
+    end
+
+    def status
+      if incorrect_guesses.size < 6
+        if word_letters.all? { |l| guesses.include? l }
+          :won
+        else
+          :in_progress
+        end
+      else
+        :lost
+      end
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && guesses == other.guesses && word == other.word
+    end
+
+    private
+
+    def word_letters
+      @word_letters ||= word.split('').tap(&:uniq!)
+    end
+  end
+end

data/lib/hangman/version.rb

@@ -0,0 +1,3 @@
+module Hangman
+  VERSION = "0.0.1"
+end

data/lib/hangman.rb

@@ -0,0 +1,18 @@
+require "hangman/version"
+require 'hangman/game'
+
+module Hangman
+  class Error < StandardError
+  end
+
+  class GameOverError < Error
+  end
+
+  class << self
+    attr_accessor :word_list
+
+    def new_game
+      Game.new word_list.shuffle[0]
+    end
+  end
+end

data/spec/hangman/game_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require_relative '../../lib/hangman/game'
+
+module Hangman
+  describe Game do
+    it 'marshals' do
+      game = Game.new 'foo'
+      game.guess 'a'
+
+      unmarshaled_game = Marshal.load(Marshal.dump(game))
+
+      expect(game).to eq(unmarshaled_game)
+    end
+
+    describe '#word' do
+      it 'is the given word' do
+        Game.new('foo').word.should == 'foo'
+      end
+    end
+
+    describe '#guesses' do
+      it { expect(Game.new('foo').guesses).to be_empty }
+    end
+
+    describe '#guess' do
+      let(:game) { Game.new 'foo' }
+
+      context 'when the game is in progress' do
+        context 'when the letter was already guessed' do
+          it 'does not change the list of guesses' do
+            game.guess 'a'
+            expect { game.guess 'a' }.to_not change { game.guesses }
+          end
+        end
+
+        context 'when the letter was not already guessed' do
+          it 'adds the letter to the list of guesses' do
+            game = Game.new('foo')
+            game.guess 'a'
+            expect(game.guesses).to include('a')
+          end
+        end
+      end
+
+      context 'when the game is not in progress' do
+        it 'raises an error' do
+          %w[f o].each { |l| game.guess l }
+          expect {
+            game.guess 'a'
+          }.to raise_error(Hangman::GameOverError, "Cannot guess: game is over")
+        end
+      end
+    end
+
+    describe '#incorrect_guesses' do
+      it 'a list of incorrectly guessed letters' do
+        game = Game.new('hangman')
+        game.guess 'a'
+        game.guess 'x'
+        expect(game.incorrect_guesses).to_not include('a')
+        expect(game.incorrect_guesses).to include('x')
+      end
+    end
+
+    describe '#status' do
+      let(:game) { Game.new 'hangman' }
+
+      context 'when there are 6 incorrect guesses' do
+        it 'is :lost' do
+          %w[x y z q f h a n g l].each { |l| game.guess l }
+          expect(game.status).to eq :lost
+        end
+      end
+
+      context 'when there is less than 6 incorrect guesses' do
+        context 'when all letters were guessed' do
+          it 'is :won' do
+            %w[x y z q f h a n g m].each { |l| game.guess l }
+            expect(game.status).to eq :won
+          end
+        end
+
+        context 'when all letters were not guessed' do
+          it 'is :in_progress' do
+            %w[x y z q f h a n g].each { |l| game.guess l }
+            expect(game.status).to eq :in_progress
+          end
+        end
+      end
+    end
+
+    describe '#==' do
+      it 'is true given another Hangman game with the same word & guesses' do
+        game = Game.new('foo')
+        game.guess 'a'
+
+        other_game = Game.new('foo')
+        other_game.guess 'a'
+
+        expect(game).to eq(other_game)
+      end
+
+      it 'is false given another Hangman game with different guesses' do
+        game = Game.new('foo')
+        game.guess 'a'
+
+        other_game = Game.new('foo')
+        other_game.guess 'b'
+
+        expect(game).to_not eq(other_game)
+      end
+
+      it 'is false given another Hangman game with a different word' do
+        game = Game.new('foo')
+        game.guess 'a'
+
+        other_game = Game.new('bar')
+        other_game.guess 'a'
+
+        expect(game).to_not eq(other_game)
+      end
+    end
+  end
+end

data/spec/hangman_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require_relative '../lib/hangman'
+
+describe Hangman do
+  describe Hangman::Error do
+    it { expect(Hangman::Error.new).to be_a StandardError  }
+  end
+
+  describe Hangman::GameOverError do
+    it { expect(Hangman::GameOverError.new).to be_a Hangman::Error  }
+  end
+
+  describe '.new_game' do
+    it 'returns a new Hangman::Game with a random word from the word list' do
+      Hangman.word_list = ['foo']
+      expect(Hangman.new_game).to eq(Hangman::Game.new('foo'))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hangman-game
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Austin Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Hangman engine
+email:
+- austinthecoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hangman.gemspec
+- lib/hangman.rb
+- lib/hangman/game.rb
+- lib/hangman/version.rb
+- spec/hangman/game_spec.rb
+- spec/hangman_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Hangman engine
+test_files:
+- spec/hangman/game_spec.rb
+- spec/hangman_spec.rb
+- spec/spec_helper.rb