qi 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea547ce94942f087213cf6a85465a231347e2cbd1805b5be7ebbe108d5cdd304
-  data.tar.gz: '00529deb18f2658355d4bf8dd6955e3bf4469047164b872dea91ff3ea61f1841'
+  metadata.gz: cee3167f3c32021191d7cb31829437f5d33c186314d8ebdeb6ce271ca25f9651
+  data.tar.gz: 2802d9e46a694d78d476251e2a194a2de725fc984e5181ff48a9c6cd9512a0e9
 SHA512:
-  metadata.gz: d46dd80b15e18ba16a3c4ea6c9d8a479e9f2f044e5b776c34c5152e80903c9e4aa806ee603c448334fdc10fcea995a710b33b30488ebf199a1c56e559065e95b
-  data.tar.gz: f905c0750db19eda558dae0e8bcab054f180f4f21997f6896426330d64f10404c8cc63b08557a4e9c0d5fd264861fe3e933a6b23be3d418851f31abe1787481d
+  metadata.gz: 34dd51e3c9179833ccebcbee0a99df78144e4a6867b30f2d9b404b166bc6f5fb039ee922b939056e2f07b80588271e94e627765622cc0e65434c1fefd402a120
+  data.tar.gz: bfbe4d8074dcf3c5a196c257f1126e29dcde90bbd0af4221a67a58cd94e93893cccd065ec058c5d3016c2fa5f39946d074f203532e9c13294459195544821b85

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 Cyril Kato
+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,6 +1,6 @@
-# Qi
+# <span lang="zh"><ruby>棋<rt>Qi</rt></ruby></span>.rb
 
-[![Build Status](https://api.travis-ci.org/sashite/qi.rb.svg?branch=master)][travis]
+[![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]
@@ -23,14 +23,14 @@ Or install it yourself as:
 
     $ gem install qi
 
-## Example
+## Examples
 
 Let's replay [The Shortest Possible Game of Shogi](https://userpages.monmouth.com/~colonel/shortshogi.html):
 
 ```ruby
 require 'qi'
 
-shogi_starting_position = Qi::Position.new(
+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',
@@ -42,6 +42,20 @@ shogi_starting_position = Qi::Position.new(
   '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' ],
@@ -52,12 +66,11 @@ moves = [
   [ nil, 13, 'G' ]
 ]
 
-last_position = moves.reduce(shogi_starting_position) do |position, move|
+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",
@@ -67,8 +80,71 @@ last_position.squares # => ["l", "n", "s", "k", nil, nil, "s", "n", "l",
                       #     "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,
+  '俥', '傌', '相', '仕', '帥', '仕', '相', '傌', '俥'
+)
+
+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
 ```
 
@@ -83,6 +159,5 @@ The `qi` gem 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/sashite/qi.rb
 [inchpages]: https://inch-ci.org/github/sashite/qi.rb
 [rubydoc]: https://rubydoc.info/gems/qi/frames

data/lib/qi/position.rb

@@ -5,10 +5,27 @@ module Qi
   #
   # @see https://developer.sashite.com/specs/portable-chess-notation
   class Position
-    attr_reader :squares, :bottomside_in_hand_pieces, :topside_in_hand_pieces
+    # 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.
@@ -79,7 +96,15 @@ module Qi
                                        topside_in_hand_pieces: updated_topside_in_hand_pieces)
     end
 
-    # The player who must play.
+    # 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?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.86.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.86.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement