board_game_grid 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd36b2b988acedde04d34d32c977268766edbe370565d7e4afc1af072e0bd49d
-  data.tar.gz: e47c5ab5280c737da98d3757ac35864aaab0cb10d435a25ec6e8ee53db11c63d
+  metadata.gz: 10e78c90bda05726eb9b8b0d68f4526fa872279c063089eeb5ac0729411fadf2
+  data.tar.gz: 832fb5ae71b1a0e6be4a56ff8b1e4cbcfd694315a8ed7c628cf47d4c1ba152eb
 SHA512:
-  metadata.gz: 7b9d4d05e209bad2899a5b721c457272d23e6a1f6242fa8015c3f7aac4f86bb490de63d195012f42df157d6e35bcf91ac3f8f601006511739c521f34c2e0d1e3
-  data.tar.gz: ecb84eb4ed4e7f076a37aed8203409ee8e5275560d6b5368188ee865bcaa5911c090ae7e6034b54dd44d9ec00e6e595df00597d2471ea547ec959dbdbdbd1a1e
+  metadata.gz: 196ded6b6dbfa358570c041e9db00b7df582e59aaa92ab0cde8cd4121bac68db6a4eb2e9a13c72fe111f642c079b052742b185d441571913a78274980b8c95f2
+  data.tar.gz: dee9e3fdcd61efb4c6b8b9fcf9f549b930b4c6da2ba3b1e202ac62689542e537a8200e21d5c9bf86f9f6ef5708371ce3d32f085b23321a7a554ad3d821535e37

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/version.rb

@@ -1,3 +1,3 @@
 module BoardGameGrid
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: board_game_grid
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-04-23 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