hangman-cli 2.0.2

data/lib/player_name.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'answer'
+
+# Class to model a player's name given as an answer
+class PlayerName < Answer
+  attr_reader :answer
+
+  def initialize(answer)
+    super(answer)
+    valid?
+  end
+
+  def valid?
+    self.errors = []
+    errors << 'Name must be between 3 - 12 chars.' unless valid_size?
+    errors.empty?
+  end
+
+  private
+
+  def valid_size?
+    answer.size > 2 && answer.size < 13
+  end
+end

data/lib/word_to_guess.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Class to model the word to guess
+class WordToGuess
+  attr_reader :word
+
+  def initialize(word)
+    @word = word
+  end
+end

data/spec/answer_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative '../lib/answer'
+
+RSpec.describe Answer do
+  describe '#answer' do
+    it 'returns the current guess' do
+      answer = described_class.new('e')
+      expect(answer.answer).to eql 'e'
+    end
+
+    it 'downcases any guess' do
+      answer = described_class.new('E')
+      expect(answer.answer).to eql 'e'
+    end
+
+    it 'removes any newlines' do
+      answer = described_class.new("e\n")
+      expect(answer.answer).to eql 'e'
+    end
+
+    it 'removes tabs' do
+      answer = described_class.new("e\r")
+      expect(answer.answer).to eql 'e'
+    end
+
+    it 'removes added white space' do
+      answer = described_class.new('e    ')
+      expect(answer.answer).to eql 'e'
+    end
+  end
+
+  describe '#quit_game?' do
+    context 'when player chooses to quit game' do
+      it 'is true' do
+        answer = described_class.new('hello')
+        answer.answer = 'quit game'
+        expect(answer.quit_game?).to be true
+      end
+    end
+  end
+end

data/spec/dictionary_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../lib/dictionary'
+
+RSpec.describe Dictionary do
+  subject(:dictionary) { described_class.new(file) }
+
+  let(:file) { 'test_file.txt' }
+
+  describe '#word' do
+    it 'returns a string' do
+      expect(dictionary.word).to be_a String
+    end
+
+    it 'returns a string only containing letters' do
+      word = dictionary.word
+      expect(word).to satisfy('only contain letters') do
+        word.chars.all? { |letter| letter =~ /[a-z]/i }
+      end
+    end
+
+    it 'returns a word between 5 and 12 characters' do
+      expect(dictionary.word.size).to be >= 5 and be <= 12
+    end
+
+    it 'returns a downcase string' do
+      word = dictionary.word
+      expect(word).to eql word.downcase
+    end
+  end
+end

