board_game_grid 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30b06334909c284fa4df43311e971bad13b2d4b03ad0c95e09e5f05ec2240d7b
-  data.tar.gz: f9821c6b664ab4eb5cd0c766e2e4b556eab40067517c9fea3abc38bf53d36205
+  metadata.gz: 65c16ddf332a1bc7229a8b038a6d1716cec9d43bdc875c4e0b139eeb5d987534
+  data.tar.gz: 1ddd8f91ccf45434eb141f1b26bc6008659555164e7f445e9947986a1bb02d58
 SHA512:
-  metadata.gz: c290da6cb71e2ef9b9eb2c841f2e86a6f165ebcf1d9fbc433f40d98f9e2117a4b3f5b1bd4bf47662489fc883a0841b67386d6b85d9eaec9d687b99c920b29cd9
-  data.tar.gz: 7be305c897cfb2290e574a6d403f71c60499f7a6315c015e4a3c1822a1f512ee19443424dde9f3e9569917885434923fc78343ae5abea11300c203b7e8305a01
+  metadata.gz: 3af1ea117ae58ad996b9f97b7deca7840ae963eeff28418cccd52b3842db987efe9a1994a0c717cf69096b82bffd179b73a85a5b3f31c3b5a1a1f198b11625cc
+  data.tar.gz: dd44cb8eef8eedfdff3330035704ed110b713abc7389497f13bda8eba462f829c9196baac108ba1a36707704451cf4f76df084e5813595159fec4582b132e788

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
@@ -62,8 +74,12 @@ module BoardGameGrid
     def attribute_match?(attribute, value)
       hash_obj_matcher = lambda do |obj, k, v|
         value = obj.send(k)
-        if !value.nil? && v.is_a?(Hash)
+        if v.is_a?(Hash) && !value.nil?
           v.all? { |k2,v2| hash_obj_matcher.call(value, k2, v2) }
+        elsif v.is_a?(Array) && !value.is_a?(Array)
+          v.include?(value)
+        elsif v.is_a?(Proc)
+          v.call(value)
         else
           value == v
         end
@@ -86,6 +102,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 +130,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
@@ -305,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]
@@ -360,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/version.rb

@@ -1,3 +1,3 @@
 module BoardGameGrid
-  VERSION = "0.1.3"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: board_game_grid
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2021-06-16 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