GemCodebreaker 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d387ad1e4ffd7b5f742c61768832b940267eabd5ffbfb920acb57debc5c84492
-  data.tar.gz: e8faf1b025e53f99585212d4264d99296d008b3696b96f8df3b8053a993b9c52
+  metadata.gz: 12131d83b585528d4439fce06930e09a875e97670771f8af7431a8435f92abb3
+  data.tar.gz: 263297083f7e135928c7abaf7d6daefab5928b865269076634d8499d27cdfe50
 SHA512:
-  metadata.gz: a2faa57d32240522392f40efe51240956609e36253142163d71ca2d7625711a1c460a8e82ed8a02734b48c0a1cd83d9bd69c67ebd8c4248f39b8fa2d5424cc9f
-  data.tar.gz: 26b9a4e0280a7ef4e0580c0139e086d8433cfb5a9e9ff6b5293ab327841c73495411fcd3a8832b22096f4634530772e5ffa097fbcdb97b174264afde19d4aed1
+  metadata.gz: 05eb5e3cdc70ef977f3e92da9ff638bbd4e2a07a8a11fc78c74c178191c8069d9e31f99375a38e31db3a8d0f1d70c785496cd0f3eb6541494d795a034bb083fd
+  data.tar.gz: eca18f4f867615dd5d0841c223c10b79cfe88b844ffeeaf29bc6d098ac96f77144210a5674d152332607151815b2c8e02fe48f72bbe7db33388efb6fb4eac677

data/.circleci/config.yml

@@ -38,12 +38,7 @@ commands:
     steps:
       - run:
           name: run spec
-          command: |
-            mkdir /tmp/test-results
-            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
-            bundle exec rspec --format progress \
-                              --out /tmp/test-results/rspec.xml \
-                              $TEST_FILES
+          command: bundle exec rspec --format progress spec
 
 jobs:
   lintering:

data/.rubocop.yml

@@ -1,15 +1,22 @@
 require:
+  - rubocop-performance
   - rubocop-rspec
 
 AllCops:
   TargetRubyVersion: 2.7.1
   NewCops: enable
 
+Style/Documentation:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
-Metrics/ModuleLength:
-  Max: 270
+
 RSpec/MessageSpies:
   EnforcedStyle: receive
+
+RSpec/NestedGroups:
+  Max: 6
+
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
+  ExcludedMethods: ['describe', 'context']

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    GemCodebreaker (0.1.8)
+    GemCodebreaker (0.1.9)
+      i18n (~> 1.8.3)
 
 GEM
   remote: https://rubygems.org/
