hangman_engine 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWY5OTE2Zjk3ODRiMDA5NGM0NTU1ODFiNzM5YTM5NGEzZGJmNjNiNg==
+  data.tar.gz: !binary |-
+    ODZjYWIzOGJiMGVlODMyMWZkZTdiMGIwOThhYjdkZTQzZDUzZmM1OA==
+SHA512:
+  metadata.gz: !binary |-
+    YmYwMGIxNTkzYzYyY2UwZDU0OGQwOTU2MzQ1YzY5YTcxZDIzMjE0ZTkyNjU3
+    NzBiMzZkZjkxMWRmOTkzYTE4NWExY2MyMTY3NDk2NzFlYjhkMGRmZTljY2Fm
+    MWI1YmUzNWI2NmE2MjEwN2VkOGYxMWE3YjgzM2YxODQ1YjhkZWQ=
+  data.tar.gz: !binary |-
+    YzAyZGNjZDgwMWRjZmIzMGFmZjg5OWQwMDkzNzM2OWI2MThiNjk3OWI2NTM4
+    MDA5NTdlMjVjZWMyYjc1MTY0YmFmZjU3YzZmMzVjMTZlYzE0ZDhlYmRmMTRj
+    ZTE5MDkyZWMzZTc3Y2MzNTExMzg5NjNjNWVmNGU3OTZiMzQ5MmM=

data/lib/hangman_engine.rb

@@ -0,0 +1,109 @@
+module HangmanEngine
+
+  class GameError < StandardError
+  end
+
+  class Game
+
+    attr_reader :word, :clue, :guesses, :attempts, :allowed_attempts
+
+    # Builder
+    def initialize(word, allowed_attempts, clue)
+      self.word = word.downcase
+      self.allowed_attempts = allowed_attempts.to_i
+      @clue = clue
+      @attempts = 0
+      @guesses = []
+    end
+
+    # Methods
+    def word=(word)
+      raise GameError, "word can't be blank" unless word.length > 0
+      raise GameError, "word to guess can't have whitespaces. Use only one word." if word.match(/\s/)
+      @word = word
+    end
+
+    def allowed_attempts=(n)
+      raise GameError, "allowed attempts must be greater or equal to the word length (>= #{word.length})." unless n >= word.length
+      @allowed_attempts = n
+    end
+
+    def guess(ltr)
+      if guessed? ltr
+        @guesses.push(ltr) unless @guesses.include?(ltr)
+      else
+        @attempts += 1
+      end
+    end
+
+    def guessed?(ltr)
+      @word.include?(ltr)
+    end
+
+    def remaining_attempts
+      @allowed_attempts - @attempts
+    end
+
+    def solved?
+      @word.split('').uniq.length == @guesses.length
+    end
+
+    def lost?
+      remaining_attempts == 0
+    end
+
+    def finished?
+      solved? || lost?
+    end
+  end
+
+  # Helper class to draw a Hangman::Game on the console
+  class Drawer
+
+    # Dinamically generate the game 'puppet' based on the length of the word to guess and the failed guesses count
+    # 
+    #  O
+    # /|\
+    # / \
+    #
+    def self.draw_puppet(hangman_game)
+      allowat = hangman_game.allowed_attempts
+      rattempts = hangman_game.remaining_attempts
+      puppet =  burn_or_body(" O ", allowat, allowat, rattempts) + "\n"
+      1.upto(allowat) do |i|
+        puppet << case allowat - i
+        when 5
+          burn_or_body('/', 5, allowat, rattempts)
+        when 4
+          burn_or_body('|', 4, allowat, rattempts)
+        when 3
+          burn_or_body("\\", 3, allowat, rattempts) + "\n"
+        when 2
+          burn_or_body('/', 2, allowat, rattempts) + ' '
+        when 1
+          burn_or_body("\\", 1, allowat, rattempts) + "\n"
+        when 0
+          ''
+        else
+          burn_or_body(" | ", allowat - i, allowat, rattempts) + "\n"
+        end
+      end
+      puppet
+    end
+
+    # Draw game board based on the word to guess and the gessues
+    # 
+    # a _ f o n _ _
+    # 
+    def self.draw_board(hangman_game)
+      board = ''
+      hangman_game.word.each_char { |ltr| board << (hangman_game.guesses.include?(ltr) ? "#{ltr} " : '_ ') }
+      board
+    end
+    
+    private
+    def self.burn_or_body(part, part_number, allowed_attempts, remaining_attempts)
+      (allowed_attempts - remaining_attempts) >= part_number ? ' ' : part
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: hangman_engine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alfonso Mancilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Use this library to build your own HANGMAN game.
+
+  HangmanEngine::Game have all you need to control the game flow.
+
+  HangmanEngine::Drawer will help you to build a console based interface for your
+  HangmanEngine::Game'
+email:
+- almancill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hangman_engine.rb
+homepage: https://github.com/ammancilla/hangman_engine
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Build your own HANGMAN game!
+test_files: []