just_xiangqi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8bb310a00877fd7e9c6dd65f268096471a03269aaeb32267f0f101b385c2a4e3
+  data.tar.gz: 388f1b172abd699738dc3b0f88fa242a356a675d10595ed652a29ec1d492cc91
+SHA512:
+  metadata.gz: e2db50ce472215026b0fd881152bbbe62337748704afecbd8079ac025ba7511c41d0f1ef4ca1589dbf71989916ede5a0dd3fcec9637e4fa9e3afafb5b5a58e15
+  data.tar.gz: 2d68309b2b1298178c26aa07b8f5a91bba4030fe045adb504fa13f3842f4798581c421bcc555ee186a5f1f0266bdc01ab7d0a85ea954db4572562d6f83c09af8

data/.gitignore

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

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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    just_xiangqi (0.1.0)
+      board_game_grid (~> 0.1.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    board_game_grid (0.1.9)
+    minitest (5.14.4)
+    rake (13.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  just_xiangqi!
+  minitest (~> 5.14.0)
+  rake (~> 13.0.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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,71 @@
+# JustXiangqi
+
+A Xiangqi engine written in ruby. It provides a representation of a xiangqi game complete with rules enforcement and serialisation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'just_xiangqi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install just_xiangqi
+
+## Usage
+
+To start, a new game state can be instantiated with the default state:
+
+```ruby
+  game_state = JustXiangqi::GameState.default
+```
+
+Moves can be made by passing in the player number and the from and to ids. It will return true if the move is valid, otherwise it will return false.
+
+```ruby
+  game_state.move(1, 'XX', 'YY')
+```
+
+The last change with all its details are found in the `last_change` attribute.
+
+```ruby
+  game_state.last_change
+```
+
+If something unexpected happens, errors may be found in the errors attribute.
+
+```ruby
+  game_state.errors
+```
+
+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_xiangqi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mrlhumphreys/just_xiangqi/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JustXiangqi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mrlhumphreys/just_xiangqi/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_xiangqi"
+
+# 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_xiangqi.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/just_xiangqi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "just_xiangqi"
+  spec.version       = JustXiangqi::VERSION
+  spec.authors       = ["Mark Humphreys"]
+  spec.email         = ["mark@mrlhumphreys.com"]
+
+  spec.summary       = %q{A Xiangqi engine written in ruby}
+  spec.description   = %q{Provides a representation of a xiangqi game complete with rules enforcement and serialisation.}
+  spec.homepage      = "https://github.com/mrlhumphreys/just_xiangqi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", "~> 13.0.1"
+  spec.add_development_dependency "minitest", "~> 5.14.0"
+
+  spec.add_runtime_dependency "board_game_grid", "~> 0.1.9"
+end

data/lib/just_xiangqi/errors/error.rb

@@ -0,0 +1,21 @@
+module JustXiangqi
+
+  # = 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
+    #   JustXiangqi::Error.new('Custom Message')
+    def initialize(message='Genertic Error')
+      @message = message 
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/invalid_move_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+  
+  # = 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
+    #   JustXiangqi::InvalidMoveError.new("Custom Message")
+    def initialize(message="Move is invalid.")
+      super 
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/moved_into_check_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+
+  # = 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
+    #   JustXiangqi::MovedIntoCheckError.new("Custom Message")
+    def initialize(message="This move would leave the ou in check.")
+      super
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/no_legal_moves_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+
+  # = NoLegalMovesError 
+  #
+  # A no legal moves error with a message
+  class NoLegalMovesError < Error
+
+    # New no legal moves errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new NoLegalMovesError 
+    #   JustXiangqi::NoLegalMovesError.new("Custom Message")
+    def initialize(message="Piece cannot move from that square.")
+      super
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/no_piece_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+  
+  # = 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
+    #   JustXiangqi::NoPieceError.new("Custom Message")
+    def initialize(message="There is no piece to move.")
+      super 
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/not_players_turn_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+  
+  # = NotPlayersTurnError
+  #
+  # A not players turn error with a message
+  class NotPlayersTurnError < Error
+    
+    # New not players turn errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Intantiates a new NotPlayersTurnError
+    #   JustXiangqi::NotPlayersTurnError.new("Custom Message")
+    def initialize(message="It is not the player's turn yet.")
+      super
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/off_board_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+
+  # = OffBoardError
+  #
+  # An off board error with a message
+  class OffBoardError < Error
+
+    # New off board errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new OffBoardError
+    #   JustXiangqi::OffBoardError.new("Custom Message")
+    def initialize(message="Cannot move off board.")
+      super 
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/piece_not_found_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+
+  # = PieceNotFoundError
+  #
+  # An piece not found error with a message
+  class PieceNotFoundError < Error
+
+    # New piece not found errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new PieceNotFoundError 
+    #   JustXiangqi::PieceNotFoundError.new("Custom Message")
+    def initialize(message="The piece could not be found.")
+      super
+    end
+  end
+end
+

data/lib/just_xiangqi/errors/square_occupied_error.rb

@@ -0,0 +1,23 @@
+require 'just_xiangqi/errors/error'
+
+module JustXiangqi
+
+  # = SquareOccupiedError
+  #
+  # A square occupied error with a message
+  class SquareOccupiedError < Error
+
+    # New square occupied errors can be instantiated with
+    #
+    # @option [String] message
+    #   the message to display.
+    #
+    # ==== Example:
+    #   # Instantiates a new SquareOccupiedError 
+    #   JustXiangqi::SquareOccupiedError.new("Custom Message")
+    def initialize(message="Square is already occupied.")
+      super
+    end
+  end
+end
+