femis_hangman 0.1.0 → 0.1.1

data/femis_hangman.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Femi Senjobi"]
   spec.email         = ["femi.senjobi@andela.com"]
 
-  spec.summary       = %q{Guess or be hanged}
-  spec.description   = %q{Guess one letter at a time.}
+  spec.summary       = "It is a do or die affiar. Get the words right or you'll be hanged"
+  spec.description   = "This gem is an implementation of the hangman.rb game.\nAttempt to guess the missing letters correctly.\nYou have a limited number of tries.\nIf you use up all your chances without getting the word correctly,\nyou will be hanged."
   spec.homepage      = "https://github.com/andela-fsenjobi/femis_hangman"
   spec.license       = "MIT"
 
@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.11"

data/lib/femis_hangman/game.rb

@@ -0,0 +1,122 @@
+module FemisHangman
+  class Game
+    include(Message)
+    attr_accessor :turns, :history, :word, :feedback, :status
+
+    def initialize(difficulty, feedback)
+      word = Word.new
+      @word = word.generate(difficulty)
+      @history = []
+      @turns = 7 + difficulty
+      @feedback = feedback
+      @status = 'play'
+    end
+
+    def control(input)
+      if input.size > 1
+        commands(input)
+      elsif input.size == 1
+        play(input)
+      else
+        invalid_prompt
+      end
+    end
+
+    def commands(input)
+      case input
+        when ':h', 'history' then print_text("You have used: #{game_history}")
+        when ':q', 'quit' then quit_game
+        else invalid_prompt
+      end
+    end
+
+    def play(input)
+      include_letter(input, @history)
+      @turns -= 1 unless @word.include?(input)
+      check_game
+    end
+
+    def include_letter(letter, history)
+      if history.include?(letter)
+        duplicate_prompt(letter)
+        false
+      else
+        history << letter
+        @history = history
+      end
+      @history
+    end
+
+    def check_game
+      if won? then game_won
+      elsif lost? then game_lost
+      else
+        turns_prompt(@turns)
+        puts show_word
+      end
+    end
+
+    def show_word
+      word = @word.split('')
+      output = ''
+      word.each do |letter|
+        if @history.include?(letter)
+          output << "#{letter} "
+        else
+          output << '_ '
+        end
+      end
+      output
+    end
+
+    def won?
+      word = @word.split('')
+      length = 0
+      word.each {|val| length += 1 if @history.include?(val)}
+      if length == word.size
+        true
+      else
+        false
+      end
+    end
+
+    def lost?
+      @turns == 0
+    end
+
+    def game_won
+      if @feedback == 2
+        won_gui(@word)
+      else
+        won_prompt(@word)
+      end
+      replay_prompt
+      @status = 'restart'
+    end
+
+    def game_lost
+      if @feedback == 2
+        lost_gui(@word)
+      else
+        lost_prompt(@word)
+      end
+      replay_prompt
+      @status = 'restart'
+    end
+
+    def game_history
+      output = ''
+      if @history.empty?
+        ''
+      else
+        @history.each {|letter| output << "#{letter} "}
+      end
+      output
+    end
+
+    def quit_game
+      @status = 'quit'
+      save_prompt
+    end
+  end
+end

data/lib/femis_hangman/message.rb

@@ -0,0 +1,114 @@
+module Message
+  def welcome_prompt
+    puts 'Welcome to Hangman. Guess right or get hanged!'
+  end
+
+  def size_prompt(size)
+    puts "Your word is a #{size} letter word"
+  end
+
+  def load_prompt
+    puts "Choose the game you want to resume.rb from the list below\nPress the respective number"
+  end
+
+  def begin_prompt
+    puts "Let the games begin\n\n"
+  end
+
+  def instructions_prompt
+    puts "########################################################\n\nThis gem is an implementation of the hangman.rb game.\nAttempt to guess the missing letters correctly.\nYou have a limited number of tries.\nIf you use up all your chances without getting\nthe word correctly, you will be hanged.\n\n"
+    puts "To play a new game: Press 'p' or 'play'"
+    puts "To load a saved game: Press 'l' or 'load'"
+    puts "To show insructions: Press 'i' or 'instructions'"
+    puts "To quit Hangman: Press 'q' or 'quit'"
+    puts "\n########################################################"
+  end
+
+  def save_prompt
+    puts "Press 's' or 'save' to save before quiting\nPress 'q' to quit anyway"
+  end
+
+  def lost_prompt(word)
+    puts "You are dead!\nThe word is #{word}"
+    puts "Press any key to continue or 'q' to quit"
+  end
+
+  def won_prompt(word)
+    puts "You win!\nThe word is #{word}"
+  end
+
+  def lost_gui(word)
+    puts <<-DEAD
+-+----------+-
+ |          |
+ |          o
+ |         /|\\
+ |         / \\
+ |
+ |
+ |
+You are dead!
+################
+The word is #{word}
+################
+    DEAD
+  end
+
+  def won_gui(word)
+   puts <<-DEAD
+-+----------+-
+ |          |
+ |
+ |
+ |           o/
+ |          /|
+ |         \\/ \\
+ |            /
+You are free to go
+################
+The word is #{word}
+################
+    DEAD
+  end
+
+  def level_prompt
+    puts "Choose your difficulty level\n\n1: Beginner\n2: Intermediate\n3: Advanced"
+  end
+
+  def feedback_prompt
+    puts "Choose your feedback type\n\n1: Boring\n2: Funny"
+  end
+
+
+  def replay_prompt
+    puts "Press 'r' or 'restart' to play again\nPress 'q' to quit"
+  end
+
+  def invalid_prompt
+    puts 'Invalid entry!'
+  end
+
+  def empty_prompt
+    puts "You haven't used any letters yet."
+  end
+
+  def duplicate_prompt(letter)
+    puts "You have used the letter #{letter} already"
+  end
+
+  def turns_prompt(turns)
+    puts "You have #{turns} turns left"
+  end
+
+  def print_text(text)
+    puts "#{text}"
+  end
+
+  def thanks_prompt
+    puts 'Thank you for playing!'
+  end
+
+  def game_instruction_prompt
+    puts "Press ':h' or 'history' to view the letters you have used\nPress ':q' or 'quit' to quit (you can save before quiting)"
+  end
+end

