just_checkers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b222d98791ecb7fbeaccbbc243a5700804beccd
+  data.tar.gz: 52f55d6e55e7d1217a1b761b89c7bd692c8d97ad
+SHA512:
+  metadata.gz: 7fcf4df66998b315fdb28bdf6c84b9a379244c73da60edb87f91f05f9595c2458077aabff90d1766d13dbbde28a7bb28f18151dea8aec3ad1a5db5108638b0a9
+  data.tar.gz: 331229a35d08ee92e1dbd454efab6f18a5a637fd88dd697071e3b4467f0d9f3e9f3741928c04509bac5e1d38351e3613d42debbf992516a320d346cc1e30507d

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer 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. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in just_checkers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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,58 @@
+# JustCheckers
+
+A checkers engine written in ruby. It provides a representation of a checkers game complete with rules enforcement and serialisation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'just_checkers'
+```
+
+Or install it yourself as:
+
+    $ gem install just_checkers
+
+## Usage
+
+To start, a new game state can be instantiated with the default state:
+
+```ruby
+  game_state = JustCheckers::GameState.default
+```
+
+Moves can be made by passing in the player number, from co-ordinates and an array of to co-ordinates. It will return true if the move is valid, otherwise it will return false.
+
+
+```ruby
+  game_state.move!(1, {x: 1, y: 2}, [{x: 2, y: 3}])
+```
+
+The Winner can be found by calling winner on the object.
+
+```ruby
+  game_state.winner
+```
+
+Also, the game can be serialized into a hash.
+
+```ruby
+  game_state.as_json
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrlhumphreys/just_checkers. 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).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "just_checkers"
+
+# 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

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/just_checkers.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'just_checkers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "just_checkers"
+  spec.version       = JustCheckers::VERSION
+  spec.authors       = ["Mark Humphreys"]
+  spec.email         = ["mark@mrlhumphreys.com"]
+
+  spec.summary       = %q{A checkers engine written in ruby}
+  spec.description   = %q{Provides a representation of a checkers game complete with rules enforcement and serialisation.}
+  spec.homepage      = "https://github.com/mrlhumphreys/just_checkers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', '~> 5.8'
+end

data/lib/just_checkers.rb

@@ -0,0 +1,7 @@
+require "just_checkers/version"
+
+module JustCheckers
+
+end
+
+require 'just_checkers/game_state'

data/lib/just_checkers/direction.rb

@@ -0,0 +1,30 @@
+module JustCheckers
+
+  # = Direction
+  #
+  # The Direction that something is moving on a 2d plane
+  class Direction
+
+    # New objects can be instantiated with
+    #
+    # * +x+ - x magnitude
+    # * +y+ - y magnitude
+    #
+    # ==== Example:
+    #   # Instantiates a new Direction
+    #   JustCheckers::Direction.new({
+    #     x: 1,
+    #     y: 1
+    #   })
+    def initialize(x, y)
+      @x, @y = x, y
+    end
+
+    attr_reader :x, :y
+
+    # check if directions are equal by seeing if their magnitudes are equal.
+    def ==(other)
+      self.x == other.x && self.y == other.y
+    end
+  end
+end

data/lib/just_checkers/game_state.rb

