just_shogi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: baa8a0c184b06f45745883501e31f89fb32382be0872a211f807cd92380c1910
+  data.tar.gz: 00d2bc98222f9a525535e51e25e17266bd65e0caee4546ed7a4171f471129113
+SHA512:
+  metadata.gz: 1bf5d7b03cb04995be193b191bf68e0e6302301e49c7fb5a4848b274c467b5e4384bd43c1ab74d107dc22168a03714beecca67f16cff0b413c2f8aa5bd107aa1
+  data.tar.gz: 4d2e75eeea5e9b124754cb0048a8fcff35920430ed1c84588340a1abcf462982321ea6d71cac4ec8015cd3c533bb523e48c47c19250b5a7bdb54e8e699ef1265

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_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 [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,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in just_shogi.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    just_shogi (0.1.0)
+      board_game_grid (~> 0.1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    board_game_grid (0.1.6)
+    minitest (5.14.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  just_shogi!
+  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) 2020 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,80 @@
+# JustShogi
+
+A shogi engine written in ruby. It provides a representation of a shogi game complete with rules enforcement and serialisation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'just_shogi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install just_shogi
+
+## Usage
+
+To start, a new game state can be instantiated with the default state:
+
+```ruby
+  game_state = JustShogi::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. The last argument is optional and if specified to true will attempt to promote the piece.
+
+```ruby
+  game_state.move(1, '77', '78', true)
+```
+
+Drops can be made by passing in the player number, the id of the piece in hand and the id of the square that the piece will be placed on. It will return true if the move is valid. Otherwise it will return false.
+
+```ruby
+  game_state.drop(1, 23, '78')
+```
+
+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
+```
+
+The winner can be gound 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_shogi. 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_shogi/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 JustShogi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mrlhumphreys/just_shogi/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_shogi"
+
+# 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_shogi.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/just_shogi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "just_shogi"
+  spec.version       = JustShogi::VERSION
+  spec.authors       = ["Mark Humphreys"]
+  spec.email         = ["mark@mrlhumphreys.com"]
+
+  spec.summary       = %q{A Shogi engine written in ruby}
+  spec.description   = %q{Provides a representation of a shogi game complete with rules enforcement and serialisation.}
+  spec.homepage      = "https://github.com/mrlhumphreys/just_shogi"
+  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.6"
+end

data/lib/just_shogi.rb

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

data/lib/just_shogi/errors/causes_check_error.rb

@@ -0,0 +1,22 @@
+require 'just_shogi/errors/error'
+
+module JustShogi
+  
+  # = 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
+    #   JustShogi::CausesCheckError.new("Custom Message")
+    def initialize(message="That move would put the ou in check.")
+      super 
+    end
+  end
+end

data/lib/just_shogi/errors/dropped_into_check_error.rb

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

data/lib/just_shogi/errors/error.rb

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

data/lib/just_shogi/errors/invalid_move_error.rb

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

data/lib/just_shogi/errors/invalid_promotion_error.rb

@@ -0,0 +1,22 @@
+require 'just_shogi/errors/error'
+
+module JustShogi
+
+  # = 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 
+    #   JustShogi::InvalidPromotionError.new("Custom Message")
+    def initialize(message="This piece cannot promote.")
+      super
+    end
+  end
+end

data/lib/just_shogi/errors/moved_into_check_error.rb

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