mastermind_generator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9071f9198d1f4edd135fade0eb8a6e877b4473ecea5ade19ce2b5b2ac0613a3
-  data.tar.gz: 376419af696ad3c77e136c335c88abe14073f65659384ece2d1fe117bc69e1a6
+  metadata.gz: 29e6aefa848cecb0f5d8a2715fa0e18755ac9963a89a203bace224bd8117d3f1
+  data.tar.gz: 793b610e4de1d2127d902aa3de246051c3de54f8c756038622fa6a7aceb85a5a
 SHA512:
-  metadata.gz: a9e904d612999ef9ce20e10381471175f81ad7b18b4a7afdb9510dc148fd69e6617950680579247873e81540fa6a9513a2e0c1f0554211027118f778645d0d53
-  data.tar.gz: bb688a3c9f2ab22149949780291b2c11a05b42a37cb1df5eec86d7b04407aba3f4eebdf55c82b9bf55b41a9aaffb9fe8a5757f327e5b8475a1a6340319efef56
+  metadata.gz: 5a3a2a54f761d3522e5f97e8c79aef1779993f2f6e904996040e58b4fb961deafc57aa0cc366cc1f4d76266aba111fec4eb5f4fde3b2688cf11443a1c307a461
+  data.tar.gz: d3f65f26cd38d2216b86f2a3cf25b1f7ee64e43bec4fc85ee82c9d16adb5ccbf89c793502b6ed8f122dc096746f217b1f61f77b55cf801107f38227f47baa6bd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mastermind_generator (0.1.0)
+    mastermind_generator (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -30,28 +30,23 @@ Or install it yourself as:
 
 ## Configuration
 
-Before you use mastermind generator you need to configure it. Two attributes should be supplied as shown below:
-  * **items:** The items array you want to play with.
-  * **difficulties:** Difficulty levels of your game. It must be in a ruby hash format.
-  * For each level,
-    * **item_count:** players allowed to use how many items.
-    * **sequence_length:** sequences must be how many characters length. 
+Before you use mastermind generator you need to configure it. Two attributes should be supplied like below:
 
 ```ruby
 MastermindGenerator.configure do |config|
   config.items = %w[red green blue yellow purple orange]
   config.difficulties = {
-    beginner: { 
+    beginner: {
       item_count: 4,
-      sequence_length: 4 
+      sequence_length: 4
     },
-    intermediate: { 
-      item_count: 5, 
-      sequence_length: 6 
+    intermediate: {
+      item_count: 5,
+      sequence_length: 6
     },
-    advanced: { 
-      item_count: 6, 
-      sequence_length: 8 
+    advanced: {
+      item_count: 6,
+      sequence_length: 8
     }
   }
 end
@@ -63,12 +58,11 @@ Require the gem and include it in your class definition.
 
 ```ruby
 require 'mastermind_generator'
-# If you write your configuration code in a seperate file uncomment the line below: 
 # require "path_to_your_configuration_file"
 
 class MastermindGame
   include MastermindGenerator
-  
+
   # your code goes here...
 end
 ```
@@ -76,139 +70,124 @@ end
 Now, you can generate game objects...
 
 ```ruby
-require 'mastermind_generator'
-# other requires
+...
 
-class MastermindGame
-  include MastermindGenerator
-  
-  def start
-    # You must supply one of the difficulty level as an argument to `Game.new`
-    @game = Game.new(:beginner)
-    
-    # You can add one or two player
-    @game.add_player("Aaron")
-    @game.add_player("Celine")
-    
-    # You are ready to create a game loop however you want
-    # An example is shown below
-    loop do
-      # Current player takes a guess (chosen automatically)
-      print "Hey #{game.player.name}! What's your guess?"
-      guess = gets.strip.downcase
-      @game.take_a_guess(guess)
-      
-      # Check the guess is succeed or fail
-      if game.finished?
-        puts "congrats"
-        break
-      else
-        puts "feedback"
+  class MastermindGame
+    include MastermindGenerator
+    attr_reader :game
+
+    def start
+      # You must supply one of the difficulty level as an argument to `Game.new`
+      @game = Game.new(:beginner)
+
+      # You can add one or two player
+      game.add_player("Aaron")
+      game.add_player("Celine")
+
+      # You are ready to create a game loop however you want
+      # An example is shown below
+      loop do
+        # Current player takes a guess (chosen automatically)
+        print "Hey #{game.player_name}! What's your guess?"
+        game.take_a_guess(gets.strip)
+
+        # Check the guess is succeed or fail
+        if game.finished?
+          puts "congrats"
+          break
+        else
+          puts "feedback"
+        end
+
+        # if the game is multi-player, you need to call `@game.next_turn`
+        game.next_turn if game.players_count > 1
       end
-      
-      # if the game is multi-player, you need to call `@game.next_turn`
-      @game.next_turn if game.players.length > 1
     end
   end
-end
 ```
 
-## Player Information
-
-After you added one or two players to the game by using `add_player` method. You can reach some useful information 
-about player of that turn. Every `MastermindGenerator::Player` instances have these methods:
-    
-    * `@game.player.guesses`: All guesses entered by current player. It might be useful to show some historical information.
-    * `@game.player.guess`: Last guess of the user, returns `MastermindGenerator::Guess` instance.
-    * `@game.player.winner?`: Returns `true` if player's latest guess is successful, otherwise returns false.
-    * `@game.player.timer`: Returns a `MastermindGenerator::Timer` object. You can use it to show players how much time they spent to break the code.
-
-## Guess Information
-
-You can access guess instances by players. Every `MastermindGenerator::Guess` instances have these methods:
-    
-    * `@game.player.guess.succeed?`: Whether the guess was successful or not.
-    * `@game.player.guess.correct_element_count`: How many elements were matched with the target sequence.
-    * `@game.player.guess.correct_position_count`: How many positions were matched with the target sequence.
-    * `@game.player.guess.correct_position_hints`: You can use it to show the correct positions like `R_BG__`
-    * `@game.player.guess.statistics`: Returns a hash that it contains all the information about the guess.
-    
+## Gathering information
+
+You can use following methods to get information about the game.
+
 ```ruby
-@game.player.guess.statistics
+game.sequence_value # returns auto-generated target sequence value
+
+game.player_name # returns current player's name
+
+game.guesses # returns all of guesses of the current player
+
+game.guess_stats
+# returns all information about the current player guesses
 # # => {
 #    value:  guess sequence value,
-#    target: target esequence value,
-#    status: successful or failed,
-#    count: how many guesses were made,
+#    target: target sequence value,
+#    status: successful or fail,
+#    count: count of guesses,
 #    element_count:  correct element count,
-#   position_count: correct position count,
-#    position_hints: correct position hints
+#    position_count: correct position count,
+#    position_hints: correct position hints,
+#    duration: elapsed time,
+#    duration_as_text: elapsed time in human readable format,
 # }
-```
-
-## Timer Information
-
-As we mentioned above, each `MastermindGenerator::Player` instance has a method called `#timer` that can be used to
-access that player's timer. However, timers are setting up behind the scenes, you can also start, pause or stop
-them by using `@game.player.timer.start`, `@game.player.timer.pause`, and `@game.player.timer.stop` methods.
 
-Main purpose of timer objects is providing duration information like below:
-
-```ruby
-# returns duration as seconds
-@game.player.timer.duration 
-# 123
-
-# returns duration as human readable text
-@game.player.timer.duration_as_text
-# 2 minutes, 3 seconds
+# You can also get some of the statistics by piece 
+game.guess_value
+game.guess_count
+game.timer_duration
+game.timer_duration_as_text
 ```
 
 ## Providing Feedbacks
 
-You can give feedbacks to your player by using the methods we mentioned above. A few example might be like these:
+You can give feedbacks to your players by using the methods we mentioned above. An example is given below:
 
 ```ruby
-... 
-  
-  def congrats
-    player = game.player
-    puts("Congratulations #{player.name}! You guessed the sequence '#{game.sequence.value.upcase}' in "\
-         "#{player.guesses.length} guesses over #{player.timer.duration_as_text}.")
-  end
+def congrats
+  print(<<~MSG)
+    Congratulations #{game.player_name}! You guessed the sequence '#{game.sequence_value.upcase}' \
+    in #{game.guesses_count} guesses over #{game.timer_duration_as_text}.
+  MSG
+end
+```
 
-  def feedback
-    stats = player.guess.statistics
-    puts("'#{stats[:value].upcase}' has #{stats[:element_count]} of the correct elements with "\
-         " #{stats[:position_count]} in the correct positions.\nYou've taken #{stats[:count]} guess.")
-  end
-...
+```ruby
+def feedback
+  stats = game.guess_stats
+  print(<<~MSG)
+      '#{stats[:value].upcase}' has #{stats[:element_count]} of the correct elements with \
+      #{stats[:position_count]} in the correct positions.\nYou've taken #{stats[:count]} guess.
+  MSG
+end
 ```
 
 ## Exception Handling
 
-There are four error types defined in the gem with proper `#message` methods.
-  * SequenceTooLongError
-  * SequenceTooShortError
-  * SequenceHasInvalidCharsError
-  * InvalidDifficultyError
+There are six error types defined in the gem with proper `#message` methods.
+
+* SequenceTooLongError
+* SequenceTooShortError
+* SequenceHasInvalidCharsError
+* InvalidDifficultyError
+* TimerNotStartedError
+* TimerNotStoppedError
 
 An example usage might be like this:
 
 ```ruby
-  begin
-    print("Hey #{game.player.name}! What's your guess? > ")
-    game.take_a_guess(gets.strip.downcase)
-  rescue SequenceTooLongError, SequenceTooShortError, SequenceHasInvalidCharsError => e
-    warn("#{e.message}. Try again!")
-    retry
-  end
+begin
+  print("Hey #{game.player_name}! What's your guess? > ")
+  game.take_a_guess(gets.strip)
+rescue SequenceTooLongError, SequenceTooShortError, SequenceHasInvalidCharsError => e
+  warn("#{e.message}. Try again!")
+  retry
+end
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/sbagdat/mastermind_generator. This project
-is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+Bug reports and pull requests are welcome on GitHub at https://github.com/sbagdat/mastermind_generator. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
 the [code of conduct](https://github.com/sbagdat/mastermind_generator/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
@@ -218,5 +197,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the MastermindGenerator project's codebases, issue trackers, chat rooms and mailing lists is
-expected to follow
-the [code of conduct](https://github.com/sbagdat/mastermind_generator/blob/main/CODE_OF_CONDUCT.md).
+expected to follow the [code of conduct](https://github.com/sbagdat/mastermind_generator/blob/main/CODE_OF_CONDUCT.md).

data/demo/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    docile (1.3.5)
+    mastermind_generator (0.2.0)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.3)
+      rubocop (>= 0.87, < 2.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  mastermind_generator
+  minitest (>= 5.14.3)
+  minitest-reporters (>= 0.5.0)
+  rake (>= 13.0.3)
+  rubocop (>= 1.8.1)
+  rubocop-minitest (>= 0.10.3)
+  simplecov (>= 0.21.2)
+
+BUNDLED WITH
+   2.2.5

data/demo/lib/mastermind.rb

@@ -59,24 +59,27 @@ class Mastermind # rubocop:disable Metrics/ClassLength
       else
         feedback
       end
-      game.next_turn if game.players.length > 1
+      game.next_turn if game.players_count > 1
     end
   end
 
   def feedback
-    stats = player.guess.statistics
-    cli.print_message("'#{stats[:value].upcase}' has #{stats[:element_count]} of the correct elements with "\
-                      " #{stats[:position_count]} in the correct positions.\nYou've taken #{stats[:count]} guess.")
+    stats = game.guess_stats
+    cli.print_message(<<~MSG.chomp)
+      '#{stats[:value].upcase}' has #{stats[:element_count]} of the correct elements with \
+      #{stats[:position_count]} in the correct positions.\nYou've taken #{stats[:count]} guess.
+    MSG
   end
 
   def congrats
-    player = game.player
-    cli.print_message("Congratulations #{player.name}! You guessed the sequence '#{game.sequence.value.upcase}' in "\
-        "#{player.guesses.length} guesses over #{player.timer.duration_as_text}.")
+    cli.print_message(<<~MSG.chomp)
+      Congratulations #{game.player_name}! You guessed the sequence '#{game.sequence_value.upcase}' \
+      in #{game.guesses_count} guesses over #{game.timer_duration_as_text}.
+    MSG
   end
 
   def take_a_guess
-    cli.ask_question("Hey #{game.player.name}! What's your guess?")
+    cli.ask_question("Hey #{game.player_name}! What's your guess?")
     begin
       game.take_a_guess(cli.answer)
     rescue SequenceTooLongError, SequenceTooShortError, SequenceHasInvalidCharsError => e
@@ -139,3 +142,5 @@ class Mastermind # rubocop:disable Metrics/ClassLength
     "(#{value[0]})#{value[1..]}"
   end
 end
+
+Mastermind.new.play

data/lib/mastermind_generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "forwardable"
 require_relative "mastermind_generator/version"
 require_relative "mastermind_generator/configuration"
 require_relative "mastermind_generator/item"

data/lib/mastermind_generator/difficulty.rb

@@ -2,7 +2,11 @@
 
 module MastermindGenerator
   # Exception for passing invalid difficulty value as an argument to `Difficulty.new`
-  class InvalidDifficultyError < StandardError; end
+  class InvalidDifficultyError < StandardError
+    def message
+      "Invalid Difficulty: It must be one of the difficulty levels which you specified in configuration"
+    end
+  end
 
   # Reprsents difficulty of the game
   # It affects of how many items will be used for secret sequences

data/lib/mastermind_generator/game.rb

@@ -5,6 +5,8 @@ module MastermindGenerator
   class Game
     attr_reader :difficulty, :sequence, :players
 
+    extend Forwardable
+
     def initialize(difficulty)
       @difficulty = Difficulty.new(difficulty)
       @sequence = SequenceGenerator.new(@difficulty).generate
@@ -15,17 +17,11 @@ module MastermindGenerator
     def take_a_guess(value)
       seq = Sequence.new(difficulty, value)
       guess = Guess.new(seq)
-      player.timer.start
+      player.timer_start
       player.take_a_guess(guess)
       player.guess.assign_target(sequence)
     end
 
-    def player
-      return players.first if players.length == 1
-
-      @turn_counter.odd? ? players.first : players.last
-    end
-
     def add_player(player_name)
       return if players.length > 1
 
@@ -35,7 +31,7 @@ module MastermindGenerator
     def finished?
       return false unless player.guess.succeed?
 
-      player.timer.stop
+      player.timer_stop
       true
     end
 
@@ -44,8 +40,23 @@ module MastermindGenerator
     end
 
     def next_turn
-      player.timer.pause
+      player.timer_pause
       @turn_counter += 1
     end
+
+    def player
+      return players.first if players_count == 1
+
+      @turn_counter.odd? ? players.first : players.last
+    end
+
+    def_delegator :@players, :length, :players_count
+    def_delegator :@sequence, :value, :sequence_value
+
+    def_delegator :player, :name, :player_name
+    def_delegators :player, :guess_value, :guess_stats, :guesses, :timer_duration, :timer_duration_as_text
+
+    def_delegator :guesses, :count, :guesses_count
+    def_delegator :winner, :name, :winner_name
   end
 end

data/lib/mastermind_generator/guess.rb

@@ -5,6 +5,8 @@ module MastermindGenerator
   class Guess
     attr_reader :sequence, :target
 
+    extend Forwardable
+
     def initialize(sequence)
       @sequence = sequence
       @target = nil
@@ -19,23 +21,22 @@ module MastermindGenerator
     end
 
     def correct_element_count
-      sequence.codes.reduce(0) { |sum, code| sum + [target.value.count(code), sequence.value.count(code)].min }
+      sequence_codes.reduce(0) { |sum, code| sum + [target_value.count(code), value.count(code)].min }
     end
 
     def correct_position_count
       seuence_target_packs.count { _1 == _2 }
     end
 
-    def correct_position_hints
-      seuence_target_packs.map { _1 == _2 ? _1 : "_" }.join
+    def correct_position_hints(mark = "_")
+      seuence_target_packs.map { _1 == _2 ? _1 : mark }.join
     end
 
     def statistics
       {
-        value: sequence.value,
-        target: target&.value.to_s,
-        status: succeed? ? "success" : "fail",
-        count: guesses.length,
+        value: value,
+        target: target_value,
+        status: status,
         element_count: correct_element_count,
         position_count: correct_position_count,
         position_hints: correct_position_hints
@@ -44,8 +45,16 @@ module MastermindGenerator
 
     private
 
+    def status
+      { true => "success", false => "fail" }[succeed?]
+    end
+
     def seuence_target_packs
-      sequence.value.chars.zip(target.value.chars)
+      value.chars.zip(target_value.chars)
     end
+
+    def_delegator :@sequence, :codes, :sequence_codes
+    def_delegator :@sequence, :value
+    def_delegator :@target, :value, :target_value
   end
 end

data/lib/mastermind_generator/player.rb

@@ -5,6 +5,8 @@ module MastermindGenerator
   class Player
     attr_reader :name, :guesses, :timer
 
+    extend Forwardable
+
     def initialize(name)
       @name = name
       @guesses = []
@@ -22,5 +24,24 @@ module MastermindGenerator
     def winner?
       guess.succeed?
     end
+
+    def guess_stats
+      guess_statistics.merge(
+        { count: guesses.count,
+          duration: timer_duration,
+          duration_as_text: timer_duration_as_text
+        }
+      )
+    end
+
+    def_delegator :guesses, :count, :guesses_count
+    def_delegator :guess, :value, :guess_value
+    def_delegator :guess, :statistics, :guess_statistics
+
+    def_delegator :@timer, :duration, :timer_duration
+    def_delegator :@timer, :duration_as_text, :timer_duration_as_text
+    def_delegator :@timer, :stop, :timer_stop
+    def_delegator :@timer, :start, :timer_start
+    def_delegator :@timer, :pause, :timer_pause
   end
 end

data/lib/mastermind_generator/timer.rb

@@ -2,10 +2,14 @@
 
 module MastermindGenerator
   # Exception for ending timer without starting it before
-  class TimerNotStartedError < StandardError; end
+  class TimerNotStartedError < StandardError
+    def message
+      "Timer is not started! To stop or pause a timer, you need to start it first."
+    end
+  end
 
   # A simple timer
-  # Calculates the time between start and end times
+  # Calculates the time between start and end
   class Timer
     include TimeHelpers
 
@@ -23,11 +27,14 @@ module MastermindGenerator
     alias pause stop
 
     def duration
-      stop_time - start_time
+      pause
+      elapsed_time = stop_time - start_time
+      start
+      elapsed_time
     end
 
     def duration_as_text
-      time_in_writing(stop_time - start_time)
+      time_in_writing(duration)
     end
 
     private

data/lib/mastermind_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MastermindGenerator
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/mastermind_generator.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["sbagdat@gmail.com"]
 
   spec.summary       = "Fully customizable mastermind game generator."
-  spec.description   = "Mastermind* Generator is a fully customizable mastermind (or master mind) game generator. It supports using custom items other than classic color variations. It can also generate multi-player games."
+  spec.description   = "Mastermind* Generator is a fully customizable mastermind (or master mind) game generator. "\
+     "It supports using custom items other than classic color variations. It can also generate multi-player games."
   spec.homepage      = "https://github.com/sbagdat/mastermind_generator"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mastermind_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sıtkı Bağdat
@@ -33,6 +33,7 @@ files:
 - bin/console
 - bin/setup
 - demo/Gemfile
+- demo/Gemfile.lock
 - demo/README.md
 - demo/lib/mastermind.rb
 - demo/lib/mastermind/console_interface.rb