mastermind_sname 1.0 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67589eac9cd726e2ba4f78c089f239bf7dc55cb2
-  data.tar.gz: 7858ff6c00b0fac69d94fe26237cbd5d3e7d9f1b
+  metadata.gz: 3b5cbfe80156234fb5b143fc49bc6011b533a056
+  data.tar.gz: b1fe6b5d36c85eaac5777d4b32ee3c5004b81e67
 SHA512:
-  metadata.gz: a593657e9430e598931f869e48ba2def9a3bc22ac349d1682d935d7a528bdb69d196f96f1865a8131b886c96511979a9429417db53a964cb83d335ff79776aa7
-  data.tar.gz: f7d9ea3f0f6a9915bb82ea70640cb64bcdc259afc943c357af7c74b49cb36e4d10bfa54cbb590e960783fbb0cca0264566d4f88acc174c90c42cda5c19549532
+  metadata.gz: fae0790effd1f82fa8b85f2ca93861098dccee1006ce9213dcd38ad57f6537a9ea7fae0eb1f419c8e5286ff745fff44e8ddf4ba560c9e61fe6390a35007ae631
+  data.tar.gz: 5c6bcb6c05ecec2a02f54a85f078077e9424d195a88d5b9d88e0b21ebda190512497b1819bbb26930fc72f08b650226ea51c6fcdccbe4c1ca8e67effa87767a5

data/.codeclimate.yml

@@ -0,0 +1,27 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Rails/Output:
+        enabled: false
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.rubocop.yml

@@ -0,0 +1,233 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "db/schema.rb"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInLiteral:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/Gemfile

@@ -1,5 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in mastermind_sname.gemspec
+source "https://rubygems.org"
 gemspec
 gem "codeclimate-test-reporter", group: :test
+gem "pry"

data/README.md

@@ -1,9 +1,15 @@
 <a href="https://codeclimate.com/github/andela-oosiname/mastermind_sname"><img src="https://codeclimate.com/github/andela-oosiname/mastermind_sname/badges/gpa.svg" /></a>
-[![Build Status](https://travis-ci.org/andela-oosiname/mastermind_sname.svg)](https://travis-ci.org/andela-oosiname/mastermind_sname)
+[![S Status](https://travis-ci.org/andela-oosiname/mastermind_sname.svg)](https://travis-ci.org/andela-oosiname/mastermind_sname)
 <a href="https://codeclimate.com/github/andela-oosiname/mastermind_sname/coverage"><img src="https://codeclimate.com/github/andela-oosiname/mastermind_sname/badges/coverage.svg" /></a>
 # MastermindSname
 
-Welcome to Mastermind by sname. An interactive gem packaged and played in a ruby environment. 
+Welcome to Mastermind by sname. An interactive gem packaged and played in a ruby environment.
+
+##About Mastermind
+
+Mastermind or Master Mind is a code-breaking game. 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 player decides in advance how many games they will play, which must be an even number. The computer is the codemaker, the player is the codebreaker. The codemaker chooses a pattern of colours. Duplicates are allowed. The codebreaker tries to figure out the pattern with a limited number of guesses.
 
 ## Installation
 
@@ -23,7 +29,7 @@ Or install it yourself as:
 
     $ gem install mastermind_sname
 
-## Usage
+## Game Play
 
 A splash screen is showed once a game is started from where the user can start a game or read instructions.
 

data/Rakefile

@@ -2,5 +2,4 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+task default: :spec

data/bin/mastermind

@@ -1,5 +1,4 @@
-#!/usr/bin/env ruby
-
 require 'mastermind_sname'
+new_game = MastermindSname::Sname.new
+new_game.start
 
-MastermindSname::Sname.start

data/lib/mastermind_sname.rb

@@ -1,34 +1,28 @@
-require_relative "mastermind_sname/sname/test.rb"
-require_relative "mastermind_sname/sname/colour_generator.rb"
+require_relative "mastermind_sname/sname/game_logic.rb"
+require_relative "mastermind_sname/sname/game_colour.rb"
+require_relative "mastermind_sname/sname/command.rb"
 require_relative "mastermind_sname/sname/game.rb"
-require_relative "mastermind_sname/sname/player_details.rb"
-require_relative "mastermind_sname/sname/messages.rb"
-require_relative "mastermind_sname/sname/checkers.rb"
-require_relative "mastermind_sname/sname/commands.rb"
-require_relative "mastermind_sname/sname/timer.rb"
+require_relative "mastermind_sname/sname/message.rb"
+require_relative "mastermind_sname/sname/input.rb"
+require_relative "mastermind_sname/sname/player.rb"
 
 module MastermindSname
   class Sname
-    def self.start
-      SnameMessages::Messages.splash_screen
-      my_choice = get_choice
-      start_choice(my_choice)
+    include Input
+    def start
+      @message = Message.new
+      @message.splash_screen
+      start_choice get_input
     end
-    def self.start_choice(user_choice)
+
+    def start_choice(user_choice)
       case user_choice
       when "p", "play"
-        SnamePlayer::Player.set_player
-        SnameGame::Game.new.play
-      when "q","quit" then exit
-      when "r", "read" then  SnameMessages::Messages.get_instructions
+        player = Player.new.set_player
+        Game.new(player).play
+      when "q", "quit" then exit
+      when "r", "read" then @message.get_instructions
       end
     end
-
-    def self.get_choice
-      choice = gets.chomp.downcase
-      choice
-    end
   end
 end
-
-

data/lib/mastermind_sname/sname/command.rb

@@ -0,0 +1,32 @@
+require_relative "game.rb"
+module MastermindSname
+  class Command
+    attr_accessor :game_colours, :guesses
+    def initialize
+      @game_colours = game_colours
+    end
+
+    def action(guess, game_colours, guesses)
+      @game_colours = game_colours
+      @guesses = guesses
+      case guess
+      when "quit", "q" then exit
+      when "cheat", "c" then cheat_mode
+      when "h", "history" then get_history
+      end
+    end
+
+    def cheat_mode
+      puts Message.new.cheat(@game_colours)
+      exit
+    end
+
+    def get_history
+      return "No guesses yet" if @guesses.empty?
+      @guesses.each_with_index\
+       { |val, i| print " #{i + 1} ==> #{val} \n" }
+      print "\n"
+      puts "Enter guess"
+    end
+  end
+end

data/lib/mastermind_sname/sname/game.rb

@@ -1,129 +1,91 @@
-require_relative "commands.rb"
-require_relative "dump_data.rb"
-module SnameGame
+require_relative "record.rb"
+require_relative "input.rb"
+module MastermindSname
   class Game
-    attr_accessor :level,:game_colours,:user_colours,:number_of_guesses, :user_guess, :player_hash, :user_guess_array, :user_guess_count
-    
-    def initialize_values
-      @user_guess_count = 0
-      @user_guess_array = []
-      @player_hash = SnamePlayer::Player.get_player
-      @game_colours = SnameGameColours::GameColours.get_colours(@player_hash["level"])
-      create_records_file  unless File.file?("game_records.json")
-      File.file?("game_records.json")
+    include Input
+    attr_accessor :game_colours, :guess, :player,
+                  :start_time
+    def initialize(player)
+      @guesses = []
+      @player = player
+      @game_colours = GameColour.new(@player).get_colours
+      puts @game_colours.join("")
+      create_records_file unless File.file?("game_records.json")
+      @message = Message.new
     end
 
     def play
-      initialize_values
-      @player_hash["start_time"] = SnameTimer::Timer.set_time
-      SnameMessages::Messages.start_message(@player_hash,@game_colours)
+      @start_time = Time.now
+      puts @message.start(@player, @game_colours)
       start_guessing
-      play_again 
+      play_again
     end
 
     def start_guessing
-      while @user_guess_count <= 11 && !is_correct? do
+      loop do
         collect_user_guess
-        break if is_quit? 
         puts record_guess
-      end 
-      unless SnameLogics::Logics.is_input_command?(@user_guess)  
-        puts game_end 
+        break if @guesses.length > 9 || correct?
       end
+      puts game_end
     end
 
-    def is_quit?
-      arr = ["cheat","quit","q","c"]
-      arr.each do |x|
-        return true if @user_guess == x
-      end
-        return false
-    end
-
-
-    def is_correct?
-      return true  if @user_guess == @game_colours.join("")
-      return false
+    def correct?
+      @guess == @game_colours.join("")
     end
 
     def create_records_file
-      system "echo '{\"beginner\":[],\"intermediate\":[],\"advanced\":[]}' > game_records.json"
-      File.file?("game_records.json")
+      system "echo '{\"beginner\":[],\"intermediate\":[],\"advanced\":[]}' > g"\
+      "ame_records.json"
     end
 
     def update_player
-      @player_hash["guesses_count"] = @user_guess_array.length
-      @player_hash["full_level"] = get_full_level_name
-      @player_hash["game_colours"] = @game_colours 
-      @player_hash["end_time"] = SnameTimer::Timer.set_time
-      @player_hash["time"] = SnameTimer::Timer.get_time_taken(@player_hash["start_time"],@player_hash["end_time"])
-      @player_hash
-    end
-
-    def get_full_level_name
-      case @player_hash["level"]
-      when "i" then return "intermediate"
-      when "b" then return "beginner"
-      when "a" then   return "advanced"
-      end       
+      @player[:guesses_count] = @guesses.length
+      @player[:game_colours] = @game_colours
+      @player[:time] = (Time.now - @start_time).round.time_format
     end
 
     def game_end
-      if  @user_guess_count > 11
-        return "GAME OVER! Out of Guesses" 
-      else
+      if correct?
         update_player
-        BuildRecord::Sname.new.set_new_record(@player_hash)
-        SnameMessages::Messages.congratulations_screen(@player_hash)
-        BuildRecord::Sname.new.display_top_ten(@player_hash)
+        record = Record.new(@player)
+        record.set_new
+        @message.congratulations_screen @player
+        record.display_top_ten
+      else
+        @message.game_over
       end
     end
 
     def collect_user_guess
-      valid = false
-      puts "You've taken #{@user_guess_array.length} guess(es)" if @user_guess_array != []
-      @user_guess = gets.chomp.downcase
-      if @user_guess == "h"
-        valid = true
-        return get_guess_history
+      puts "#{10 - @guesses.length} guess(es) left" unless @guesses.empty?
+      @guess = get_input
+      loop do
+        @game_logic = GameLogic.new(@guess, @game_colours)
+        valid = @game_logic.valid_length? || @game_logic.input_command?
+        Command.new.action(@guess, @game_colours, @guesses)
+        puts @game_logic.length_feedback unless valid
+        @guess = get_input unless valid
+        break if valid
       end
-      until valid == true do
-        valid = true if SnameLogics::Logics.is_input_command?(@user_guess)
-        puts SnameCommands::Commands.command_action(@user_guess,@game_colours) 
-        valid = SnameLogics::Logics.check_guess?(@user_guess, @player_hash["level"])  if !valid
-        puts  SnameLogics::Logics.check_guess_length?(@user_guess, @player_hash["level"]) if !valid
-        @user_guess = gets.chomp.downcase if !valid
-      end
-    end
-
-    def user_guess_check
     end
 
     def play_again
-      puts "Do you want to play again? (y for yes/ press any other key to quit)"
-      choice = gets.chomp.downcase
+      @message.play_again
+      choice = get_input
       if choice == "y"
-        MastermindSname::Sname.start 
+        Game.new(@player).play
       else
         exit
       end
     end
 
-    def get_guess_history
-      for i in (0...@user_guess_array.length) do print " #{i+1} ==> #{@user_guess_array[i]} \n" end
-      print "\n"
-      puts "Enter guess"
-      return @user_guess_array
-    end
-
     def record_guess
-      if @user_guess != "h"
-        @user_guess_count += 1 
-        @user_guess_array << @user_guess 
-        is_correct? 
-        SnameLogics::Logics.get_feedback(@user_guess,@game_colours)
-      end 
+      unless @guess == "h"
+        @guesses << @guess
+        correct?
+        @game_logic.get_feedback
+      end
     end
-
-  end 
+  end
 end