qi 7.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18ca7bb7fca15a8ce854e8a205160b05a14127970039a904c3ce8ad6f8baf8fc
-  data.tar.gz: fc4b915c93488f39835f762b1f89fb44a74ab25ca3faa47fb4a6ea846db66c77
+  metadata.gz: 52024f72e11787560aa6fc8bed990c359e49d3e995f2d3cfea875de5febaeba5
+  data.tar.gz: d04a6301684f284f29aa1b67c811ca596006a6aa0f33e22d1c67790da55418ef
 SHA512:
-  metadata.gz: 6079a5cb3f9b5b83a5bbc0db41694e6037a46a8e5ef6ce8bd4e65f36863d17008cb5d08d806681c4b17daff89ef2d43abd4e260c4ba068b7ac499fe51a36053c
-  data.tar.gz: 164bb2211d24d9119061a9c771438d0b77f96c0e2d51d4f18c3cfe3f82acdeaf50bd532d4eafb071441a64a18be68cefc9bae9a6dcfcf81b633cf3498912e76c
+  metadata.gz: e9afd43466c2ea7b6608d0f94996bffd40622fa2ff98bc008098c78375074c4ae8c6e12235520053a35619fca22b3588ccc120d06910f9b8af10cf349273af6c
+  data.tar.gz: 4264fd4ff0e12bc86b1451b1a411bea1e700cb58581f87e0216a0b601bd26c2443e144c44ddb765e8e6428ae0bdc2f406342248851a5c36c9f9c00494c8c1253

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,9 +1,10 @@
 # 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 updating positions of chess variants (including Chess, Janggi, Markruk, Shogi, Xiangqi), with a move.
 
@@ -17,33 +18,33 @@ gem "qi"
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install qi
+```sh
+gem install qi
+```
 
-## Examples
+## Example
 
 ```ruby
 require "qi"
 
 Qi.call(
-  [43, 13, "+B"],
-  "side_id": 0,
-  "board": {
-     3 => "s",
-     4 => "k",
-     5 => "s",
+  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"
-  },
-  "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"]]}
+# => {: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"}}
 ```
 
 ## License
@@ -55,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/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.rb

@@ -1,84 +1,53 @@
 # frozen_string_literal: true
 
+require_relative File.join("qi", "action")
+
 # The Qi abstraction.
 #
-# @example
+# @example Apply a move to a classic Shogi problem
 #   Qi.call(
-#     [43, 13, "+B"],
-#     "side_id": 0,
-#     "board": {
+#     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"
-#     },
-#     "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"]]}
+#   # => {: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.
+  # Apply an action 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.
+  # @param src_square_id [Integer] A source square index.
+  # @param dst_square_id [Integer] A target square index.
+  # @param moved_piece_name [String] A piece name.
+  # @param captured_piece_name [String] A captured piece name.
+  # @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
+  # @example Apply a move to a classic Shogi problem
   #   call(
-  #     [43, 13, "+B"],
-  #     "side_id": 0,
-  #     "board": {
+  #     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"
-  #     },
-  #     "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"]]}
+  #   # => {: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 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
-
-      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
-    }
+  # @return [Hash] The piece set of the next position.
+  def self.call(src_square_id, dst_square_id, moved_piece_name, captured_piece_name = nil, in_hand:, square:)
+    Action.new(src_square_id, dst_square_id, moved_piece_name, captured_piece_name).call(in_hand: in_hand, square: square)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2021-09-26 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,6 +159,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/qi.rb
+- lib/qi/action.rb
 homepage: https://developer.sashite.com/specs/
 licenses:
 - MIT
@@ -124,7 +167,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
@@ -132,15 +175,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Update positions with a move.
 test_files: []