qi 6.3.1 → 9.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72084022a3eaca3cec4ff33c2106c99e2b5da61412049b37180f0ddddd87793
-  data.tar.gz: 56082cc561866965d8f37178f8e6710d54593e4d67f6a24bd63ec23e5c183094
+  metadata.gz: f66c9affa38d8e5dadfc596d5df81b47839187830d834600d624558d3643077e
+  data.tar.gz: fd345a4baeacbf22a0a898731dc26b19063727190a497a6d4cf779ca6275bf96
 SHA512:
-  metadata.gz: f12a76bed9d203b56fcadf2133ec8e985494827d8e5533a7c4bcbe2c350de43d9ff8254c5b9f66c862ddb137f74fb4522b0f88ccd1d29fbec7d972a3acea5984
-  data.tar.gz: 057b02a60a91a292bce36d173128e8a22117211d2afc32d5155ff81e289ebe7fb501b31a1c03c148c335c4ed61c3819f7b47fb8a51b0804f6098f3926b7c6a6c
+  metadata.gz: f5ef7c30f20b03fb3a6712c8b14824b1878a0f706159973b9d5c0c6270092042e12a4ecc50254e99f8d6107466367f58d530d77489370b3a54437e8f31bf42bb
+  data.tar.gz: 9364870e925d1769e5c9d233bcc8acb626a0a9d70d62725eafda311a926bd6ed398cb5e0efbff71a09ca659bcfc5e67037126ee4c4cffaa7b79e2687dcc1f470

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 Sashite
+Copyright (c) 2015-2021 Sashite
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,341 +1,50 @@
 # 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]
