codebreaker2018 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61facc7472210fb21a64ea7f511a8e33f7198fce4a3b1f69b53d51a92b7703b0
+  data.tar.gz: dca15d6a979479efd75a40ce46e555c7d1fbd58811ad181cc3ccbe7d017d1d34
+SHA512:
+  metadata.gz: 786ed3fd86aab78cc50881570755f2e306471c5be91d2a6454f852b2571c8ff67b6a5009af8286ce6e7af3ef57f76dacf49fb0f6bda18f5b44301ed9226d5e23
+  data.tar.gz: 17aede226827b05e93bdc5f2930162cbe4051e2faf3ccd0a08c7c00a99751ba12c884687050dcc288373a0a9b84780e267447972a591c81d6b1b36c08aa70586

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+gem 'rspec'
+gem 'colorize'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Vladislav Trotsenko
+
+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,108 @@
+# Codebreaker #
+
+Codebreaker is a logic game in which the code-breaker tries to break a secret code created by a code-maker. The code-maker, which will be played by the application we’re going to write, creates a secret code of four numbers between 1 and 6.
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codebreaker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codebreaker2018
+
+## Usage ##
+Best way to demonstrate Codebreaker is auto start demo game:
+
+```ruby
+require 'codebreaker2018'
+Codebreaker::Console.new
+```
+
+### Game features ###
+  - Configurator:
+    - Player's name
+    - Max attempts and hints: integers only
+    - Levels: :simple, :middle, :hard
+    - Languages: :en, :ru
+
+### Console features ###
+  - Autoloading localization by game language
+  - Color interface
+  - Ability to save results
+  - Ability to play again
+  - Ability to erase all results
+  - Demo mode
+
+### Localization features ###
+  - Autoload localizations from locale dir
+  - Default language
+  - Ability to change locale
+
+### Score features ###
+  - Date
+  - Player's name
+  - Winner or not
+  - Level
+  - Score
+
+### Detail sample of Codebreaker usage ###
+
+```ruby
+# Init Game instance with block
+game = Codebreaker::Game.new do |config|
+  config.player_name = 'Mike'
+  config.max_attempts = 5
+  config.max_hints = 2
+  config.level = :middle
+  config.lang = :en
+end
+
+# Alternative init Game instance with args
+game = Codebreaker::Game.new('Mike', 5, 2, :middle, :en)
+
+# Init Console instance with your game
+console = Codebreaker::Console.new(game)
+
+# Also you can auto load demo game instance and auto start it
+Codebreaker::Console.new
+
+# Interactive methods
+# Let's play!
+console.start_game
+
+# Erase all game statistic
+console.erase_scores
+
+# Static methods
+# Able to view current game instance into console
+console.game
+
+# Able to view path to yml-file
+console.storage_path
+
+# Able to view all game statistic
+console.scores
+```
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bestwebua/homework-04-codebreaker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'codebreaker'
+require 'irb'
+IRB.start

data/bin/setup

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

data/codebreaker.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codebreaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'codebreaker2018'
+  spec.version       = Codebreaker::VERSION
+  spec.authors       = ['Vladislav Trotsenko']
+  spec.email         = ['admin@bestweb.com.ua']
+
+  spec.summary       = %q{Codebreaker}
+  spec.description   = %q{New version of logic terminal game.}
+  spec.homepage      = 'https://github.com/bestwebua/homework-04-codebreaker'
+  spec.license       = 'MIT'
+
+  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.require_paths = ['lib']
+
+  spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/codebreaker/console.rb

