qi 5.1.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b71cc8f8f8249bea5ddb1b585a4fa0d114641ff9
-  data.tar.gz: 50c20bbcc0cce557118d7c805280b1e006b1976f
+SHA256:
+  metadata.gz: 9def332500b0191148a3261cbf17fb9a1a737d46a54366e1f680ee9b924dd2f4
+  data.tar.gz: f9eabe8017a92934537d5a4763a74f0c18a0f3437f4e7a7e417ae18bf420eb8d
 SHA512:
-  metadata.gz: b0ca154a36dfb588f6a29b3e092e62cd21a7feb1d4b5fe46ca4101fb7018afa84d35c6449e3d1071159658a90397a4643e607e39c94fa0d0e7f863cbf2daf784
-  data.tar.gz: f13fbe0ba4b0a1d80267fc5747e40aa78ab41031709cb7b627ddf39a6c6b7942add34a16e38e2f54975fe4fe95bbee3e8f7141df0545b1c7ba0ced6adcb82efb
+  metadata.gz: 665e3b706f9b8652ff8280652c6ae808b9b968a1ea6e17603bdd27cbb8d43332b6ed532ebf153a192a5cd6049f8a1cbacdaaccd86824054a0583669e2903c127
+  data.tar.gz: e10b2f9376a1d8cd1706b4998f35cb0ef2f9180f9014ccf5193c69e8fbc11d40bfa5a61e9d27c0659c7447c032a884d231f51f92776c01d14a8ef5d6aa782605

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Cyril Wack
+Copyright (c) 2015-2020 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,24 +1,19 @@
-# Qi
+# Qi.rb
 
