just_checkers 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a652941a37584d1c3448d3a904eaf7568a96c7d
-  data.tar.gz: 25df3f4619cefcffc64c38c6e2ccf0931d5fb4f3
+  metadata.gz: fabb7610908ffb7ed90de11e7a43d592b94f3855
+  data.tar.gz: fa87a6420ff5b3274df8d33e9de3beb7c47ed41c
 SHA512:
-  metadata.gz: 2fc08be188d77cd15ae9e2a990e25e232cebda974ad3a5cd6ec57387878e0ec03c315e26cb18ab46e1b9923140e3ca7822c6aa6f488efb2268ac9f617aabeefd
-  data.tar.gz: cd2b521698896e634c979d39361c81fc68dfa7f160677587945a4aa834afa2bb0d9ae6937f223d41f8be95d59aeeadb50d01aeafdd43fe5b81f4167e05909fbd
+  metadata.gz: 45de02e0328b9ec03bfa44e5235326abfa5bc300e056989ea1c39f1e5f4e909a6dcbf90dc174afc946b6d953055af9303b9e8aa862df82bcf0bb3b8b0d1e3f3a
+  data.tar.gz: e4ea11adbd062eafea5e496f639f30b7743726358be839258170b603f4d6207b9b0675cc4c9a903b1b4a0c974fe4f1cf3e73ae96fe8966aaca8d18ca285c38ce

data/just_checkers.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.1'
+  spec.required_ruby_version = '>= 2.2'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'board_game_grid', '~> 0.1'
 end

data/lib/just_checkers/square.rb

@@ -1,12 +1,13 @@
 require 'just_checkers/piece'
 require 'just_checkers/point'
+require 'board_game_grid'
 
 module JustCheckers
 
   # = Square
   #
   # A Square on a board of checkers
-  class Square
+  class Square < BoardGameGrid::Square
 
     # New objects can be instantiated by passing in a hash with
     #
@@ -41,54 +42,11 @@ 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
-
-    # @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
-
-    # checks if the square matches the attributes passed.
-    #
-    # @param [Symbol] attribute
-    #   the square's attribute.
-    #
-    # @param [Object,Hash] value
-    #   a value to match on. Can be a hash of attribute/value pairs for deep matching
-    #
-    # ==== Example:
-    #   # Check if square has a piece owned by player 1
-    #   square.attribute_match?(:piece, player_number: 1)
-    def attribute_match?(attribute, value)
-      hash_obj_matcher = lambda do |obj, k, v|
-        value = obj.send(k)
-        if !value.nil? && v.is_a?(Hash)
-          v.all? { |k2,v2| hash_obj_matcher.call(value, k2, v2) }
-        else
-          value == v
-        end
-      end
-
-      hash_obj_matcher.call(self, attribute, value)
-    end
-
-    # Is the square unoccupied by a piece?
-    #
-    # @return [Boolean]
-    def unoccupied?
-      piece.nil?
-    end
-
-    # A point object with the square's co-ordinates.
+    # A serialized version of the square as a hash
     #
-    # @return [Point]
-    def point
-      Point.new(x, y)
+    # @return [Hash]
+    def as_json
+      { id: id, x: x, y: y, piece: piece && piece.as_json }
     end
 
     # All squares that a piece on this square could jump to, given the board.
@@ -101,7 +59,7 @@ module JustCheckers
     #
     # @return [SquareSet]
     def possible_jumps(piece, squares)
-      squares.two_squares_away_from(self).in_direction_of(piece, self).unoccupied.select do |s|
+      squares.at_range(self, 2).in_direction_of(piece, self).unoccupied.select do |s|
         squares.between(self, s).occupied_by_opponent_of(piece.player_number).any?
       end
     end
@@ -116,7 +74,7 @@ module JustCheckers
     #
     # @return [SquareSet]
     def possible_moves(piece, squares)
-      squares.one_square_away_from(self).in_direction_of(piece, self).unoccupied
+      squares.at_range(self, 1).in_direction_of(piece, self).unoccupied
     end
 
     # Checks if the piece on the square can promote.
@@ -139,12 +97,5 @@ module JustCheckers
     def promote
       piece && piece.promote
     end
-
-    # 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
   end
 end

data/lib/just_checkers/square_set.rb

@@ -1,14 +1,12 @@
-require 'forwardable'
+require 'board_game_grid'
 require 'just_checkers/square'
-require 'just_checkers/vector'
 
 module JustCheckers
 
   # = 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.
@@ -24,104 +22,15 @@ module JustCheckers
     #     ]
     #   })
     def initialize(squares: [])
-      @squares = if squares.first.class == Square
+      @squares = if squares.all? { |element| element.instance_of?(Hash) }
+        squares.map { |args| JustCheckers::Square.new(args) }
+      elsif squares.all? { |element| element.instance_of?(JustCheckers::Square) }
         squares
       else
-        squares.map { |s| Square.new(s) }
+        raise ArgumentError, "all squares must have the same class"
       end
     end
 
-    # @return [Array<Square>] The squares in the set.
-    attr_reader :squares
-
-    def_delegator :squares, :first
-    def_delegator :squares, :size
-    def_delegator :squares, :include?
-    def_delegator :squares, :any?
-    def_delegator :squares, :none?
-    def_delegator :squares, :empty?
-
-    # Iterate over the squares with a block and behaves like Enumerable#each.
-    #
-    # @return [Enumerable]
-    def each(&block)
-      squares.each(&block)
-    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)
-      self.class.new(squares: squares.select(&block))
-    end
-
-    # Filter the squares with a hash of attribute and matching values.
-    #
-    # @param [Hash] hash
-    #   attributes to query for.
-    #
-    # @return [SquareSet]
-    #
-    # ==== Example:
-    #   # Find all squares where piece is nil
-    #   square_set.where(piece: nil)
-    def where(hash)
-      res = hash.inject(squares) do |memo, (attribute, value)|
-        memo.select { |square| square.attribute_match?(attribute, value) }
-      end
-      self.class.new(squares: res)
-    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.
-    #
-    # @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)
-      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
-    #   the square in question.
-    #
-    # @return [SquareSet]
-    def one_square_away_from(square)
-      select { |s| Vector.new(square, s).magnitude == 1 }
-    end
-
-    # Return all squares that are two squares away from the passed square.
-    #
-    # @param [Square] square
-    #   the square in question.
-    #
-    # @return [SquareSet]
-    def two_squares_away_from(square)
-      select { |s| Vector.new(square, s).magnitude == 2 }
-    end
-
     # Find squares in the direction of the piece from the square
     # If the piece is normal, it returns squares in front of it.
     # If the piece is king, it returns all squares.
@@ -139,51 +48,10 @@ module JustCheckers
     #   square_set.in_direction_of(piece, square)
     def in_direction_of(piece, square)
       select do |s|
-        piece.king? || Vector.new(square, s).direction_y == piece.direction
+        piece.king? || BoardGameGrid::Vector.new(square, s).direction.y == piece.direction
       end
     end
 
-    # Find all squares without pieces on them.
-    #
-    # @return [SquareSet]
-    def unoccupied
-      select(&:unoccupied?)
-    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
-        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
-
     # Takes a player number and returns all squares occupied by the opponent of the player
     #
     # @param [Fixnum] player_number
@@ -203,14 +71,5 @@ module JustCheckers
     def occupied_by(player_number)
       select { |s| s.piece && s.piece.player_number == player_number }
     end
-
-    attr_reader :squares
-
-    # serializes the squares as a hash
-    #
-    # @return [Hash]
-    def as_json
-      squares.map(&:as_json)
-    end
   end
 end

data/lib/just_checkers/version.rb

@@ -1,4 +1,4 @@
 module JustCheckers
   # :nodoc:
-  VERSION = "0.3.3"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_checkers
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2018-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: board_game_grid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: Provides a representation of a checkers game complete with rules enforcement
   and serialisation.
 email:
@@ -70,7 +84,6 @@ files:
 - bin/setup
 - just_checkers.gemspec
 - lib/just_checkers.rb
-- lib/just_checkers/direction.rb
 - lib/just_checkers/errors/empty_square_error.rb
 - lib/just_checkers/errors/error.rb
 - lib/just_checkers/errors/invalid_move_error.rb
@@ -81,7 +94,6 @@ files:
 - lib/just_checkers/point.rb
 - lib/just_checkers/square.rb
 - lib/just_checkers/square_set.rb
-- lib/just_checkers/vector.rb
 - lib/just_checkers/version.rb
 homepage: https://github.com/mrlhumphreys/just_checkers
 licenses:
@@ -95,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/just_checkers/direction.rb

@@ -1,42 +0,0 @@
-module JustCheckers
-
-  # = Direction
-  #
-  # The Direction that something is moving on a 2d plane
-  class Direction
-
-    # New objects can be instantiated with
-    #
-    # @param [Fixnum] x
-    #   the x magnitude.
-    #
-    # @param [Fixnum] y
-    #   the y magnitude.
-    #
-    # ==== Example:
-    #   # Instantiates a new Direction
-    #   JustCheckers::Direction.new({
-    #     x: 1,
-    #     y: 1
-    #   })
-    def initialize(x, y)
-      @x, @y = x, y
-    end
-
-    # @return [Fixnum] the x magnitude.
-    attr_reader :x
-    
-    # @return [Fixnum] the y magnitude.
-    attr_reader :y
-
-    # Check if directions are equal by seeing if their magnitudes are equal.
-    #
-    # @param [Direction] other
-    #   the other direction to compare to.
-    #
-    # @return [Boolean]
-    def ==(other)
-      self.x == other.x && self.y == other.y
-    end
-  end
-end

data/lib/just_checkers/vector.rb

@@ -1,95 +0,0 @@
-require 'just_checkers/direction'
-
-module JustCheckers
-
-  # = 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] a
-    #   the start point.
-    #
-    # @param [Point] b
-    #   the end point.
-    #
-    # ==== Example:
-    #   # Instantiates a new Vector
-    #   JustCheckers::Vector.new({
-    #     a: JustCheckers::Point.new(x: 1, y: 1),
-    #     b: JustCheckers::Point.new(x: 3, y: 3)
-    #   })
-    def initialize(a, b)
-      @a, @b = a, b
-    end
-
-    # @return [Point] the start point.
-    attr_reader :a
-    
-    # @return [Point] the end point.
-    attr_reader :b
-
-    # How big the vector is if it's diagonal, otherwise, nil.
-    #
-    # @return [Fixnum,NilClass]
-    def magnitude
-      if diagonal
-        dx.abs
-      else
-        nil
-      end
-    end
-
-    # The direction of the vector as a object
-    #
-    # @return [Direction]
-    def direction
-      Direction.new(direction_x, direction_y)
-    end
-
-    # The x component of the direction, 1 if moving down, -1 if moving up, 0 otherwise
-    #
-    # @return [Fixnum]
-    def direction_x
-      if dx > 0
-        1
-      elsif dx == 0
-        0
-      else
-        -1
-      end
-    end
-
-    # The y component of the direction, 1 if moving right, -1 if moving left, 0 otherwise
-    #
-    # @return [Fixnum]
-    def direction_y
-      if dy > 0
-        1
-      elsif dy == 0
-        0
-      else
-        -1
-      end
-    end
-
-    # Is the vector diagonal?
-    #
-    # @return [Boolean]
-    def diagonal
-      dx.abs == dy.abs
-    end
-
-    private
-
-    def dx
-      b.x - a.x
-    end
-
-    def dy
-      b.y - a.y
-    end
-  end
-end