@@ -0,0 +1,186 @@
+require 'colorize'
+require 'erb'
+require 'yaml'
+
+module Codebreaker
+  class Console
+    DEMO = Game.new('Demo User', 5, 2, :middle, :en)
+    HINT = '-h'.freeze
+    YES = 'y'.freeze
+    EMPTY_INPUT = ''.freeze
+
+    attr_reader :game, :storage_path, :scores
+
+    def initialize(game = DEMO)
+      @locale = Localization.new(:console)
+      load_console(game)
+      start_game if game == DEMO
+    end
+
+    def start_game
+      puts message['alerts']['welcome'].colorize(:background => :blue)
+      puts message['alerts']['hint_info']
+      submit_answer
+    end
+
+    def erase_scores
+      print message['alerts']['erase_scores']
+      erase_game_data if input_selector
+      exit_console
+    end
+
+    private_constant :DEMO
+
+    private
+
+    def load_console(game)
+      raise ArgumentError, message['errors']['wrong_object'] unless game.is_a?(Game)
+      @game = game
+      @locale.lang = game.configuration.lang
+      @game_config_snapshot = game.configuration.clone
+      @storage_path = File.expand_path('./data/scores.yml', File.dirname(__FILE__))
+      @scores = load_game_data
+    end
+
+    def load_game_data
+      YAML.load(File.open(storage_path, 'r')) rescue []
+    end
+
+    def message
+      @locale.localization
+    end
+
+    def submit_answer
+      process(user_interaction)
+    end
+
+    def show_hint
+      puts begin
+        "#{message['alerts']['hint']}: #{game.hint.to_s.green}"
+      rescue => error
+        error.to_s.red
+      end
+    end
+
+    def user_interaction
+      return if game.attempts.zero?
+      input, status, step = EMPTY_INPUT, false, 0
+        until status
+          begin
+            game.guess_valid?(input)
+            status = true
+          rescue => error
+            puts error.to_s.red unless step.zero? || input == HINT
+            puts "#{message['alerts']['guess']}:"
+            input = gets.chomp
+            step += 1
+            show_hint if input == HINT
+          end
+        end
+      input
+    end
+
+    def message_is_allowed?
+      !game.won? && game.attempts == rand(1..game.configuration.max_attempts)
+    end
+
+    def motivation_message
+      return unless message_is_allowed?
+      message['alerts']['motivation']
+    end
+
+    def process(input)
+      begin
+        puts game.to_guess(input)
+        puts motivation_message
+      rescue => error
+        puts error
+        finish_game
+      end
+      game.won? ? finish_game : submit_answer
+    end
+
+    def summary
+      game.won? ? message['alerts']['won'].green : message['alerts']['lose'].red
+    end
+
+    def finish_game
+      puts ERB.new(message['info']['results']).result(binding)
+      save_game
+      new_game
+    end
+
+    def input_selector
+      input = EMPTY_INPUT
+        until %w(y n).include?(input)
+          print " (y/n) #{message['alerts']['yes_or_no']}:"
+          input = gets.chomp
+        end
+      input == YES
+    end
+
+    def save_game
+      print message['alerts']['save_game']
+      save_game_data if input_selector
+    end
+
+    def save_game_data
+      save_user_score
+      save_to_yml
+      puts message['info']['successfully_saved'].green
+    end
+
+    def save_user_score
+      scores << current_user_score
+    end
+
+    def current_user_score
+      Score.new do |save|
+        save.date = Time.now
+        save.player_name = game.configuration.player_name
+        save.winner = game.won?
+        save.level = game.configuration.level
+        save.score = game.score
+      end
+    end
+
+    def save_to_yml
+      File.open(storage_path, 'w') do |file|
+        file.write(YAML.dump(scores))
+      end
+    end
+
+    def new_game
+      print message['alerts']['new_game']
+      if input_selector
+        load_new_game
+        start_game
+      else
+        puts message['alerts']['shutdown']
+        exit_console
+      end
+    end
+
+    def exit_console
+      exit
+    end
+
+    def load_new_game
+      @game = Game.new do |config|
+        @game_config_snapshot.each_pair do |key, value|
+          config[key] = value
+        end
+      end
+    end
+
+    def erase_game_data
+      begin
+        File.delete(storage_path)
+        scores.clear
+        puts message['info']['successfully_erased'].green
+      rescue
+        puts message['errors']['file_not_found'].red
+      end
+    end
+  end
+end

data/lib/codebreaker/game.rb

@@ -0,0 +1,123 @@
+module Codebreaker
+  GameConfiguration = Struct.new(:player_name, :max_attempts, :max_hints, :level, :lang)
+
+  class Game
+    ZERO_POINTS = 0
+    TEN_POINTS = 10
+    TWENTY_POINTS = 20
+    FIFTY_POINTS = 50
+    ONE_HUNDRED_POINTS = 100
+    BONUS_POINTS = 500
+    RIGHT_ANSWER = '+'.freeze
+    RIGHT_ANSWER_DIFF_INDEX = '-'.freeze
+    WRONG_ANSWER = ' '.freeze
+
+    attr_reader :attempts, :hints, :configuration
+
+    def initialize(*config)
+      @locale = Localization.new(:game)
+      @configuration ||= GameConfiguration.new(*config)
+      yield @configuration if block_given?
+      apply_configuration
+      generate_secret_code
+    end
+
+    def guess_valid?(input)
+      raise message['errors']['invalid_input'] unless input.is_a?(String)
+      raise message['alerts']['invalid_input'] unless input[/\A[1-6]{4}\z/]
+      true
+    end
+
+    def to_guess(input)
+      raise message['alerts']['no_attempts'] if attempts.zero?
+      @attempts -= 1
+      @result = fancy_algo(input, secret_code)
+    end
+
+    def won?
+      result == RIGHT_ANSWER * 4
+    end
+
+    def hint
+      raise message['alerts']['no_hints'] if hints.zero?
+      @hints -= 1
+      return secret_code.sample if result.empty?
+      not_guessed = result.chars.map.with_index do |item, index|
+        secret_code[index] unless item == RIGHT_ANSWER
+      end
+      not_guessed.compact.sample
+    end
+
+    def score
+      calculate_score
+    end
+
+    private
+
+    def check_configuration
+      raise message['errors']['fail_configuration'] if configuration.any?(&:nil?)
+      begin
+        raise if configuration.max_attempts < 1 || configuration.max_hints.negative?
+      rescue
+        raise message['errors']['fail_configuration_values']
+      end
+    end
+
+    def create_instance_vars
+      @attempts = configuration.max_attempts
+      @hints = configuration.max_hints
+      @locale.lang = configuration.lang
+      @result = ''
+    end
+
+    def apply_configuration
+      check_configuration
+      configuration.freeze
+      create_instance_vars
+    end
+
+    def result
+      @result
+    end
+
+    def message
+      @locale.localization
+    end
+
+    def generate_secret_code
+      @secret_code = (1..4).map { rand(1..6) }
+    end
+
+    def secret_code
+      @secret_code
+    end
+
+    def fancy_algo(guess, secret_code)
+      guess.chars.map(&:to_i).map.with_index do |item, index|
+        case
+          when item == secret_code[index] then RIGHT_ANSWER
+          when secret_code[index..-1].include?(item) then RIGHT_ANSWER_DIFF_INDEX
+          else WRONG_ANSWER
+        end
+      end.join
+    end
+
+    def calculate_score
+      level_rates = case configuration.level
+        when :simple then [TEN_POINTS, ZERO_POINTS]
+        when :middle then [TWENTY_POINTS, TWENTY_POINTS]
+        when :hard   then [FIFTY_POINTS, ONE_HUNDRED_POINTS]
+        else raise message['errors']['unknown_level']
+      end
+
+      attempt_rate, hint_rate = level_rates
+      guessed = result.count(RIGHT_ANSWER)
+
+      used_attempts = configuration.max_attempts - attempts
+      used_hints = configuration.max_hints - hints
+      bonus_points = won? && used_attempts == 1 ? BONUS_POINTS : ZERO_POINTS
+
+      used_attempts * attempt_rate * guessed - used_hints * hint_rate + bonus_points
+    end
+  end
+end

data/lib/codebreaker/locale/console/en-US.yml

