sashite-qpi 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5ed07c3a3f3a6840db662c963fdbbf9df121b2eae6af9242bc2cf0cd7e3d1a
-  data.tar.gz: 490241caa45a1f01551a6fc84b8f0b85a4a257496c0e87b08036b46885298d95
+  metadata.gz: 6174ad5c08247b566832cd22236980189b809f445cfca54ecda6f67938a8d9c5
+  data.tar.gz: 590406c9c7e14ec79fcb4b522f45b65f0872e88d1e4f3bdde849f4e912673ae6
 SHA512:
-  metadata.gz: b487054a34ae585172a78f6db44a3ed228ee7d61e0f8d6eac0faca5ea2cc0e0d9c6f600e6c85be594cb58f2f3b59aa60490edb9a1b4cb874905d983d14f024f2
-  data.tar.gz: 3c6768a42f8d1a336e594dac6267c617532f8bb310e90d638702badff7ce131c94a3306620ab57264f3f7345a679242b20f97f20534dc5848b6a9d42db0ad43c
+  metadata.gz: 343523eefe8442e27e37b7f773a54e7b11925f7125d765ae5e85cfe51b12c453c89129f788c7eced0285cd3011442880bd39b57f113aaa40e91a2ab1f946aa8c
+  data.tar.gz: 2f506015f10416d449eae6ef2fd44969c6c36ce5ec2a11ab928798a0cbc7762dda53c30a7ecfa6a8abd207999a0f1819a2115543501caef035917b6788764ac9

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Cyril Kato
+   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.

data/README.md

@@ -51,8 +51,8 @@ qpi = Sashite::Qpi.parse("C:K^")
 qpi.to_s  # => "C:K^"
 
 # Access the five Piece Identity attributes through components
-qpi.sin.style      # => :C (Piece Style)
-qpi.pin.type       # => :K (Piece Name)
+qpi.sin.abbr       # => :C (Piece Style)
+qpi.pin.abbr       # => :K (Piece Name)
 qpi.pin.side       # => :first (Piece Side)
 qpi.pin.state      # => :normal (Piece State)
 qpi.pin.terminal?  # => true (Terminal Status)
@@ -100,8 +100,8 @@ Sashite::Qpi.valid?(":K")       # => false
 qpi = Sashite::Qpi.parse("S:+R^")
 
 # Get components
-qpi.sin  # => #<Sashite::Sin::Identifier style=:S side=:first>
-qpi.pin  # => #<Sashite::Pin::Identifier type=:R state=:enhanced terminal=true>
+qpi.sin  # => #<Sashite::Sin::Identifier S>
+qpi.pin  # => #<Sashite::Pin::Identifier +R^>
 
 # Serialize components
 qpi.sin.to_s  # => "S"
@@ -117,10 +117,10 @@ All attributes come directly from the components:
 qpi = Sashite::Qpi.parse("S:+R^")
 
 # From SIN component
-qpi.sin.style  # => :S (Piece Style)
+qpi.sin.abbr  # => :S (Piece Style)
 
 # From PIN component
-qpi.pin.type       # => :R (Piece Name)
+qpi.pin.abbr       # => :R (Piece Name)
 qpi.pin.side       # => :first (Piece Side)
 qpi.pin.state      # => :enhanced (Piece State)
 qpi.pin.terminal?  # => true (Terminal Status)
@@ -165,10 +165,10 @@ qpi.with_pin(new_pin).to_s  # => "C:+Q^"
 # Transform both
 qpi.with_sin(new_sin).with_pin(new_pin).to_s  # => "S:+Q^"
 
-# Flip both components (change player)
-qpi.flip.to_s  # => "c:k^"
+# Flip PIN side (SIN unchanged)
+qpi.flip.to_s  # => "C:k^"
 
-# Native/Derived transformations
+# Native/Derived transformations (modify PIN only)
 qpi = Sashite::Qpi.parse("C:r")
 qpi.native.to_s  # => "C:R" (PIN case aligned with SIN case)
 qpi.derive.to_s  # => "C:r" (already derived, unchanged)
@@ -183,16 +183,16 @@ qpi.derive.to_s  # => "C:r" (PIN case differs from SIN case)
 ```ruby
 qpi = Sashite::Qpi.parse("C:K^")
 
-# Transform SIN via component
-qpi.with_sin(qpi.sin.with_style(:S)).to_s  # => "S:K^"
-
 # Transform PIN via component
-qpi.with_pin(qpi.pin.with_type(:Q)).to_s          # => "C:Q^"
-qpi.with_pin(qpi.pin.with_state(:enhanced)).to_s  # => "C:+K^"
-qpi.with_pin(qpi.pin.with_terminal(false)).to_s   # => "C:K"
+qpi.with_pin(qpi.pin.with_abbr(:Q)).to_s         # => "C:Q^"
+qpi.with_pin(qpi.pin.with_state(:enhanced)).to_s # => "C:+K^"
+qpi.with_pin(qpi.pin.with_terminal(false)).to_s  # => "C:K"
+
+# Replace SIN with new instance
+qpi.with_sin(Sashite::Sin.parse("S")).to_s  # => "S:K^"
 
 # Chain transformations
-qpi.flip.with_sin(qpi.sin.with_style(:S)).to_s  # => "s:k^"
+qpi.flip.with_sin(Sashite::Sin.parse("c")).to_s  # => "c:k^"
 ```
 
 ### Component Queries
@@ -203,13 +203,13 @@ Since QPI is a composition, use the component APIs directly:
 qpi = Sashite::Qpi.parse("S:+P^")
 
 # SIN queries (style and side)
-qpi.sin.style          # => :S
+qpi.sin.abbr           # => :S
 qpi.sin.side           # => :first
 qpi.sin.first_player?  # => true
-qpi.sin.letter         # => "S"
+qpi.sin.to_s           # => "S"
 
-# PIN queries (type, state, terminal)
-qpi.pin.type       # => :P
+# PIN queries (abbr, state, terminal)
+qpi.pin.abbr       # => :P
 qpi.pin.state      # => :enhanced
 qpi.pin.terminal?  # => true
 qpi.pin.enhanced?  # => true
@@ -219,10 +219,10 @@ qpi.pin.suffix     # => "^"
 
 # Compare QPIs via components
 other = Sashite::Qpi.parse("C:+P^")
-qpi.sin.same_style?(other.sin)  # => false (S vs C)
-qpi.pin.same_type?(other.pin)   # => true (both P)
-qpi.sin.same_side?(other.sin)   # => true (both first)
-qpi.pin.same_state?(other.pin)  # => true (both enhanced)
+qpi.sin.same_abbr?(other.sin)  # => false (S vs C)
+qpi.pin.same_abbr?(other.pin)  # => true (both P)
+qpi.sin.same_side?(other.sin)  # => true (both first)
+qpi.pin.same_state?(other.pin) # => true (both enhanced)
 ```
 
 ## API Reference
@@ -296,10 +296,10 @@ def Sashite::Qpi.valid?(string)
 def with_sin(new_sin)  # => Identifier with different SIN
 def with_pin(new_pin)  # => Identifier with different PIN
 
-# Flip transformation (transforms both components)
-def flip  # => Identifier with both SIN and PIN flipped
+# Flip transformation (modifies PIN only)
+def flip  # => Identifier with PIN side flipped
 
-# Native/Derived transformations
+# Native/Derived transformations (modify PIN only)
 def native  # => Identifier with PIN case aligned to SIN case
 def derive  # => Identifier with PIN case opposite to SIN case
 ```
@@ -323,8 +323,8 @@ QPI encodes complete **Piece Identity** as defined in the [Glossary](https://sas
 
 | Piece Attribute     | QPI Access           | Encoding                                               |
 |---------------------|----------------------|--------------------------------------------------------|
-| **Piece Style**     | `qpi.sin.style`      | SIN letter (case-insensitive identity)                 |
-| **Piece Name**      | `qpi.pin.type`       | PIN letter (case-insensitive identity)                 |
+| **Piece Style**     | `qpi.sin.abbr`       | SIN letter (case-insensitive identity)                 |
+| **Piece Name**      | `qpi.pin.abbr`       | PIN letter (case-insensitive identity)                 |
 | **Piece Side**      | `qpi.pin.side`       | PIN letter case (uppercase = first, lowercase = second)|
 | **Piece State**     | `qpi.pin.state`      | PIN modifier (`+` = enhanced, `-` = diminished)        |
 | **Terminal Status** | `qpi.pin.terminal?`  | PIN marker (`^` = terminal)                            |
@@ -336,7 +336,7 @@ Additionally, QPI provides a **Native/Derived relationship** via `native?`, `der
 - **Pure composition**: QPI composes SIN and PIN without reimplementing features
 - **Minimal API**: Core methods (`sin`, `pin`, `native?`, `derived?`, `native`, `derive`, `to_s`) plus transformations
 - **Component transparency**: Access components directly, no wrapper methods
-- **QPI-specific conveniences**: `flip`, `native`, `derive` (operations that span both components)
+- **QPI-specific conveniences**: `flip`, `native`, `derive` (operations that modify PIN only, per spec)
 - **Immutable identifiers**: Frozen instances prevent mutation
 - **Ruby idioms**: `valid?` predicate, `to_s` conversion, `ArgumentError` for invalid input
 - **No duplication**: Delegates to `sashite-sin` and `sashite-pin`

data/lib/sashite/qpi/identifier.rb

@@ -22,8 +22,8 @@ module Sashite
     #   qpi = Identifier.new(sin, pin)
     #
     # @example Accessing components
-    #   qpi.sin.style      # => :C
-    #   qpi.pin.type       # => :K
+    #   qpi.sin.abbr       # => :C
+    #   qpi.pin.abbr       # => :K
     #   qpi.pin.side       # => :first
     #   qpi.pin.state      # => :normal
     #   qpi.pin.terminal?  # => true
@@ -181,15 +181,22 @@ module Sashite
         self.class.new(sin, new_pin)
       end
 
-      # Returns a new Identifier with both components flipped.
+      # Returns a new Identifier with PIN side flipped.
       #
-      # @return [Identifier] A new Identifier with both SIN and PIN flipped
+      # The SIN component remains unchanged. This reflects the QPI specification
+      # constraint that SIN (Player Style + Player Side) is stable within a Match,
+      # while PIN side (Piece Side) may change via Mutation.
+      #
+      # @return [Identifier] A new Identifier with PIN side flipped
       #
       # @example
       #   qpi = Identifier.new(Sin.parse("C"), Pin.parse("K^"))
-      #   qpi.flip.to_s  # => "c:k^"
+      #   qpi.flip.to_s  # => "C:k^"
+      #
+      #   qpi = Identifier.new(Sin.parse("c"), Pin.parse("r"))
+      #   qpi.flip.to_s  # => "c:R"
       def flip
-        self.class.new(sin.flip, pin.flip)
+        self.class.new(sin, pin.flip)
       end
 
       # ========================================================================

data/lib/sashite/qpi.rb

@@ -39,8 +39,8 @@ module Sashite
   # == Examples
   #
   #   qpi = Sashite::Qpi.parse("C:K^")
-  #   qpi.sin.style      # => :C
-  #   qpi.pin.type       # => :K
+  #   qpi.sin.abbr       # => :C
+  #   qpi.pin.abbr       # => :K
   #   qpi.pin.side       # => :first
   #   qpi.pin.state      # => :normal
   #   qpi.pin.terminal?  # => true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sashite-qpi
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Cyril Kato
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: sashite-sin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 description: QPI (Qualified Piece Identifier) implementation for Ruby. Provides a
   rule-agnostic format for complete piece identification in abstract strategy board
   games by combining SIN and PIN primitives, with Native/Derived relationship support.