data/spec/display_spec.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+require_relative '../lib/display'
+require_relative '../lib/guess_logic'
+require_relative '../lib/word_to_guess'
+require_relative '../lib/player'
+require_relative '../lib/player_name'
+require_relative '../lib/guess'
+
+RSpec.describe Display do
+  subject(:display) { described_class }
+
+  let(:guess_logic) do
+    instance_double(GuessLogic,
+                    guessed_word: '-e---',
+                    guessed_letters: ['e'],
+                    incorrect_letters: %w[w y z],
+                    incorrect_guesses: 2,
+                    messages: ['Correct guess!'])
+  end
+
+  describe '.welcome_message' do
+    it 'displays welcome message' do
+      expect { display.welcome_message }.to output.to_stdout
+    end
+  end
+
+  describe '.instruction_intro' do
+    it 'displays instruction intro message' do
+      expect { display.instruction_intro }.to output.to_stdout
+    end
+  end
+
+  describe '.play_again' do
+    it 'displays instruction intro message' do
+      expect { display.play_again }.to output.to_stdout
+    end
+  end
+
+  describe '.leave' do
+    it 'displays goodbye message' do
+      expect { display.leave }.to output.to_stdout
+    end
+  end
+
+  describe '.instructions' do
+    it 'displays instruction intro message' do
+      expect { display.instructions }.to output.to_stdout
+    end
+  end
+
+  describe '.enter_name' do
+    it 'displays enter name text' do
+      expect { display.enter_name }.to output.to_stdout
+    end
+  end
+
+  describe '.thank_player' do
+    it 'display thank you message' do
+      player = instance_double(Player, name: 'Helen')
+      expect { display.thank_player(player) }.to output.to_stdout
+    end
+  end
+
+  describe '.word_to_guess' do
+    it 'displays the word to guess' do
+      expect { display.word_to_guess(guess_logic) }.to output(" Word to guess: -e---\n").to_stdout
+    end
+  end
+
+  describe '.beginning_of_guess_round' do
+    it 'displays beginning of round info' do
+      expect { display.beginning_of_guess_round(guess_logic) }.to output.to_stdout
+    end
+  end
+
+  describe '.end_of_guess_round' do
+    context 'when correct guess' do
+      it 'displays end of game round information' do
+        expect { display.end_of_guess_round(guess_logic) }.to output("Correct guess!\n").to_stdout
+      end
+    end
+  end
+
+  describe '.gallows' do
+    context 'when 0 incorrect guesses' do
+      it 'displays the gallows' do
+        allow(guess_logic).to receive(:incorrect_guesses).and_return(0)
+        start = <<-START
+    ===========
+      |/    |
+      |
+      |
+      |
+      |\\
+    ============
+        START
+        expect { display.gallows(guess_logic) }.to output(start).to_stdout
+      end
+    end
+
+    context 'with 1 incorrect guess' do
+      it 'displays gallows and head' do
+        allow(guess_logic).to receive(:incorrect_guesses).and_return(1)
+        head = <<-HEAD
+    ===========
+      |/    |
+      |     O
+      |
+      |
+      |\\
+    ============
+        HEAD
+        expect { display.gallows(guess_logic) }.to output(head).to_stdout
+      end
+    end
+
+    context 'with 2 incorrect guesses' do
+      it 'displays gallows, head and body' do
+        allow(guess_logic).to receive(:incorrect_guesses).and_return(2)
+        body = <<-BODY
+    ===========
+      |/    |
+      |     O
+      |     |
+      |
+      |\\
+    ============
+        BODY
+        expect { display.gallows(guess_logic) }.to output(body).to_stdout
+      end
+    end
+
+    context 'with 3 incorrect guess' do
+      it 'displays gallows, head, right-arm and body' do
+        allow(guess_logic).to receive(:incorrect_guesses).and_return(3)
+        right_arm = <<-RIGHT_ARM
+    ===========
+      |/    |
+      |     O
+      |    /|
+      |
+      |\\
+    ============
+        RIGHT_ARM
+        expect { display.gallows(guess_logic) }.to output(right_arm).to_stdout
+      end
+    end
+
+    context 'with 4 incorrect guesses' do
+      it 'displays the gallows, head, right-arm, left-arm and body' do
+        allow(guess_logic).to receive(:incorrect_guesses).and_return(4)
+        left_arm = <<-LEFT_ARM
+    ===========
+      |/    |
+      |     O
+      |    /|\\
+      |
+      |\\
+    ============
+        LEFT_ARM
+        expect { display.gallows(guess_logic) }.to output(left_arm).to_stdout
+      end
+    end
+
+    context 'with 5 incorrect guesses' do
+      it 'displays the gallows, head, right-arm, left-arm, right-leg and body' do
+        allow(guess_logic).to receive(:incorrect_guesses).and_return(5)
+        right_leg = <<-RIGHT_LEG
+    ===========
+      |/    |
+      |     O
+      |    /|\\
+      |    /
+      |\\
+    ============
+        RIGHT_LEG
+        expect { display.gallows(guess_logic) }.to output(right_leg).to_stdout
+      end
+    end
+
+    context 'with 6 incorrect guesses' do
+      it 'displays the gallows and whole body' do
+        allow(guess_logic).to receive(:incorrect_guesses).and_return(6)
+        finish = <<-FINISH
+    ===========
+      |/    |
+      |     O
+      |    /|\\
+      |    / \\
+      |\\
+    ============
+        FINISH
+        expect { display.gallows(guess_logic) }.to output(finish).to_stdout
+      end
+    end
+  end
+
+  describe '.validation_errors' do
+    context 'when validation error has been triggered' do
+      it 'displays validation errors' do
+        errors = ['Name must be between 3 and 12 characters.']
+        expect { display.validation_errors(errors) }.to output.to_stdout
+      end
+    end
+
+    context 'when validation error has not been triggered' do
+      it 'does not display an error message' do
+        errors = []
+        expect { display.validation_errors(errors) }.to_not output.to_stdout
+      end
+    end
+  end
+
+  describe '.victory' do
+    it 'displays victory text' do
+      word_to_guess = instance_double(WordToGuess, word: 'hello')
+      expect { display.victory(word_to_guess) }.to output.to_stdout
+    end
+  end
+
+  describe '.defeat' do
+    it 'displays defeat text' do
+      word_to_guess = instance_double(WordToGuess, word: 'hello')
+      expect { display.defeat(word_to_guess) }.to output.to_stdout
+    end
+  end
+
+  describe '.load' do
+    it 'displays load game text' do
+      expect { display.load_game }.to output.to_stdout
+    end
+  end
+end

data/spec/gallows_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative '../lib/gallows'
+
+RSpec.describe Gallows do
+  subject(:gallows) { described_class }
+
+  describe '#start' do
+    it 'returns the starting gallows' do
+      start = <<-START
+    ===========
+      |/    |
+      |
+      |
+      |
+      |\\
+    ============
+      START
+
+      expect(gallows.start).to eq start
+    end
+  end
+
+  describe '#head' do
+    it 'returns the gallows with head' do
+      head = <<-HEAD
+    ===========
+      |/    |
+      |     O
+      |
+      |
+      |\\
+    ============
+      HEAD
+
+      expect(gallows.head).to eq head
+    end
+  end
+
+  describe '#body' do
+    it 'returns the gallows with body' do
+      body = <<-BODY
+    ===========
+      |/    |
+      |     O
+      |     |
+      |
+      |\\
+    ============
+      BODY
+
+      expect(gallows.body).to eq body
+    end
+  end
+
+  describe '#right_arm' do
+    it 'returns the gallows with right arm' do
+      right_arm = <<-RIGHT_ARM
+    ===========
+      |/    |
+      |     O
+      |    /|
+      |
+      |\\
+    ============
+      RIGHT_ARM
+
+      expect(gallows.right_arm).to eq right_arm
+    end
+  end
+
+  describe '#left_arm' do
+    it 'returns the gallows with left arm' do
+      left_arm = <<-LEFT_ARM
+    ===========
+      |/    |
+      |     O
+      |    /|\\
+      |
+      |\\
+    ============
+      LEFT_ARM
+
+      expect(gallows.left_arm).to eq left_arm
+    end
+  end
+
+  describe '#right_leg' do
+    it 'returns the gallows with right leg' do
+      right_leg = <<-RIGHT_LEG
+    ===========
+      |/    |
+      |     O
+      |    /|\\
+      |    /
+      |\\
+    ============
+      RIGHT_LEG
+
+      expect(gallows.right_leg).to eq right_leg
+    end
+  end
+
+  describe '#left_leg' do
+    it 'returns the gallows with left leg' do
+      finish = <<-FINISH
+    ===========
+      |/    |
+      |     O
+      |    /|\\
+      |    / \\
+      |\\
+    ============
+      FINISH
+
+      expect(gallows.finish).to eq finish
+    end
+  end
+end