qi 6.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cee3167f3c32021191d7cb31829437f5d33c186314d8ebdeb6ce271ca25f9651
-  data.tar.gz: 2802d9e46a694d78d476251e2a194a2de725fc984e5181ff48a9c6cd9512a0e9
+  metadata.gz: 18ca7bb7fca15a8ce854e8a205160b05a14127970039a904c3ce8ad6f8baf8fc
+  data.tar.gz: fc4b915c93488f39835f762b1f89fb44a74ab25ca3faa47fb4a6ea846db66c77
 SHA512:
-  metadata.gz: 34dd51e3c9179833ccebcbee0a99df78144e4a6867b30f2d9b404b166bc6f5fb039ee922b939056e2f07b80588271e94e627765622cc0e65434c1fefd402a120
-  data.tar.gz: bfbe4d8074dcf3c5a196c257f1126e29dcde90bbd0af4221a67a58cd94e93893cccd065ec058c5d3016c2fa5f39946d074f203532e9c13294459195544821b85
+  metadata.gz: 6079a5cb3f9b5b83a5bbc0db41694e6037a46a8e5ef6ce8bd4e65f36863d17008cb5d08d806681c4b17daff89ef2d43abd4e260c4ba068b7ac499fe51a36053c
+  data.tar.gz: 164bb2211d24d9119061a9c771438d0b77f96c0e2d51d4f18c3cfe3f82acdeaf50bd532d4eafb071441a64a18be68cefc9bae9a6dcfcf81b633cf3498912e76c

data/README.md

@@ -1,18 +1,18 @@
-# <span lang="zh"><ruby>棋<rt>Qi</rt></ruby></span>.rb
+# Qi.rb
 
 [![Build Status](https://travis-ci.org/sashite/qi.rb.svg?branch=master)](https://travis-ci.org/sashite/qi.rb)
 [![Gem Version](https://badge.fury.io/rb/qi.svg)][gem]
 [![Inline docs](https://inch-ci.org/github/sashite/qi.rb.svg?branch=master)][inchpages]
 [![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
 
-> Instantiate [Portable Chess Notation](https://developer.sashite.com/specs/portable-chess-notation)'s positions and apply [Portable Move Notation](https://developer.sashite.com/specs/portable-move-notation)'s moves.
+> `Qi` (棋) is an abstraction for updating positions of chess variants (including Chess, Janggi, Markruk, Shogi, Xiangqi), with a move.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'qi'
+gem "qi"
 ```
 
 And then execute:
@@ -25,136 +25,34 @@ Or install it yourself as:
 
 ## Examples
 
-Let's replay [The Shortest Possible Game of Shogi](https://userpages.monmouth.com/~colonel/shortshogi.html):
-
-```ruby
-require 'qi'
-
-starting_position = Qi::Position.new(
-  'l', 'n', 's', 'g', 'k', 'g', 's', 'n', 'l',
-  nil, 'r', nil, nil, nil, nil, nil, 'b', nil,
-  'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p',
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P',
-  nil, 'B', nil, nil, nil, nil, nil, 'R', nil,
-  'L', 'N', 'S', 'G', 'K', 'G', 'S', 'N', 'L'
-)
-
-starting_position.topside_in_hand_pieces # => []
-starting_position.squares # => ["l", "n", "s", "g", "k", "g", "s", "n", "l",
-                          #     nil, "r", nil, nil, nil, nil, nil, "b", nil,
-                          #     "p", "p", "p", "p", "p", "p", "p", "p", "p",
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     "P", "P", "P", "P", "P", "P", "P", "P", "P",
-                          #     nil, "B", nil, nil, nil, nil, nil, "R", nil,
-                          #     "L", "N", "S", "G", "K", "G", "S", "N", "L"]
-starting_position.bottomside_in_hand_pieces # => []
-starting_position.in_hand_pieces # => []
-starting_position.turn_to_topside? # => false
-
-moves = [
-  [ 56, 47, 'P' ],
-  [ 3, 11, 'g' ],
-  [ 64, 24, '+B', 'P' ],
-  [ 5, 14, 'g' ],
-  [ 24, 14, '+B', 'G' ],
-  [ 4, 3, 'k' ],
-  [ nil, 13, 'G' ]
-]
-
-last_position = moves.reduce(starting_position) do |position, move|
-  position.call(move)
-end
-
-last_position.topside_in_hand_pieces # => []
-last_position.squares # => ["l", "n", "s", "k", nil, nil, "s", "n", "l",
-                      #     nil, "r", "g", nil, "G", "+B", nil, "b", nil,
-                      #     "p", "p", "p", "p", "p", "p", nil, "p", "p",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, "P", nil, nil, nil, nil, nil, nil,
-                      #     "P", "P", nil, "P", "P", "P", "P", "P", "P",
-                      #     nil, nil, nil, nil, nil, nil, nil, "R", nil,
-                      #     "L", "N", "S", "G", "K", "G", "S", "N", "L"]
-last_position.bottomside_in_hand_pieces # => ["P"]
-last_position.in_hand_pieces # => []
-last_position.turn_to_topside? # => true
-```
-
-Another example with Xiangqi's Short Double Cannons Checkmate:
-
 ```ruby
-require 'qi'
-
-starting_position = Qi::Position.new(
-  '車', '馬', '象', '士', '將', '士', '象', '馬', '車',
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  nil, '砲', nil, nil, nil, nil, nil, '砲', nil,
-  '卒', nil, '卒', nil, '卒', nil, '卒', nil, '卒',
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  '兵', nil, '兵', nil, '兵', nil, '兵', nil, '兵',
-  nil, '炮', nil, nil, nil, nil, nil, '炮', nil,
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  '俥', '傌', '相', '仕', '帥', '仕', '相', '傌', '俥'
+require "qi"
+
+Qi.call(
+  [43, 13, "+B"],
+  "side_id": 0,
+  "board": {
+     3 => "s",
+     4 => "k",
+     5 => "s",
+    22 => "+P",
+    43 => "+B"
+  },
+  "hands": [
+    %w[S],
+    %w[r r b g g g g s n n n n p p p p p p p p p p p p p p p p p]
+  ]
 )
-
-starting_position.topside_in_hand_pieces # => []
-starting_position.squares # => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
-                          #     "卒", nil, "卒", nil, "卒", nil, "卒", nil, "卒",
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     "兵", nil, "兵", nil, "兵", nil, "兵", nil, "兵",
-                          #     nil, "炮", nil, nil, nil, nil, nil, "炮", nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
-starting_position.bottomside_in_hand_pieces # => []
-starting_position.in_hand_pieces # => []
-starting_position.turn_to_topside? # => false
-
-moves = [
-  [ 64, 67, '炮' ],
-  [ 25, 22, '砲' ],
-  [ 70, 52, '炮' ],
-  [ 19, 55, '砲' ],
-  [ 67, 31, '炮' ],
-  [ 22, 58, '砲' ],
-  [ 52, 49, '炮' ]
-]
-
-last_position = moves.reduce(starting_position) do |position, move|
-  position.call(move)
-end
-
-last_position.topside_in_hand_pieces # => []
-last_position.squares # => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     "卒", nil, "卒", nil, "炮", nil, "卒", nil, "卒",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, "炮", nil, nil, nil, nil,
-                      #     "兵", "砲", "兵", nil, "砲", nil, "兵", nil, "兵",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
-last_position.bottomside_in_hand_pieces # => []
-last_position.in_hand_pieces # => []
-last_position.turn_to_topside? # => true
+# => {:side_id=>1, :board=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}, :hands=>[["S"], ["r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"]]}
 ```
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The code is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## About Sashite
 
-The `qi` gem is maintained by [Sashite](https://sashite.com/).
+This [gem](https://rubygems.org/gems/qi) is maintained by [Sashite](https://sashite.com/).
 
 With some [lines of code](https://github.com/sashite/), let's share the beauty of Chinese, Japanese and Western cultures through the game of chess!
 

data/lib/qi.rb

@@ -1,7 +1,84 @@
 # frozen_string_literal: true
 
-# The Qi module.
+# The Qi abstraction.
+#
+# @example
+#   Qi.call(
+#     [43, 13, "+B"],
+#     "side_id": 0,
+#     "board": {
+#        3 => "s",
+#        4 => "k",
+#        5 => "s",
+#       22 => "+P",
+#       43 => "+B"
+#     },
+#     "hands": [
+#       %w[S],
+#       %w[r r b g g g g s n n n n p p p p p p p p p p p p p p p p p]
+#     ]
+#   )
+#   # => {:side_id=>1, :board=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}, :hands=>[["S"], ["r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"]]}
 module Qi
-end
+  # Apply a move to the position.
+  #
+  # @param move [Array] The move to play.
+  # @param side_id [Integer] The identifier of the player who must play.
+  # @param board [Hash] The indexes of each piece on the board.
+  # @param hands [Array] The list of pieces in hand grouped by players.
+  #
+  # @see https://developer.sashite.com/specs/portable-chess-notation
+  # @see https://developer.sashite.com/specs/portable-move-notation
+  #
+  # @example
+  #   call(
+  #     [43, 13, "+B"],
+  #     "side_id": 0,
+  #     "board": {
+  #        3 => "s",
+  #        4 => "k",
+  #        5 => "s",
+  #       22 => "+P",
+  #       43 => "+B"
+  #     },
+  #     "hands": [
+  #       %w[S],
+  #       %w[r r b g g g g s n n n n p p p p p p p p p p p p p p p p p]
+  #     ]
+  #   )
+  #   # => {:side_id=>1, :board=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}, :hands=>[["S"], ["r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"]]}
+  #
+  # @return [Hash] The next position.
+  def self.call(move, side_id:, board:, hands:)
+    updated_board = board.dup
+    updated_in_hand_pieces = hands.fetch(side_id).dup
+
+    actions = move.each_slice(4)
+
+    actions.each do |action|
+      src_square_id       = action.fetch(0)
+      dst_square_id       = action.fetch(1)
+      moved_piece_name    = action.fetch(2)
+      captured_piece_name = action.fetch(3, nil)
+
+      if src_square_id.nil?
+        piece_in_hand_id = updated_in_hand_pieces.index(moved_piece_name)
+        updated_in_hand_pieces.delete_at(piece_in_hand_id) unless piece_in_hand_id.nil?
+      else
+        updated_board.delete(src_square_id)
+      end
 
-require_relative 'qi/position'
+      updated_board[dst_square_id] = moved_piece_name
+      updated_in_hand_pieces.push(captured_piece_name) unless captured_piece_name.nil?
+    end
+
+    updated_hands = hands.dup
+    updated_hands[side_id] = updated_in_hand_pieces
+
+    {
+      side_id: side_id.succ % hands.length,
+      board: updated_board,
+      hands: updated_hands
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal
@@ -117,7 +117,6 @@ files:
 - LICENSE.md
 - README.md
 - lib/qi.rb
-- lib/qi/position.rb
 homepage: https://developer.sashite.com/specs/
 licenses:
 - MIT
@@ -133,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -143,5 +142,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Represent positions and play moves.
+summary: Update positions with a move.
 test_files: []

data/lib/qi/position.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Qi
-  # The position class.
-  #
-  # @see https://developer.sashite.com/specs/portable-chess-notation
-  class Position
-    # The list of squares of on the board.
-    #
-    # @!attribute [r] squares
-    #   @return [Array] The list of squares.
-    attr_reader :squares
-
-    # The list of pieces in hand owned by the bottomside player.
-    #
-    # @!attribute [r] bottomside_in_hand_pieces
-    #   @return [Array] The list of bottomside's pieces in hand.
-    attr_reader :bottomside_in_hand_pieces
-
-    # The list of pieces in hand owned by the topside player.
-    #
-    # @!attribute [r] topside_in_hand_pieces
-    #   @return [Array] The list of topside's pieces in hand.
-    attr_reader :topside_in_hand_pieces
-
-    # Initialize a position.
-    #
-    # @param squares [Array] The list of squares of on the board.
-    # @param is_turn_to_topside [Boolean] The player who must play.
-    # @param bottomside_in_hand_pieces [Array] The list of bottom-side's pieces in hand.
-    # @param topside_in_hand_pieces [Array] The list of top-side's pieces in hand.
-    #
-    # @example The Shogi's starting position
-    #   Position.new(
-    #     'l', 'n', 's', 'g', 'k', 'g', 's', 'n', 'l',
-    #     nil, 'r', nil, nil, nil, nil, nil, 'b', nil,
-    #     'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p',
-    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P',
-    #     nil, 'B', nil, nil, nil, nil, nil, 'R', nil,
-    #     'L', 'N', 'S', 'G', 'K', 'G', 'S', 'N', 'L'
-    #   )
-    def initialize(*squares, is_turn_to_topside: false, bottomside_in_hand_pieces: [], topside_in_hand_pieces: [])
-      @squares                    = squares
-      @is_turn_to_topside         = is_turn_to_topside
-      @bottomside_in_hand_pieces  = bottomside_in_hand_pieces
-      @topside_in_hand_pieces     = topside_in_hand_pieces
-
-      freeze
-    end
-
-    # Apply a move in PMN (Portable Move Notation) format.
-    #
-    # @see https://developer.sashite.com/specs/portable-move-notation
-    # @return [Position] The new position.
-    def call(move)
-      updated_squares = squares.dup
-      updated_bottomside_in_hand_pieces = bottomside_in_hand_pieces.dup
-      updated_topside_in_hand_pieces = topside_in_hand_pieces.dup
-
-      actions = move.each_slice(4)
-
-      actions.each do |action|
-        src_square_id       = action.fetch(0)
-        dst_square_id       = action.fetch(1)
-        moved_piece_name    = action.fetch(2)
-        captured_piece_name = action.fetch(3, nil)
-
-        if src_square_id.nil?
-          if turn_to_topside?
-            piece_in_hand_id = updated_topside_in_hand_pieces.index(moved_piece_name)
-            updated_topside_in_hand_pieces.delete_at(piece_in_hand_id)
-          else
-            piece_in_hand_id = updated_bottomside_in_hand_pieces.index(moved_piece_name)
-            updated_bottomside_in_hand_pieces.delete_at(piece_in_hand_id)
-          end
-        else
-          updated_squares[src_square_id] = nil
-        end
-
-        updated_squares[dst_square_id] = moved_piece_name
-
-        unless captured_piece_name.nil?
-          if turn_to_topside?
-            updated_topside_in_hand_pieces.push(captured_piece_name)
-          else
-            updated_bottomside_in_hand_pieces.push(captured_piece_name)
-          end
-        end
-      end
-
-      self.class.new(*updated_squares, is_turn_to_topside: !turn_to_topside?,
-                                       bottomside_in_hand_pieces: updated_bottomside_in_hand_pieces,
-                                       topside_in_hand_pieces: updated_topside_in_hand_pieces)
-    end
-
-    # The list of pieces in hand owned by the current player.
-    #
-    # @return [Array] Topside's pieces in hand if turn to topside, bottomside's
-    #   ones otherwise.
-    def in_hand_pieces
-      turn_to_topside? ? topside_in_hand_pieces : bottomside_in_hand_pieces
-    end
-
-    # The side who must play.
-    #
-    # @return [Boolean] True if it is turn to topside, false otherwise.
-    def turn_to_topside?
-      @is_turn_to_topside
-    end
-  end
-end