hangman-cli 2.0.2

data/spec/game_save_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../lib/game_save'
+require_relative '../lib/game'
+
+RSpec.describe GameSave do
+  subject(:game_save) { described_class }
+
+  let(:game) { instance_double(Game) }
+
+  describe '.save' do
+    it 'saves the a game object' do
+      file = StringIO.new
+      game_data = 'game data'
+      allow(YAML).to receive(:dump).and_return(game_data)
+      allow(File).to receive(:join).and_return('a file')
+      allow(File).to receive(:directory?).and_return(true)
+      allow(File).to receive(:open).and_yield(file)
+      game_save.save('game')
+      expect(file.string).to eql game_data
+    end
+  end
+
+  describe '.load' do
+    it 'loads saved game' do
+      file = StringIO.new
+      file.puts 'game data'
+      file.rewind
+      allow(File).to receive(:join).and_return('a file')
+      allow(File).to receive(:exist?).and_return(true)
+      allow(File).to receive(:open).and_yield(file)
+      expect(game_save.load).to eql 'game data'
+    end
+  end
+end

data/spec/game_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative '../lib/game'
+
+RSpec.describe Game do
+  subject(:game) { described_class.new }
+
+  around do |example|
+    example.run
+  rescue SystemExit
+  end
+
+  before do
+    # Suppresses puts output, comment out to reveal output again.
+    allow($stdout).to receive(:write)
+    # Suppresses auto game save
+    allow(GameSave).to receive(:save).and_return(nil)
+  end
+
+  describe 'play through' do
+    context 'with victory' do
+      it 'by guessing the correct word' do
+        word = game.word_to_guess.word
+        allow($stdin).to receive(:gets).and_return('no', 'no', 'Beth', word, 'no')
+        expect(game).to receive(:victory).and_call_original
+        game.start
+      end
+
+      it 'by guessing each letter' do
+        letters = game.word_to_guess.word.chars.uniq
+        allow($stdin).to receive(:gets).and_return('no', 'no', 'Beth', *letters, 'no')
+        expect(game).to receive(:victory).and_call_original
+        game.start
+      end
+    end
+
+    context 'with defeat' do
+      def wrong_letter
+        let = 'a'
+        word = game.word_to_guess.word
+        while word.include?(let)
+          let = let.next
+        end
+        let
+      end
+
+      it 'by guessing an incorrect word' do
+        word = game.word_to_guess.word.chars.shuffle.join
+        word = word.chars.shuffle.join
+        allow($stdin).to receive(:gets).and_return('no', 'no', 'Beth', word, 'no')
+        expect(game).to receive(:defeat).and_call_original
+        game.start
+      end
+
+      it 'by running out of lives' do
+        let = wrong_letter
+        letters = (1..6).map { let }
+        allow($stdin).to receive(:gets).and_return('no', 'no', 'Beth', *letters, 'no')
+        expect(game).to receive(:defeat).and_call_original
+        game.start
+      end
+    end
+  end
+
+  describe 'invaldation is triggered' do
+    context 'with invalid name' do
+      it 're-tries the loop if player name is invalid' do
+        allow($stdin).to receive(:gets).and_return('no', 'no', 'be', 'bee', 'quit game')
+        expect(Display).to receive(:enter_name).twice
+        game.start
+      end
+    end
+
+    context 'with invalid guess' do
+      it 're-tries the loop if guess is invalid' do
+        allow($stdin).to receive(:gets).and_return('no', 'no', 'Dan', '4', 'quit game')
+        expect(Display).to receive(:beginning_of_guess_round).twice
+        game.start
+      end
+    end
+  end
+
+  describe 'load' do
+    it 'loads previously saved game when selected' do
+      allow($stdin).to receive(:gets).and_return('load', 'quit game')
+      expect(GameSave).to receive(:load).and_call_original
+      game.start
+    end
+  end
+
+  describe 'instructions' do
+    it 'instructions are shown when selected' do
+      allow($stdin).to receive(:gets).and_return('no', 'i', 'quit game')
+      expect(Display).to receive(:instructions).and_call_original
+      game.start
+    end
+  end
+
+  describe 'reload' do
+    it 'starts a new game at game end' do
+      word = game.word_to_guess.word
+      allow($stdin).to receive(:gets).and_return('no', 'no', 'Beth', word, 'yes', 'quit game')
+      expect(described_class).to receive(:new).and_call_original
+      game.start
+    end
+  end
+end