@@ -0,0 +1,181 @@
+require 'just_checkers/square_set'
+
+module JustCheckers
+
+  # = Game State
+  #
+  # Represents a game of Checkers in progress.
+  class GameState
+
+    # New objects can be instantiated by passing in a hash with
+    #
+    # * +current_player_number+ - Who's turn it is, 1 or 2
+    # * +squares+ - An array of squares, each with x and y co-ordinates and a piece.
+    #
+    # ==== Example:
+    #   # Instantiates a new Game of Checkers
+    #   JustCheckers::GameState.new({
+    #     current_player_number: 1,
+    #     squares: [
+    #       { x: 1, y: 0, piece: { player_number: 1, direction: 1, king: false }}
+    #     ]
+    #   })
+    def initialize(args = {})
+      @current_player_number = args[:current_player_number]
+      @squares = SquareSet.new(squares: args[:squares])
+    end
+
+    # Instantiates a new GameState object in the starting position
+    def self.default
+      new({
+        current_player_number: 1,
+        squares: [
+          { x: 1, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 3, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 5, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 7, y: 0, piece: { player_number: 1, direction: 1, king: false }},
+
+          { x: 0, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 2, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 4, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 6, y: 1, piece: { player_number: 1, direction: 1, king: false }},
+
+          { x: 1, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 3, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 5, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+          { x: 7, y: 2, piece: { player_number: 1, direction: 1, king: false }},
+
+          { x: 0, y: 3, piece: nil },
+          { x: 2, y: 3, piece: nil },
+          { x: 4, y: 3, piece: nil },
+          { x: 6, y: 3, piece: nil },
+
+          { x: 1, y: 4, piece: nil },
+          { x: 3, y: 4, piece: nil },
+          { x: 5, y: 4, piece: nil },
+          { x: 7, y: 4, piece: nil },
+
+          { x: 0, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 2, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 4, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 6, y: 5, piece: { player_number: 2, direction: -1, king: false }},
+
+          { x: 1, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 3, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 5, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 7, y: 6, piece: { player_number: 2, direction: -1, king: false }},
+
+          { x: 0, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 2, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 4, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+          { x: 6, y: 7, piece: { player_number: 2, direction: -1, king: false }},
+        ]
+      })
+    end
+
+    attr_reader :current_player_number, :squares
+
+    # Returns a hash serialized representation of the game state
+    def as_json
+      { current_player_number: current_player_number, squares: squares.as_json, winner: winner }
+    end
+
+    # Returns the json serialized representation of the game state.
+    def to_json
+      as_json.to_json
+    end
+
+    # Returns the player number of the winner. It returns nil if there is no winner
+    def winner
+      if squares.occupied_by(1).none? { |s| s.possible_jumps(s.piece, squares).any? || s.possible_moves(s.piece, squares).any? }
+        2
+      elsif squares.occupied_by(2).none? { |s| s.possible_jumps(s.piece, squares).any? || s.possible_moves(s.piece, squares).any? }
+        1
+      else
+        nil
+      end
+    end
+
+    # Moves a piece owned by the player, from one square, to another
+    #
+    # * +player_number+ - the player number, 1 or 2
+    # * +from+ - A hash containing x and y co-ordinates.
+    # * +to+ - An array of hashes containing x and y co-ordinates.
+    #
+    # It moves the piece and returns true if the move is valid and it's the player's turn.
+    # It returns false otherwise.
+    #
+    # ==== Example:
+    #   # Moves a piece from a square to perform a double jump
+    #   game_state.move!(1, {x: 0, y: 1}, [{x: 1, y: 2}, {x: 3, y: 4}])
+    def move!(player_number, from, to)
+      from_square = squares.find_by_x_and_y(from[:x].to_i, from[:y].to_i)
+      to_squares = to.map { |p| squares.find_by_x_and_y(p[:x].to_i, p[:y].to_i) }
+
+      if player_number != current_player_number
+        false
+      else
+        if move_valid?(from_square, to_squares)
+          perform_move!(from_square, to_squares)
+          promote!(to_squares.last) if promotable?(to_squares.last)
+          turn!
+          true
+        else
+          false
+        end
+      end
+    end
+
+    private
+
+    def move_valid?(from, to) # :nodoc:
+      legs = to.unshift(from)
+      if from && from.piece
+        legs.each_cons(2).map do |a, b|
+          if squares.occupied_by(from.piece.player_number).any? { |s| s.possible_jumps(s.piece, squares).any? }
+            a.possible_jumps(from.piece, squares).include?(b)
+          else
+            a.possible_moves(from.piece, squares).include?(b)
+          end
+        end.all?
+      else
+        false
+      end
+    end
+
+    def promote!(square) # :nodoc:
+      square.piece.promote!
+    end
+
+    def perform_move!(from, to) # :nodoc:
+      legs = to.unshift(from)
+      legs.each_cons(2) do |a, b|
+        between_square = squares.between(a, b).first
+        between_square.piece = nil if between_square
+      end
+
+      to.last.piece = from.piece
+      from.piece = nil
+    end
+
+    def turn! # :nodoc:
+      @current_player_number = other_player_number
+    end
+
+    def other_player_number # :nodoc:
+      current_player_number == 1 ? 2 : 1
+    end
+
+    def promotable?(square) # :nodoc:
+      case square.piece.direction
+      when 1
+        square.y == 7
+      when -1
+        square.y == 0
+      else
+        false
+      end
+    end
+
+  end
+end

data/lib/just_checkers/piece.rb

@@ -0,0 +1,39 @@
+module JustCheckers
+  # = Game State
+  #
+  # A piece that can move on a checkers board
+  class Piece
+
+    # New objects can be instantiated by passing in a hash with
+    #
+    # * +player_number+ - The player who owns the piece, 1 or 2
+    # * +direction+ - The direction forward on the board, 1 for moving down, -1 for moving up.
+    # * +king+ - Set to true if the piece has been crowned
+    #
+    # ==== Example:
+    #   # Instantiates a new Piece
+    #   JustCheckers::Piece.new({
+    #     player_number: 1,
+    #     direction: 1,
+    #     king: false
+    #   })
+    def initialize(args = {})
+      @player_number = args[:player_number]
+      @direction = args[:direction]
+      @king = args[:king]
+    end
+
+    attr_reader :player_number, :direction, :king
+    alias_method :king?, :king
+
+    # promotes the piece by setting the +king+ attribute to true.
+    def promote!
+      @king = true
+    end
+
+    # returns a serialized piece as a hash
+    def as_json
+      { player_number: player_number, direction: direction, king: king }
+    end
+  end
+end

data/lib/just_checkers/point.rb

@@ -0,0 +1,35 @@
+module JustCheckers
+
+  # = Point
+  #
+  # A point with an x and y co-ordinates
+  class Point
+
+    # New objects can be instantiated with
+    #
+    # * +x+ - x co-ordinate
+    # * +y+ - y co-ordinate
+    #
+    # ==== Example:
+    #   # Instantiates a new Point
+    #   JustCheckers::Point.new({
+    #     x: 1,
+    #     y: 1
+    #   })
+    def initialize(x, y)
+      @x, @y = x, y
+    end
+
+    attr_reader :x, :y
+
+    # add a point to another point by adding their co-ordinates and returning a new point.
+    def +(other)
+      self.class.new(self.x + other.x, self.y + other.y)
+    end
+
+    # check if points are equal by seeing if their co-ordinates are equal.
+    def ==(other)
+      self.x == other.x && self.y == other.y
+    end
+  end
+end

data/lib/just_checkers/square.rb

@@ -0,0 +1,85 @@
+require 'just_checkers/piece'
+require 'just_checkers/point'
+
+module JustCheckers
+
+  # = Square
+  #
+  # A Square on a board of checkers
+  class Square
+
+    # New objects can be instantiated by passing in a hash with
+    #
+    # * +x+ - The x co-ordinate of the square.
+    # * +y+ - The y co-ordinate of the square.
+    # * +piece+ - The piece on the square, can be a piece object or hash or nil.
+    #
+    # ==== Example:
+    #   # Instantiates a new Square
+    #   JustCheckers::Square.new({
+    #     x: 1,
+    #     y: 0,
+    #     piece: { player_number: 1, direction: 1, king: false }
+    #   })
+    def initialize(args = {})
+      @x = args[:x]
+      @y = args[:y]
+      if args[:piece].is_a?(Hash)
+        @piece = Piece.new(args[:piece])
+      else
+        @piece = args[:piece]
+      end
+    end
+
+    attr_reader :x, :y
+    attr_accessor :piece
+
+    # checks if the square matches the attributes passed.
+    #
+    # * +attribute+ - a symbol for the squares attribute
+    # * +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
+
+    # returns true if the square has no piece on it.
+    def unoccupied?
+      piece.nil?
+    end
+
+    # returns a point object with the square's co-ordinates.
+    def point
+      Point.new(x, y)
+    end
+
+    # returns all squares that a piece on this square could jump to, given the board.
+    def possible_jumps(piece, squares)
+      squares.two_squares_away_from(self).in_direction_of(piece, self).unoccupied.select do |s|
+        squares.between(self, s).occupied_by_opponent_of(piece.player_number).any?
+      end
+    end
+
+    # returns all squares that a piece on this square could jump to, given the board.
+    def possible_moves(piece, squares)
+      squares.one_square_away_from(self).in_direction_of(piece, self).unoccupied
+    end
+
+    # returns a serialized version of the square as a hash
+    def as_json
+      { x: x, y: y, piece: piece && piece.as_json }
+    end
+  end
+end

data/lib/just_checkers/square_set.rb

@@ -0,0 +1,145 @@
+require 'forwardable'
+require 'just_checkers/square'
+require 'just_checkers/vector'
+
+module JustCheckers
+
+  # = 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.
+    #
+    # * +squares+ - An array of squares, each with x and y co-ordinates and a piece.
+    #
+    # ==== Example:
+    #   # Instantiates a new Square Set
+    #   JustCheckers::SquareSet.new({
+    #     squares: [
+    #       { x: 1, y: 0, piece: { player_number: 1, direction: 1, king: false }}
+    #     ]
+    #   })
+    def initialize(args = {})
+      if args[:squares].first.class == Square
+        @squares = args[:squares]
+      else
+        @squares = args[:squares].map { |s| Square.new(s) }
+      end
+    end
+
+    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.
+    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.
+    def select(&block)
+      self.class.new(squares: squares.select(&block))
+    end
+
+    # Filter the squares with a hash of attribute and matching values.
+    #
+    # ==== Example:
+    #   # Find all squares where piece is nil
+    #   square_set.where(piece: nil)
+    def where(hash)
+      res = hash.inject(squares) do |memo, (k, v)|
+        memo.select { |s| s.attribute_match?(k, v) }
+      end
+      self.class.new(squares: res)
+    end
+
+    # Find the square with the matching x and y co-ordinates
+    #
+    # ==== 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
+
+    # Return all squares that are one square away from the passed square.
+    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.
+    def two_squares_away_from(square)
+      select { |s| Vector.new(square, s).magnitude == 2 }
+    end
+
+    # Returns 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.
+    #
+    # ==== Example:
+    #   # Get all squares in the direction of the piece.
+    #   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
+      end
+    end
+
+    # Returns all squares without pieces on them.
+    def unoccupied
+      select { |s| s.piece.nil? }
+    end
+
+    # Returns squares between a and b.
+    # Only squares that are in the same diagonal will return squares.
+    #
+    # ==== 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
+    def occupied_by_opponent_of(player_number)
+      select { |s| s.piece && s.piece.player_number != player_number }
+    end
+
+    # takes a player number and returns all squares occupied by the player
+    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
+    def as_json
+      squares.map(&:as_json)
+    end
+  end
+end

data/lib/just_checkers/vector.rb

@@ -0,0 +1,78 @@
+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
+    #
+    # * +a+ - A point with an x and y co-ordinates.
+    # * +b+ - A point with an x and y co-ordinates.
+    #
+    # ==== 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
+
+    attr_reader :a, :b
+
+    # returns how big the vector is if it's diagonal, otherwise, nil.
+    def magnitude
+      if diagonal
+        dx.abs
+      else
+        nil
+      end
+    end
+
+    # returns a direction of the vector as a object
+    def direction
+      Direction.new(direction_x, direction_y)
+    end
+
+    # returns the x component of the direction, 1 if moving down, -1 if moving up, 0 otherwise
+    def direction_x
+      if dx > 0
+        1
+      elsif dx == 0
+        0
+      else
+        -1
+      end
+    end
+
+    # returns the y component of the direction, 1 if moving right, -1 if moving left, 0 otherwise
+    def direction_y
+      if dy > 0
+        1
+      elsif dy == 0
+        0
+      else
+        -1
+      end
+    end
+
+    # returns true if the vector is diagonal.
+    def diagonal
+      dx.abs == dy.abs
+    end
+
+    private
+
+    def dx
+      b.x - a.x
+    end
+
+    def dy
+      b.y - a.y
+    end
+  end
+end

data/lib/just_checkers/version.rb

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: just_checkers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Humphreys
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: Provides a representation of a checkers game complete with rules enforcement
+  and serialisation.
+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
+- just_checkers.gemspec
+- lib/just_checkers.rb
+- lib/just_checkers/direction.rb
+- lib/just_checkers/game_state.rb
+- lib/just_checkers/piece.rb
+- 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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A checkers engine written in ruby
+test_files: []