qi 9.0.0 → 10.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52024f72e11787560aa6fc8bed990c359e49d3e995f2d3cfea875de5febaeba5
-  data.tar.gz: d04a6301684f284f29aa1b67c811ca596006a6aa0f33e22d1c67790da55418ef
+  metadata.gz: eac5eea8bb1218d4db55138e7d80a4dcba2feb9ebe300e78235df8e558879856
+  data.tar.gz: b81aece5af901f081d598a1e40a128ebff19dca023a61385a5b46de2648a4df6
 SHA512:
-  metadata.gz: e9afd43466c2ea7b6608d0f94996bffd40622fa2ff98bc008098c78375074c4ae8c6e12235520053a35619fca22b3588ccc120d06910f9b8af10cf349273af6c
-  data.tar.gz: 4264fd4ff0e12bc86b1451b1a411bea1e700cb58581f87e0216a0b601bd26c2443e144c44ddb765e8e6428ae0bdc2f406342248851a5c36c9f9c00494c8c1253
+  metadata.gz: e4c7e2919813e59af6f4d45bde55bcb575512026a525a2994c3a62f21becbc85c5b95cecbd44a9de96cabc6c379dd92765fce6fad9c99cf21d98ef24aaa88df8
+  data.tar.gz: '0562650908ba50fd11cc086899170a69542b5d459bd49c9c4c3e189e028a33a25087dfb419d4df0e00d57e1058b7b832360d465e7ec89a86cb614013d1956ffb'

data/LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+# The MIT License
 
-Copyright (c) 2015-2021 Sashite
+Copyright (c) 2015-2023 Sashité
 
 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

@@ -6,26 +6,26 @@
 [![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.
+> `Qi` (Chinese: 棋; pinyin: _qí_) is an abstraction that could help to update positions for games like Shogi.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "qi"
+gem "qi", ">= 10.0.0.beta2"
 ```
 
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 Or install it yourself as:
 
 ```sh
-gem install qi
+gem install qi --pre
 ```
 
 ## Example
@@ -33,26 +33,21 @@ gem install qi
 ```ruby
 require "qi"
 
-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: {
-    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"}}
+captures  = %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]
+squares   = { "3": "s", "4": "k", "5": "s", "22": "+P", "43": "+B" }
+
+captures, squares = Qi(*captures, **squares).call("43": nil, "13": "+B")
+
+captures  # => ["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"]
+squares   # => {:"3"=>"s", :"4"=>"k", :"5"=>"s", :"22"=>"+P", :"13"=>"+B"}
 ```
 
 ## License
 
 The code is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## About Sashite
+## About Sashité
 
-This [gem](https://rubygems.org/gems/qi) is maintained by [Sashite](https://sashite.com/).
+This [gem](https://rubygems.org/gems/qi) is maintained by [Sashité](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/kernel.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# shareable_constant_value: none
+
+# warn_indent: true
+
+require_relative File.join("qi", "action")
+
+# The Kernel module.
+module Kernel
+  # Abstraction to build positions.
+  #
+  # @return [Array] An action to change the position.
+  #
+  # @api public
+  def Qi(*captures, **squares)
+    ::Qi::Action.new(*captures, **squares)
+  end
+end

data/lib/qi/action.rb

@@ -3,59 +3,46 @@
 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
+    CAPTURE_CHAR = "&"
+    DROP_CHAR    = "*"
+
+    # Action initializer.
+    def initialize(*captures, **squares)
+      @captures = captures
+      @squares  = squares
     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)
+    # @return [Array] An action to change the position.
+    def call(**diffs)
+      captures = @captures
+      squares  = @squares
+
+      diffs.each do |k, v|
+        case String(k)
+        when CAPTURE_CHAR
+          captures = capture(v, *captures)
+        when DROP_CHAR
+          captures = drop(v, *captures)
+        else
+          squares = squares.merge(k => v)
+        end
       end
 
-      square[@dst_square_id] = @moved_piece_name
-      in_hand.push(@captured_piece_name) unless @captured_piece_name.nil?
+      [captures, squares.compact]
+    end
+
+    private
+
+    def capture(item, *items)
+      [item] + items
+    end
 
-      { in_hand: in_hand, square: square }
+    def drop(item, *items)
+      item_id = items.index(item) || raise(::IndexError, "Piece #{item.inspect} not found!")
+      items.delete_at(item_id)
+      items
     end
   end
 end

data/lib/qi.rb

@@ -1,53 +1,7 @@
 # frozen_string_literal: true
 
-require_relative File.join("qi", "action")
+require_relative "kernel"
 
 # The Qi abstraction.
-#
-# @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: {
-#        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"}}
 module Qi
-  # Apply an action to the position.
-  #
-  # @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 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 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,156 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 10.0.0.beta2
 platform: ruby
 authors:
 - Cyril Kato
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-26 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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !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
-    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-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
-    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-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
-    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: simplecov
-  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: yard
-  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'
-description: Instantiate PCN's positions and apply PMN's moves.
+date: 2023-02-18 00:00:00.000000000 Z
+dependencies: []
+description: An abstraction that could help to update positions for games like Shogi.
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -158,16 +18,15 @@ extra_rdoc_files: []
 files:
 - LICENSE.md
 - README.md
+- lib/kernel.rb
 - lib/qi.rb
 - lib/qi/action.rb
-homepage: https://developer.sashite.com/specs/
+homepage: https://github.com/sashite/qi.rb
 licenses:
 - MIT
 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:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -175,15 +34,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.4.1
+signing_key: 
 specification_version: 4
-summary: Update positions with a move.
+summary: An abstraction that could help to update positions for games like Shogi.
 test_files: []