just_xiangqi 0.1.0

data/lib/just_xiangqi/square_set.rb

@@ -0,0 +1,69 @@
+require 'just_xiangqi/square'
+require 'board_game_grid'
+
+module JustXiangqi
+  
+  # = Square Set
+  #
+  # A collection of Squares with useful filtering functions
+  class SquareSet < BoardGameGrid::SquareSet
+
+    # New objects can be instantiated by passing in a hash with squares.
+    # They can be square objects or hashes.
+    #
+    # @param [Array<Square,Hash>] squares
+    #   An array of squares, each with an x and y co-oordinates an a piece.
+    #
+    # ==== Example:
+    #   # Instantiates a new Square Sete
+    #   JustXiangqi::SquareSet.new({
+    #     squares: [
+    #       { id: '1', x: 0, y: 0, piece: { id: 1, player_number: 1, type: 'zu' } }
+    #     ]
+    #   })
+    def initialize(squares: )
+      @squares = if squares.instance_of?(Array)
+                   if squares.all? { |s| s.instance_of?(Hash) }
+                     squares.map { |s| Square.new(**s) } 
+                   elsif squares.all? { |s| s.instance_of?(Square) }
+                     squares
+                   else
+                     raise ArgumentError, "all squares must have the same class"
+                   end
+                 else
+                   raise ArgumentError, "squares must be an array"
+                 end
+    end
+
+    # Find the square occupied by the player's king
+    #
+    # @param [Fixnum] player_number
+    #   the number of the player
+    #
+    # @return [Square]
+    # ==== Example:
+    #   # Find the square occupied by player 2's jiang 
+    #   square_est.find_jiang_for_player(2)
+    def find_jiang_for_player(player_number)
+      find { |s| s.piece && s.piece.is_a?(JustXiangqi::Jiang) && s.occupied_by_player?(player_number) }
+    end
+
+    # Returns all squares threatened by the specified player
+    #
+    # @param [Fixnum] player_number
+    #   the player's number.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [SquareSet]
+    def threatened_by(player_number, game_state)
+      _squares = occupied_by_player(player_number).map do |s|
+        s.piece.potential_capture_squares(s, game_state).squares
+      end.flatten.uniq
+
+      self.class.new(squares: _squares)
+    end
+  end
+end
+

data/lib/just_xiangqi/version.rb

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

data/lib/just_xiangqi.rb

@@ -0,0 +1,9 @@
+require "just_xiangqi/version"
+
+# :nodoc:
+module JustXiangqi
+  class Error < StandardError; end
+
+end
+
+require 'just_xiangqi/game_state'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: just_xiangqi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Humphreys
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+- !ruby/object:Gem::Dependency
+  name: board_game_grid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+description: Provides a representation of a xiangqi game complete with rules enforcement
+  and serialisation.
+email:
+- mark@mrlhumphreys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- just_xiangqi.gemspec
+- lib/just_xiangqi.rb
+- lib/just_xiangqi/errors/error.rb
+- lib/just_xiangqi/errors/invalid_move_error.rb
+- lib/just_xiangqi/errors/moved_into_check_error.rb
+- lib/just_xiangqi/errors/no_legal_moves_error.rb
+- lib/just_xiangqi/errors/no_piece_error.rb
+- lib/just_xiangqi/errors/not_players_turn_error.rb
+- lib/just_xiangqi/errors/off_board_error.rb
+- lib/just_xiangqi/errors/piece_not_found_error.rb
+- lib/just_xiangqi/errors/square_occupied_error.rb
+- lib/just_xiangqi/game_state.rb
+- lib/just_xiangqi/piece_factory.rb
+- lib/just_xiangqi/pieces/jiang.rb
+- lib/just_xiangqi/pieces/ju.rb
+- lib/just_xiangqi/pieces/ma.rb
+- lib/just_xiangqi/pieces/pao.rb
+- lib/just_xiangqi/pieces/piece.rb
+- lib/just_xiangqi/pieces/shi.rb
+- lib/just_xiangqi/pieces/xiang.rb
+- lib/just_xiangqi/pieces/zu.rb
+- lib/just_xiangqi/square.rb
+- lib/just_xiangqi/square_set.rb
+- lib/just_xiangqi/version.rb
+homepage: https://github.com/mrlhumphreys/just_xiangqi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Xiangqi engine written in ruby
+test_files: []