-[![Build Status](https://travis-ci.org/cyril/qi.rb.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/cyril/qi.rb/badges/gpa.svg)][codeclimate]
+[![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](http://inch-ci.org/github/cyril/qi.rb.svg?branch=master)][inchpages]
-[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+[![Inline docs](https://inch-ci.org/github/sashite/qi.rb.svg?branch=master)][inchpages]
+[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
 
-> An ordered store of stuff to manage, for Ruby.
-
-## Rubies
-
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](http://rubini.us/)
-* [JRuby](http://jruby.org/)
+> `Qi` (棋) is an abstraction for initializing and updating positions of chess variants (including Chess, Janggi, Markruk, Shogi, Xiangqi).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'qi'
+```ruby
+gem "qi"
+```
 
 And then execute:
 
@@ -28,36 +23,331 @@ Or install it yourself as:
 
     $ gem install qi
 
-## Example
+## 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
+```
+
+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'
+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,
+#     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
 
-db = Qi::Store.new(8)       # => #<Qi::Store:0x007fb79f09b8d0 @size=8, @captured=nil, @position={}>
+last_position.pieces_in_hand_grouped_by_sides
+# => [[], []]
 
-result = db.call(2, 3, 'p') # => #<Qi::Store:0x007fb79f091150 @size=8, @captured=nil, @position={3=>"p"}>
-result.to_a                 # => [nil, nil, nil, "p", nil, nil, nil, nil]
-result.captured             # => nil
+last_position.active_side_id
+# => 1
 ```
 
-## Versioning
+Let's do some moves on a [Four-player chess](https://en.wikipedia.org/wiki/Four-player_chess) board:
 
-__Qi__ follows [Semantic Versioning 2.0](http://semver.org/).
+```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: [
+    [],
+    [],
+    [],
+    []
+  ]
+)
+
+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" ]
+]
 
-## Contributing
+last_position = moves.reduce(starting_position) do |position, move|
+  position.call(move)
+end
 
-1. [Fork it](https://github.com/cyril/qi.rb/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+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
+```
 
 ## License
 
-See `LICENSE.md` file.
+The code is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## About Sashite
+
+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
-[travis]: https://travis-ci.org/cyril/qi.rb
-[codeclimate]: https://codeclimate.com/github/cyril/qi.rb
-[inchpages]: http://inch-ci.org/github/cyril/qi.rb
-[rubydoc]: http://rubydoc.info/gems/qi/frames
+[inchpages]: https://inch-ci.org/github/sashite/qi.rb
+[rubydoc]: https://rubydoc.info/gems/qi/frames

data/lib/qi.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
+# The Qi module.
 module Qi
 end
 
-require_relative File.join 'qi', 'store'
+require_relative "qi/position"

data/lib/qi/position.rb

@@ -0,0 +1,181 @@
+# 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 of on the board.
+    #
+    # @!attribute [r] squares
+    #   @return [Array] The list of squares.
+    attr_reader :squares
+
+    # Initialize a position.
+    #
+    # @param squares [Array] The list of squares of 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.length
+      @pieces_in_hand_grouped_by_sides = pieces_in_hand_grouped_by_sides
+
+      freeze
+    end
+
+    # Apply a move in PMN (Portable Move Notation) format.
+    #
+    # @param move [Array] The move to play.
+    # @see https://developer.sashite.com/specs/portable-move-notation
+    # @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)
+        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.next,
+        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] Topside's pieces in hand if turn to topside, bottomside's
+    #   ones otherwise.
+    def in_hand_pieces
+      pieces_in_hand_grouped_by_sides.fetch(active_side_id)
+    end
+  end
+end

metadata

@@ -1,132 +1,130 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: brutal
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: fix
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: An ordered store of stuff to manage, for Ruby.
-email:
-- contact@cyril.email
+        version: '0'
+description: Instantiate PCN's positions and apply PMN's moves.
+email: contact@cyril.email
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
-- VERSION.semver
-- bin/console
-- bin/setup
-- checksum/qi-3.0.0.gem.sha512
-- checksum/qi-3.0.1.gem.sha512
-- checksum/qi-3.0.2.gem.sha512
-- checksum/qi-4.0.0.gem.sha512
-- checksum/qi-5.0.0.gem.sha512
-- fix/store_fix.rb
-- fix/support/coverage.rb
 - lib/qi.rb
-- lib/qi/store.rb
-- pkg_checksum
-- qi.gemspec
-homepage: https://github.com/cyril/qi.rb
+- lib/qi/position.rb
+homepage: https://developer.sashite.com/specs/
 licenses:
 - MIT
-metadata: {}
+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: 
 rdoc_options: []
 require_paths:
@@ -142,9 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Store to manage ordered stuff.
+summary: Represent positions and play moves.
 test_files: []

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.ruby-version
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-script: 'bundle exec rake test:coverage --trace'
-before_install:
-  - gem install bundler
-rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - ruby-head
-  - jruby
-  - jruby-head
-  - rbx-2

data/.yardopts

@@ -1 +0,0 @@
-- README.md

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,21 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
-  t.pattern = File.join('fix', '**', '*_fix.rb')
-end
-
-namespace :test do
-  task :coverage do
-    ENV['COVERAGE'] = 'true'
-    Rake::Task['test'].invoke
-  end
-end
-
-task(:doc_stats) { ruby '-S yard stats' }
-task default: %i[test doc_stats]

data/VERSION.semver

@@ -1 +0,0 @@
-5.1.0

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'qi'
-
-require 'irb'
-IRB.start

data/bin/setup

@@ -1,5 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install

data/checksum/qi-3.0.0.gem.sha512

@@ -1 +0,0 @@
-7a4d1c15b8214a9eb475ed919ac4fcaf4b3a9aab5936b1522cbb801b243a649f95d23f42584c0fbad7f4a2ab71efaab9e6b030496a2f7471c74f74986e0e620d

data/checksum/qi-3.0.1.gem.sha512

@@ -1 +0,0 @@
-03a1a4eb9f239b817fcab338c15c652a47183c0d58a63c505df1f6a7011ef0d9f2c94bb51f25c5ac455536b5f649dcbaa7087c6033ffe35c4acf5265efa0f853

data/checksum/qi-3.0.2.gem.sha512

@@ -1 +0,0 @@
-bacf809a9ee2de6656c3180bd7200503004cfd3017472501854a6e73cab84fc02f37c1190fabc15d3f1ff7cedbc1a0ff5bae2391f4766b2d27819a57c8713661

data/checksum/qi-4.0.0.gem.sha512

@@ -1 +0,0 @@
-957cae1db3b9f904922f3081fb482802ec8dc6867e3fc6a7d5fd8ba9c892246a53da7a7c9950464b40bd7777ed64f70aee727713292b62cc090dd68db724dcf7

data/checksum/qi-5.0.0.gem.sha512

@@ -1 +0,0 @@
-b4a7910e65556a19a74e0beffa3a00d05b38da150749ff73ea30df62aeaea2e6626a7680304a4bc62ccfd0850b6c948017e8ba4911b06adcd1162fa21b627a72

data/fix/store_fix.rb

@@ -1,53 +0,0 @@
-require_relative File.join 'support', 'coverage'
-require_relative File.join '..', 'lib', 'qi'
-require 'fix'
-
-Fix.describe Qi::Store do
-  on :new, 8 do
-    on :to_a do
-      it { MUST eql [nil, nil, nil, nil, nil, nil, nil, nil] }
-    end
-
-    on :call, 44, 3, 'p' do
-      it { MUST raise_exception ArgumentError }
-    end
-
-    on :call, 2, 444, 'p' do
-      it { MUST raise_exception ArgumentError }
-    end
-
-    on :captured do
-      it { MUST be_nil }
-    end
-
-    on :call, 2, 3, 'p' do
-      on :to_a do
-        it { MUST eql [nil, nil, nil, 'p', nil, nil, nil, nil] }
-      end
-
-      on :captured do
-        it { MUST be_nil }
-      end
-
-      on :call, 2, 4, 'K' do
-        on :to_a do
-          it { MUST eql [nil, nil, nil, 'p', 'K', nil, nil, nil] }
-        end
-
-        on :captured do
-          it { MUST be_nil }
-        end
-
-        on :call, 3, 4, 'p' do
-          on :to_a do
-            it { MUST eql [nil, nil, nil, nil, 'p', nil, nil, nil] }
-          end
-
-          on :captured do
-            it { MUST eql 'K' }
-          end
-        end
-      end
-    end
-  end
-end

data/fix/support/coverage.rb

@@ -1,3 +0,0 @@
-require 'simplecov'
-
-SimpleCov.start

data/lib/qi/store.rb

@@ -1,41 +0,0 @@
-module Qi
-  class Store
-    attr_reader :size, :captured, :position
-
-    def initialize(size, captured = nil, position = {})
-      @size     = Integer(size)
-      @captured = captured
-      @position = Hash(position).compact
-    end
-
-    def call(position_id, capture_position_id, content)
-      position_id         = Integer(position_id)
-      capture_position_id = Integer(capture_position_id)
-
-      [position_id, capture_position_id].each do |id|
-        next if range.include?(id)
-
-        raise ArgumentError, "#{id} out of range"
-      end
-
-      self.class.new(
-        size,
-        position[capture_position_id],
-        position.merge(
-          position_id         => nil,
-          capture_position_id => content
-        )
-      )
-    end
-
-    def to_a
-      range.map { |i| position[i] }
-    end
-
-    protected
-
-    def range
-      0...size
-    end
-  end
-end

data/pkg_checksum

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'digest/sha2'
-
-gemname         = :qi
-ARGV[0]         = File.read('VERSION.semver').chomp if ARGV[0].nil?
-built_gem_path  = "pkg/#{gemname}-#{ARGV[0]}.gem"
-checksum        = Digest::SHA512.new.hexdigest(File.read(built_gem_path))
-checksum_path   = "checksum/#{gemname}-#{ARGV[0]}.gem.sha512"
-
-File.open(checksum_path, 'w') { |f| f.write("#{checksum}\n") }

data/qi.gemspec

@@ -1,23 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name          = 'qi'
-  spec.version       = File.read('VERSION.semver').chomp
-  spec.authors       = ['Cyril Kato']
-  spec.email         = ['contact@cyril.email']
-
-  spec.summary       = 'Store to manage ordered stuff.'
-  spec.description   = 'An ordered store of stuff to manage, for Ruby.'
-  spec.homepage      = 'https://github.com/cyril/qi.rb'
-  spec.license       = 'MIT'
-
-  spec.files         =
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler',    '~> 1.15'
-  spec.add_development_dependency 'rake',       '~> 12.0'
-  spec.add_development_dependency 'yard',       '~> 0.9'
-  spec.add_development_dependency 'simplecov',  '~> 0.14'
-  spec.add_development_dependency 'rubocop',    '~> 0.49'
-  spec.add_development_dependency 'fix',        '~> 0.17'
-end