@@ -0,0 +1,21 @@
+:en:
+  errors:
+    wrong_object: Wrong object type!
+    file_not_found: Game data file not found. Nothing to delete.
+  alerts:
+    welcome: ....Codebreaker Console Game....
+    hint_info: Use '-h' for help.
+    hint: Hint
+    guess: Enter your guess
+    motivation: Come on, step on it!
+    won: You won!
+    lose: You lost(
+    yes_or_no:
+    save_game: Do you want to save your score?
+    new_game: Do you want to play again?
+    erase_scores: Do you want to erase all scores data? Attention, this action cannot be undone.
+    shutdown: Exit...
+  info:
+    results: <%= summary %> With total score <%= game.score %> points.
+    successfully_saved: Current game data was successfully saved.
+    successfully_erased: All game data was successfully erased.

data/lib/codebreaker/locale/console/ru-RU.yml

@@ -0,0 +1,21 @@
+:ru:
+  errors:
+    wrong_object: Неверный тип объекта!
+    file_not_found: Файл данных не найден. Ничего удалять.
+  alerts:
+    welcome: ....Терминальная игра Codebreaker....
+    hint_info: Используй '-h' для подсказки.
+    hint: Подсказка
+    guess: Введи свое предположение
+    motivation: Подумай хорошенько и сделай это!
+    won: Ты выиграл!
+    lose: Ты проиграл(
+    yes_or_no: латинская раскладка
+    save_game: Сохранить твой результат?
+    new_game: Еще поиграем?
+    erase_scores: Очистить всю игровую статистику? Внимание, это действие не может быть отменено.
+    shutdown: Выхожу...
+  info:
+    results: <%= summary %> С общим  счетом <%= game.score %> поинтов.
+    successfully_saved: Твой текущий результат успешно сохранен.
+    successfully_erased: Все игровая статистика была успешно удалена.

data/lib/codebreaker/locale/game/en-US.yml

@@ -0,0 +1,10 @@
+:en:
+  errors:
+    fail_configuration: The configuration is incomplete.
+    fail_configuration_values: Max_attempts must be more then zero, max_hints must be positive.
+    invalid_input: Invalid input type.
+    unknown_level: Unknown game level.
+  alerts:
+    invalid_input: Answer should equal 4 digits in range from 1 to 6!
+    no_attempts: Oops, no attempts left!
+    no_hints: Oops, no hints left!

data/lib/codebreaker/locale/game/ru-RU.yml

@@ -0,0 +1,10 @@
+:ru:
+  errors:
+    fail_configuration: Конфигурация не завершена.
+    fail_configuration_values: Max_attempts > 0, max_hints не должен быть <= 0.
+    invalid_input: Недопустимый тип ввода.
+    unknown_level: Неизвестный игровой уровень.
+  alerts:
+    invalid_input: Ответ должен содержать 4 цифры в диапазоне от 1 до 6!
+    no_attempts: Доступные попытки исчерпаны!
+    no_hints: К сожалению, больше нет подсказок!

data/lib/codebreaker/localization.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+
+module Codebreaker
+  class Localization
+    attr_accessor :lang
+
+    def initialize(app_type, lang = :en)
+      @lang = lang
+      select_application(app_type)
+      candidates_to_load
+      merge_localizations
+    end
+
+    def localization
+      return localizations[:en] unless localizations[lang]
+      localizations[lang]
+    end
+
+    private
+
+    def localizations_dir
+      File.expand_path('./locale/.', File.dirname(__FILE__))
+    end
+
+    def authorized_apps
+      Dir.entries(localizations_dir).reject { |dir_name| dir_name.include?('.') }.map(&:to_sym)
+    end
+
+    def select_application(app_type)
+      raise 'Unknown application type.' unless authorized_apps.include?(app_type)
+      @app_dir = app_type.to_s
+    end
+
+    def candidates_to_load
+      @ymls_paths = Dir.glob("#{localizations_dir}/#{@app_dir}/*.yml")
+    end
+
+    def localizations
+      @localizations ||= Hash.new
+    end
+
+    def merge_localizations
+      localizations
+      loaded_ymls = @ymls_paths.map { |file| YAML.load(File.open(file, 'r')) }
+      loaded_ymls.each { |loaded_yml| @localizations.update(loaded_yml) }
+    end
+  end
+end

data/lib/codebreaker/score.rb

@@ -0,0 +1,7 @@
+module Codebreaker
+  Score = Struct.new(:date, :player_name, :winner, :level, :score) do
+    def initialize
+      yield self if block_given?
+    end    
+  end
+end

data/lib/codebreaker/version.rb

@@ -0,0 +1,3 @@
+module Codebreaker
+  VERSION = '0.2.5'
+end

data/lib/codebreaker.rb

@@ -0,0 +1,5 @@
+require_relative 'codebreaker/version'
+require_relative 'codebreaker/localization'
+require_relative 'codebreaker/game'
+require_relative 'codebreaker/score'
+require_relative 'codebreaker/console'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: codebreaker2018
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+platform: ruby
+authors:
+- Vladislav Trotsenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: New version of logic terminal game.
+email:
+- admin@bestweb.com.ua
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codebreaker.gemspec
+- lib/codebreaker.rb
+- lib/codebreaker/console.rb
+- lib/codebreaker/game.rb
+- lib/codebreaker/locale/console/en-US.yml
+- lib/codebreaker/locale/console/ru-RU.yml
+- lib/codebreaker/locale/game/en-US.yml
+- lib/codebreaker/locale/game/ru-RU.yml
+- lib/codebreaker/localization.rb
+- lib/codebreaker/score.rb
+- lib/codebreaker/version.rb
+homepage: https://github.com/bestwebua/homework-04-codebreaker
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Codebreaker
+test_files: []