just_shogi 0.1.0

data/lib/just_shogi/pieces/piece.rb

@@ -0,0 +1,18 @@
+require 'board_game_grid' 
+
+module JustShogi
+
+  # = Piece
+  #
+  # A piece that can move on a chess board
+  class Piece < BoardGameGrid::Piece
+    def initialize(id: , player_number: , type: nil)
+      @id = id
+      @player_number = player_number
+    end
+
+    def switch_player
+      @player_number = opponent
+    end
+  end
+end

data/lib/just_shogi/pieces/ryuuma.rb

@@ -0,0 +1,23 @@
+require 'just_shogi/pieces/piece'
+
+module JustShogi
+
+  # = Ryuuma 
+  #
+  # The piece that moves diagonally any number of squares and 1 space orthogonally
+  class Ryuuma < Piece
+
+    # All the squares that the piece can move to and/or capture.
+    #
+    # @param [Square] square
+    #   the origin square.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [SquareSet]
+    def destinations(square, game_state)
+      (game_state.squares.diagonal(square) | game_state.squares.at_range(square, 1)).unoccupied_or_occupied_by_opponent(player_number).unblocked(square, game_state.squares)
+    end
+  end
+end

data/lib/just_shogi/pieces/ryuuou.rb

@@ -0,0 +1,23 @@
+require 'just_shogi/pieces/piece'
+
+module JustShogi
+
+  # = Ryuuou 
+  #
+  # The piece that moves any number of squares orthogonally and 1 space diagonally.
+  class Ryuuou < Piece
+    
+    # All the squares that the piece can move to and/or capture.
+    #
+    # @param [Square] square
+    #   the origin square.
+    #
+    # @param [GameState] game_state
+    #   the current game state.
+    #
+    # @return [SquareSet]
+    def destinations(square, game_state)
+      (game_state.squares.orthogonal(square) | game_state.squares.at_range(square, 1)).unoccupied_or_occupied_by_opponent(player_number).unblocked(square, game_state.squares)
+    end
+  end
+end

data/lib/just_shogi/pieces/tokin.rb

@@ -0,0 +1,9 @@
+require 'just_shogi/pieces/kin_base'
+
+module JustShogi
+
+  # = Tokin
+  #
+  # The piece that can move 1 space orthogonally or forwards diagonally
+  class Tokin < KinBase; end
+end

data/lib/just_shogi/promotion_factory.rb

@@ -0,0 +1,71 @@
+require 'just_shogi/pieces/fuhyou'
+require 'just_shogi/pieces/kakugyou'
+require 'just_shogi/pieces/hisha'
+require 'just_shogi/pieces/kyousha'
+require 'just_shogi/pieces/keima'
+require 'just_shogi/pieces/ginshou'
+require 'just_shogi/pieces/kinshou'
+require 'just_shogi/pieces/oushou'
+require 'just_shogi/pieces/gyokushou'
+
+require 'just_shogi/pieces/tokin'
+require 'just_shogi/pieces/narikyou'
+require 'just_shogi/pieces/narikei'
+require 'just_shogi/pieces/narigin'
+require 'just_shogi/pieces/ryuuma'
+require 'just_shogi/pieces/ryuuou'
+
+module JustShogi
+
+  # = Promotion Factory
+  #
+  # Generates the promoted or demoted piece given a piece
+  class PromotionFactory
+    
+    # A mapping of promotions
+    PROMOTIONS = {
+      Fuhyou => Tokin,
+      Kakugyou => Ryuuma,
+      Hisha => Ryuuou,
+      Kyousha => Narikyou,
+      Keima => Narikei,
+      Ginshou => Narigin
+    }
+
+    # New objects can be instantiated by passing in the piece
+    #
+    # @params [Piece] piece
+    #   the piece to be promoted
+    def initialize(piece)
+      @piece = piece
+    end
+
+    def promotable?
+      !PROMOTIONS[@piece.class].nil?
+    end
+
+    def demotable?
+      !PROMOTIONS.key(@piece.class).nil?
+    end
+
+    # Returns the promoted piece
+    def promote
+      promoted_klass = PROMOTIONS[@piece.class]
+      if promoted_klass 
+        promoted_klass.new(id: @piece.id, player_number: @piece.player_number)
+      else
+        raise ArgumentError, "Piece cannot be promoted."
+      end
+    end
+
+    # Returns the demoted piece
+    def demote
+      demoted_klass = PROMOTIONS.key(@piece.class)
+      if demoted_klass 
+        demoted_klass.new(id: @piece.id, player_number: @piece.player_number)
+      else
+        raise ArgumentError, "Piece cannot be demoted."
+      end
+    end
+  end
+end

data/lib/just_shogi/square.rb

@@ -0,0 +1,51 @@
+require 'just_shogi/piece_factory'
+require 'board_game_grid'
+
+module JustShogi
+
+  # = Square
+  #
+  # A Square on a shogi board.
+  class Square < BoardGameGrid::Square
+
+    # New object can be instantiated by passing in a hash with
+    #
+    # @param [String] id
+    #   the unique identifier of the square.
+    #
+    # @param [Fixnum] x
+    #   the x co-ordinate of the square.
+    #
+    # @param [Fixnum] y
+    #   the y co-ordinate of the square.
+    #
+    # @option [Piece,Hash,NilClass] piece
+    #   The piece on the square, can be a piece object or hash or nil.
+    #
+    # ==== Example:
+    #   # Instantiates a new Square
+    #   JustShogi::Square.new({
+    #     id: '91',
+    #     x: 0,
+    #     y: 0,
+    #     piece: { id: 1, player_number: 1, type: 'fuhyou' }
+    #   })
+    def initialize(id: , x: , y: , piece: nil)
+      @id = id
+      @x = x
+      @y = y
+      @piece = PieceFactory.new(piece).build
+    end
+
+    def promotion_zone(player_number)
+      case player_number
+      when 1
+        (0..2).include?(y)
+      when 2
+        (6..8).include?(y)
+      else
+        raise ArgumentError, "Invalid Player Number"
+      end
+    end
+  end
+end

data/lib/just_shogi/square_set.rb

@@ -0,0 +1,64 @@
+require 'just_shogi/square'
+require 'board_game_grid'
+
+module JustShogi
+  
+  # = 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
+    #   JustShogi::SquareSet.new({
+    #     squares: [
+    #       { id: '91', x: 0, y: 0, piece: { id: 1, player_number: 1, type: 'fuhyou' } }
+    #     ]
+    #   })
+    def initialize(squares: )
+      @squares = 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
+    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 ou
+    #   square_est.find_ou_for_player(2)
+    def find_ou_for_player(player_number)
+      find { |s| s.piece && s.piece.is_a?(JustShogi::OuBase) && 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_shogi/version.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: just_shogi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Humphreys
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-20 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.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: Provides a representation of a shogi 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_shogi.gemspec
+- lib/just_shogi.rb
+- lib/just_shogi/errors/causes_check_error.rb
+- lib/just_shogi/errors/dropped_into_check_error.rb
+- lib/just_shogi/errors/error.rb
+- lib/just_shogi/errors/invalid_move_error.rb
+- lib/just_shogi/errors/invalid_promotion_error.rb
+- lib/just_shogi/errors/moved_into_check_error.rb
+- lib/just_shogi/errors/no_piece_error.rb
+- lib/just_shogi/errors/not_players_turn_error.rb
+- lib/just_shogi/errors/off_board_error.rb
+- lib/just_shogi/errors/piece_not_found_error.rb
+- lib/just_shogi/errors/square_occupied_error.rb
+- lib/just_shogi/game_state.rb
+- lib/just_shogi/hand.rb
+- lib/just_shogi/piece_factory.rb
+- lib/just_shogi/pieces/fuhyou.rb
+- lib/just_shogi/pieces/ginshou.rb
+- lib/just_shogi/pieces/gyokushou.rb
+- lib/just_shogi/pieces/hisha.rb
+- lib/just_shogi/pieces/kakugyou.rb
+- lib/just_shogi/pieces/keima.rb
+- lib/just_shogi/pieces/kin_base.rb
+- lib/just_shogi/pieces/kinshou.rb
+- lib/just_shogi/pieces/kyousha.rb
+- lib/just_shogi/pieces/narigin.rb
+- lib/just_shogi/pieces/narikei.rb
+- lib/just_shogi/pieces/narikyou.rb
+- lib/just_shogi/pieces/ou_base.rb
+- lib/just_shogi/pieces/oushou.rb
+- lib/just_shogi/pieces/piece.rb
+- lib/just_shogi/pieces/ryuuma.rb
+- lib/just_shogi/pieces/ryuuou.rb
+- lib/just_shogi/pieces/tokin.rb
+- lib/just_shogi/promotion_factory.rb
+- lib/just_shogi/square.rb
+- lib/just_shogi/square_set.rb
+- lib/just_shogi/version.rb
+homepage: https://github.com/mrlhumphreys/just_shogi
+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 Shogi engine written in ruby
+test_files: []