just_chess 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6272f4c1c746d2ef9c3dd9ca9569c4564f714a3b
-  data.tar.gz: 96f5372a8b9220f720abac49e2a7d8c586a81556
+  metadata.gz: adb4a267ab8fd196ea121bcf3cf1031d13bce76c
+  data.tar.gz: 114b58a5d9d564fba83939d99bd0eaa5a5a23c78
 SHA512:
-  metadata.gz: 71e99a15d466599fd0e286e9c51afe765c04b50191e5588c616b925e34520bd5e78fb230e2fdf9d09df9ff664644f196711b8326450c2aebd14a52f989d2cdec
-  data.tar.gz: a0cbf2a6cd01e4540d31020570fa0f8ac306d911b97fe113e022184022eb0148cc04a432dee72cacf08e863ff81bb0742ce2b033fdacebeccecb01e44a8a7dd4
+  metadata.gz: aac77f24dfb1bc701c5e4c35aa1886a46e77f5c8c054c4dcd56ef152a618e87d70d92d47007a02347d56c29beb56587073058b2e1a5a685993dfc233cf2c5df5
+  data.tar.gz: 24fef72e911e7478b5817e3848114cc010c35b37cad00946b5e247779e92c41424fb6610942720829246faa37418b6bf769291aa10142500895972c1a6f0aef3

data/just_chess.gemspec

@@ -26,4 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "board_game_grid", "~> 0.1.0"
+
 end

data/lib/just_chess/game_state.rb

@@ -4,6 +4,7 @@ require 'just_chess/errors/invalid_move_error'
 require 'just_chess/errors/invalid_promotion_error'
 require 'just_chess/errors/moved_into_check_error'
 require 'just_chess/square_set'
+require 'board_game_grid'
 
 module JustChess
 
@@ -223,7 +224,7 @@ module JustChess
       to = squares.find_by_id(to_id)
 
       captured = captured_square(from, to)
-      double_step_pawn = from.piece.is_a?(JustChess::Pawn) && Vector.new(from,to).magnitude == 2
+      double_step_pawn = from.piece.is_a?(JustChess::Pawn) && BoardGameGrid::Vector.new(from,to).magnitude == 2
       @last_double_step_pawn_id = double_step_pawn ? from.piece.id : nil
 
       @last_change = { type: 'move', data: {player_number: player_number, from: from_id, to: to_id} }
@@ -272,7 +273,7 @@ module JustChess
 
     def rook_castle_move(from, to)
       if from.occupied? && from.piece.is_a?(King) && from.piece.castle(from, self).include?(to)
-        vector = Vector.new(from, to)
+        vector = BoardGameGrid::Vector.new(from, to)
 
         rook_from_x = vector.direction.x > 0 ? 7 : 0
         rook_from_y = from.y

data/lib/just_chess/pieces/king.rb

@@ -47,7 +47,7 @@ module JustChess
 
       if has_not_moved? && rooks.any?
         _squares = rooks.map do |s|
-          vector = Vector.new(square, s)
+          vector = BoardGameGrid::Vector.new(square, s)
           x = square.x + (2 * vector.direction.x)
           y = square.y
           game_state.squares.find_by_x_and_y(x, y)

data/lib/just_chess/pieces/pawn.rb

@@ -1,5 +1,5 @@
 require 'just_chess/pieces/piece'
-require 'just_chess/vector.rb'
+require 'board_game_grid'
 
 module JustChess
 
@@ -73,7 +73,7 @@ module JustChess
     def en_passant_square(square, game_state)
       if square.rank_number(player_number) == 5 && game_state.last_double_step_pawn_id
         double_step = game_state.squares.find_by_piece_id(game_state.last_double_step_pawn_id)
-        vector = Vector.new(square, double_step)
+        vector = BoardGameGrid::Vector.new(square, double_step)
         if vector.magnitude.abs == 1
           x = double_step.x
           y = square.y + forwards_direction

data/lib/just_chess/pieces/piece.rb

@@ -1,5 +1,3 @@
-require 'just_chess/vector'
-
 module JustChess
 
   # = Piece

data/lib/just_chess/square.rb

@@ -1,12 +1,12 @@
 require 'just_chess/piece_factory'
-require 'just_chess/point'
+require 'board_game_grid'
 
 module JustChess
 
   # = Square
   #
   # A Square on a checker board
-  class Square
+  class Square < BoardGameGrid::Square
 
     # New objects can be instantiated by passing in a hash with
     #
@@ -37,32 +37,6 @@ module JustChess
       @piece = PieceFactory.new(piece).build
     end
 
-    # @return [String] the unique identifier of the square.
-    attr_reader :id
-
-    # @return [Fixnum] the x co-ordinate of the square.
-    attr_reader :x
-
-    # @return [Fixnum] the y co-ordinate of the square.
-    attr_reader :y
-
-    # @return [Piece,NilClass] The piece on the square if any.
-    attr_accessor :piece
-
-    # Is the square occupied by a piece?
-    #
-    # @return [Boolean]
-    def occupied?
-      !!piece
-    end
-
-    # Is the square unoccupied by a piece?
-    #
-    # @return [Boolean]
-    def unoccupied?
-      !piece
-    end
-
     # Is the square occupied by the specified player?
     #
     # @return [Boolean]
@@ -95,20 +69,6 @@ module JustChess
       rank_number(player_number) == 8
     end
 
-    # Is the square the same as another one?
-    #
-    # @return [Boolean]
-    def ==(other)
-      self.id == other.id
-    end
-
-    # A point object with the square's co-ordinates.
-    #
-    # @return [Point]
-    def point
-      Point.new(x, y)
-    end
-
     # A serialized version of the square as a hash
     #
     # @return [Hash]

data/lib/just_chess/square_set.rb

@@ -1,13 +1,12 @@
-require 'forwardable'
 require 'just_chess/square'
+require 'board_game_grid'
 
 module JustChess
 
   # = Square Set
   #
   # A collection of Squares with useful filtering functions
-  class SquareSet
-    extend Forwardable
+  class SquareSet < BoardGameGrid::SquareSet
 
     # New objects can be instantiated by passing in a hash with squares.
     # They can be square objects or hashes.
@@ -32,113 +31,11 @@ module JustChess
       end
     end
 
-    # @return [Array<Square>] The squares in the set.
-    attr_reader :squares
-
-    def_delegator :squares, :find
-    def_delegator :squares, :size
-    def_delegator :squares, :any?
-    def_delegator :squares, :all?
-    def_delegator :squares, :none?
-    def_delegator :squares, :include?
-    def_delegator :squares, :map
-    def_delegator :squares, :empty?
-
-    # Concat two SquareSets together
-    #
-    # @param [SquareSet] other
-    #   the second SquareSet
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Concat two SquareSets together
-    #   square_set + other
-    def +(other)
-      _squares = squares + other.squares
-
-      self.class.new(squares: _squares)
-    end
-
-    # Remove squares from one SquareSet from another
-    #
-    # @param [SquareSet] other
-    #   the second SquareSet
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Remove squares from one SquareSet
-    #   square_set - other
-    def -(other)
-      _squares = squares - other.squares
-
-      self.class.new(squares: _squares)
-    end
-
-    # Push a Square onto a SquareSet
-    #
-    # @param [Square] square
-    #   the square being pushed on
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Push a Square onto a SquareSet
-    #   square_set << square
-    def <<(square)
-      _squares = squares << square
-
-      self.class.new(squares: _squares)
-    end
-
-    # Find the intersection of Squares between sets
-    #
-    # @param [SquareSet] other
-    #   the second SquareSet
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Find the intersection of Squares
-    #   square_set & other
-    def &(other)
-      select { |square| other.include?(square) }
-    end
-
-    # Filter the squares with a block and behaves like Enumerable#select.
-    # It returns a SquareSet with the filtered squares.
-    #
-    # @return [SquareSet]
-    def select(&block)
-      _squares = squares.select(&block)
-
-      self.class.new(squares: _squares)
-    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)
-      find { |s| s.id == id }
-    end
-
-    # Find the square with the matching x and y co-ordinates
-    #
-    # @param [Fixnum] x
-    #   the x co-ordinate.
-    #
-    # @param [Fixnum] y
-    #   the y co-ordinate.
+    # serializes the squares as a hash
     #
-    # @return [Square]
-    # ==== Example:
-    #   # Find the square at 4,2
-    #   square_set.find_by_x_and_y(4, 2)
-    def find_by_x_and_y(x, y)
-      find { |s| s.x == x && s.y == y }
+    # @return [Hash]
+    def as_json
+      squares.map(&:as_json)
     end
 
     # Find the square with the matching piece identifier
@@ -167,74 +64,6 @@ module JustChess
       find { |s| s.piece && s.piece.is_a?(JustChess::King) && s.occupied_by_player?(player_number) }
     end
 
-    # Returns squares between a and b.
-    # Only squares that are in the same diagonal will return squares.
-    #
-    # @param [Square] a
-    #   a square.
-    #
-    # @param [Square] b
-    #   another square.
-    #
-    # @return [SquareSet]
-    #
-    # ==== Example:
-    #   # Get all squares between square_a and square_b
-    #   square_set.between(square_a, square_b)
-    def between(a, b)
-      vector = Vector.new(a, b)
-
-      if vector.diagonal? || vector.orthogonal?
-        point_counter = a.point
-        direction = vector.direction
-        _squares = []
-
-        while point_counter != b.point
-          point_counter = point_counter + direction
-          square = find_by_x_and_y(point_counter.x, point_counter.y)
-          if square && square.point != b.point
-            _squares.push(square)
-          end
-        end
-      else
-        _squares = []
-      end
-
-      self.class.new(squares: _squares)
-    end
-
-    # Find all squares within distance of square
-    #
-    # @param [Square] square
-    #   the originating square
-    #
-    # @param [Fixnum] distance
-    #   the specified distance from the square
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Get all squares within 2 squares of square_a
-    #   square_set.in_range(square_a, 2)
-    def in_range(square, distance)
-      select { |s| Vector.new(square, s).magnitude.abs <= distance }
-    end
-
-    # Find all squares at distance of square
-    #
-    # @param [Square] square
-    #   the originating square
-    #
-    # @param [Fixnum] distance
-    #   the specified distance from the square
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Get all squares at 2 squares from square_a
-    #   square_set.at_range(square_a, 2)
-    def at_range(square, distance)
-      select { |s| Vector.new(square, s).magnitude.abs == distance }
-    end
-
     # Find all squares in the y direction of square
     #
     # @param [Square] square
@@ -248,66 +77,7 @@ module JustChess
     #   # Get all squares up from square_a
     #   square_set.in_direction(square_a, -1)
     def in_direction(square, direction_y)
-      select { |s| Vector.new(square, s).direction.y == direction_y }
-    end
-
-    # Find all squares orthogonal from square
-    #
-    # @param [Square] square
-    #   the originating square
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Get all squares orthogonal from square_a
-    #   square_set.orthogonal(square_a)
-    def orthogonal(square)
-      select { |s| Vector.new(square, s).orthogonal? }
-    end
-
-    # Find all squares diagonal from square
-    #
-    # @param [Square] square
-    #   the originating square
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Get all squares diagonal from square_a
-    #   square_set.diagonal(square_a)
-    def diagonal(square)
-      select { |s| Vector.new(square, s).diagonal? }
-    end
-
-    # Find all squares orthogonal or diagonal from square
-    #
-    # @param [Square] square
-    #   the originating square
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Get all squares orthogonal or diagonal from square_a
-    #   square_set.orthogonal_or_diagonal(square_a)
-    def orthogonal_or_diagonal(square)
-      select { |s| Vector.new(square, s).orthogonal_or_diagonal? }
-    end
-
-    # Find all squares not orthogonal or diagonal from square
-    #
-    # @param [Square] square
-    #   the originating square
-    #
-    # @return [SquareSet]
-    # ==== Example:
-    #   # Get all squares not orthogonal or diagonal from square_a
-    #   square_set.not_orthogonal_or_diagonal(square_a)
-    def not_orthogonal_or_diagonal(square)
-      select { |s| Vector.new(square, s).not_orthogonal_or_diagonal? }
-    end
-
-    # Find all squares without pieces on them.
-    #
-    # @return [SquareSet]
-    def unoccupied
-      select { |s| s.unoccupied? }
+      select { |s| BoardGameGrid::Vector.new(square, s).direction.y == direction_y }
     end
 
     # Takes a player number and returns all squares occupied by the player
@@ -360,19 +130,6 @@ module JustChess
       select { |s| s.piece && !s.piece.is_a?(piece_type) }
     end
 
-    # Returns destination from the origin that have a clear path
-    #
-    # @param [Square] origin
-    #   the originating square.
-    #
-    # @param [SquareSet] square_set
-    #   the board position.
-    #
-    # @return [SquareSet]
-    def unblocked(origin, square_set)
-      select { |destination| square_set.between(origin, destination).all?(&:unoccupied?) }
-    end
-
     # Returns all squares with pieces that haven't moved
     #
     # @return [SquareSet]
@@ -396,12 +153,5 @@ module JustChess
 
       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/just_chess/version.rb

@@ -1,4 +1,4 @@
 module JustChess
   # :nodoc:
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_chess
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: board_game_grid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: Provides a representation of a chess game complete with rules enforcement
   and serialisation.
 email:
@@ -70,7 +84,6 @@ files:
 - bin/setup
 - just_chess.gemspec
 - lib/just_chess.rb
-- lib/just_chess/direction.rb
 - lib/just_chess/errors/causes_check_error.rb
 - lib/just_chess/errors/error.rb
 - lib/just_chess/errors/invalid_move_error.rb
@@ -88,10 +101,8 @@ files:
 - lib/just_chess/pieces/piece.rb
 - lib/just_chess/pieces/queen.rb
 - lib/just_chess/pieces/rook.rb