+[![Version](https://img.shields.io/github/v/tag/sashite/qi.rb?label=Version&logo=github)](https://github.com/sashite/qi.rb/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/sashite/qi.rb/main)
+[![CI](https://github.com/sashite/qi.rb/workflows/CI/badge.svg?branch=main)](https://github.com/sashite/qi.rb/actions?query=workflow%3Aci+branch%3Amain)
+[![RuboCop](https://github.com/sashite/qi.rb/workflows/RuboCop/badge.svg?branch=main)](https://github.com/sashite/qi.rb/actions?query=workflow%3Arubocop+branch%3Amain)
+[![License](https://img.shields.io/github/license/sashite/qi.rb?label=License&logo=github)](https://github.com/sashite/qi.rb/raw/main/LICENSE.md)
 
-> `Qi` (棋) is an abstraction for initializing and updating positions of chess variants (including Chess, Janggi, Markruk, Shogi, Xiangqi).
+> `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", ">= 9.0.0.beta2"
 ```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install qi
-
-## Examples
-
-Let's replay [The Shortest Possible Game](https://userpages.monmouth.com/~colonel/shortshogi.html) of [Shogi](https://en.wikipedia.org/wiki/Shogi):
-
-```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.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.pieces_in_hand_grouped_by_sides
-# => [[], []]
-
-starting_position.active_side_id
-# => 0
-
-# List of moves (see https://github.com/sashite/pmn.rb)
-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.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.pieces_in_hand_grouped_by_sides
-# => [["P"], []]
-
-last_position.active_side_id
-# => 1
+```sh
+bundle
 ```
 
-A classic [Tsume Shogi](https://en.wikipedia.org/wiki/Tsume_shogi) problem:
-
-```ruby
-require "qi"
-
-starting_position = Qi::Position.new(
-  nil, nil, nil, "s", "k", "s", nil, nil, nil,
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  nil, nil, nil, nil, "+P", nil, nil, nil, nil,
-  nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  nil, nil, nil, nil, nil, nil, nil, "+B", 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,
-  pieces_in_hand_grouped_by_sides: [
-    ["S"],
-    ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s"]
-  ]
-)
-
-starting_position.in_hand_pieces
-# => ["S"]
-
-starting_position.squares
-# => [nil, nil, nil, "s", "k", "s", nil, nil, nil,
-#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-#     nil, nil, nil, nil, "+P", nil, nil, nil, nil,
-#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-#     nil, nil, nil, nil, nil, nil, nil, "+B", 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.pieces_in_hand_grouped_by_sides
-# => [["S"], ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s"]]
-
-starting_position.active_side_id
-# => 0
-
-# List of moves (see https://github.com/sashite/pmn.rb)
-moves = [
-  [  43, 13, "+B" ],  [ 5, 13, "s", "b" ],
-  [ nil, 14,  "S" ]
-]
-
-last_position = moves.reduce(starting_position) do |position, move|
-  position.call(move)
-end
-
-last_position.in_hand_pieces
-# => ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s", "b"]
-
-last_position.squares
-# => [nil, nil, nil, "s", "k", nil, nil, nil, nil,
-#     nil, nil, nil, nil, "s", "S", nil, nil, nil,
-#     nil, nil, nil, nil, "+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, 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.pieces_in_hand_grouped_by_sides
-# => [[], ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s", "b"]]
-
-last_position.active_side_id
-# => 1
-```
-
-Another example with [Xiangqi](https://en.wikipedia.org/wiki/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,
-  "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"
-)
-
-starting_position.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.pieces_in_hand_grouped_by_sides
-# => [[], []]
-
-starting_position.active_side_id
-# => 0
-
-# List of moves (see https://github.com/sashite/pmn.rb)
-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.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.pieces_in_hand_grouped_by_sides
-# => [[], []]
+Or install it yourself as:
 
-last_position.active_side_id
-# => 1
+```sh
+gem install qi --pre
 ```
 
-Let's do some moves on a [Four-player chess](https://en.wikipedia.org/wiki/Four-player_chess) board:
+## Examples
 
 ```ruby
 require "qi"
 
-starting_position = Qi::Position.new(
-  nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
-  nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
-  nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-  "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-  "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-  "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-  "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
-  "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
-  "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-  "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-  "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-  nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-  nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
-  nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil ,
-  pieces_in_hand_grouped_by_sides: [
-    [],
-    [],
-    [],
-    []
-  ]
+Qi.call(
+  [43, 13, "+B"],
+  in_hand: %w[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],
+  square: {
+    3 => "s",
+    4 => "k",
+    5 => "s",
+    22 => "+P",
+    43 => "+B"
+  }
 )
-
-starting_position.in_hand_pieces
-# => []
-
-starting_position.squares
-# => [nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
-#     nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
-#     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-#     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-#     "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
-#     "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
-#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-#     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-#     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-#     nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
-#     nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil]
-
-starting_position.pieces_in_hand_grouped_by_sides
-# => [[], [], [], []]
-
-starting_position.active_side_id
-# => 0
-
-# List of moves (see https://github.com/sashite/pmn.rb)
-moves = [
-  [ 175, 147, "rP" ],
-  [ 85, 87, "bP" ],
-  [ 20, 48, "yP" ],
-  [ 110, 108, "gP" ],
-  [ 191, 162, "rN" ]
-]
-
-last_position = moves.reduce(starting_position) do |position, move|
-  position.call(move)
-end
-
-last_position.in_hand_pieces
-# => []
-
-last_position.squares
-# => [nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
-#     nil , nil , nil , "yP", "yP", "yP", nil , "yP", "yP", "yP", "yP", nil , nil , nil ,
-#     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-#     "bR", "bP", nil , nil , nil , nil , "yP", nil , nil , nil , nil , nil , "gP", "gR",
-#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-#     "bK", nil , nil , "bP", nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
-#     "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , "gP", nil , nil , "gK",
-#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-#     "bR", "bP", nil , nil , nil , nil , nil , "rP", nil , nil , nil , nil , "gP", "gR",
-#     nil , nil , nil , nil , nil , nil , nil , nil , "rN", nil , nil , nil , nil , nil ,
-#     nil , nil , nil , "rP", "rP", "rP", "rP", nil , "rP", "rP", "rP", nil , nil , nil ,
-#     nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", nil , "rR", nil , nil , nil]
-
-last_position.pieces_in_hand_grouped_by_sides
-# => [[], [], [], []]
-
-last_position.active_side_id
-# => 1
+# => {:square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}, :in_hand=>["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
@@ -347,7 +56,3 @@ The code is available as open source under the terms of the [MIT License](https:
 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!
-
-[gem]: https://rubygems.org/gems/qi
-[inchpages]: https://inch-ci.org/github/sashite/qi.rb
-[rubydoc]: https://rubydoc.info/gems/qi/frames

data/lib/qi.rb

@@ -1,7 +1,48 @@
 # frozen_string_literal: true
 
-# The Qi module.
+require_relative File.join("qi", "move")
+
+# The Qi abstraction.
+#
+# @example Apply a move to a classic Shogi problem
+#   Qi.call(
+#     [43, 13, "+B"],
+#     in_hand: %w[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],
+#     square: {
+#        3 => "s",
+#        4 => "k",
+#        5 => "s",
+#       22 => "+P",
+#       43 => "+B"
+#     }
+#   )
+#   # => {:in_hand=>["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"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
 module Qi
+  # Apply a move to the position.
+  #
+  # @param move [Array] The move to play.
+  # @param in_hand [Array] The list of pieces in hand.
+  # @param square [Hash] The index of each piece on the board.
+  #
+  # @see https://developer.sashite.com/specs/portable-chess-notation
+  # @see https://developer.sashite.com/specs/portable-move-notation
+  #
+  # @example Apply a move to a classic Shogi problem
+  #   call(
+  #     [43, 13, "+B"],
+  #     in_hand: %w[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],
+  #     square: {
+  #        3 => "s",
+  #        4 => "k",
+  #        5 => "s",
+  #       22 => "+P",
+  #       43 => "+B"
+  #     }
+  #   )
+  #   # => {:in_hand=>["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"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
+  #
+  # @return [Hash] The piece set of the next position.
+  def self.call(move, in_hand:, square:)
+    Move.new(move).call(in_hand: in_hand, square: square)
+  end
 end
-
-require_relative "qi/position"

data/lib/qi/action.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Qi
+  # The Action abstraction.
+  class Action
+    # Initialize an action instance.
+    #
+    # @param src_square_id [Integer, nil] The source square ID.
+    # @param dst_square_id [Integer] The target square ID.
+    # @param moved_piece_name [String] The moved piece name.
+    # @param captured_piece_name [String, nil] The captured piece name.
+    #
+    # @example Initialize a promoted bishop action from 43 to 13
+    #   new(43, 13, "+B", nil)
+    #
+    # @see https://developer.sashite.com/specs/portable-action-notation
+    def initialize(src_square_id, dst_square_id, moved_piece_name, captured_piece_name = nil)
+      @src_square_id = src_square_id
+      @dst_square_id = dst_square_id
+      @moved_piece_name = moved_piece_name
+      @captured_piece_name = captured_piece_name
+    end
+
+    # Commit an action to the position.
+    #
+    # @param in_hand [Array] The list of pieces in hand.
+    # @param square [Hash] The index of each piece on the board.
+    #
+    # @example Commit a Shogi action to the piece set of a position
+    #   call(
+    #     43, 13, "+B", nil,
+    #     in_hand: %w[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],
+    #     square: {
+    #        3 => "s",
+    #        4 => "k",
+    #        5 => "s",
+    #       22 => "+P",
+    #       43 => "+B"
+    #     }
+    #   )
+    #   # => {:in_hand=>["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"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
+    #
+    # @return [Hash] The next piece set.
+    def call(in_hand:, square:)
+      in_hand = in_hand.dup
+      square = square.dup
+
+      if @src_square_id.nil?
+        piece_in_hand_id = in_hand.index(@moved_piece_name)
+        in_hand.delete_at(piece_in_hand_id) unless piece_in_hand_id.nil?
+      else
+        square.delete(@src_square_id)
+      end
+
+      square[@dst_square_id] = @moved_piece_name
+      in_hand.push(@captured_piece_name) unless @captured_piece_name.nil?
+
+      { in_hand: in_hand, square: square }
+    end
+  end
+end

data/lib/qi/move.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "action"
+
+module Qi
+  # The Move abstraction.
+  class Move
+    # Initialize a move instance.
+    #
+    # @param move [Array] The move to apply.
+    #
+    # @example Initialize a promoted bishop move from 43 to 13
+    #   new([43, 13, "+B"])
+    #
+    # @see https://developer.sashite.com/specs/portable-move-notation
+    def initialize(move)
+      @actions = move.each_slice(4)
+    end
+
+    # Apply a move to the piece set of a position.
+    #
+    # @param in_hand [Array] The list of pieces in hand.
+    # @param square [Hash] The index of each piece on the board.
+    #
+    # @example Apply a move to a classic Shogi problem
+    #   call(
+    #     [43, 13, "+B"],
+    #     in_hand: %w[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],
+    #     square: {
+    #        3 => "s",
+    #        4 => "k",
+    #        5 => "s",
+    #       22 => "+P",
+    #       43 => "+B"
+    #     }
+    #   )
+    #   # => {:in_hand=>["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"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
+    #
+    # @return [Hash] The piece set of the next position.
+    def call(in_hand:, square:)
+      @actions.inject(in_hand: in_hand, square: square) do |piece_set, attrs|
+        Action.new(*attrs).call(**piece_set)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 9.0.0.beta2
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +159,8 @@ files:
 - LICENSE.md
 - README.md
 - lib/qi.rb
-- lib/qi/position.rb
+- lib/qi/action.rb
+- lib/qi/move.rb
 homepage: https://developer.sashite.com/specs/
 licenses:
 - MIT
@@ -125,7 +168,7 @@ metadata:
   bug_tracker_uri: https://github.com/sashite/qi.rb/issues
   documentation_uri: https://rubydoc.info/gems/qi/index
   source_code_uri: https://github.com/sashite/qi.rb
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,15 +176,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+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,182 +0,0 @@
-# frozen_string_literal: true
-
-module Qi
-  # The position class.
-  #
-  # @see https://developer.sashite.com/specs/portable-chess-notation
-  class Position
-    # Players are identified by a number according to the order in which they
-    #   traditionally play from the starting position.
-    #
-    # @!attribute [r] active_side_id
-    #   @return [Integer] The identifier of the player who must play.
-    attr_reader :active_side_id
-
-    # The list of pieces in hand owned by players.
-    #
-    # @!attribute [r] pieces_in_hand_grouped_by_sides
-    #   @return [Array] The list of pieces in hand for each side.
-    attr_reader :pieces_in_hand_grouped_by_sides
-
-    # The list of squares on the board.
-    #
-    # @!attribute [r] squares
-    #   @return [Array] The list of squares on the board.
-    attr_reader :squares
-
-    # Initialize a position.
-    #
-    # @param squares [Array] The list of squares on the board.
-    # @param active_side_id [Integer] The identifier of the player who must play.
-    # @param pieces_in_hand_grouped_by_sides [Array] The list of pieces in hand
-    #   grouped by players.
-    #
-    # @example Chess's starting position
-    #   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,
-    #     "♙", "♙", "♙", "♙", "♙", "♙", "♙", "♙",
-    #     "♖", "♘", "♗", "♕", "♔", "♗", "♘", "♖"
-    #   )
-    #
-    # @example Four-player chess's starting position
-    #   Position.new(
-    #     nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
-    #     nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
-    #     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-    #     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-    #     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-    #     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-    #     "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
-    #     "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
-    #     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
-    #     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
-    #     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
-    #     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
-    #     nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
-    #     nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil ,
-    #     pieces_in_hand_grouped_by_sides: [
-    #       [],
-    #       [],
-    #       [],
-    #       []
-    #     ]
-    #   )
-    #
-    # @example Makruk's starting position
-    #   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,
-    #     "♖", "♘", "♗", "♔", "♕", "♗", "♘", "♖"
-    #   )
-    #
-    # @example 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"
-    #   )
-    #
-    # @example A classic Tsume Shogi problem
-    #   Position.new(
-    #     nil, nil, nil, "s", "k", "s", nil, nil, nil,
-    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     nil, nil, nil, nil, "+P", nil, nil, nil, nil,
-    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     nil, nil, nil, nil, nil, nil, nil, "+B", 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,
-    #     pieces_in_hand_grouped_by_sides: [
-    #       ["S"],
-    #       ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s"]
-    #     ]
-    #   )
-    #
-    # @example Xiangqi's starting position
-    #   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,
-    #     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"
-    #   )
-    def initialize(*squares, active_side_id: 0, pieces_in_hand_grouped_by_sides: [[], []])
-      @squares = squares
-      @active_side_id = active_side_id % pieces_in_hand_grouped_by_sides.size
-      @pieces_in_hand_grouped_by_sides = pieces_in_hand_grouped_by_sides
-
-      freeze
-    end
-
-    # Apply a move to the position.
-    #
-    # @param move [Array] The move to play.
-    # @see https://developer.sashite.com/specs/portable-move-notation
-    # @see https://github.com/sashite/pmn.rb
-    #
-    # @return [Position] The new position.
-    def call(move)
-      updated_squares = squares.dup
-      updated_in_hand_pieces = 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?
-          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_squares[src_square_id] = nil
-        end
-
-        updated_squares[dst_square_id] = moved_piece_name
-
-        unless captured_piece_name.nil?
-          updated_in_hand_pieces.push(captured_piece_name)
-        end
-      end
-
-      updated_pieces_in_hand_grouped_by_sides = pieces_in_hand_grouped_by_sides.dup
-      updated_pieces_in_hand_grouped_by_sides[active_side_id] = updated_in_hand_pieces
-
-      self.class.new(*updated_squares,
-        active_side_id: active_side_id.succ,
-        pieces_in_hand_grouped_by_sides: updated_pieces_in_hand_grouped_by_sides
-      )
-    end
-
-    # The list of pieces in hand owned by the current player.
-    #
-    # @return [Array] The list of pieces in hand of the active side.
-    def in_hand_pieces
-      pieces_in_hand_grouped_by_sides.fetch(active_side_id)
-    end
-  end
-end