data/spec/guess_logic_spec.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require_relative '../lib/guess_logic'
+require_relative '../lib/word_to_guess'
+require_relative '../lib/guess'
+
+RSpec.describe GuessLogic do
+  subject(:guess_logic) { described_class.new(word_to_guess) }
+
+  let(:word_to_guess) { instance_double(WordToGuess, word: 'hello') }
+
+  describe '#word_to_guess' do
+    it 'returns the word to guess' do
+      expect(guess_logic.word_to_guess).to eq 'hello'
+    end
+  end
+
+  describe '#compare' do
+    context 'when guess is correct' do
+      it 'adds the correctly guessed letters' do
+        guess = instance_double(Guess, answer: 'h')
+        guess_logic.compare(guess)
+        expect(guess_logic.guessed_letters).to eq ['h']
+      end
+
+      it 'adds the correctly guessed letter and returns all guessed letters' do
+        guess = instance_double(Guess, answer: 'e')
+        allow(guess_logic).to receive(:guessed_letters).and_return ['h']
+        guess_logic.compare(guess)
+        expect(guess_logic.guessed_letters).to eq %w[h e]
+      end
+
+      it 'adds positive message to messages' do
+        guess = instance_double(Guess, answer: 'o')
+        expect { guess_logic.compare(guess) }.to change { guess_logic.messages.size }.by(1)
+      end
+    end
+
+    context 'when guess is incorrect' do
+      it 'adds the incorrectly guessed letters' do
+        guess = instance_double(Guess, answer: 'q')
+        guess_logic.compare(guess)
+        expect(guess_logic.incorrect_letters).to eq ['q']
+      end
+
+      it 'adds the incorrectly guessed letters and returns all incorrectly guessed' do
+        guess = instance_double(Guess, answer: 'w')
+        allow(guess_logic).to receive(:incorrect_letters).and_return ['q']
+        guess_logic.compare(guess)
+        expect(guess_logic.incorrect_letters).to eq %w[q w]
+      end
+
+      it 'adds a negative message to messages' do
+        guess = instance_double(Guess, answer: 'w')
+        expect { guess_logic.compare(guess) }.to change { guess_logic.messages.size }.by(1)
+      end
+    end
+  end
+
+  describe '#guessed_word' do
+    context 'with no guesses' do
+      it 'returns the blank word to guess' do
+        expect(guess_logic.guessed_word).to eq '-----'
+      end
+    end
+
+    context 'with 1 guess right' do
+      it 'returns the correctly guessed letter filled in' do
+        guess = instance_double(Guess, answer: 'e')
+        guess_logic.compare(guess)
+        expect(guess_logic.guessed_word).to eq '-e---'
+      end
+
+      it 'returns all of the same correctly guessed letter filled in' do
+        guess = instance_double(Guess, answer: 'l')
+        guess_logic.compare(guess)
+        expect(guess_logic.guessed_word).to eq '--ll-'
+      end
+    end
+
+    context 'with 2 correct guesses' do
+      it 'returns all the correctly filled in letters' do
+        guess1 = instance_double(Guess, answer: 'h')
+        guess2 = instance_double(Guess, answer: 'o')
+        guess_logic.compare(guess1)
+        guess_logic.compare(guess2)
+        expect(guess_logic.guessed_word).to eq 'h---o'
+      end
+    end
+
+    context 'with incorrect guess' do
+      it "doesn't fill in any incorrect guesses" do
+        guess = instance_double(Guess, answer: 'x')
+        guess_logic.compare(guess)
+        expect(guess_logic.guessed_word).to eq '-----'
+      end
+    end
+  end
+
+  describe '#incorrect_guesses' do
+    it 'increases by 1 if guess is incorrect' do
+      guess = instance_double(Guess, answer: 'w')
+      expect { guess_logic.compare(guess) }.to change(guess_logic, :incorrect_guesses).by 1
+    end
+  end
+
+  describe '#full_word_guess' do
+    context 'when guess is same length as word to guess' do
+      it 'returns true' do
+        guess = instance_double(Guess, answer: 'threw')
+        expect(guess_logic.full_word_guess?(guess)).to be true
+      end
+    end
+
+    context 'when guess is not same length as word to guess' do
+      it 'returns false' do
+        guess = instance_double(Guess, answer: 'thrw')
+        expect(guess_logic.full_word_guess?(guess)).to be false
+      end
+    end
+  end
+
+  describe '#correct_word?' do
+    context 'when full word guess is correct' do
+      it 'returns true' do
+        guess = instance_double(Guess, answer: 'hello')
+        expect(guess_logic.correct_word?(guess)).to be true
+      end
+    end
+
+    context 'when full word guess is incorrect' do
+      it 'returns true' do
+        guess = instance_double(Guess, answer: 'hippo')
+        expect(guess_logic.correct_word?(guess)).to be false
+      end
+    end
+  end
+end

