mastermind_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3ad4cf50286b09c3bec1e6e74f96642b075a346
+  data.tar.gz: 44a19863fda1c35ace0ce9ba35e6dd8c9eb960eb
+SHA512:
+  metadata.gz: a6b55153f5459955aed6b529d6597a4bb7e105773c9947a75543806e59b9079bb98d16a91a5dc26be6f49ce41d6efc239b2629777cc865c77ffc103e480d4fa0
+  data.tar.gz: 75f75a96928525d51d61356502442d2a1018425ffe4744ba035a3ac42f9a113ee32f9e8feb124e9211d64c11c437434f7dcdde769d4013799e4f4c11f0ef1080

data/exe/mastermind

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/mastermind_ruby'
+
+ui = MastermindRuby::ConsoleInterface.new
+# Game intialization
+game = MastermindRuby::Game.new(ui)
+game.start

data/lib/mastermind_ruby.rb

@@ -0,0 +1,3 @@
+require_relative 'mastermind_ruby/console_interface'
+require_relative 'mastermind_ruby/game'
+require_relative 'mastermind_ruby/code'

data/lib/mastermind_ruby/code.rb

@@ -0,0 +1,116 @@
+module MastermindRuby
+  class Code
+    AVAILABLE_CHARACTERS = %w(R Y G O M P)
+    CODE_PATTERN = /\A[#{AVAILABLE_CHARACTERS.join("")}]{4}\z/
+
+    def initialize(code)
+      @code = code
+    end
+
+    # Parse a string to a code object
+    # Params:
+    # +str+:: the string which is to parse to a code object
+    def self.parse(str)
+      new str.split('')
+    end
+
+    # Method to generate a code
+    def self.random
+      new 4.times.map { AVAILABLE_CHARACTERS.sample }
+    end
+
+    # Returns a code object containing 'BBBB'
+    def self.solution
+      @solution ||= Code.parse('BBBB')
+    end
+
+    # Checks if a code is valid (must be 4 characters long and can only contain the available characters)
+    def valid?
+      @code.join =~ CODE_PATTERN
+    end
+
+    # Returns true if code is 'BBBB'
+    def solution?
+      self == Code.solution
+    end
+
+    # Get assesment for solution
+    # e.g. self is YYRG and solution is MMGR it will return WW-- (Code Object)
+    # Params:
+    # +solution+:: the solution which an assessment should be made with
+    def assessment_for_solution(solution)
+      tmp = @code.dup
+      tmp = mark_right_position(tmp, solution)
+      tmp = mark_right_color(tmp, solution)
+      tmp = mark_unmatched(tmp)
+      Code.parse(tmp.sort.join('').tr('X', '-'))
+    end
+
+    # Search for same character at same index and mark it with 'B'
+    # Params:
+    # +input+:: the input
+    # +solution+:: the solution to compare with
+    def mark_right_position(input, solution)
+      input.each.with_index.map do |char, index|
+        if solution[index] == char
+          'B'
+        else
+          char
+        end
+      end
+    end
+
+    # Search for character contained in solution
+    # Params:
+    # +input+:: the input
+    # +solution+:: the solution to compare with
+    def mark_right_color(input, solution)
+      rest_solution = solution.map.with_index { |char, index| input[index] == 'B' ? nil : char }
+      input.each.with_index.map do |char, index|
+        if index = rest_solution.index(char)
+          rest_solution[index] = nil
+          'W'
+        else
+          char
+        end
+      end
+    end
+
+    # Mark unmatched with an '-'
+    # Params:
+    # +input+:: the input which should be filled with '-'
+    def mark_unmatched(input)
+      input.map do |char|
+        if %w(B W).include? char
+          char
+        else
+          'X'
+        end
+      end
+    end
+
+    def [](index)
+      @code[index]
+    end
+
+    def map(&block)
+      @code.map(&block)
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    def eql?(other)
+      to_s.eql?(other.to_s)
+    end
+
+    def hash
+      to_s.hash
+    end
+
+    def to_s
+      @code.join
+    end
+  end
+end

data/lib/mastermind_ruby/console_interface.rb

@@ -0,0 +1,63 @@
+trap 'SIGINT' do
+  puts "\r\rThe game was interrupted :("
+  exit 130
+end
+
+module MastermindRuby
+  # The console interface represents the game
+  # interacting with the UI (in that case a terminal window)
+
+  # Must have methods
+  # * :read_playername
+  # * :read_next_guess
+  # * :display_welcome_message
+  # * :display_assessment
+  # * :display_invalid_code
+  class ConsoleInterface
+
+    # Method which reads the playername
+    # Return the playername as string
+    def read_playername
+      # User inital input
+      print 'Please enter a name: '
+      gets.chomp
+    end
+
+    # Method which is called when the next turn is initiated
+    # Return next guess as Code object
+    # Params:
+    # +try_count+:: what number of guess
+    def read_next_guess(try_count)
+      print "#{try_count}: "
+      MastermindRuby::Code.parse(gets.strip)
+    end
+
+    # Method which is called when the game is initiated to display the game has been started
+    # Params:
+    # +playername+:: the playername which was read before with :read_playername
+    def display_welcome_message(playername)
+      puts '-------- Mastermind Ruby Project -------'
+      puts "Hello #{playername}, your code is generated!"
+      puts "Avaliable Characters:\t#{MastermindRuby::Code::AVAILABLE_CHARACTERS.join("\t")}"
+    end
+
+    # Method which is called when the guess is evaluated
+    # Params:
+    # +result+:: the result (e.g. BBW-, ATTENTION: Code object)
+    def display_assessment(result)
+      puts (result)
+    end
+
+    # Method which is called when the guess was not a valid code
+    def display_invalid_code
+      puts 'Invalid code'
+    end
+
+    # Method which is called when the game is ended
+    # Params:
+    # +try_count+:: how many times guessed until finished
+    def display_end_game(try_count)
+      puts "Congrats! You made it with #{try_count} tries."
+    end
+  end
+end

data/lib/mastermind_ruby/game.rb

@@ -0,0 +1,55 @@
+module MastermindRuby
+  class Game
+    attr_reader :try_count
+
+    def initialize(ui, solution: Code.random)
+      @solution_code = solution
+      @ui = ui
+      @try_count = 1
+      @started = false
+    end
+
+    # Method to start a game
+    # Requests by calling read_playername for the playername on the UI
+    def start
+      @started = true
+      @playername = @ui.read_playername
+      @ui.display_welcome_message(@playername)
+      run
+    end
+
+    private
+
+    # Method to run the game (prevent from dying if the solution was not found yet)
+    # Requests by calling read_next_guess for a new guess on the UI
+    # Shows an assessment on the UI by calling display_assessment
+    def run
+      while running?
+        guess = @ui.read_next_guess(@try_count)
+        if guess.valid?
+          result = guess.assessment_for_solution(@solution_code)
+          if result.solution?
+            stop
+          else
+            @try_count += 1
+            @ui.display_assessment(result)
+          end
+        else
+          @ui.display_invalid_code
+        end
+      end
+    end
+
+    # Method to stop the game
+    # On the ui display_end_game is called
+    def stop
+      @started = false
+      @ui.display_end_game(@try_count)
+    end
+
+    # Method to check if the game is running
+    def running?
+      @started
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: mastermind_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yves Siegrist
+- Yves Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Mastermind or Master Mind is a code-breaking game for two players.
+                     The modern game with pegs was invented in 1970 by Mordecai Meirowitz, an Israeli postmaster and telecommunications expert.
+                     It resembles an earlier pencil and paper game called Bulls and Cows that may date back a century or more.
+                     The library is here to reuse the game logic I wrote, and to make your game (UI) as easy as possible to manage.
+email: y.siegrist@4teamwork.ch
+executables:
+- mastermind
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/mastermind
+- lib/mastermind_ruby.rb
+- lib/mastermind_ruby/code.rb
+- lib/mastermind_ruby/console_interface.rb
+- lib/mastermind_ruby/game.rb
+homepage: https://github.com/Elektron1c97/Mastermind_ruby
+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: A mastermind library
+test_files: []