just_backgammon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d93c6c0bcf97a4d75323ad95881347cbe992215
+  data.tar.gz: 9e02aba6744f4057d1cf367abce89be027a747ee
+SHA512:
+  metadata.gz: c69f8fa340a095e98d8ae1bd7078fa3ea957d10879246186cb61d71663ede027a345f4b38437183258b0d9c0058db69b7b5d69b4b6f10b000d23e96d24d8e1e4
+  data.tar.gz: 03fbae1226c27cb7ce5760803b4352ffca72b41bce6df98c18a26e38c51e9e57780545e60078481c691509118332f9c40f8d40f53ed3ecac5529080e655acc46

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

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_backgammon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,68 @@
+# JustBackgammon
+
+A backgammon engine written in ruby. It provides a representation of a backgammon game complete with rules enforcement and serialisation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'just_backgammon'
+```
+
+Or install it yourself as:
+
+    $ gem install just_backgammon
+
+## Usage
+
+To start, a new game state can be instantiated with the default state:
+
+```ruby
+  game_state = JustBackgammon::GameState.default
+```
+
+Rolls can be made by calling the roll method, passing in the player number.
+
+```ruby
+  game_state.roll(1)
+```
+
+Moves can be made by passing in the player number, and an array of moves each consisting of the from point number and to point number. It will return true if the move is valid, otherwise it will return false.
+
+```ruby
+  game_state.move(1, [{from: 1, to: 2}]])
+```
+
+If something happens errors may be found in the errors attribute
+
+```ruby
+  game_state.errors
+```
+
+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. Then, run `rake test` to run the tests. 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/just_backgammon. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'just_backgammon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "just_backgammon"
+  spec.version       = JustBackgammon::VERSION
+  spec.authors       = ["Mark Humphreys"]
+  spec.email         = ["mark@mrlhumphreys.com"]
+
+  spec.summary       = %q{A backgammon engine written in ruby}
+  spec.description   = %q{Provides a representation of a backgammon game complete with rules enforcement and serialisation.}
+  spec.homepage      = "https://github.com/mrlhumphreys/just_backgammon"
+  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.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/just_backgammon/bar.rb

@@ -0,0 +1,107 @@
+require 'just_backgammon/common'
+require 'just_backgammon/piece'
+
+module JustBackgammon
+
+  # = Bar
+  #
+  # The bar is where hit pieces go. Contains an array of pieces.
+  class Bar
+    extend Common
+    extend Forwardable
+
+    # A new instance of Bar.
+    #
+    # @param [Array<Hash>] pieces
+    #   All the pieces on the bar, each piece has an owner.
+    #
+    # ==== Example:
+    #   # Instantiates a new Bar
+    #   JustBackgammon::Bar.new({
+    #     pieces: [{owner: 1}, {owner: 1}]
+    #   })
+    def initialize(pieces:)
+      @pieces = JustBackgammon::Piece.load(pieces)
+    end
+
+    # @return [Array<Piece>] all the pieces on the bar, each piece has an owner
+    attr_reader :pieces
+
+    def_delegator :pieces, :empty?
+
+    # The identifier of the bar, returns the string 'bar'.
+    #
+    # @return [String]
+    def number
+      'bar'
+    end
+
+    # ALl the pieces owned by the specified player.
+    #
+    # @param [Fixnum] player_number
+    #   the specified player number.
+    #
+    # @return [Array<Piece>]
+    def pieces_owned_by_player(player_number)
+      pieces.select { |p| p.owner == player_number }
+    end
+
+    # Number of pieces owned by the specified player.
+    #
+    # @param [Fixnum] player_number
+    #   the specified player number.
+    #
+    # @return [Fixnum]
+    def number_of_pieces_owned_by_player(player_number)
+      pieces_owned_by_player(player_number).size
+    end
+
+    # If the player has any pieces.
+    #
+    # @param [Fixnum] player_number
+    #   the specified player number.
+    #
+    # @return [Boolean]
+    def any_pieces_for_player?(player_number)
+      pieces_owned_by_player(player_number).any?
+    end
+
+    # If the player has no pieces.
+    #
+    # @param [Fixnum] player_number
+    #   the specified player number.
+    #
+    # @return [Boolean]
+    def empty_for_player?(player_number)
+      pieces_owned_by_player(player_number).none?
+    end
+
+    # Removes a piece owned by the specified player and return it.
+    #
+    # @param [Fixnum] player_number
+    #   the specified player number.
+    #
+    # @return [Piece,NilClass]
+    def pop_for_player(player_number)
+      p = pieces.find { |p| p.owner == player_number }
+      pieces.delete(p)
+    end
+
+    # Adds a piece to the bar.
+    #
+    # @param [Piece] piece
+    #   the piece to push onto the bar.
+    #
+    # @return [Array<Piece>]
+    def push(piece)
+      pieces.push(piece)
+    end
+
+    # A hashed serialized representation of the bar.
+    #
+    # @return [Hash]
+    def as_json
+      { pieces: pieces.map(&:as_json) }
+    end
+  end
+end

data/lib/just_backgammon/combined_move.rb

@@ -0,0 +1,55 @@
+module JustBackgammon
+
+  # = CombinedMove
+  #
+  # A combined move is a move where one piece moves multiple times.
+  class CombinedMove
+    extend Forwardable
+
+    # A new instance of CombinedMove.
+    #
+    # @param [Array<Move>] legs
+    #   The legs of the combined move.
+    #
+    # ==== Example:
+    #   # Instantiates a new CombinedMove
+    #   JustBackgammon::CombinedMove.new({
+    #     legs: [move_a, move_b]
+    #   })
+    def initialize(legs:)
+      @legs = legs
+    end
+
+    # @return [Array<Move>] the legs of the combined move.
+    attr_reader :legs
+
+    def_delegator :legs, :size
+
+    # Does the combined move start from a point?
+    #
+    # @return [Boolean]
+    def from_point?
+      first_leg.instance_of?(JustBackgammon::Point) if first_leg
+    end
+
+    # Does the combined move start with an empty point?
+    #
+    # @return [Boolean]
+    def empty?
+      first_leg.empty? if first_leg
+    end
+
+    # Does the combined move have pieces owned by the opponent?
+    #
+    # @return [Boolean]
+    def owned_by_opponent?(player_number)
+      first_leg.owned_by_opponent?(player_number) if first_leg
+    end
+
+    private
+
+    def first_leg # :nodoc:
+      legs.first
+    end
+  end
+end

data/lib/just_backgammon/common.rb

@@ -0,0 +1,38 @@
+module JustBackgammon
+
+  # = Common
+  #
+  # Mixin that allows the class to have a custom load method
+  # It allows initializing by arrays, hashes or objects with the same class.
+  module Common
+
+    # Method that initializing an object by arrays, hashes or objects with the same class.
+    # Returns the object or array of objects.
+    # Will raise error if elements of array are not all the same Class.
+    # Will raise error if argument is not Hash, Array or the same Class.
+    #
+    # @param [Array<Hash>, Hash, Object] argument
+    #   The initialization data.
+    #
+    # @return [Array<Object>, Object]
+    def load(argument)
+      case argument
+      when Hash
+        self.new(argument)
+      when Array
+        case
+        when argument.all? { |o| o.instance_of?(Hash) }
+          argument.map { |o| self.new(o) }
+        when argument.all? { |o| o.instance_of?(self) }
+          argument
+        else
+          raise ArgumentError, "elements of array must have the same class"
+        end
+      when self
+        argument
+      else
+        raise ArgumentError, "argument needs to be a Hash, Array or #{self}"
+      end
+    end
+  end
+end

data/lib/just_backgammon/dice_set.rb

@@ -0,0 +1,74 @@
+require 'just_backgammon/common'
+require 'just_backgammon/die'
+
+module JustBackgammon
+
+  # = DiceSet
+  #
+  # The collections of dice.
+  class DiceSet
+    extend Common
+    extend Forwardable
+
+    # A new instance of DiceSet.
+    #
+    # @param [Array<Hash>] dice
+    #   All the dice in the set, each with a number.
+    #
+    # ==== Example:
+    #   # Instantiates a new DiceSet
+    #   JustBackgammon::DiceSet.new({
+    #     dice: [{number: 1}, {number: 2}]
+    #   })
+    def initialize(dice:)
+      @dice = Die.load(dice)
+    end
+
+    # @return [Array<Dice>] allthe dice in the set, each with a number
+    attr_reader :dice
+
+    def_delegator :dice, :map
+    def_delegator :dice, :each
+
+    # finds a die that matches the specified number.
+    #
+    # @return [Die]
+    def find_by_number(number)
+      @dice.find { |d| d.number == number }
+    end
+
+    # returns an array of the numbers on the dice.
+    #
+    # @return [Array<Fixnum>]
+    def numbers
+      @dice.map(&:number)
+    end
+
+    # randomizes each die and duplicates if they are the same number.
+    #
+    # @return [Array<Die>]
+    def roll
+      @dice.each(&:roll)
+      if @dice.first == @dice.last
+        @dice.concat(@dice)
+      end
+    end
+
+    # sets all dice numbers to nil and reduces the number of dice to two.
+    #
+    # @return [Array<Die>]
+    def reset
+      @dice.each(&:reset)
+      if @dice.size > 2
+        @dice.slice!(-2..-1)
+      end
+    end
+
+    # A hashed serialized representation of the dice set.
+    #
+    # @return [Hash]
+    def as_json
+      dice.map(&:as_json)
+    end
+  end
+end

data/lib/just_backgammon/die.rb

@@ -0,0 +1,54 @@
+require 'just_backgammon/common'
+
+module JustBackgammon
+
+  # = Die
+  #
+  # The die is a cube that be rolled to result in a number from 1 to 6.
+  class Die
+    extend Common
+
+    # A new instance of Die.
+    #
+    # @param [Fixnum, NilClass] number
+    #   The number of the die. Returns nil if not yet rolled.
+    #
+    # ==== Example:
+    #   # Instantiates a new Die
+    #   JustBackgammon::Die.new(number: 1)
+    def initialize(number:)
+      @number = number
+    end
+
+    # @return [Fixnum] the number of the die. Returns nil if not yet rolled
+    attr_reader :number
+
+    # Rolls the die, the number will be between 1 and 6.
+    #
+    # @return [Fixnum]
+    def roll
+      @number = Random.new.rand(6) + 1
+    end
+
+    # Resets the die, the number will be nil.
+    #
+    # @return [NilClass]
+    def reset
+      @number = nil
+    end
+
+    # Equals operator compares the number to determine if the dice are equal.
+    #
+    # @return [Boolean]
+    def == (other)
+      self.number == other.number
+    end
+
+    # A hashed serialized representation of the die
+    #
+    # @return [Hash]
+    def as_json
+      { number: number }
+    end
+  end
+end

data/lib/just_backgammon/errors/bear_off_error.rb

@@ -0,0 +1,20 @@
+module JustBackgammon
+
+  # = BearOffError
+  #
+  # A bear off error with a message
+  class BearOffError
+
+    # A new instance of BearOffError.
+    #
+    # @option [String] message
+    #   the message.
+    #
+    # ==== Example:
+    #   # Instantiates a new BearOffError
+    #   JustBackgammon::BearOffError.new("Custom Message")
+    def initialize(message="Cannot bear off while pieces are not home.")
+      @message = message
+    end
+  end
+end

data/lib/just_backgammon/errors/blocked_error.rb

@@ -0,0 +1,20 @@
+module JustBackgammon
+
+  # = BlockedError
+  #
+  # A blocked error with a message
+  class BlockedError
+
+    # A new instance of BlockedError.
+    #
+    # @option [String] message
+    #   the message.
+    #
+    # ==== Example:
+    #   # Instantiates a new BlockedError
+    #   JustBackgammon::BlockedError.new("Custom Message")
+    def initialize(message="Point blocked by opponent.")
+      @message = message
+    end
+  end
+end

data/lib/just_backgammon/errors/dice_mismatch_error.rb

@@ -0,0 +1,20 @@
+module JustBackgammon
+
+  # = DiceMismatchError
+  #
+  # A dice mismatch error with a message
+  class DiceMismatchError
+
+    # A new instance of DiceMismatchError.
+    #
+    # @option [String] message
+    #   the message.
+    #
+    # ==== Example:
+    #   # Instantiates a new DiceMismatchError
+    #   JustBackgammon::DiceMismatchError.new("Custom Message")
+    def initialize(message="Move does not match dice rolls.")
+      @message = message
+    end
+  end
+end

data/lib/just_backgammon/errors/empty_bar_error.rb

@@ -0,0 +1,20 @@
+module JustBackgammon
+
+  # = EmptyBarError
+  #
+  # An empty bar error with a message
+  class EmptyBarError
+
+    # A new instance of EmptyBarError.
+    #
+    # @option [String] message
+    #   the message.
+    #
+    # ==== Example:
+    #   # Instantiates a new EmptyBarError
+    #   JustBackgammon::EmptyBarError.new("Custom Message")
+    def initialize(message="No pieces owned by player on bar.")
+      @message = message
+    end
+  end
+end

data/lib/just_backgammon/errors/empty_point_error.rb

@@ -0,0 +1,20 @@
+module JustBackgammon
+
+  # = EmptyPointError
+  #
+  # An empty point error with a message
+  class EmptyPointError
+
+    # A new instance of EmptyPointError.
+    #
+    # @option [String] message
+    #   the message.
+    #
+    # ==== Example:
+    #   # Instantiates a new EmptyPointError
+    #   JustBackgammon::EmptyPointError.new("Custom Message")
+    def initialize(message="Point is empty.")
+      @message = message
+    end
+  end
+end