just_chess 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6272f4c1c746d2ef9c3dd9ca9569c4564f714a3b
+  data.tar.gz: 96f5372a8b9220f720abac49e2a7d8c586a81556
+SHA512:
+  metadata.gz: 71e99a15d466599fd0e286e9c51afe765c04b50191e5588c616b925e34520bd5e78fb230e2fdf9d09df9ff664644f196711b8326450c2aebd14a52f989d2cdec
+  data.tar.gz: a0cbf2a6cd01e4540d31020570fa0f8ac306d911b97fe113e022184022eb0148cc04a432dee72cacf08e863ff81bb0742ce2b033fdacebeccecb01e44a8a7dd4

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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in just_chess.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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,74 @@
+# JustChess
+
+A chess engine written in ruby. It provides a representation of a chess game complete with rules enforcement and serialisation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'just_chess'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install just_chess
+
+## Usage
+
+To start, a new game state can be instantiated with the default state:
+
+```ruby
+  game_state = JustChess::GameState.default
+```
+
+Moves can be made by passing in the player number and the from and to rank and file co-ordinates. It will return true if the move is valid, otherwise it will return false.
+
+
+```ruby
+  game_state.move(1, 'e4', 'e5')
+```
+
+The last change with all its details are found in the `last_change` attribute
+
+```ruby
+  game_state.last_change
+```
+
+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. 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_chess. 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 JustChess project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mrlhumphreys/just_chess/blob/master/CODE_OF_CONDUCT.md).

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_chess"
+
+# 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/just_chess.gemspec

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

data/lib/just_chess.rb

@@ -0,0 +1,8 @@
+require "just_chess/version"
+
+# :nodoc:
+module JustChess
+
+end
+
+require 'just_chess/game_state'

data/lib/just_chess/direction.rb

@@ -0,0 +1,35 @@
+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/errors/causes_check_error.rb

@@ -0,0 +1,22 @@
+require 'just_chess/errors/error'
+
+module JustChess
+
+  # = CausesCheckError
+  #
+  # A causes check error with a message
+  class CausesCheckError < Error
+
+    # New causes check errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new CausesCheckError
+    #   JustChess::CausesCheckError.new("Custom Message")
+    def initialize(message="That move would put the king in check.")
+      super
+    end
+  end
+end

data/lib/just_chess/errors/error.rb

@@ -0,0 +1,20 @@
+module JustChess
+
+  # = Error
+  #
+  # An error with a message
+  class Error
+
+    # New errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new Error
+    #   JustChess::Error.new("Custom Message")
+    def initialize(message="Generic Error")
+      @message = message
+    end
+  end
+end

data/lib/just_chess/errors/invalid_move_error.rb

@@ -0,0 +1,22 @@
+require 'just_chess/errors/error'
+
+module JustChess
+
+  # = InvalidMoveError
+  #
+  # An invalid move error with a message
+  class InvalidMoveError < Error
+
+    # New invalid move errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new InvalidMoveError
+    #   JustChess::InvalidMoveError.new("Custom Message")
+    def initialize(message="Move is invalid.")
+      super
+    end
+  end
+end

data/lib/just_chess/errors/invalid_promotion_error.rb

@@ -0,0 +1,22 @@
+require 'just_chess/errors/error'
+
+module JustChess
+
+  # = InvalidPromotionError
+  #
+  # An invalid promotion error with a message
+  class InvalidPromotionError < Error
+
+    # New invalid promotion errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new InvalidPromotionError
+    #   JustChess::InvalidPromotionError.new("Custom Message")
+    def initialize(message="Promotion is invalid.")
+      super
+    end
+  end
+end

data/lib/just_chess/errors/moved_into_check_error.rb

@@ -0,0 +1,22 @@
+require 'just_chess/errors/error'
+
+module JustChess
+
+  # = MovedIntoCheckError
+  #
+  # A moved into check error with a message
+  class MovedIntoCheckError < Error
+
+    # New moved into check errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new MovedIntoCheckError
+    #   JustChess::MovedIntoCheckError.new("Custom Message")
+    def initialize(message="This move would leave the king in check.")
+      super
+    end
+  end
+end

data/lib/just_chess/errors/no_piece_error.rb

@@ -0,0 +1,22 @@
+require 'just_chess/errors/error'
+
+module JustChess
+
+  # = NoPieceError
+  #
+  # A no piece error with a message
+  class NoPieceError < Error
+
+    # New no piece errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new NoPieceError
+    #   JustChess::NoPieceError.new("Custom Message")
+    def initialize(message="There is no piece to move.")
+      super
+    end
+  end
+end