@@ -45,6 +46,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.0.3)
       parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
     rubocop-rspec (1.41.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
@@ -63,10 +66,10 @@ PLATFORMS
 DEPENDENCIES
   GemCodebreaker!
   fasterer (~> 0.8.3)
-  i18n (~> 1.8.3)
   rake (~> 13.0.1)
   rspec (~> 3.7.0)
   rubocop (~> 0.84.0)
+  rubocop-performance (~> 1.6.1)
   rubocop-rspec (~> 1.41.0)
   simplecov (~> 0.18.5)
 

data/{GemCodebreaker.gemspec → gem_codebreaker.gemspec}

@@ -2,7 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require_relative 'lib/GemCodebreaker/version'
+require_relative 'lib/gem_codebreaker/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'GemCodebreaker'
@@ -28,10 +28,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.add_development_dependency 'fasterer', '~> 0.8.3'
-  spec.add_development_dependency 'i18n', '~> 1.8.3'
+  spec.add_dependency 'i18n', '~> 1.8.3'
   spec.add_development_dependency 'rake', '~> 13.0.1'
   spec.add_development_dependency 'rspec', '~> 3.7.0'
   spec.add_development_dependency 'rubocop', '~> 0.84.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.6.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.41.0'
   spec.add_development_dependency 'simplecov', '~> 0.18.5'
 end

data/lib/{GemCodebreaker/classes/codemaker.rb → gem_codebreaker/classes/code_maker.rb}

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module GemCodebreaker
-  # Marker class for game
   class CodeMaker
     attr_reader :plus_match, :minus_match, :empty_match
 

data/lib/gem_codebreaker/classes/game.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module GemCodebreaker
+  class Game
+    LENGTH_OF_SECRET_CODE = 4
+    DIGIT_RANGE = (1..6).freeze
+
+    include Validator
+    attr_reader :statistic, :matcher_hash, :config
+
+    def initialize(user, level)
+      @config = GameConfig.new(user, level)
+      @statistic = []
+    end
+
+    def secrete_code
+      @secrete_code ||= (1..LENGTH_OF_SECRET_CODE).map { rand DIGIT_RANGE }
+    end
+
+    def guess_start(input_code)
+      guess_valid?(input_code)
+      raise GemCodebreaker::NoAttemptsError if @config.attempts_used?
+
+      @config.increase_user_attempts
+      user_code = input_code.chars.map(&:to_i)
+      code_marker = CodeMaker.new(@secrete_code, user_code)
+      code_marker.calculate_result_code
+      @matcher_hash = { plus: code_marker.plus_match, minus: code_marker.minus_match, empty: code_marker.empty_match }
+    end
+
+    def win_game?
+      @matcher_hash[:plus] == LENGTH_OF_SECRET_CODE
+    end
+
+    def game_over?
+      @config.attempts_used? && win_game? == false
+    end
+
+    def hint
+      raise GemCodebreaker::NoHintsError if @config.hints_used?
+
+      @config.increase_user_hints
+      @secrete_code.sample
+    end
+
+    def restart_game
+      @config.reset_user_attempts_hints
+      secrete_code
+    end
+
+    def save_user_statistic
+      @statistic << GameStatistic.new(self)
+    end
+
+    private
+
+    def guess_valid?(user_code)
+      validate_class(user_code, String)
+      raise GemCodebreaker::IncorrectLengthError if user_code.length != LENGTH_OF_SECRET_CODE
+      unless user_code[/\A[#{DIGIT_RANGE.first}-#{DIGIT_RANGE.last}]{#{LENGTH_OF_SECRET_CODE}}\z/]
+        raise GemCodebreaker::ValueRangeError
+      end
+
+      true
+    end
+  end
+end

data/lib/gem_codebreaker/classes/game_config.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GemCodebreaker
+  class GameConfig
+    GAME_LEVEL = {
+      easy: {
+        attempts: 15,
+        hints: 2
+      },
+      medium: {
+        attempts: 10,
+        hints: 1
+      },
+      hell: {
+        attempts: 5,
+        hints: 1
+      },
+      strong_hell: {
+        attempts: 1,
+        hints: 0
+      }
+    }.freeze
+
+    include Validator
+
+    attr_reader :user_nick_name, :difficulty, :max_attempts, :max_hints, :user_attempts, :user_hints
+
+    def initialize(user, level)
+      check_difficulty(level)
+      @user_nick_name = user.nick_name
+      @difficulty = level
+      @max_attempts = GAME_LEVEL[level][:attempts]
+      @max_hints = GAME_LEVEL[level][:hints]
+      @user_attempts = 0
+      @user_hints = 0
+    end
+
+    def increase_user_attempts
+      @user_attempts += 1
+    end
+
+    def increase_user_hints
+      @user_hints += 1
+    end
+
+    def attempts_used?
+      @user_attempts >= @max_attempts
+    end
+
+    def hints_used?
+      @user_hints >= @max_hints
+    end
+
+    def reset_user_attempts_hints
+      @user_attempts = 0
+      @user_hints = 0
+    end
+
+    private
+
+    def check_difficulty(difficulty)
+      validate_inclusion(GAME_LEVEL.keys, difficulty)
+    end
+  end
+end

data/lib/{GemCodebreaker → gem_codebreaker}/classes/game_statistic.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module GemCodebreaker
-  # Game statistic class
   class GameStatistic
     attr_reader :user_nickname, :difficulty, :attempts_total, :attempts_used, :hints_total, :hints_used
 

data/lib/gem_codebreaker/classes/serializer_deserializer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GemCodebreaker
+  class SerializerDeserializer
+    def initialize
+      @file_name = 'game_statistic.yml'
+      @statistic_dir = 'data'
+      @storage_path = File.expand_path("./#{@statistic_dir}/#{@file_name}")
+    end
+
+    def data_dir_get
+      data_directory = File.dirname(@storage_path)
+      Dir.mkdir(data_directory) unless File.directory?(data_directory)
+    end
+
+    def load_game_statistic
+      File.exist?(@storage_path) ? YAML.load_file(@storage_path) : []
+    end
+
+    def save_game_statistic(game_statistic)
+      save_game_stat = game_statistic | load_game_statistic
+      File.open(@storage_path, 'w') do |file|
+        YAML.dump(save_game_stat, file)
+      end
+    end
+  end
+end

data/lib/{GemCodebreaker → gem_codebreaker}/classes/user.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 module GemCodebreaker
-  # User class for game
   class User
     include Validator
-    attr_accessor :nick_name
+    attr_reader :nick_name
 
     def initialize(nick_name)
       @nick_name = nick_name
     end
 
     def nickname_valid?
-      validate_string(@nick_name)
-      validate_nickname_length(@nick_name)
+      validate_class(@nick_name, String)
+      validate_length(@nick_name, (3..20))
       true
     end
   end

data/lib/gem_codebreaker/gem_codebreaker.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'gem_codebreaker/config/i18n_locales'
+require 'gem_codebreaker/version'
+require 'gem_codebreaker/errors/incorrect_length_error'
+require 'gem_codebreaker/errors/name_length_error'
+require 'gem_codebreaker/errors/no_attempts_error'
+require 'gem_codebreaker/errors/no_hints_error'
+require 'gem_codebreaker/errors/unknow_level_error'
+require 'gem_codebreaker/errors/value_range_error'
+require 'gem_codebreaker/errors/wrong_class_error'
+require 'gem_codebreaker/modules/validator'
+require 'gem_codebreaker/classes/serializer_deserializer'
+require 'gem_codebreaker/classes/user'
+require 'gem_codebreaker/classes/code_maker'
+require 'gem_codebreaker/classes/game_config'
+require 'gem_codebreaker/classes/game_statistic'
+require 'gem_codebreaker/classes/game'

data/lib/gem_codebreaker/modules/validator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GemCodebreaker
+  module Validator
+    def validate_inclusion(difficulty, game_level)
+      raise GemCodebreaker::UnknowLevelError unless difficulty.include?(game_level)
+    end
+
+    def validate_class(user_code, klass)
+      raise GemCodebreaker::WrongClassError unless user_code.is_a?(klass)
+    end
+
+    def validate_length(nickname, ranges)
+      raise GemCodebreaker::NameLengthError unless ranges.member?(nickname.length)
+    end
+  end
+end

data/lib/{GemCodebreaker → gem_codebreaker}/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemCodebreaker
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: GemCodebreaker
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Vasyl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fasterer
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.3
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.84.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -120,31 +134,30 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- GemCodebreaker.gemspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - bin/console
 - bin/setup
-- lib/GemCodebreaker/classes/codemaker.rb
-- lib/GemCodebreaker/classes/game.rb
-- lib/GemCodebreaker/classes/game_config.rb
-- lib/GemCodebreaker/classes/game_statistic.rb
-- lib/GemCodebreaker/classes/user.rb
-- lib/GemCodebreaker/config/i18n_locales.rb
-- lib/GemCodebreaker/errors/incorrect_length_error.rb
-- lib/GemCodebreaker/errors/name_length_error.rb
-- lib/GemCodebreaker/errors/no_attempts_error.rb
-- lib/GemCodebreaker/errors/no_hints_error.rb
-- lib/GemCodebreaker/errors/unknow_level_error.rb
-- lib/GemCodebreaker/errors/value_range_error.rb
-- lib/GemCodebreaker/errors/wrong_class_error.rb
-- lib/GemCodebreaker/gem_codebreaker.rb
-- lib/GemCodebreaker/modules/game_configurations.rb
-- lib/GemCodebreaker/modules/serializer_deserializer.rb
-- lib/GemCodebreaker/modules/validator.rb
-- lib/GemCodebreaker/version.rb
+- gem_codebreaker.gemspec
+- lib/gem_codebreaker/classes/code_maker.rb
+- lib/gem_codebreaker/classes/game.rb
+- lib/gem_codebreaker/classes/game_config.rb
+- lib/gem_codebreaker/classes/game_statistic.rb
+- lib/gem_codebreaker/classes/serializer_deserializer.rb
+- lib/gem_codebreaker/classes/user.rb
+- lib/gem_codebreaker/config/i18n_locales.rb
+- lib/gem_codebreaker/errors/incorrect_length_error.rb
+- lib/gem_codebreaker/errors/name_length_error.rb
+- lib/gem_codebreaker/errors/no_attempts_error.rb
+- lib/gem_codebreaker/errors/no_hints_error.rb
+- lib/gem_codebreaker/errors/unknow_level_error.rb
+- lib/gem_codebreaker/errors/value_range_error.rb
+- lib/gem_codebreaker/errors/wrong_class_error.rb
+- lib/gem_codebreaker/gem_codebreaker.rb
+- lib/gem_codebreaker/modules/validator.rb
+- lib/gem_codebreaker/version.rb
 homepage: https://github.com/vasivaas/GemCodebreaker
 licenses:
 - MIT

data/lib/GemCodebreaker/classes/game.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module GemCodebreaker
-  # Game class
-  class Game
-    LENGTH_OF_SECRET_CODE = 4
-    DIGIT_RANGE = (1..6).freeze
-
-    include GameConfigurations
-    include Validator
-    attr_reader :secrete_code, :statistic, :matcher_hash
-    attr_accessor :config
-
-    def initialize(user, level)
-      @config = GameConfig.new(user, level.to_sym)
-      @statistic = []
-    end
-
-    def check_configuration
-      validate_game_level(@config.difficulty)
-    end
-
-    def generate_secret_code
-      @secrete_code = (1..LENGTH_OF_SECRET_CODE).map { rand DIGIT_RANGE }
-    end
-
-    def guess_valid?(user_code)
-      validate_string(user_code)
-      validate_guess_length if user_code.length != LENGTH_OF_SECRET_CODE
-      validate_chars_range unless user_code[/\A[1-6]{4}\z/]
-      true
-    end
-
-    def guess_start(input_code)
-      validate_number_of_attempts if @config.user_attempts >= @config.max_attempts
-
-      @config.user_attempts += 1
-      user_code = convert_string_to_array(input_code)
-      code_marker = CodeMaker.new(@secrete_code, user_code)
-      code_marker.calculate_result_code
-      @matcher_hash = { plus: code_marker.plus_match, minus: code_marker.minus_match, empty: code_marker.empty_match }
-    end
-
-    def win_game?
-      @matcher_hash[:plus] == LENGTH_OF_SECRET_CODE
-    end
-
-    def game_over?
-      (@config.user_attempts >= @config.max_attempts) && win_game? == false
-    end
-
-    def hints_used?
-      @config.user_hints >= @config.max_hints
-    end
-
-    def hint
-      validate_number_of_hints if hints_used?
-
-      @config.user_hints += 1
-      @secrete_code.sample
-    end
-
-    def reset
-      @config.user_attempts = 0
-      @config.user_hints = 0
-      generate_secret_code
-    end
-
-    def save_user_statistic
-      @statistic << current_user_statistic
-    end
-
-    private
-
-    def current_user_statistic
-      GameStatistic.new(self)
-    end
-
-    def convert_string_to_array(user_code)
-      user_code.chars.map(&:to_i)
-    end
-  end
-end

data/lib/GemCodebreaker/classes/game_config.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module GemCodebreaker
-  # Configuration class for game
-  class GameConfig
-    include GameConfigurations
-    attr_accessor :user_nick_name, :difficulty, :max_attempts, :max_hints, :user_attempts, :user_hints
-
-    def initialize(user, level)
-      @user_nick_name = user.nick_name
-      @difficulty = level
-      @max_attempts = GAME_LEVEL[level][:attempts]
-      @max_hints = GAME_LEVEL[level][:hints]
-      @user_attempts = 0
-      @user_hints = 0
-    end
-  end
-end

data/lib/GemCodebreaker/gem_codebreaker.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'GemCodebreaker/config/i18n_locales'
-require 'GemCodebreaker/version'
-require 'GemCodebreaker/errors/incorrect_length_error'
-require 'GemCodebreaker/errors/name_length_error'
-require 'GemCodebreaker/errors/no_attempts_error'
-require 'GemCodebreaker/errors/no_hints_error'
-require 'GemCodebreaker/errors/unknow_level_error'
-require 'GemCodebreaker/errors/value_range_error'
-require 'GemCodebreaker/errors/wrong_class_error'
-require 'GemCodebreaker/modules/validator'
-require 'GemCodebreaker/modules/serializer_deserializer'
-require 'GemCodebreaker/modules/game_configurations'
-require 'GemCodebreaker/classes/user'
-require 'GemCodebreaker/classes/codemaker'
-require 'GemCodebreaker/classes/game_config'
-require 'GemCodebreaker/classes/game_statistic'
-require 'GemCodebreaker/classes/game'
-
-module GemCodebreaker
-  class Error < StandardError; end
-end

data/lib/GemCodebreaker/modules/game_configurations.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module GemCodebreaker
-  module GameConfigurations
-    GAME_LEVEL = { easy:
-                       { attempts: 15,
-                         hints: 2 },
-                   medium:
-                       { attempts: 10,
-                         hints: 1 },
-                   hell:
-                       { attempts: 5,
-                         hints: 1 },
-                   strong_hell:
-                       { attempts: 1,
-                         hints: 0 } }.freeze
-  end
-end

data/lib/GemCodebreaker/modules/serializer_deserializer.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module GemCodebreaker
-  # Serialize and Deserialize data for game statistic
-  module SerializerDeserializer
-    FILE_NAME = 'game_statistic.yml'
-    STATISTIC_DIR = 'data'
-    STORAGE_PATH = File.expand_path("./#{STATISTIC_DIR}/#{FILE_NAME}")
-
-    def data_dir_get
-      data_directory = File.dirname(STORAGE_PATH)
-      Dir.mkdir(data_directory) unless File.directory?(data_directory)
-    end
-
-    def load_game_statistic
-      File.exist?(STORAGE_PATH) ? YAML.load_file(STORAGE_PATH) : []
-    end
-
-    def save_game_statistic(game_statistic)
-      save_game_stat = game_statistic | load_game_statistic
-      File.open(STORAGE_PATH, 'w') do |file|
-        YAML.dump(save_game_stat, file)
-      end
-    end
-  end
-end

data/lib/GemCodebreaker/modules/validator.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module GemCodebreaker
-  # Validator
-  module Validator
-    def validate_game_level(game_level)
-      level = %i[easy medium hell strong_hell]
-      raise GemCodebreaker::UnknowLevelError unless level.include?(game_level)
-    end
-
-    def validate_number_of_hints
-      raise GemCodebreaker::NoHintsError
-    end
-
-    def validate_number_of_attempts
-      raise GemCodebreaker::NoAttemptsError
-    end
-
-    def validate_string(object)
-      raise GemCodebreaker::WrongClassError unless object.is_a?(String)
-    end
-
-    def validate_guess_length
-      raise GemCodebreaker::IncorrectLengthError
-    end
-
-    def validate_chars_range
-      raise GemCodebreaker::ValueRangeError
-    end
-
-    def validate_nickname_length(nickname)
-      raise GemCodebreaker::NameLengthError if nickname.length < 3 || nickname.length > 20
-    end
-  end
-end