data/spec/guess_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../lib/guess'
+require_relative '../lib/word_to_guess'
+
+RSpec.describe Guess do
+  subject(:guess) { described_class.new('e', word_to_guess) }
+
+  let(:word_to_guess) { instance_double(WordToGuess, word: 'hello') }
+
+  describe '#valid?' do
+    context 'with valid guess' do
+      it 'is true for a single letter' do
+        expect(guess.valid?).to be true
+      end
+
+      it 'is true for a word the same length as the word to guess' do
+        guess = described_class.new('fudge', word_to_guess)
+        expect(guess.valid?).to be true
+      end
+    end
+
+    context 'with invalid guess' do
+      it 'is false for a number' do
+        guess.answer = '3'
+        expect(guess.valid?).to be false
+      end
+
+      it 'is false for an array' do
+        guess.answer = '[]'
+        expect(guess.valid?).to be false
+      end
+
+      it 'is false if more than 1 letter (and not a full word guess)' do
+        guess.answer = 'he'
+        expect(guess.valid?).to be false
+      end
+
+      it 'adds an error message to errors' do
+        guess.answer = '888'
+        guess.valid?
+        expect(guess.errors).to_not be_empty
+      end
+
+      it 'is false for a full word guess that is numbers' do
+        guess.answer = '99999'
+        expect(guess.valid?).to be false
+      end
+    end
+  end
+end

data/spec/player_name_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../lib/player_name'
+
+RSpec.describe PlayerName do
+  subject(:player_name) { described_class.new('beth') }
+
+  describe '#initialize' do
+    describe '#name' do
+      it 'sets the given name' do
+        expect(player_name.answer).to eql 'beth'
+      end
+    end
+
+    describe '#errors' do
+      it 'sets an empty array' do
+        expect(player_name.errors).to eql []
+      end
+    end
+
+    describe '#valid?' do
+      it 'calls the valid? method' do
+        expect_any_instance_of(described_class).to receive(:valid?)
+        player_name
+      end
+    end
+  end
+
+  describe '#valid?' do
+    context 'when player name is valid' do
+      it 'is true if name is between 3 and 12 chars' do
+        expect(player_name.valid?).to be true
+      end
+
+      it 'does not add an error message to errors' do
+        expect(player_name.errors).to be_empty
+      end
+    end
+
+    context 'when player name is invalid' do
+      subject(:player_name) { described_class.new('po') }
+
+      it 'is false' do
+        expect(player_name.valid?).to be false
+      end
+
+      it 'is false if name is below 3 chars' do
+        player_name = described_class.new('po')
+        expect(player_name.valid?).to be false
+      end
+
+      it 'is false if name is longer than 12 chars' do
+        player_name = described_class.new('montgomery the third esquire')
+        expect(player_name.valid?).to be false
+      end
+
+      it 'adds an error message to errors' do
+        expect(player_name.errors).to_not be_empty
+      end
+    end
+  end
+end

data/spec/player_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative '../lib/player'
+
+RSpec.describe Player do
+  subject(:player) { described_class.new('jess') }
+
+  it 'has a capitalized name' do
+    expect(player.name).to eql 'Jess'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+require 'simplecov'
+SimpleCov.start do
+  enable_coverage :branch
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 3
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end