just_checkers 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f9a84872947e5dddb0826c13edd669786b581fe
-  data.tar.gz: 34a9dbadce0fc0b47e8d564fbb0888a342ae093c
+  metadata.gz: 404c68f0f2336d1e7082534610f59f9a82dfe427
+  data.tar.gz: af653b067e74d1e31d4f97a5bccaef45b4c78e4a
 SHA512:
-  metadata.gz: fd608fe24b0e129f86a580c24902340b6119da7962aafcec9f75cae7b55b72b6f628284823e4f9cfe068d143e7dc9bd4115cf16f50f14c80bf9c1c2a3099b9ae
-  data.tar.gz: d252d1405ea6fca132d01d379a0ad5ecafe34a3549a97d03b2dcbb6c7ca74fb170d4619895aa80868b664c202840666b6acd7e9471534694a9c5b44b4f3499dd
+  metadata.gz: 9088167eaa8e61a7c0fcbc2a45ecddce41c845810471fa593e3e84668e75b37a9cab2326f80fa0bd2c8cf85b1bffc01588beb802156de686ff52ef2765077a39
+  data.tar.gz: fd1903da0c448ac2208cd44232a0722b23f0e9e7356a68039c9bb702809538a668744155bd2ba28182521ed75e9d947017e66aba914b2bd4d5ca89dcb92d481a

data/README.md

@@ -26,13 +26,13 @@ Moves can be made by passing in the player number, from co-ordinates and an arra
 
 
 ```ruby
-  game_state.move!(1, {x: 1, y: 2}, [{x: 2, y: 3}])
+  game_state.move(1, {x: 1, y: 2}, [{x: 2, y: 3}])
 ```
 
-If something happens a message may be found in the messages attribute
+If something happens errors may be found in the errors attribute
 
 ```ruby
-  game_state.messages
+  game_state.errors
 ```
 
 The Winner can be found by calling winner on the object.

data/just_checkers.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = '>= 2.1'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/just_checkers.rb

@@ -1,5 +1,6 @@
 require "just_checkers/version"
 
+# :nodoc:
 module JustCheckers
 
 end

data/lib/just_checkers/errors/empty_square_error.rb

@@ -0,0 +1,22 @@
+require 'just_checkers/errors/error'
+
+module JustCheckers
+
+  # = EmptySquareError
+  #
+  # An empty square error with a message
+  class EmptySquareError < Error
+
+    # New empty square errors can be instantiated with
+    #
+    # @option [String] message
+    #   the x co-ordinate.
+    #
+    # ==== Example:
+    #   # Instantiates a new EmptySquareError
+    #   JustCheckers::EmptySquareError.new("Custom Message")
+    def initialize(message="Square is empty.")
+      super
+    end
+  end
+end

data/lib/just_checkers/errors/error.rb

@@ -0,0 +1,20 @@
+module JustCheckers
+
+  # = Error
+  #
+  # An error with a message
+  class Error
+
+    # New errors can be instantiated with
+    #
+    # @option [String] message
+    #   the x co-ordinate.
+    #
+    # ==== Example:
+    #   # Instantiates a new Error
+    #   JustCheckers::Error.new("Custom Message")
+    def initialize(message="Generic Error")
+      @message = message
+    end
+  end
+end

data/lib/just_checkers/errors/invalid_move_error.rb

@@ -0,0 +1,22 @@
+require 'just_checkers/errors/error'
+
+module JustCheckers
+
+  # = InvalidMoveError
+  #
+  # An invalid move error with a message
+  class InvalidMoveError < Error
+
+    # New invalid move errors can be instantiated with
+    #
+    # @option [String] message
+    #   the x co-ordinate.
+    #
+    # ==== Example:
+    #   # Instantiates a new InvalidMoveError
+    #   JustCheckers::InvalidMoveError.new("Custom Message")
+    def initialize(message="Move is invalid.")
+      super
+    end
+  end
+end

data/lib/just_checkers/errors/not_players_turn_error.rb

@@ -0,0 +1,22 @@
+require 'just_checkers/errors/error'
+
+module JustCheckers
+
+  # = NotPlayersTurnError
+  #
+  # A not players turn error with a message
+  class NotPlayersTurnError < Error
+
+    # New not players turn errors can be instantiated with
+    #
+    # @option [String] message
+    #   the x co-ordinate.
+    #
+    # ==== Example:
+    #   # Instantiates a new NotPlayersTurnError
+    #   JustCheckers::NotPlayersTurnError.new("Custom Message")
+    def initialize(message="It is not the player's turn yet.")
+      super
+    end
+  end
+end

data/lib/just_checkers/errors/piece_must_capture_error.rb

@@ -0,0 +1,22 @@
+require 'just_checkers/errors/error'
+
+module JustCheckers
+
+  # = PieceMustCaptureError
+  #
+  # A piece must capture error with a message
+  class PieceMustCaptureError < Error
+
+    # New piece must capture errors can be instantiated with
+    #
+    # @option [String] message
+    #   the x co-ordinate.
+    #
+    # ==== Example:
+    #   # Instantiates a new PieceMustCaptureError
+    #   JustCheckers::PieceMustCaptureError.new("Custom Message")
+    def initialize(message="Another piece must capture first.")
+      super
+    end
+  end
+end

data/lib/just_checkers/game_state.rb

@@ -1,4 +1,8 @@
 require 'just_checkers/square_set'
+require 'just_checkers/errors/not_players_turn_error'
+require 'just_checkers/errors/piece_must_capture_error'
+require 'just_checkers/errors/invalid_move_error'
+require 'just_checkers/errors/empty_square_error'
 
 module JustCheckers
 
@@ -9,13 +13,10 @@ module JustCheckers
 
     # New objects can be instantiated.
     #
-    # @param [Hash] args
-    #   The data needed for a game
-    #
-    # @option args [Fixnum] :current_player_number
+    # @param [Fixnum] current_player_number
     #   Who's turn it is, 1 or 2
     #
-    # @option args [Array<Square>] :squares
+    # @param [Array<Square>] squares
     #   An array of squares, each with x and y co-ordinates and a piece.
     #
     # ==== Example:
@@ -29,7 +30,7 @@ module JustCheckers
     def initialize(current_player_number: , squares: [])
       @current_player_number = current_player_number
       @squares = SquareSet.new(squares: squares)
-      @messages = []
+      @errors = []
     end
 
     # @return [Fixnum] who's turn it is.
@@ -38,8 +39,8 @@ module JustCheckers
     # @return [Array<Square>] the board state.
     attr_reader :squares
 
-    # @return [Array<String>] useful messages if any.
-    attr_reader :messages
+    # @return [Array<Error>] errors if any.
+    attr_reader :errors
 
     # Instantiates a new GameState object in the starting position
     #
@@ -105,9 +106,9 @@ module JustCheckers
     #
     # @return [Fixnum,NilClass]
     def winner
-      if squares.occupied_by(1).none? { |s| s.possible_jumps(s.piece, squares).any? || s.possible_moves(s.piece, squares).any? }
+      if no_pieces_for_player?(1)
         2
-      elsif squares.occupied_by(2).none? { |s| s.possible_jumps(s.piece, squares).any? || s.possible_moves(s.piece, squares).any? }
+      elsif no_pieces_for_player?(2)
         1
       else
         nil
@@ -121,7 +122,7 @@ module JustCheckers
     #
     # ==== Example:
     #   # Moves a piece from a square to perform a double jump
-    #   game_state.move!(1, {x: 0, y: 1}, [{x: 1, y: 2}, {x: 3, y: 4}])
+    #   game_state.move(1, {x: 0, y: 1}, [{x: 1, y: 2}, {x: 3, y: 4}])
     #
     # @param [Fixnum] player_number
     #   the player number, 1 or 2.
@@ -133,59 +134,48 @@ module JustCheckers
     #   each place the piece is going to move to.
     #
     # @return [Boolean]
-    def move!(player_number, from, to)
-      @messages = []
+    def move(player_number, from, to)
+      @errors = []
       from_square = squares.find_by_x_and_y(from[:x].to_i, from[:y].to_i)
-      to_squares = to.map { |p| squares.find_by_x_and_y(p[:x].to_i, p[:y].to_i) }
+      to_squares = to.map { |s| squares.find_by_x_and_y(s[:x].to_i, s[:y].to_i) }
 
       if player_number != current_player_number
-        @messages.push("It is not that player's turn.")
-        false
-      else
-        if move_valid?(from_square, to_squares)
-          perform_move!(from_square, to_squares)
-          promote!(to_squares.last) if promotable?(to_squares.last)
-          turn!
-          true
-        else
-          false
-        end
+        @errors.push NotPlayersTurnError.new
+      elsif move_valid?(from_square, to_squares)
+        perform_move(from_square, to_squares)
+        promote(to_squares.last) if promotable?(to_squares.last)
+        turn
       end
+
+      @errors.empty?
     end
 
     private
 
     def move_valid?(from, to) # :nodoc:
       legs = to.unshift(from)
-      if from && from.piece
-        legs.each_cons(2).map do |a, b|
-          if squares.occupied_by(from.piece.player_number).any? { |s| s.possible_jumps(s.piece, squares).any? }
-            if a.possible_jumps(from.piece, squares).include?(b)
-              true
-            else
-              @messages.push('Another piece must capture first.')
-              false
-            end
+      from_piece = from && from.piece
+
+      if from_piece
+        legs.each_cons(2).map do |origin, destination|
+          if squares.occupied_by(from_piece.player_number).any? { |s| s.possible_jumps(s.piece, squares).any? }
+            @errors.push(PieceMustCaptureError.new) unless origin.possible_jumps(from_piece, squares).include?(destination)
           else
-            if a.possible_moves(from.piece, squares).include?(b)
-              true
-            else
-              @messages.push('That piece cannot move like that.')
-              false
-            end
+            @errors.push(InvalidMoveError.new) unless origin.possible_moves(from_piece, squares).include?(destination)
           end
         end.all?
       else
-        @messages.push('There is no piece there.')
-        false
+        @errors.push EmptySquareError.new
       end
+
+      @errors.empty?
     end
 
-    def promote!(square) # :nodoc:
-      square.piece.promote!
+    def promote(square) # :nodoc:
+      square.piece.promote
     end
 
-    def perform_move!(from, to) # :nodoc:
+    def perform_move(from, to) # :nodoc:
       legs = to.unshift(from)
       legs.each_cons(2) do |a, b|
         between_square = squares.between(a, b).first
@@ -196,7 +186,7 @@ module JustCheckers
       from.piece = nil
     end
 
-    def turn! # :nodoc:
+    def turn # :nodoc:
       @current_player_number = other_player_number
     end
 
@@ -204,6 +194,10 @@ module JustCheckers
       current_player_number == 1 ? 2 : 1
     end
 
+    def no_pieces_for_player?(player_number) # :nodoc:
+      squares.occupied_by(player_number).none? { |s| s.possible_jumps(s.piece, squares).any? || s.possible_moves(s.piece, squares).any? }
+    end
+
     def promotable?(square) # :nodoc:
       case square.piece.direction
       when 1

data/lib/just_checkers/piece.rb

@@ -6,16 +6,13 @@ module JustCheckers
 
     # New objects can be instantiated by passing in a hash with
     #
-    # @param [Hash] args
-    #   The data needed for a piece
-    #
-    # @option args [Fixnum] player_number
+    # @param [Fixnum] player_number
     #   the owner of the piece.
     #
-    # @option args [Fixnum] direction
+    # @param [Fixnum] direction
     #   the direction forward on the board, 1 for moving down, -1 for moving up.
     #
-    # @option args [Boolean] king
+    # @option [Boolean] king
     #   set to true if the piece has been crowned.
     #
     # ==== Example:
@@ -45,7 +42,7 @@ module JustCheckers
     # promotes the piece by setting the +king+ attribute to true.
     #
     # @return [TrueClass]
-    def promote!
+    def promote
       @king = true
     end
 

data/lib/just_checkers/point.rb

@@ -25,7 +25,7 @@ module JustCheckers
 
     # @return [Fixnum] the x co-ordinate.
     attr_reader :x
-    
+
     # @return [Fixnum] the y co-ordinate.
     attr_reader :y
 

data/lib/just_checkers/square.rb

@@ -10,16 +10,13 @@ module JustCheckers
 
     # New objects can be instantiated by passing in a hash with
     #
-    # @param [Hash] args
-    #   The data needed for a square
-    #
-    # @option args [Fixnum] x
+    # @param [Fixnum] x
     #   the x co-ordinate of the square.
     #
-    # @option args [Fixnum] y
+    # @param [Fixnum] y
     #   the y co-ordinate of the square.
     #
-    # @option args [Piece,Hash,NilClass] piece
+    # @option [Piece,Hash,NilClass] piece
     #   The piece on the square, can be a piece object or hash or nil.
     #
     # ==== Example:

data/lib/just_checkers/square_set.rb

@@ -13,10 +13,7 @@ module JustCheckers
     # New objects can be instantiated by passing in a hash with squares.
     # They can be square objects or hashes.
     #
-    # @param [Hash] args
-    #   The data needed for the squares
-    #
-    # @option args [Array<Square,Hash>] squares
+    # @param [Array<Square,Hash>] squares
     #   An array of squares, each with x and y co-ordinates and a piece.
     #
     # ==== Example:

data/lib/just_checkers/version.rb

@@ -1,3 +1,4 @@
 module JustCheckers
-  VERSION = "0.1.3"
+  # :nodoc:
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_checkers
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-31 00:00:00.000000000 Z
+date: 2016-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,11 @@ files:
 - just_checkers.gemspec
 - lib/just_checkers.rb
 - lib/just_checkers/direction.rb
+- lib/just_checkers/errors/empty_square_error.rb
+- lib/just_checkers/errors/error.rb
+- lib/just_checkers/errors/invalid_move_error.rb
+- lib/just_checkers/errors/not_players_turn_error.rb
+- lib/just_checkers/errors/piece_must_capture_error.rb
 - lib/just_checkers/game_state.rb
 - lib/just_checkers/piece.rb
 - lib/just_checkers/point.rb
@@ -88,7 +93,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -103,3 +108,4 @@ signing_key:
 specification_version: 4
 summary: A checkers engine written in ruby
 test_files: []
+has_rdoc: