qi 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cee3167f3c32021191d7cb31829437f5d33c186314d8ebdeb6ce271ca25f9651
-  data.tar.gz: 2802d9e46a694d78d476251e2a194a2de725fc984e5181ff48a9c6cd9512a0e9
+  metadata.gz: 6d85f0a7a03ecc612c24bf29363b843fb88fa0572b8f74bf955eb92039314a54
+  data.tar.gz: ee40f146832333bf952ba810d1d95fafeabc8e6dc17905e39310b7c746faeb5f
 SHA512:
-  metadata.gz: 34dd51e3c9179833ccebcbee0a99df78144e4a6867b30f2d9b404b166bc6f5fb039ee922b939056e2f07b80588271e94e627765622cc0e65434c1fefd402a120
-  data.tar.gz: bfbe4d8074dcf3c5a196c257f1126e29dcde90bbd0af4221a67a58cd94e93893cccd065ec058c5d3016c2fa5f39946d074f203532e9c13294459195544821b85
+  metadata.gz: 1310f61417a533fb3c6f19350b759f1831d1b9e7afc04ac4946ac36850cd53eea5ed27942af0f9132d93871047f888217f265d6db782e2d153453ec34c4c80fd
+  data.tar.gz: a2c2ca62646b82063b132d69a2f5fc15b062500a23daa6c5953154b23c798fdbbe9c4c6d4f3406be8b01b07c9737a0570c4d6fa0c27f69021c41a4fba79abb3d

data/README.md

@@ -1,11 +1,11 @@
-# <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 initializing and updating positions of chess variants (including Chess, Janggi, Markruk, Shogi, Xiangqi).
 
 ## Installation
 
@@ -56,6 +56,7 @@ starting_position.bottomside_in_hand_pieces # => []
 starting_position.in_hand_pieces # => []
 starting_position.turn_to_topside? # => false
 
+# List of moves in Portable Move Notation (https://developer.sashite.com/specs/portable-move-notation) format.
 moves = [
   [ 56, 47, 'P' ],
   [ 3, 11, 'g' ],
@@ -150,11 +151,11 @@ last_position.turn_to_topside? # => true
 
 ## 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/position.rb

@@ -30,7 +30,31 @@ module Qi
     # @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
+    # @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 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,
@@ -42,6 +66,20 @@ module Qi
     #     nil, 'B', nil, nil, nil, nil, nil, 'R', nil,
     #     'L', 'N', 'S', 'G', 'K', 'G', 'S', 'N', 'L'
     #   )
+    #
+    # @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, is_turn_to_topside: false, bottomside_in_hand_pieces: [], topside_in_hand_pieces: [])
       @squares                    = squares
       @is_turn_to_topside         = is_turn_to_topside
@@ -53,6 +91,7 @@ module Qi
 
     # 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal