board_game_grid 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbcdb4a9672a1d039ef09cccc368dcaaf01463258683bc3dc80f557e018918f2
-  data.tar.gz: 0d8cf28d4594433989f48ab193e1db4feb74aa971ec254f123db6d500c8b5046
+  metadata.gz: '08f7b2a3342d4355bb117938c6eab6f2d6a10cd31bad0eeee2a6f5b0eee14fb7'
+  data.tar.gz: f5fb49a01d5a1a2cee3d5a22a43c3651af02baafa3f8fc775617f37f72c5d329
 SHA512:
-  metadata.gz: e7cc7f9587922d5fd23760df797cf5f83aef6f0ad57836b642287b16d9aa446980c6030e1e776496eed0cb12b27a7f56aac18a252ddf2153f0d6c38153b81999
-  data.tar.gz: ad708fd41faa49f3cc5f090e5d6396efbd33dab9a8ddcfa5cc2cf86f81309293ef0224ede0e788bed7af7dc4f0bfbfd2edaa8d7d0854945f7a508f2a8bd082eb
+  metadata.gz: 03b293ca58728b526c868a4382929093bec8c67f5b0ba6a9223a4e14fa0440b695fd1a5ff53a27dbb472b4923407bfaeb1c637ce48b2bf78598bdb3ef18b6740
+  data.tar.gz: 41c0e069d78f457ab290f47efe178b97c43d74077b6649aaa0c01a5d51cf16e4171a9b1906ea9ecfd734fbb37f882c49585008d02de486040e95dc563d7d95ae

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.swp

data/lib/board_game_grid.rb

@@ -5,4 +5,6 @@ module BoardGameGrid
 
 end
 
-require 'board_game_grid/square_set'
+require 'board_game_grid/square_set'
+require 'board_game_grid/square'
+require 'board_game_grid/piece'

data/lib/board_game_grid/piece.rb

@@ -0,0 +1,124 @@
+module BoardGameGrid
+
+  # = Piece
+  #
+  # A piece that can move on a board
+  class Piece
+    # The forwards direciton of the piece for each player
+    FORWARDS_DIRECTION = { 1 => -1, 2 => 1 }
+
+    def initialize(id: , player_number: , type: nil)
+      @id = id
+      @player_number = player_number
+    end
+
+    # @return [Fixnum] the identifier of the piece.
+    attr_reader :id
+
+    # @return [Fixnum] the owner of the piece.
+    attr_reader :player_number
+
+    # The opposing player number
+    #
+    # @return [Fixnum]
+    def opponent
+      player_number == 1 ? 2 : 1
+    end
+
+    # The stringified identifier of the piece type.
+    #
+    # @return [Fixnum]
+    def type
+      self.class.to_s.split('::').last.downcase
+    end
+
+    # Can the piece move from a square, to a square, given the game state?
+    # 
+    # @param [Square] from
+    #   the origin square.
+    #
+    # @param [Square] to
+    #   the destination square.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [Boolean]
+    def can_move?(from, to, game_state)
+      destinations(from, game_state).include?(to) 
+    end
+
+    # All the squares that the piece can move to and/or capture.
+    #
+    # @param [Square] square 
+    #   the origin square.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [SquareSet]
+    def destinations(square, game_state)
+      []
+    end
+
+    # All the squares that the piece can move to.
+    #
+    # @param [Square] square
+    #   the origin square.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [SquareSet]
+    def move_squares(square, game_state)
+      destinations(square, game_state)
+    end
+
+    # All the squares that the piece can capture.
+    #
+    # @param [Square] square
+    #   the origin square.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [SquareSet]
+    def capture_squares(squares, game_state)
+      destinations(squares, game_state)
+    end
+
+    # All the squares that the piece could potentially capture. (i.e. if a piece was there)
+    #
+    # @param [Square] square
+    #   the origin square.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [SquareSet]
+    def potential_capture_squares(square, game_state)
+      capture_squares(square, game_state)
+    end
+
+    # returns a serialized piece as a hash
+    #
+    # @return [Hash]
+    def as_json
+      {
+        id: id,
+        player_number: player_number,
+        type: type
+      }
+    end
+
+    # returns the direction the piece moves
+    #
+    # player 1 moves up (-1)
+    # player 2 moves down (1)
+    #
+    # @return [Fixnum]
+    def forwards_direction
+      FORWARDS_DIRECTION[player_number]
+    end
+  end
+end

data/lib/board_game_grid/square.rb

@@ -48,6 +48,18 @@ module BoardGameGrid
     # @return [Hash,NilClass] The piece on the square if any.
     attr_accessor :piece
 
+    # A serialized version of the square as a hash
+    #
+    # @return [Hash]
+    def as_json
+      { 
+        id: id, 
+        x: x, 
+        y: y, 
+        piece: piece && piece.as_json
+      }
+    end
+
     # checks if the square matches the attributes passed.
     #
     # @param [Symbol] attribute
@@ -64,6 +76,8 @@ module BoardGameGrid
         value = obj.send(k)
         if !value.nil? && v.is_a?(Hash)
           v.all? { |k2,v2| hash_obj_matcher.call(value, k2, v2) }
+        elsif v.is_a?(Array) && !value.is_a?(Array)
+          v.include?(value)
         else
           value == v
         end
@@ -86,6 +100,20 @@ module BoardGameGrid
       !piece
     end
 
+    # Is the square occupied by the specified player?
+    #
+    # @return [Boolean]
+    def occupied_by_player?(player_number)
+      piece && piece.player_number == player_number
+    end
+
+    # Is the square occupied by the specified player?
+    #
+    # @return [Boolean]
+    def occupied_by_opponent?(player_number)
+      piece && piece.player_number != player_number
+    end
+
     # Is the square the same as another one?
     #
     # @return [Boolean]
@@ -100,11 +128,5 @@ module BoardGameGrid
       Point.new(x, y)
     end
 
-    # A serialized version of the square as a hash
-    #
-    # @return [Hash]
-    def as_json
-      { id: id, x: x, y: y, piece: piece }
-    end
   end
 end

data/lib/board_game_grid/square_set.rb

@@ -47,6 +47,13 @@ module BoardGameGrid
     def_delegator :squares, :each
     def_delegator :squares, :empty?
 
+    # serializes the squares as a hash
+    #
+    # @return [Hash]
+    def as_json
+      squares.map(&:as_json)
+    end
+
     # Concat two SquareSets together
     #
     # @param [SquareSet] other
@@ -188,6 +195,35 @@ module BoardGameGrid
       select { |square| square.x == x && square.y == y }.first
     end
 
+    # Find the square with the matching piece identifier
+    #
+    # @param [Fixnum] piece_id
+    #   the unique identifier of the piece.
+    #
+    # @return [Square]
+    # ==== example:
+    #   # Find the square with a piece with id 4
+    #   square_set.find_by_piece_id(4)
+    def find_by_piece_id(piece_id)
+      find { |s| s.piece && s.piece.id == piece_id }
+    end
+
+    # Find all squares in the y direction of square
+    #
+    # @param [Square] square
+    #   the originating square
+    #
+    # @param [Fixnum] direction_y
+    #   the direction, either up (-1) or down (1)
+    #
+    # @return [SquareSet]
+    # ==== Example:
+    #   # Get all squares up from square_a
+    #   square_set.in_direction(square_a, -1)
+    def in_direction(square, direction_y)
+      select { |s| BoardGameGrid::Vector.new(square, s).direction.y == direction_y }
+    end
+
     # Find all squares within distance of square
     #
     # @param [Square] square
@@ -220,6 +256,39 @@ module BoardGameGrid
       select { |square| Vector.new(origin, square).magnitude == distance }
     end
 
+
+    # Find all squares a certain number of ranks away 
+    #
+    # @param [Square] origin 
+    #   the originating square
+    #
+    # @param [Fixnum] distance
+    #   the specified distance from the square
+    #
+    # @return [SquareSet]
+    # ==== Example:
+    #   # Get all squares at 2 ranks away from square_a
+    #   square_set.ranks_away(square_a, 2)
+    def ranks_away(origin, distance)
+      select { |square| Vector.new(origin, square).dy.abs == distance }
+    end
+
+    # Find all squares a certain number of files away 
+    #
+    # @param [Square] origin 
+    #   the originating square
+    #
+    # @param [Fixnum] distance
+    #   the specified distance from the square
+    #
+    # @return [SquareSet]
+    # ==== Example:
+    #   # Get all squares at 2 ranks away from square_a
+    #   square_set.files_away(square_a, 2)
+    def files_away(origin, distance)
+      select { |square| Vector.new(origin, square).dx.abs == distance }
+    end
+
     # Find all squares orthogonal from square
     #
     # @param [Square] square
@@ -272,6 +341,56 @@ module BoardGameGrid
       select { |square| Vector.new(origin, square).not_orthogonal_or_diagonal? }
     end
 
+    # Takes a player number and returns all squares occupied by the player
+    #
+    # @param [Fixnum] player_number
+    #   the player's number.
+    #
+    # @return [SquareSet]
+    def occupied_by_player(player_number)
+      select { |s| s.occupied_by_player?(player_number) }
+    end
+
+    # Takes a player number and returns all squares occupied by the opponent of the player
+    #
+    # @param [Fixnum] player_number
+    #   the player's number.
+    #
+    # @return [SquareSet]
+    def occupied_by_opponent(player_number)
+      select { |s| s.occupied_by_opponent?(player_number) }
+    end
+
+    # Takes a player number and returns all squares unoccupied or occupied by the opponent of the player
+    #
+    # @param [Fixnum] player_number
+    #   the player's number.
+    #
+    # @return [SquareSet]
+    def unoccupied_or_occupied_by_opponent(player_number)
+      select { |s| s.unoccupied? || s.occupied_by_opponent?(player_number) }
+    end
+
+    # Find all squares occupied by a piece of a particular type
+    #
+    # @param [Class] piece_type
+    #   the class of the piece.
+    #
+    # @return [SquareSet]
+    def occupied_by_piece(piece_type)
+      select { |s| s.piece && s.piece.is_a?(piece_type) }
+    end
+
+    # Find all squares occupied by a piece not of a particular type
+    #
+    # @param [Class] piece_type
+    #   the class of the piece.
+    #
+    # @return [SquareSet]
+    def excluding_piece(piece_type)
+      select { |s| s.piece && !s.piece.is_a?(piece_type) }
+    end
+
     # Find all squares without pieces on them.
     #
     # @return [SquareSet]
@@ -327,12 +446,5 @@ module BoardGameGrid
 
       self.class.new(squares: _squares)
     end
-
-    # serializes the squares as a hash
-    #
-    # @return [Hash]
-    def as_json
-      squares.map(&:as_json)
-    end
   end
 end

data/lib/board_game_grid/vector.rb

@@ -73,14 +73,18 @@ module BoardGameGrid
       orthogonal? || diagonal?
     end
 
-    private
-
+    # The distance on the x axis
+    #
+    # @return [Fixnum]
     def dx
       destination.x - origin.x
     end
 
+    # The distance on the y axis
+    #
+    # @return [Fixnum]
     def dy
       destination.y - origin.y
     end
   end
-end
+end

data/lib/board_game_grid/version.rb

@@ -1,3 +1,3 @@
 module BoardGameGrid
-  VERSION = "0.1.2"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: board_game_grid
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - board_game_grid.gemspec
 - lib/board_game_grid.rb
 - lib/board_game_grid/direction.rb
+- lib/board_game_grid/piece.rb
 - lib/board_game_grid/point.rb
 - lib/board_game_grid/square.rb
 - lib/board_game_grid/square_set.rb