just_checkers 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 404c68f0f2336d1e7082534610f59f9a82dfe427
-  data.tar.gz: af653b067e74d1e31d4f97a5bccaef45b4c78e4a
+  metadata.gz: 60946aa3db499cb440fd0c2d9979c86f76d535d3
+  data.tar.gz: 58d674537166da0ad642230543b5911e1cfa558f
 SHA512:
-  metadata.gz: 9088167eaa8e61a7c0fcbc2a45ecddce41c845810471fa593e3e84668e75b37a9cab2326f80fa0bd2c8cf85b1bffc01588beb802156de686ff52ef2765077a39
-  data.tar.gz: fd1903da0c448ac2208cd44232a0722b23f0e9e7356a68039c9bb702809538a668744155bd2ba28182521ed75e9d947017e66aba914b2bd4d5ca89dcb92d481a
+  metadata.gz: 9a57e7a29e8e0c6f950abac5d470501fd55977c78fe502414dd78130b6957ef113df5437a3ba5f35319f6905441769fc47e75a934cd31dbba603734feec550a4
+  data.tar.gz: 7d6f5c656e3d79558dc7ada2ec6d442d6badc247803632a8abbb5117aaf9f01d44f7e7608e5b71afaf5f0603e11fae9dcf6a1433697e24f721665473ddad4365

data/README.md

@@ -29,6 +29,18 @@ Moves can be made by passing in the player number, from co-ordinates and an arra
   game_state.move(1, {x: 1, y: 2}, [{x: 2, y: 3}])
 ```
 
+Alternatively, moves can be made by specifying the ids of the squares.
+
+```ruby
+  game_state.move(1, 1, [2])
+```
+
+The last change with all its details are found in the `last_change` attribute
+
+```ruby
+  game_state.last_change
+```
+
 If something happens errors may be found in the errors attribute
 
 ```ruby

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require 'bundler/gem_tasks'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'

data/lib/just_checkers/game_state.rb

@@ -31,6 +31,7 @@ module JustCheckers
       @current_player_number = current_player_number
       @squares = SquareSet.new(squares: squares)
       @errors = []
+      @last_change = {}
     end
 
     # @return [Fixnum] who's turn it is.
@@ -42,6 +43,9 @@ module JustCheckers
     # @return [Array<Error>] errors if any.
     attr_reader :errors
 
+    # @return [Hash] most recent change.
+    attr_reader :last_change
+
     # Instantiates a new GameState object in the starting position
     #
     # @return [GameState]
@@ -49,45 +53,45 @@ module JustCheckers
       new({
         current_player_number: 1,
         squares: [
-          { x: 1, y: 0, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 3, y: 0, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 5, y: 0, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 7, y: 0, piece: { player_number: 1, direction: 1, king: false }},
-
-          { x: 0, y: 1, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 2, y: 1, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 4, y: 1, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 6, y: 1, piece: { player_number: 1, direction: 1, king: false }},
-
-          { x: 1, y: 2, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 3, y: 2, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 5, y: 2, piece: { player_number: 1, direction: 1, king: false }},
-          { x: 7, y: 2, piece: { player_number: 1, direction: 1, king: false }},
-
-          { x: 0, y: 3, piece: nil },
-          { x: 2, y: 3, piece: nil },
-          { x: 4, y: 3, piece: nil },
-          { x: 6, y: 3, piece: nil },
-
-          { x: 1, y: 4, piece: nil },
-          { x: 3, y: 4, piece: nil },
-          { x: 5, y: 4, piece: nil },
-          { x: 7, y: 4, piece: nil },
-
-          { x: 0, y: 5, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 2, y: 5, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 4, y: 5, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 6, y: 5, piece: { player_number: 2, direction: -1, king: false }},
-
-          { x: 1, y: 6, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 3, y: 6, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 5, y: 6, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 7, y: 6, piece: { player_number: 2, direction: -1, king: false }},
-
-          { x: 0, y: 7, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 2, y: 7, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 4, y: 7, piece: { player_number: 2, direction: -1, king: false }},
-          { x: 6, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 1, x: 1, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 2, x: 3, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 3, x: 5, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 4, x: 7, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+
+          { id: 5, x: 0, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 6, x: 2, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 7, x: 4, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 8, x: 6, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+
+          { id: 9, x: 1, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 10, x: 3, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 11, x: 5, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+          { id: 12, x: 7, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+
+          { id: 13, x: 0, y: 3, piece: nil },
+          { id: 14, x: 2, y: 3, piece: nil },
+          { id: 15, x: 4, y: 3, piece: nil },
+          { id: 16, x: 6, y: 3, piece: nil },
+
+          { id: 17, x: 1, y: 4, piece: nil },
+          { id: 18, x: 3, y: 4, piece: nil },
+          { id: 19, x: 5, y: 4, piece: nil },
+          { id: 20, x: 7, y: 4, piece: nil },
+
+          { id: 21, x: 0, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 22, x: 2, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 23, x: 4, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 24, x: 6, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+
+          { id: 25, x: 1, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 26, x: 3, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 27, x: 5, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 28, x: 7, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+
+          { id: 29, x: 0, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 30, x: 2, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 31, x: 4, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+          { id: 32, x: 6, y: 7, piece: { player_number: 2, direction: -1, king: false }},
         ]
       })
     end
@@ -127,23 +131,34 @@ module JustCheckers
     # @param [Fixnum] player_number
     #   the player number, 1 or 2.
     #
-    # @param [Hash] from
+    # @param [Hash, Fixnum] from
     #   where the moving piece currently is.
     #
-    # @param [Array<Hash>] to
+    # @param [Array<Hash>, Array<Fixnum>] to
     #   each place the piece is going to move to.
     #
     # @return [Boolean]
     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 { |s| squares.find_by_x_and_y(s[:x].to_i, s[:y].to_i) }
+
+      from_square = if from.is_a?(Hash)
+        squares.find_by_x_and_y(from[:x].to_i, from[:y].to_i)
+      else
+        squares.find_by_id(from.to_i)
+      end
+
+      to_squares = if to.all? { |s| s.is_a?(Hash) }
+        to.map { |position| squares.find_by_x_and_y(position[:x].to_i, position[:y].to_i) }
+      else
+        to.map { |id| squares.find_by_id(id) }
+      end
 
       if player_number != current_player_number
         @errors.push NotPlayersTurnError.new
       elsif move_valid?(from_square, to_squares)
+        @last_change = { type: 'move', data: {player_number: player_number, from: from, to: to} }
         perform_move(from_square, to_squares)
-        promote(to_squares.last) if promotable?(to_squares.last)
+        to_squares.last.promote if to_squares.last.promotable?
         turn
       end
 
@@ -171,14 +186,10 @@ module JustCheckers
       @errors.empty?
     end
 
-    def promote(square) # :nodoc:
-      square.piece.promote
-    end
-
     def perform_move(from, to) # :nodoc:
       legs = to.unshift(from)
-      legs.each_cons(2) do |a, b|
-        between_square = squares.between(a, b).first
+      legs.each_cons(2) do |origin, destination|
+        between_square = squares.between(origin, destination).first
         between_square.piece = nil if between_square
       end
 
@@ -197,17 +208,5 @@ module JustCheckers
     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
-        square.y == 7
-      when -1
-        square.y == 0
-      else
-        false
-      end
-    end
-
   end
 end

data/lib/just_checkers/square.rb

@@ -10,6 +10,9 @@ module JustCheckers
 
     # New objects can be instantiated by passing in a hash with
     #
+    # @param [Fixnum] id
+    #   the unique identifier of the square.
+    #
     # @param [Fixnum] x
     #   the x co-ordinate of the square.
     #
@@ -22,11 +25,13 @@ module JustCheckers
     # ==== Example:
     #   # Instantiates a new Square
     #   JustCheckers::Square.new({
+    #     id: 1,
     #     x: 1,
     #     y: 0,
     #     piece: { player_number: 1, direction: 1, king: false }
     #   })
-    def initialize(x: , y: , piece: nil)
+    def initialize(id: , x: , y: , piece: nil)
+      @id = id
       @x = x
       @y = y
       @piece = if piece.is_a?(Hash)
@@ -36,6 +41,9 @@ module JustCheckers
       end
     end
 
+    # @return [Fixnum] the unique identifier of the square.
+    attr_reader :id
+
     # @return [Fixnum] the x co-ordinate of the square.
     attr_reader :x
 
@@ -111,11 +119,32 @@ module JustCheckers
       squares.one_square_away_from(self).in_direction_of(piece, self).unoccupied
     end
 
+    # Checks if the piece on the square can promote.
+    #
+    # @return [Boolean]
+    def promotable?
+      case piece && piece.direction
+      when 1
+        y == 7
+      when -1
+        y == 0
+      else
+        false
+      end
+    end
+
+    # Promotes the piece if the piece exists.
+    #
+    # @return [Boolean]
+    def promote
+      piece && piece.promote
+    end
+
     # A serialized version of the square as a hash
     #
     # @return [Hash]
     def as_json
-      { x: x, y: y, piece: piece && piece.as_json }
+      { id: id, x: x, y: y, piece: piece && piece.as_json }
     end
   end
-end
+end

data/lib/just_checkers/square_set.rb

@@ -67,8 +67,8 @@ module JustCheckers
     #   # Find all squares where piece is nil
     #   square_set.where(piece: nil)
     def where(hash)
-      res = hash.inject(squares) do |memo, (k, v)|
-        memo.select { |s| s.attribute_match?(k, v) }
+      res = hash.inject(squares) do |memo, (attribute, value)|
+        memo.select { |square| square.attribute_match?(attribute, value) }
       end
       self.class.new(squares: res)
     end
@@ -89,6 +89,19 @@ module JustCheckers
       select { |s| s.x == x && s.y == y }.first
     end
 
+    # Find the square with the matching unique identifier
+    #
+    # @param [Fixnum] id
+    #   the unique identifier.
+    #
+    # @return [Square]
+    # ==== Example:
+    #   # Find the square with id 4
+    #   square_set.find_by_id(4)
+    def find_by_id(id)
+      select { |s| s.id == id }.first
+    end
+
     # Return all squares that are one square away from the passed square.
     #
     # @param [Square] square
@@ -134,7 +147,7 @@ module JustCheckers
     #
     # @return [SquareSet]
     def unoccupied
-      select { |s| s.piece.nil? }
+      select(&:unoccupied?)
     end
 
     # Returns squares between a and b.

data/lib/just_checkers/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_checkers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2016-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,4 +108,3 @@ signing_key:
 specification_version: 4
 summary: A checkers engine written in ruby
 test_files: []
-has_rdoc: