sashite-hand 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a34e61b9b036899e230483af790988ca1ee15a47d046e75422158062a1f8688
-  data.tar.gz: 2f40ad92442b907e0385ccae4363bfe3c3aad561b2b94264b8456f3623eda193
+  metadata.gz: eac13e6189d9a6dd0afa046f1006b4e995770e6fac93105b4aa43cce3d529054
+  data.tar.gz: 7df2d9305c61869e5fb34de71e1aa8940174961a7ed251d2313554df695468bf
 SHA512:
-  metadata.gz: f18bec432f3ab88e64957c17400c317e7f1068b247fa04f5b26d682ca3601c4d892e647406a9c0afb90cf04bb60d67cfc72a262323335587b3629e5d7c4b2445
-  data.tar.gz: a3891d91130f6b7fb78767d049b6e543ce4ccc6eb49fb93a4a56ec9a6eea1f4401bf3a2b86e59f7164043fe5d91c763abb7f4dce19e68ee9aa267cf33993c0ef
+  metadata.gz: bc94d68099e9ba77d3d260156c2e1f2252c578083920cf4228be4e83c3fd51a072aa3c59c7a7765a6f852863a3a2051004d6aea8813d17f82a505fccf0a04084
+  data.tar.gz: 2c8a20b522accc9ba9bcdb20ae654947b3df712f13021f84fd017017d75931c30672f81620e6cdd0656b9a0b6de675ed000c92fb72f4db4c62013290e1735bc1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025-2026 Cyril Kato
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,17 +1,15 @@
-# Hand.rb
+# hand.rb
 
 [![Version](https://img.shields.io/github/v/tag/sashite/hand.rb?label=Version&logo=github)](https://github.com/sashite/hand.rb/tags)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/sashite/hand.rb/main)
-![Ruby](https://github.com/sashite/hand.rb/actions/workflows/main.yml/badge.svg?branch=main)
-[![License](https://img.shields.io/github/license/sashite/hand.rb?label=License&logo=github)](https://github.com/sashite/hand.rb/raw/main/LICENSE.md)
+[![CI](https://github.com/sashite/hand.rb/actions/workflows/ruby.yml/badge.svg?branch=main)](https://github.com/sashite/hand.rb/actions)
+[![License](https://img.shields.io/github/license/sashite/hand.rb)](https://github.com/sashite/hand.rb/blob/main/LICENSE)
 
-> **HAND** (Hold And Notation Designator) implementation for the Ruby language.
+> **HAND** (Hold And Notation Designator) implementation for Ruby.
 
-## What is HAND?
+## Overview
 
-HAND (Hold And Notation Designator) is a standardized notation for representing piece reserve locations in board games where pieces can be held off-board and potentially placed. This applies to games like Shōgi, Crazyhouse, Go, and other games featuring reserve mechanics.
-
-This gem implements the [HAND Specification v1.0.0](https://sashite.dev/specs/hand/1.0.0/), providing a minimalist Ruby interface using a single character: `*` (asterisk).
+This library implements the [HAND Specification v1.0.0](https://sashite.dev/specs/hand/1.0.0/).
 
 ## Installation
 
@@ -28,89 +26,108 @@ gem install sashite-hand
 
 ## Usage
 
+### Parsing (String → Symbol)
+
+Convert a HAND string into a symbol.
+
 ```ruby
 require "sashite/hand"
 
-# Check if a location represents the reserve
-Sashite::Hand.reserve?("*")    # => true
-Sashite::Hand.reserve?("a1")   # => false
-Sashite::Hand.reserve?("**")   # => false
+# Standard parsing (raises on error)
+Sashite::Hand.parse("*")  # => :"*"
 
-# Get the canonical representation
-Sashite::Hand.to_s # => "*"
+# Invalid input raises ArgumentError
+Sashite::Hand.parse("e4")  # => raises ArgumentError
+Sashite::Hand.parse("")    # => raises ArgumentError
 ```
 
-### Movement Notation Examples
+### Validation
 
 ```ruby
-# From reserve to board
-source = "*"
-destination = "e4"
-puts "#{source} → #{destination}" # => "* → e4"
-
-# Shōgi piece drop
-puts "Dropping piece from reserve to 5e" if Sashite::Hand.reserve?("*")
-
-# Go stone placement
-supply = "*"
-puts "Placing stone from supply to dd" if Sashite::Hand.reserve?(supply)
+# Boolean check
+Sashite::Hand.valid?("*")  # => true
+Sashite::Hand.valid?("e4") # => false
+Sashite::Hand.valid?("")   # => false
 ```
 
-## Integration with CELL
-
-HAND complements the [CELL specification](https://sashite.dev/specs/cell/) for complete location coverage:
+### Using the Notation Constant
 
 ```ruby
-def valid_location?(location)
-  Sashite::Cell.valid?(location) || Sashite::Hand.reserve?(location)
-end
+# Access the HAND notation symbol
+Sashite::Hand::NOTATION # => :"*"
 
-valid_location?("*")  # => true (reserve)
-valid_location?("a1") # => true (board position)
+# Convert to string when needed
+Sashite::Hand::NOTATION.to_s # => "*"
 ```
 
 ## API Reference
 
-### Methods
-
-- `Sashite::Hand.reserve?(location)` - Check if location represents the reserve
-- `Sashite::Hand.to_s` - Get the canonical HAND representation (`"*"`)
-
 ### Constants
 
-- `Sashite::Hand::RESERVE` - The reserve location character (`"*"`)
+```ruby
+Sashite::Hand::NOTATION # => :"*"
+```
 
-## Properties
+### Parsing
 
-* **Minimalist**: Single character (`*`) for all reserve operations
-* **Universal**: Works across different board game systems
-* **Rule-agnostic**: Independent of specific reserve mechanics
-* **Complementary**: Designed to work with CELL coordinates
+```ruby
+# Parses a HAND string into a symbol.
+# Raises ArgumentError if the string is not valid.
+#
+# @param input [String] HAND notation string
+# @return [Symbol] the :"*" symbol
+# @raise [ArgumentError] if invalid
+def Sashite::Hand.parse(input)
+```
 
-## Protocol Mapping
+### Validation
 
-Following the [Game Protocol](https://sashite.dev/game-protocol/):
+```ruby
+# Validates a HAND string.
+# Raises ArgumentError with descriptive message if invalid.
+#
+# @param input [String] HAND notation string
+# @return [nil]
+# @raise [ArgumentError] if invalid
+def Sashite::Hand.validate(input)
+
+# Reports whether string is a valid HAND notation.
+#
+# @param input [String] HAND notation string
+# @return [Boolean]
+def Sashite::Hand.valid?(input)
+```
 
-| Protocol Attribute | HAND Encoding | Meaning |
-|-------------------|---------------|---------|
-| **Location** | `*` | Any off-board reserve area |
+### Errors
 
-## Related Specifications
+All parsing and validation errors raise `ArgumentError` with descriptive messages:
 
-- [CELL](https://sashite.dev/specs/cell/) - Board position coordinates
-- [GGN](https://sashite.dev/specs/ggn/) - Movement possibility rules
-- [PMN](https://sashite.dev/specs/pmn/) - Portable Move Notation
+| Message | Cause |
+|---------|-------|
+| `"invalid hand notation"` | Input is not exactly `*` |
 
-## Documentation
+```ruby
+begin
+  Sashite::Hand.parse("**")
+rescue ArgumentError => e
+  puts e.message # => "invalid hand notation"
+end
+```
 
-- [Official HAND Specification v1.0.0](https://sashite.dev/specs/hand/1.0.0/)
-- [Game Protocol Foundation](https://sashite.dev/game-protocol/)
-- [API Documentation](https://rubydoc.info/github/sashite/hand.rb/main)
+## Design Principles
 
-## License
+- **Symbol-based**: Notation represented as Ruby symbol for identity semantics
+- **Minimal**: Single constant and three methods
+- **Ruby idioms**: `valid?` predicate, `parse` conversion
+- **Strict validation**: Only the `*` character is accepted
+- **No dependencies**: Pure Ruby standard library only
 
-Available as open source under the [MIT License](https://opensource.org/licenses/MIT).
+## Related Specifications
 
-## About
+- [Game Protocol](https://sashite.dev/game-protocol/) — Conceptual foundation
+- [HAND Specification](https://sashite.dev/specs/hand/1.0.0/) — Official specification
+- [CELL Specification](https://sashite.dev/specs/cell/1.0.0/) — Complementary notation for Board squares
+
+## License
 
-Maintained by [Sashité](https://sashite.com/) — promoting chess variants and sharing the beauty of board game cultures.
+Available as open source under the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).

data/lib/sashite/hand.rb

@@ -1,44 +1,63 @@
 # frozen_string_literal: true
 
 module Sashite
-  # HAND (Hold And Notation Designator) implementation
+  # HAND (Hold And Notation Designator) implementation.
   #
-  # HAND defines a simple, standardized notation for piece reserve locations
-  # in board games where pieces can be held off-board and potentially placed.
+  # Provides parsing and validation of HAND notation for off-board
+  # reserve locations in board games.
   #
-  # @see https://sashite.dev/specs/hand/1.0.0/
-  # @author Sashité
+  # @example Parsing a notation
+  #   Sashite::Hand.parse("*") # => :"*"
+  #
+  # @example Validation
+  #   Sashite::Hand.valid?("*")  # => true
+  #   Sashite::Hand.valid?("e4") # => false
   #
-  # @example Basic usage
-  #   Sashite::Hand.reserve?("*")     # => true
-  #   Sashite::Hand.reserve?("a1")    # => false
-  #   Sashite::Hand.to_s              # => "*"
+  # @see https://sashite.dev/specs/hand/1.0.0/
   module Hand
-    # The reserve location character
-    RESERVE = "*"
+    # The HAND notation symbol representing an off-board reserve location.
+    NOTATION = :"*"
+
+    # Error message for invalid input.
+    ERROR_MESSAGE = "invalid hand notation"
+
+    # Parses a HAND string into a symbol.
+    #
+    # @param input [String] HAND notation string
+    # @return [Symbol] the :"*" symbol
+    # @raise [ArgumentError] if the string is not valid HAND notation
+    #
+    # @example
+    #   Sashite::Hand.parse("*")   # => :"*"
+    #   Sashite::Hand.parse("e4")  # => raises ArgumentError
+    def self.parse(input)
+      validate(input)
+      NOTATION
+    end
 
-    # Check if a string represents the reserve location
+    # Validates a HAND string.
     #
-    # @param string [String] the string to check
-    # @return [Boolean] true if the string is the reserve location
+    # @param input [String] HAND notation string
+    # @return [nil]
+    # @raise [ArgumentError] if the string is not valid HAND notation
     #
     # @example
-    #   Sashite::Hand.reserve?("*")   # => true
-    #   Sashite::Hand.reserve?("a1")  # => false
-    #   Sashite::Hand.reserve?("**")  # => false
-    #   Sashite::Hand.reserve?("")    # => false
-    def self.reserve?(string)
-      RESERVE.eql?(string)
+    #   Sashite::Hand.validate("*")   # => nil
+    #   Sashite::Hand.validate("**")  # => raises ArgumentError
+    def self.validate(input)
+      raise ::ArgumentError, ERROR_MESSAGE unless valid?(input)
     end
 
-    # Get the canonical HAND representation
+    # Reports whether string is a valid HAND notation.
     #
-    # @return [String] the reserve location character
+    # @param input [String] HAND notation string
+    # @return [Boolean] true if valid, false otherwise
     #
     # @example
-    #   Sashite::Hand.to_s            # => "*"
-    def self.to_s
-      RESERVE
+    #   Sashite::Hand.valid?("*")  # => true
+    #   Sashite::Hand.valid?("e4") # => false
+    def self.valid?(input)
+      input == NOTATION.to_s
     end
   end
 end

data/lib/sashite-hand.rb

@@ -1,9 +1,3 @@
 # frozen_string_literal: true
 
-# Sashité namespace
-module Sashite
-  # @see https://sashite.dev/documents/hand/1.0.0/ HAND Specification v1.0.0
-  # @author Sashité
-end
-
 require_relative "sashite/hand"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sashite-hand
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Cyril Kato
@@ -17,19 +17,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.md
+- LICENSE
 - README.md
 - lib/sashite-hand.rb
 - lib/sashite/hand.rb
 homepage: https://github.com/sashite/hand.rb
 licenses:
-- MIT
+- Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/sashite/hand.rb/issues
   documentation_uri: https://rubydoc.info/github/sashite/hand.rb/main
   homepage_uri: https://github.com/sashite/hand.rb
   source_code_uri: https://github.com/sashite/hand.rb
   specification_uri: https://sashite.dev/specs/hand/1.0.0/
+  wiki_uri: https://sashite.dev/specs/hand/1.0.0/examples/
+  funding_uri: https://github.com/sponsors/sashite
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -45,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: HAND (Hold And Notation Designator) implementation for Ruby
 test_files: []

data/LICENSE.md

@@ -1,22 +0,0 @@
-Copyright (c) 2025 Sashite
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.