-- lib/just_chess/point.rb
 - lib/just_chess/square.rb
 - lib/just_chess/square_set.rb
-- lib/just_chess/vector.rb
 - lib/just_chess/version.rb
 homepage: https://github.com/mrlhumphreys/just_chess
 licenses:

data/lib/just_chess/direction.rb

@@ -1,35 +0,0 @@
-module JustChess
-
-  # = Direction
-  #
-  # The Direction that something is moving on a 2d plane
-  class Direction
-
-    # New objects can be instantiated with
-    #
-    # @param [Fixnum] dx
-    #   the dx magnitude.
-    #
-    # @param [Fixnum] dy
-    #   the dy magnitude.
-    #
-    # ==== Example:
-    #   # Instantiates a new Direction
-    #   JustChess::Direction.new({
-    #     dx: 1,
-    #     dy: 1
-    #   })
-    def initialize(dx, dy)
-      x = dx == 0 ? dx : dx/dx.abs
-      y = dy == 0 ? dy : dy/dy.abs
-
-      @x, @y = x, y
-    end
-
-    # @return [Fixnum] the x magnitude.
-    attr_reader :x
-
-    # @return [Fixnum] the y magnitude.
-    attr_reader :y
-  end
-end

data/lib/just_chess/point.rb

@@ -1,52 +0,0 @@
-module JustChess
-
-  # = Point
-  #
-  # A point with an x and y co-ordinates
-  class Point
-
-    # New objects can be instantiated with
-    #
-    # @param [Fixnum] x
-    #   the x co-ordinate.
-    #
-    # @param [Fixnum] y
-    #   the y co-ordinate.
-    #
-    # ==== Example:
-    #   # Instantiates a new Point
-    #   JustChess::Point.new({
-    #     x: 1,
-    #     y: 1
-    #   })
-    def initialize(x, y)
-      @x, @y = x, y
-    end
-
-    # @return [Fixnum] the x co-ordinate.
-    attr_reader :x
-
-    # @return [Fixnum] the y co-ordinate.
-    attr_reader :y
-
-    # Add a point to another point by adding their co-ordinates and returning a new point.
-    #
-    # @param [Point] other
-    #   the other point to add.
-    #
-    # @return [Point]
-    def +(other)
-      self.class.new(self.x + other.x, self.y + other.y)
-    end
-
-    # Check if popints are equal by seeing if their co-ordinates are equal.
-    #
-    # @param [Point] other
-    #   the other point to compare to.
-    #
-    # @return [TrueClass, FalseClass]
-    def ==(other)
-      self.x == other.x && self.y == other.y
-    end
-  end
-end

data/lib/just_chess/vector.rb

@@ -1,86 +0,0 @@
-require 'just_chess/direction'
-
-module JustChess
-
-  # = Vector
-  #
-  # An element of Vector space
-  class Vector
-
-    # New objects can be instantiated by passing in a two points with x and y co-ordinates
-    #
-    # @param [Point] origin
-    #   the start point.
-    #
-    # @param [Point] destination
-    #   the end point.
-    #
-    # ==== Example:
-    #   # Instantiates a new Vector
-    #   JustChess::Vector.new(
-    #     Struct.new(:x, :y).new(1, 1),
-    #     Struct.new(:x, :y).new(3, 3)
-    #   })
-    def initialize(origin, destination)
-      @origin, @destination = origin, destination
-    end
-
-    # @return [Object] the origin.
-    attr_reader :origin
-
-    # @return [Object] the destination.
-    attr_reader :destination
-
-    # The direction of the vector as a object
-    #
-    # @return [Direction]
-    def direction
-      Direction.new(dx, dy)
-    end
-
-    # The biggest difference between co-ordinates
-    #
-    # @return [Fixnum]
-    def magnitude
-      [dx.abs, dy.abs].max
-    end
-
-    # Is the vector orthogonal?
-    #
-    # @return [Boolean]
-    def orthogonal?
-      dx == 0 || dy == 0
-    end
-
-    # Is the vector diagonal?
-    #
-    # @return [Boolean]
-    def diagonal?
-      dx.abs == dy.abs
-    end
-
-    # Is the vector not orthogonal or diagonal?
-    #
-    # @return [Boolean]
-    def not_orthogonal_or_diagonal?
-      !(orthogonal? || diagonal?)
-    end
-
-    # Is the vector orthogonal or diagonal?
-    #
-    # @return [Boolean]
-    def orthogonal_or_diagonal?
-      orthogonal? || diagonal?
-    end
-
-    private
-
-    def dx
-      destination.x - origin.x
-    end
-
-    def dy
-      destination.y - origin.y
-    end
-  end
-end