hangman_y 0.1.8

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hangman.gemspec
+gem 'pry'
+gem 'coveralls', require: false
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 andela-ydaniju
+
+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,43 @@
+# Hangman
+
+[![Code Climate](https://codeclimate.com/github/andela-ydaniju/hangman/badges/gpa.svg)](https://codeclimate.com/github/andela-ydaniju/hangman) [![Build Status](https://travis-ci.org/andela-ydaniju/hangman.svg?branch=master)](https://travis-ci.org/andela-ydaniju/hangman) [![Coverage Status](https://coveralls.io/repos/andela-ydaniju/hangman/badge.svg?branch=master&service=github)](https://coveralls.io/github/andela-ydaniju/hangman?branch=master)  [![Issue Count](https://codeclimate.com/github/andela-ydaniju/hangman/badges/issue_count.svg)](https://codeclimate.com/github/andela-ydaniju/hangman)
+
+Hangman is a paper and pencil guessing game for two or more players. One player thinks of a word, phrase or sentence and the other tries to guess it by suggesting letters or numbers, within a certain number of guesses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hangman_y'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hangman_y
+
+## Usage
+
+After Installation, Run the "hangman_y" gem in your Command Line Interface. After the welcome screen has been displayed, proceed by entering the desired option "start", "load", or "quit".
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Hangman is currently in its first edition and is open-source. Feel free to contribute, clone or Fork
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andela-ydaniju/hangman. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'hangman'
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/hangman

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'hangman'
+Hangman::Game.new.pre_start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hangman.gemspec

@@ -0,0 +1,35 @@
+# 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_y'
+  spec.version       = Hangman::VERSION
+  spec.authors       = ['andela-ydaniju']
+  spec.email         = ['yusuf.daniju@andela.com']
+
+  spec.summary       = %q{Hangman game allows you guess the letters of a word. You have seven chances!}
+  # spec.description   = %q{Hangman game allows you guess the letters of a word. You have seven chances!}
+  spec.homepage      = "https://github.com/andela-ydaniju/hangman"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/hangman.rb

@@ -0,0 +1,9 @@
+require 'hangman/version'
+# Your comment goes here...
+module Hangman
+  require_relative './hangman/choice.rb'
+  require_relative './hangman/play.rb'
+  require_relative './hangman/game.rb'
+  require_relative './hangman/show.rb'
+  require_relative './hangman/save.rb'
+end

data/lib/hangman/choice.rb

@@ -0,0 +1,20 @@
+# Hangman module
+module Hangman
+  # This class serves words from file and tracks their display
+  class Choice
+    def initialize
+      read_file('5desk.txt')
+    end
+
+    def read_file(dictionary)
+      @@word_list ||= File.readlines(dictionary)
+    end
+
+    def pick_word
+      loop do
+        choice = @@word_list.sample.chomp.downcase
+        break(choice) if choice.length > 5 && choice.length < 12
+      end
+    end
+  end
+end

data/lib/hangman/game.rb

@@ -0,0 +1,110 @@
+require 'pry'
+require 'stringio'
+# Hangman module
+module Hangman
+  # This class starts and ends game
+  class Game
+    attr_accessor :right_guess, :wrong_count, :show, :total_lives, :play, :word,
+    :display, :save, :entry
+    def initialize
+      @right_guess = ''
+      @wrong_count = 0
+      @total_lives = 7
+      @play = Hangman::Play.new
+      @word = Hangman::Choice.new.pick_word
+      @display = @play.show_word(@word, @right_guess)
+      @show = Hangman::Show.new
+      @save = Hangman::Save.new(self)
+    end
+
+    def pre_start
+      puts @show.begin
+      @entry = gets.strip.downcase
+      case @entry
+      when 'start' then start!
+      when 'load' then play_loaded
+      else
+        sleep 3
+        exit
+      end
+    end
+
+    def start!
+      puts 'Which word is:' + @play.show_word(@word, '') + '?'
+      condition_for_play
+    end
+
+    def condition_for_play
+      while @wrong_count < @total_lives
+        print "You have #{@total_lives - @wrong_count} chances left. "
+        char = @play.enter_guess
+        if char.match(/[^a-zA-Z0-9_]/)
+          save_options
+        elsif @word.include? char
+          right_entry(char)
+        else
+          wrong_entry(char)
+        end
+      end
+    end
+
+    def save_options
+      puts @show.save_or_quit?
+      options = gets.strip.downcase
+      case options
+      when 's' then @save.save_data(self)
+      when 'c'
+        puts @play.show_word(@word, @right_guess)
+        save_data(condition_for_play)
+      else
+        abort(@show.end)
+      end
+    end
+
+    def play_loaded
+      play_data = @save.load_data
+      @word = play_data[0].to_s
+      @right_guess = play_data[1].to_s
+      @wrong_count = play_data[2].to_i
+      @total_lives = play_data[3].to_i
+      puts @play.show_word(@word, @right_guess)
+      condition_for_play
+    end
+
+    def full_game
+      puts @show.continue
+      play_on = gets.downcase.strip
+      if play_on == 'y'
+        @word = Hangman::Choice.new.pick_word
+        @wrong_count = 0
+        @total_lives = 7
+        @right_guess = ''
+        puts @play.show_word(@word, @right_guess)
+        condition_for_play
+      end
+    end
+
+    def right_entry(char)
+      if @right_guess.include? char
+        puts char + ' is already given and accepted.'
+        puts 'Try another: ' + @play.show_word(@word, @right_guess)
+      else
+        @right_guess += char
+        puts @show.show_right_entry + @play.show_word(@word, @right_guess)
+      end
+      abort(@show.show_win) unless
+        @play.show_word(@word, @right_guess).include? '*'
+    end
+
+    def wrong_entry(char)
+      puts "Sorry! The word doesn't contain '#{char}'"
+      @wrong_count += 1
+      if @wrong_count == @total_lives
+        puts "#{@word} + '\n' + #{@show.hang}"
+        full_game
+      else
+        puts @show.show_wrong_entry + @play.show_word(@word, @right_guess)
+      end
+    end
+  end
+end

data/lib/hangman/play.rb

@@ -0,0 +1,25 @@
+require 'stringio'
+
+# Hangman module
+module Hangman
+  # This class follows gameplay logic
+  class Play
+    def show_word(picked_word, enter_guess)
+      display = ''
+      picked_word.chars do |char|
+        display += (enter_guess.include? char) ? char : '*'
+      end
+      display
+    end
+
+    def enter_guess
+      $stdout.puts 'Please  enter a letter'
+      puts "\n"
+      string = '3'
+      while string.to_i != 0 || string.length != 1
+        string = $stdin.gets.chomp.downcase
+      end
+      string
+    end
+  end
+end

data/lib/hangman/save.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+module Hangman
+  # Save and load class
+  class Save
+    attr_reader :word, :right_guess, :total_lives, :wrong_count
+
+    def initialize(game)
+      @game = game
+      @play = Hangman::Play.new
+    end
+
+    def save_data(obj = nil)
+      play_data = [obj.word, obj.right_guess, obj.wrong_count, obj.total_lives]
+      serialize_data = YAML.dump(play_data)
+      data = File.open('gamelog.yml', 'w') { |line| line.write(serialize_data) }
+      if data
+        puts 'Game successfully saved'
+        sleep 3
+        exit
+      end
+    end
+
+    def load_data
+      read_file = File.read('gamelog.yml')
+      YAML.load(read_file)
+    end
+  end
+end

data/lib/hangman/show.rb

@@ -0,0 +1,66 @@
+module Hangman
+  # hangman game displays
+  class Show
+    def begin
+      <<-HEREDOC
+        WELCOME TO HANGMAN
+        Type 'start' to Start a new game
+        or   'load' to Load an existing game
+      HEREDOC
+    end
+
+    def show_right_entry
+      <<-HEREDOC
+      GREAT!!
+      HEREDOC
+    end
+
+    def show_wrong_entry
+      <<-HEREDOC
+      WRONG! TRY AGAIN!!
+      HEREDOC
+    end
+
+    def show_win
+      <<-HEREDOC
+      CONGRATULATIONS!!! YOU HAVE WON!
+      HEREDOC
+    end
+
+    def save_or_quit?
+      <<-HEREDOC
+      PRESS 's' TO SAVE
+            'c' TO CONTINUE
+            'q' TO QUIT
+      HEREDOC
+    end
+
+    def hang
+      <<-HEREDOC
+          +------+
+          |      |
+          |      O
+          |     /|\
+          |     / \
+          |
+          |
+        --+------------
+        GAME-OVER!!!! :(
+      HEREDOC
+    end
+
+    def continue
+      <<-HEREDOC
+        DO YOU LIKE TO CONTINUE
+        PRESS 'Y' TO CONTINUE
+      HEREDOC
+    end
+
+    def end
+      <<-HEREDOC
+        GOODBYE!!
+      HEREDOC
+    end
+
+  end
+end

data/lib/hangman/version.rb

@@ -0,0 +1,4 @@
+# Version of gem
+module Hangman
+  VERSION = '0.1.8'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: hangman_y
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- andela-ydaniju
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: 
+email:
+- yusuf.daniju@andela.com
+executables:
+- console
+- hangman
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- 5desk.txt
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/hangman
+- bin/setup
+- hangman.gemspec
+- lib/hangman.rb
+- lib/hangman/choice.rb
+- lib/hangman/game.rb
+- lib/hangman/play.rb
+- lib/hangman/save.rb
+- lib/hangman/show.rb
+- lib/hangman/version.rb
+homepage: https://github.com/andela-ydaniju/hangman
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+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.14.1
+signing_key: 
+specification_version: 4
+summary: Hangman game allows you guess the letters of a word. You have seven chances!
+test_files: []