qi 8.0.0 → 9.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb79c3951884c03bb69f5b570c776e6154181b2e9c780a568faeb37b079b749e
-  data.tar.gz: 180ff6505865b89be300c3f3fbdc99d1f945d49f2469e73c6c3b28ad2cedd3f0
+  metadata.gz: 80f30262bee5c02c0df18d00b03848331e9bc673980e88c1c1949f0ac6915ff7
+  data.tar.gz: eca221290986aef674784c4c2f840f8485ea89d7deb5b19075df883e05cf574a
 SHA512:
-  metadata.gz: 6e1281cc8424faee3b9be0be0842b816aa824595e3f9e62e54c0bb0949dcf1671ce942bfb47bf5ffcb78abdff03dd11de723b3dba58256570b33b83fad6545a9
-  data.tar.gz: e3b0c8103baa427ff22f770c6afc70eef6c5251fee580864c23129c264ea5534528dd365099fa9f5e4bf2b9f5d8d4762094e6bf771bab2acde4eeeeee795d680
+  metadata.gz: 5945e941761301f153d6db897b710d9548e6c3a514f1edc61222773e9cbee15f4d28e5abf7d4b85f072b2fc3dc866d07489c6e8d42aabb3c7bc38be788b70092
+  data.tar.gz: fd96cf0829d263a9374e52992c61a2b97815f3c6431bee0373080dbdde85c1d0a62eb9e414e950d0bc9ee49ff5d44594f3286ae9996aec8f2a6725dcb0a9fbcb

data/README.md

@@ -30,8 +30,8 @@ require "qi"
 
 Qi.call(
   [43, 13, "+B"],
-  *%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],
-  **{
+  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",

data/lib/qi.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+require_relative File.join("qi", "move")
+
 # The Qi abstraction.
 #
-# @example
+# @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": {
+#     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",
@@ -25,11 +27,11 @@ module Qi
   # @see https://developer.sashite.com/specs/portable-chess-notation
   # @see https://developer.sashite.com/specs/portable-move-notation
   #
-  # @example A classic Shogi problem
+  # @example Apply a move to a classic Shogi problem
   #   call(
   #     [43, 13, "+B"],
-  #     *%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],
-  #     **{
+  #     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",
@@ -39,30 +41,8 @@ module Qi
   #   )
   #   # => {: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, *in_hand, **square)
-    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 = 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?
-    end
-
-    {
-      in_hand: in_hand,
-      square: square
-    }
+  # @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

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: 8.0.0
+  version: 9.0.0.beta1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2020-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brutal
@@ -117,6 +117,8 @@ files:
 - LICENSE.md
 - README.md
 - lib/qi.rb
+- lib/qi/action.rb
+- lib/qi/move.rb
 homepage: https://developer.sashite.com/specs/
 licenses:
 - MIT
@@ -135,9 +137,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.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: