board_game_grid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c3cc1dd64439cb8caf674f6a26fbaaaaa9dd987
+  data.tar.gz: 599590f9c7ec87f172f714710e6260025a54a382
+SHA512:
+  metadata.gz: 4d58ee472c595e6cdcc7267b17de7079c05a696e4b41c4fc5319b56b105527b2b356b4adb53c635e776008688761d9e5af078abebf01053525bcb67ce5938905
+  data.tar.gz: c6414b12c2b15ba873aa14198e0877f89de0a86cdacb6c0c581571698b88b575fdc1444a9c7d8fd0dbb76d72968debb275f7f2c874cfb8b6f7809c7e6c8f1157

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mark@mrlhumphreys.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in board_game_grid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mark Humphreys
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# BoardGameGrid
+
+Data structure and logic for a board game grid. Provides classes that help interpret and operation on the state of a grid of squares with pieces on them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'board_game_grid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install board_game_grid
+
+## Usage
+
+The primary class is the square set, which can be initialised from an array of hashes:
+
+```ruby
+  square_set = BoardGameGrid::SquareSet.new(squares: [
+    {id: 1, x: 2, y: 3, piece: nil},
+    {id: 2, x: 4, y: 6, piece: {player_number: 1} }
+  ])
+```
+
+or an array of squares:
+
+```ruby
+  square_set = BoardGameGrid::SquareSet.new(squares: [
+    BoardGameGrid::Square.new({id: 1, x: 2, y: 3, piece: nil}),
+    BoardGameGrid::Square.new({id: 2, x: 4, y: 6, piece: {player_number: 1}) }
+  ])
+```
+
+A square set has some enumerable functionality and common enumerable methods can be called on it (e.g. `map`, `all?`, `include?`, `size`, `+`, `-`)
+
+Most methods that would return an array of squares will return a square set object.
+
+Querying methods such as `orthogonal` and `diagonal`, which returns a square set containing squares orthogonal or diagonal to an origin square are available.
+
+Other querying methods include the `where` method which takes a hash of attribute/values to filter down the set.
+
+```ruby
+  square_set.where(x: 1, y: 2, piece: {player_number: 1})
+```
+
+More details are available in the documentation on rubydoc.info
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrlhumphreys/board_game_grid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BoardGameGrid project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mrlhumphreys/board_game_grid/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+task :default => :spec
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/board_game_grid/*_test.rb']
+end
+
+desc 'run tests'
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "board_game_grid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/board_game_grid.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "board_game_grid/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "board_game_grid"
+  spec.version       = BoardGameGrid::VERSION
+  spec.authors       = ["Mark Humphreys"]
+  spec.email         = ["mark@mrlhumphreys.com"]
+
+  spec.summary       = %q{Data structure and logic for a board game grid.}
+  spec.description   = %q{Classes that help interpret and operation on the state of a grid of squares with pieces on them.}
+  spec.homepage      = "https://github.com/mrlhumphreys/board_game_grid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/board_game_grid.rb

@@ -0,0 +1,8 @@
+require "board_game_grid/version"
+
+# :nodoc:
+module BoardGameGrid
+
+end
+
+require 'board_game_grid/square_set'

data/lib/board_game_grid/direction.rb

@@ -0,0 +1,42 @@
+module BoardGameGrid
+
+  # = 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
+    #   BoardGameGrid::Direction.new(1, 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
+
+    # 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/board_game_grid/point.rb

@@ -0,0 +1,52 @@
+module BoardGameGrid
+
+  # = 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
+    #   BoardGameGrid::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/board_game_grid/square.rb

@@ -0,0 +1,110 @@
+require 'board_game_grid/point'
+
+module BoardGameGrid
+
+  # = Square
+  #
+  # A Square on a board
+  class Square
+
+    # New objects can be instantiated by passing in a hash with
+    #
+    # @param [Fixnum] id
+    #   the unique identifier of the square.
+    #
+    # @param [Fixnum] x
+    #   the x co-ordinate of the square.
+    #
+    # @param [Fixnum] y
+    #   the y co-ordinate of the square.
+    #
+    # @option [Hash,NilClass] piece
+    #   The piece on the square, can be a hash or nil.
+    #
+    # ==== Example:
+    #   # Instantiates a new Square
+    #   JustCheckers::Square.new({
+    #     id: 1,
+    #     x: 1,
+    #     y: 0,
+    #     piece: { player_number: 1, king: false }
+    #   })
+    def initialize(id: , x: , y: , piece: nil)
+      @id = id
+      @x = x
+      @y = y
+      @piece = piece
+    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 [Hash,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 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 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]
+    def as_json
+      { id: id, x: x, y: y, piece: piece }
+    end
+  end
+end

data/lib/board_game_grid/square_set.rb

@@ -0,0 +1,311 @@
+require 'forwardable'
+require 'board_game_grid/square'
+require 'board_game_grid/vector'
+
+module BoardGameGrid
+
+  # = Square Set
+  #
+  # A collection of Squares with useful filtering functions
+  class SquareSet
+    extend Forwardable
+
+    # New objects can be instantiated by passing in a hash with squares.
+    # They can be square objects or hashes.
+    #
+    # @param [Array<Square,Hash>] squares
+    #   An array of squares, each with x and y co-ordinates and a piece.
+    #
+    # ==== Example:
+    #   # Instantiates a new Square Set
+    #   BoardGameGrid::SquareSet.new({
+    #     squares: [
+    #       { x: 1, y: 0, piece: { player_number: 1, king: false }}
+    #     ]
+    #   })
+    def initialize(squares: [])
+      @squares = if squares.all? { |element| element.instance_of?(Hash) }
+        squares.map { |args| BoardGameGrid::Square.new(args) }
+      elsif squares.all? { |element| element.instance_of?(BoardGameGrid::Square) }
+        squares
+      else
+        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, :find
+    def_delegator :squares, :first
+    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, :each
+    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
+
+    # 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 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 { |square| square.id == id }.first
+    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 { |square| square.x == x && square.y == y }.first
+    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(origin, distance)
+      select { |square| Vector.new(origin, square).magnitude <= 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(origin, distance)
+      select { |square| Vector.new(origin, square).magnitude == distance }
+    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(origin)
+      select { |square| Vector.new(origin, square).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(origin)
+      select { |square| Vector.new(origin, square).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(origin)
+      select { |square| Vector.new(origin, square).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(origin)
+      select { |square| Vector.new(origin, square).not_orthogonal_or_diagonal? }
+    end
+
+    # Find all squares without pieces on them.
+    #
+    # @return [SquareSet]
+    def unoccupied
+      select(&:unoccupied?)
+    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 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(origin, destination)
+      vector = Vector.new(origin, destination)
+
+      if vector.diagonal? || vector.orthogonal?
+        point_counter = origin.point
+        direction = vector.direction
+        _squares = []
+
+        while point_counter != destination.point
+          point_counter = point_counter + direction
+          square = find_by_x_and_y(point_counter.x, point_counter.y)
+          if square && square.point != destination.point
+            _squares.push(square)
+          end
+        end
+      else
+        _squares = []
+      end
+
+      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

@@ -0,0 +1,86 @@
+require 'board_game_grid/direction'
+
+module BoardGameGrid
+
+  # = 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
+    #   BoardGameGrid::Vector.new(
+    #     BoardGameGrid::Point.new(x: 1, y: 1),
+    #     BoardGameGrid::Point.new(x: 3, y: 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

data/lib/board_game_grid/version.rb

@@ -0,0 +1,3 @@
+module BoardGameGrid
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: board_game_grid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Humphreys
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Classes that help interpret and operation on the state of a grid of squares
+  with pieces on them.
+email:
+- mark@mrlhumphreys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- board_game_grid.gemspec
+- lib/board_game_grid.rb
+- lib/board_game_grid/direction.rb
+- lib/board_game_grid/point.rb
+- lib/board_game_grid/square.rb
+- lib/board_game_grid/square_set.rb
+- lib/board_game_grid/vector.rb
+- lib/board_game_grid/version.rb
+homepage: https://github.com/mrlhumphreys/board_game_grid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Data structure and logic for a board game grid.
+test_files: []