data/lib/femis_hangman/router.rb

@@ -0,0 +1,153 @@
+module FemisHangman
+  class Router
+    include(Message)
+    attr_accessor :status, :difficulty, :feedback, :game
+    def initialize
+      @status = 'begin'
+    end
+
+    def process(input)
+      if @status == 'begin' then welcome(input)
+      elsif @status == 'feedback' then choose_feedback(input)
+      elsif @status == 'start' then begin_game(input)
+      elsif @status == 'play' then play_game(input)
+      elsif @status == 'finish' then finish_game(input)
+      elsif @status == 'save' then save_game
+      elsif @status == 'load' then load_game(input)
+      elsif @status == 'quit' || 'end' then quit_game
+      else
+        welcome(input)
+      end
+    end
+
+    def welcome(input)
+      case input
+        when 'p', 'play' then start_game
+        when 'q', 'quit' then quit_game
+        when 'l', 'load' then show_saved_games
+        when 'i', 'instructions' then instructions_prompt
+        else invalid_prompt
+      end
+    end
+
+    def choose_feedback(input)
+      @feedback = input.to_i
+      if @feedback < 1 || @feedback > 2
+        feedback_prompt
+        return
+      end
+      level_prompt
+      @status = 'start'
+    end
+
+    def begin_game(input)
+      @difficulty = input.to_i
+      if @difficulty < 1 || @difficulty > 3
+        invalid_prompt
+        return
+      end
+      @status = 'play'
+      create_game
+    end
+
+    def create_game
+      begin_prompt
+      @game = Game.new(@difficulty, @feedback)
+      size_prompt(@game.word.size)
+      turns_prompt(@game.turns)
+      game_instruction_prompt
+      print_text(@game.show_word)
+    end
+
+    def play_game(input)
+      if @game.status == 'restart'
+        if input == 'r' || input == 'restart'
+          level_prompt
+          @status = 'start'
+        elsif input == 'q' || input == 'quit'
+          quit_game
+        else invalid_prompt
+        end
+      elsif @game.status == 'quit'
+        if input == 's' || 'save' then save_game
+        elsif input == 'q' || 'quit' then quit_game
+        else
+          invalid_prompt
+        end
+      else @game.control(input)
+      end
+    end
+
+    def start_game
+      @status = 'feedback'
+      welcome_prompt
+      feedback_prompt
+    end
+
+    def finish_game(input)
+      if input == 'r' || 'restart'
+        @status = 'start'
+        begin_game(input)
+      elsif input == 'q' || 'quit'
+        save_prompt
+        @status = 'save'
+      else
+        invalid_prompt
+      end
+    end
+
+    def save_game
+      File.open('./saved_games.yaml', 'a'){|f| f.write(YAML.dump(@game))}
+      thanks_prompt
+      @status = 'end'
+    end
+
+    def show_saved_games
+      @status = 'load'
+      load_prompt
+      i = 0
+      YAML.load_stream(File.open('./saved_games.yaml', 'r')).each do |game|
+        print "#{i += 1}: "
+        word = game.word.split('')
+        history = game.history
+        word.each do |letter|
+          if history.include?(letter)
+            print "#{letter} "
+          else
+            print '_ '
+          end
+        end
+        print "(#{game.turns} turns left)"
+        print "\n"
+      end
+    end
+
+    def load_game(input)
+      game_id = input.to_i
+      i = 0
+      YAML.load_stream(File.open('./saved_games.yaml', 'r')).each do |game|
+        i += 1
+        if i == game_id
+          @status = 'play'
+          @game = game
+          @game.status = 'play'
+          @game.check_game
+        end
+      end
+    end
+
+    def quit_game
+      @status = 'end'
+      thanks_prompt
+    end
+
+    def loop
+      repl = lambda do |prompt|
+        print prompt
+        process(gets.chomp!)
+      end
+
+      repl["% Hangman-#{FemisHangman::VERSION}: "] while @status != 'end'
+    end
+  end
+end

data/lib/femis_hangman/version.rb

@@ -1,3 +1,3 @@
 module FemisHangman
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/femis_hangman/word.rb

@@ -0,0 +1,27 @@
+module FemisHangman
+  class Word
+    def generate(difficulty)
+      file = File.open('./dictionary.txt', 'r')
+      rand(41211).times { file.gets }
+      word = clean_word($_)
+      file.close
+      if confirm(difficulty, word)
+        word
+      else
+        generate(difficulty)
+      end
+    end
+
+    def confirm(difficulty, word)
+      if word.length > 4 * difficulty && word.length <= 4 * (difficulty + 1)
+        true
+      else
+        false
+      end
+    end
+
+    def clean_word(word)
+      cleaned_word = word.gsub("\n", '')
+    end
+  end
+end