sashite-pin 2.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70bbc211cb1dd38efa9f0c39b2d0e1b0fd09c2dcf2d7ac3773719ce11786a5ac
-  data.tar.gz: cd6831f22ee3e9fd8ce559f5535bbcbb1d9ca13ba9083a9d9c1fe66d41e2eef9
+  metadata.gz: e469a5469a29de49338f5066b5b5743860459709ab2e771209d1c55ab7e7ff0d
+  data.tar.gz: 680f65379ee7ea0ead2238ed646a29ee54d673a80de7f0c54f1c56a11cf8f98f
 SHA512:
-  metadata.gz: d0808aac8a46423256ec3546a4eb71d5882d3535b4a74929680cd31f84294ffd406716565f53ef072ff35c5c1131bb2612ab93398001d3d80772bb34a3dc3d07
-  data.tar.gz: ba7ecb1765c03c801f014bdbb9792fcae5dacd8d119890b0c73f0e550a345a8fc307cb39a82b803c986ef7fa50f76ad5fff39c6a7bffc5fe39e1b06bebe6b809
+  metadata.gz: 1a4b4ce38433cdf1cd9a26baaba13fa8e48ff21676976287422ac917d3a41bc67e7eb688bf347a94cefb294542e98fa7d2bd292f923b7a8c6b66d73edfaebdd2
+  data.tar.gz: 5da68a02154b85ab6a9b1070954f14be0a4f79e11e07c54448c0aae40772e4664c2b3368067a44c8fdef5a43b122a3c868e2cc8c6df5ed52f46afa2a2b65f021

data/README.md

@@ -11,7 +11,7 @@
 
 PIN (Piece Identifier Notation) provides an ASCII-based format for representing pieces in abstract strategy board games. PIN translates piece attributes from the [Game Protocol](https://sashite.dev/game-protocol/) into a compact, portable notation system.
 
-This gem implements the [PIN Specification v1.0.0](https://sashite.dev/specs/pin/1.0.0/), providing a modern Ruby interface with immutable piece objects and functional programming principles.
+This gem implements the [PIN Specification v1.0.0](https://sashite.dev/specs/pin/1.0.0/), providing a modern Ruby interface with immutable identifier objects and functional programming principles.
 
 ## Installation
 
@@ -31,16 +31,16 @@ gem install sashite-pin
 ```ruby
 require "sashite/pin"
 
-# Parse PIN strings into piece objects
-piece = Sashite::Pin.parse("K")          # => #<Pin::Piece type=:K side=:first state=:normal>
-piece.to_s                               # => "K"
-piece.type                               # => :K
-piece.side                               # => :first
-piece.state                              # => :normal
+# Parse PIN strings into identifier objects
+identifier = Sashite::Pin.parse("K")          # => #<Pin::Identifier type=:K side=:first state=:normal>
+identifier.to_s                               # => "K"
+identifier.type                               # => :K
+identifier.side                               # => :first
+identifier.state                              # => :normal
 
-# Create pieces directly
-piece = Sashite::Pin.piece(:K, :first, :normal)    # => #<Pin::Piece type=:K side=:first state=:normal>
-piece = Sashite::Pin::Piece.new(:R, :second, :enhanced)  # => #<Pin::Piece type=:R side=:second state=:enhanced>
+# Create identifiers directly
+identifier = Sashite::Pin.identifier(:K, :first, :normal)    # => #<Pin::Identifier type=:K side=:first state=:normal>
+identifier = Sashite::Pin::Identifier.new(:R, :second, :enhanced)  # => #<Pin::Identifier type=:R side=:second state=:enhanced>
 
 # Validate PIN strings
 Sashite::Pin.valid?("K")                 # => true
@@ -48,171 +48,104 @@ Sashite::Pin.valid?("+R")                # => true
 Sashite::Pin.valid?("invalid")           # => false
 
 # State manipulation (returns new immutable instances)
-enhanced = piece.enhance                 # => #<Pin::Piece type=:K side=:first state=:enhanced>
-enhanced.to_s                            # => "+K"
-diminished = piece.diminish              # => #<Pin::Piece type=:K side=:first state=:diminished>
-diminished.to_s                          # => "-K"
+enhanced = identifier.enhance                 # => #<Pin::Identifier type=:K side=:first state=:enhanced>
+enhanced.to_s                                 # => "+K"
+diminished = identifier.diminish              # => #<Pin::Identifier type=:K side=:first state=:diminished>
+diminished.to_s                               # => "-K"
 
 # Side manipulation
-flipped = piece.flip                     # => #<Pin::Piece type=:K side=:second state=:normal>
-flipped.to_s                             # => "k"
+flipped = identifier.flip                     # => #<Pin::Identifier type=:K side=:second state=:normal>
+flipped.to_s                                  # => "k"
 
 # Type manipulation
-queen = piece.with_type(:Q)              # => #<Pin::Piece type=:Q side=:first state=:normal>
-queen.to_s                               # => "Q"
+queen = identifier.with_type(:Q)              # => #<Pin::Identifier type=:Q side=:first state=:normal>
+queen.to_s                                    # => "Q"
 
 # State queries
-piece.normal?                            # => true
-enhanced.enhanced?                       # => true
-diminished.diminished?                   # => true
+identifier.normal?                            # => true
+enhanced.enhanced?                            # => true
+diminished.diminished?                        # => true
 
 # Side queries
-piece.first_player?                      # => true
-flipped.second_player?                   # => true
+identifier.first_player?                      # => true
+flipped.second_player?                        # => true
 
 # Attribute access
-piece.letter                             # => "K"
-enhanced.prefix                          # => "+"
-piece.prefix                             # => ""
+identifier.letter                             # => "K"
+enhanced.prefix                               # => "+"
+identifier.prefix                             # => ""
 
 # Type and side comparison
 king1 = Sashite::Pin.parse("K")
 king2 = Sashite::Pin.parse("k")
 queen = Sashite::Pin.parse("Q")
 
-king1.same_type?(king2)                  # => true (both kings)
-king1.same_side?(queen)                  # => true (both first player)
-king1.same_type?(queen)                  # => false (different types)
+king1.same_type?(king2)                       # => true (both kings)
+king1.same_side?(queen)                       # => true (both first player)
+king1.same_type?(queen)                       # => false (different types)
 
 # Functional transformations can be chained
 pawn = Sashite::Pin.parse("P")
-enemy_promoted = pawn.flip.enhance       # => "+p" (second player promoted pawn)
+enemy_promoted = pawn.flip.enhance            # => "+p" (second player promoted pawn)
 ```
 
 ## Format Specification
 
 ### Structure
+
 ```
 [<state>]<letter>
 ```
 
 ### Components
 
-- **Letter** (`A-Z`, `a-z`): Represents piece type and side
-  - Uppercase: First player pieces
-  - Lowercase: Second player pieces
-- **State** (optional prefix):
-  - `+`: Enhanced state (promoted, upgraded, empowered)
-  - `-`: Diminished state (weakened, restricted, temporary)
-  - No prefix: Normal state
-
-### Regular Expression
-```ruby
-/\A[-+]?[A-Za-z]\z/
-```
+* **Letter** (`A-Z`, `a-z`): Represents piece type and side
 
-### Examples
-- `K` - First player king (normal state)
-- `k` - Second player king (normal state)
-- `+R` - First player rook (enhanced state)
-- `-p` - Second player pawn (diminished state)
+  * Uppercase: First player pieces
+  * Lowercase: Second player pieces
+* **State** (optional prefix):
 
-## Game Examples
+  * `+`: Enhanced state (promoted, upgraded, empowered)
+  * `-`: Diminished state (weakened, restricted, temporary)
+  * No prefix: Normal state
 
-### Western Chess
-```ruby
-# Standard pieces
-king = Sashite::Pin.piece(:K, :first, :normal)    # => white king
-king.first_player?                                # => true
-king.type                                         # => :K
-
-# State modifiers for special conditions
-castling_king = king.enhance                      # => castling-eligible king
-castling_king.to_s                                # => "+K"
-
-vulnerable_pawn = Sashite::Pin.piece(:P, :first, :diminished)  # => en passant vulnerable
-vulnerable_pawn.to_s                              # => "-P"
-
-# All piece types
-piece_types = [:K, :Q, :R, :B, :N, :P]
-white_pieces = piece_types.map { |type| Sashite::Pin.piece(type, :first, :normal) }
-black_pieces = white_pieces.map(&:flip)           # Convert to black pieces
-```
+### Regular Expression
 
-### Japanese Chess (Shōgi)
 ```ruby
-# Basic pieces
-rook = Sashite::Pin.piece(:R, :first, :normal)    # => white rook
-bishop = Sashite::Pin.piece(:B, :first, :normal)  # => white bishop
-
-# Promoted pieces (enhanced state)
-dragon_king = rook.enhance                        # => promoted rook (Dragon King)
-dragon_king.to_s                                  # => "+R"
-
-dragon_horse = bishop.enhance                     # => promoted bishop (Dragon Horse)
-dragon_horse.to_s                                 # => "+B"
-
-# Promoted pawn
-pawn = Sashite::Pin.piece(:P, :first, :normal)
-tokin = pawn.enhance                              # => promoted pawn (Tokin)
-tokin.to_s                                        # => "+P"
-
-# All promotable pieces can use the same pattern
-promotable_types = [:R, :B, :S, :N, :L, :P]
-promotable = promotable_types.map { |type| Sashite::Pin.piece(type, :first, :normal) }
-promoted = promotable.map(&:enhance)
+/\A[-+]?[A-Za-z]\z/
 ```
 
-### Thai Chess (Makruk)
-```ruby
-# Basic pieces
-met = Sashite::Pin.piece(:M, :first, :normal)     # => white Met (queen)
-pawn = Sashite::Pin.piece(:P, :first, :normal)    # => white Bia (pawn)
-
-# Promoted pawns
-bia_kaew = pawn.enhance                           # => promoted pawn (Bia Kaew)
-bia_kaew.to_s                                     # => "+P"
-
-# Makruk pieces
-makruk_types = [:K, :M, :R, :B, :N, :P]
-makruk_pieces = makruk_types.map { |type| Sashite::Pin.piece(type, :first, :normal) }
-```
+### Examples
 
-### Chinese Chess (Xiangqi)
-```ruby
-# Pieces with positional states
-general = Sashite::Pin.piece(:G, :first, :normal) # => red general
-flying_general = general.enhance                  # => flying general (special state)
-flying_general.to_s                               # => "+G"
-
-# Soldiers that crossed the river
-soldier = Sashite::Pin.piece(:P, :first, :normal)
-crossed_soldier = soldier.enhance                 # => soldier with enhanced movement
-crossed_soldier.to_s                              # => "+P"
-```
+* `K` - First player king (normal state)
+* `k` - Second player king (normal state)
+* `+R` - First player rook (enhanced state)
+* `-p` - Second player pawn (diminished state)
 
 ## API Reference
 
 ### Main Module Methods
 
-- `Sashite::Pin.valid?(pin_string)` - Check if string is valid PIN notation
-- `Sashite::Pin.parse(pin_string)` - Parse PIN string into Piece object
-- `Sashite::Pin.piece(type, side, state = :normal)` - Create piece instance directly
+* `Sashite::Pin.valid?(pin_string)` - Check if string is valid PIN notation
+* `Sashite::Pin.parse(pin_string)` - Parse PIN string into Identifier object
+* `Sashite::Pin.identifier(type, side, state = :normal)` - Create identifier instance directly
 
-### Piece Class
+### Identifier Class
 
 #### Creation and Parsing
-- `Sashite::Pin::Piece.new(type, side, state = :normal)` - Create piece instance
-- `Sashite::Pin::Piece.parse(pin_string)` - Parse PIN string (same as module method)
-- `Sashite::Pin::Piece.valid?(pin_string)` - Validate PIN string (class method)
+
+* `Sashite::Pin::Identifier.new(type, side, state = :normal)` - Create identifier instance
+* `Sashite::Pin::Identifier.parse(pin_string)` - Parse PIN string (same as module method)
+* `Sashite::Pin::Identifier.valid?(pin_string)` - Validate PIN string (class method)
 
 #### Attribute Access
-- `#type` - Get piece type (symbol :A to :Z, always uppercase)
-- `#side` - Get player side (:first or :second)
-- `#state` - Get state (:normal, :enhanced, or :diminished)
-- `#letter` - Get letter representation (string, case determined by side)
-- `#prefix` - Get state prefix (string: "+", "-", or "")
-- `#to_s` - Convert to PIN string representation
+
+* `#type` - Get piece type (symbol \:A to \:Z, always uppercase)
+* `#side` - Get player side (\:first or \:second)
+* `#state` - Get state (\:normal, \:enhanced, or \:diminished)
+* `#letter` - Get letter representation (string, case determined by side)
+* `#prefix` - Get state prefix (string: "+", "-", or "")
+* `#to_s` - Convert to PIN string representation
 
 #### Type and Case Handling
 
@@ -220,46 +153,52 @@ crossed_soldier.to_s                              # => "+P"
 
 ```ruby
 # Both create the same internal type representation
-piece1 = Sashite::Pin.parse("K")  # type: :K, side: :first
-piece2 = Sashite::Pin.parse("k")  # type: :K, side: :second
+identifier1 = Sashite::Pin.parse("K")  # type: :K, side: :first
+identifier2 = Sashite::Pin.parse("k")  # type: :K, side: :second
 
-piece1.type    # => :K (uppercase symbol)
-piece2.type    # => :K (same uppercase symbol)
+identifier1.type    # => :K (uppercase symbol)
+identifier2.type    # => :K (same uppercase symbol)
 
-piece1.letter  # => "K" (uppercase display)
-piece2.letter  # => "k" (lowercase display)
+identifier1.letter  # => "K" (uppercase display)
+identifier2.letter  # => "k" (lowercase display)
 ```
 
 #### State Queries
-- `#normal?` - Check if normal state (no modifiers)
-- `#enhanced?` - Check if enhanced state
-- `#diminished?` - Check if diminished state
+
+* `#normal?` - Check if normal state (no modifiers)
+* `#enhanced?` - Check if enhanced state
+* `#diminished?` - Check if diminished state
 
 #### Side Queries
-- `#first_player?` - Check if first player piece
-- `#second_player?` - Check if second player piece
+
+* `#first_player?` - Check if first player identifier
+* `#second_player?` - Check if second player identifier
 
 #### State Transformations (immutable - return new instances)
-- `#enhance` - Create enhanced version
-- `#unenhance` - Remove enhanced state
-- `#diminish` - Create diminished version
-- `#undiminish` - Remove diminished state
-- `#normalize` - Remove all state modifiers
-- `#flip` - Switch player (change side)
+
+* `#enhance` - Create enhanced version
+* `#unenhance` - Remove enhanced state
+* `#diminish` - Create diminished version
+* `#undiminish` - Remove diminished state
+* `#normalize` - Remove all state modifiers
+* `#flip` - Switch player (change side)
 
 #### Attribute Transformations (immutable - return new instances)
-- `#with_type(new_type)` - Create piece with different type
-- `#with_side(new_side)` - Create piece with different side
-- `#with_state(new_state)` - Create piece with different state
+
+* `#with_type(new_type)` - Create identifier with different type
+* `#with_side(new_side)` - Create identifier with different side
+* `#with_state(new_state)` - Create identifier with different state
 
 #### Comparison Methods
-- `#same_type?(other)` - Check if same piece type
-- `#same_side?(other)` - Check if same side
-- `#same_state?(other)` - Check if same state
-- `#==(other)` - Full equality comparison
+
+* `#same_type?(other)` - Check if same piece type
+* `#same_side?(other)` - Check if same side
+* `#same_state?(other)` - Check if same state
+* `#==(other)` - Full equality comparison
 
 ### Constants
-- `Sashite::Pin::Piece::PIN_PATTERN` - Regular expression for PIN validation (internal use)
+
+* `Sashite::Pin::Identifier::PIN_PATTERN` - Regular expression for PIN validation (internal use)
 
 ## Advanced Usage
 

data/lib/sashite/pin/{piece.rb → identifier.rb}

@@ -2,9 +2,9 @@
 
 module Sashite
   module Pin
-    # Represents a piece in PIN (Piece Identifier Notation) format.
+    # Represents an identifier in PIN (Piece Identifier Notation) format.
     #
-    # A piece consists of a single ASCII letter with optional state modifiers:
+    # An identifier consists of a single ASCII letter with optional state modifiers:
     # - Enhanced state: prefix '+'
     # - Diminished state: prefix '-'
     # - Normal state: no modifier
@@ -15,7 +15,7 @@ module Sashite
     #
     # All instances are immutable - state manipulation methods return new instances.
     # This follows the Game Protocol's piece model with Type, Side, and State attributes.
-    class Piece
+    class Identifier
       # PIN validation pattern matching the specification
       PIN_PATTERN = /\A(?<prefix>[-+])?(?<letter>[a-zA-Z])\z/
 
@@ -57,7 +57,7 @@ module Sashite
       # @return [Symbol] the piece state (:normal, :enhanced, or :diminished)
       attr_reader :state
 
-      # Create a new piece instance
+      # Create a new identifier instance
       #
       # @param type [Symbol] piece type (:A to :Z)
       # @param side [Symbol] player side (:first or :second)
@@ -75,15 +75,15 @@ module Sashite
         freeze
       end
 
-      # Parse a PIN string into a Piece object
+      # Parse a PIN string into an Identifier object
       #
       # @param pin_string [String] PIN notation string
-      # @return [Piece] new piece instance
+      # @return [Identifier] new identifier instance
       # @raise [ArgumentError] if the PIN string is invalid
       # @example
-      #   Pin::Piece.parse("k")     # => #<Pin::Piece type=:K side=:second state=:normal>
-      #   Pin::Piece.parse("+R")    # => #<Pin::Piece type=:R side=:first state=:enhanced>
-      #   Pin::Piece.parse("-p")    # => #<Pin::Piece type=:P side=:second state=:diminished>
+      #   Pin::Identifier.parse("k")     # => #<Pin::Identifier type=:K side=:second state=:normal>
+      #   Pin::Identifier.parse("+R")    # => #<Pin::Identifier type=:R side=:first state=:enhanced>
+      #   Pin::Identifier.parse("-p")    # => #<Pin::Identifier type=:P side=:second state=:diminished>
       def self.parse(pin_string)
         string_value = String(pin_string)
         matches = match_pattern(string_value)
@@ -92,18 +92,17 @@ module Sashite
         enhanced = matches[:prefix] == ENHANCED_PREFIX
         diminished = matches[:prefix] == DIMINISHED_PREFIX
 
-        # Extract type and side from letter
-        piece_type = letter.upcase.to_sym
-        piece_side = letter == letter.upcase ? FIRST_PLAYER : SECOND_PLAYER
-        piece_state = if enhanced
-                        ENHANCED_STATE
-                      elsif diminished
-                        DIMINISHED_STATE
-                      else
-                        NORMAL_STATE
-                      end
-
-        new(piece_type, piece_side, piece_state)
+        type = letter.upcase.to_sym
+        side = letter == letter.upcase ? FIRST_PLAYER : SECOND_PLAYER
+        state = if enhanced
+                  ENHANCED_STATE
+                elsif diminished
+                  DIMINISHED_STATE
+                else
+                  NORMAL_STATE
+                end
+
+        new(type, side, state)
       end
 
       # Check if a string is a valid PIN notation
@@ -112,24 +111,22 @@ module Sashite
       # @return [Boolean] true if valid PIN, false otherwise
       #
       # @example
-      #   Sashite::Pin::Piece.valid?("K")    # => true
-      #   Sashite::Pin::Piece.valid?("+R")   # => true
-      #   Sashite::Pin::Piece.valid?("-p")   # => true
-      #   Sashite::Pin::Piece.valid?("KK")   # => false
-      #   Sashite::Pin::Piece.valid?("++K")  # => false
+      #   Sashite::Pin::Identifier.valid?("K")    # => true
+      #   Sashite::Pin::Identifier.valid?("+R")   # => true
+      #   Sashite::Pin::Identifier.valid?("-p")   # => true
+      #   Sashite::Pin::Identifier.valid?("KK")   # => false
+      #   Sashite::Pin::Identifier.valid?("++K")  # => false
       def self.valid?(pin_string)
         return false unless pin_string.is_a?(::String)
 
         pin_string.match?(PIN_PATTERN)
       end
 
-      # Convert the piece to its PIN string representation
+      # Convert the identifier to its PIN string representation
       #
       # @return [String] PIN notation string
       # @example
-      #   piece.to_s  # => "+R"
-      #   piece.to_s  # => "-p"
-      #   piece.to_s  # => "K"
+      #   identifier.to_s  # => "+R"
       def to_s
         "#{prefix}#{letter}"
       end
@@ -152,76 +149,62 @@ module Sashite
         end
       end
 
-      # Create a new piece with enhanced state
+      # Create a new identifier with enhanced state
       #
-      # @return [Piece] new piece instance with enhanced state
-      # @example
-      #   piece.enhance  # (:K, :first, :normal) => (:K, :first, :enhanced)
+      # @return [Identifier] new identifier instance with enhanced state
       def enhance
         return self if enhanced?
 
         self.class.new(type, side, ENHANCED_STATE)
       end
 
-      # Create a new piece without enhanced state
+      # Create a new identifier without enhanced state
       #
-      # @return [Piece] new piece instance without enhanced state
-      # @example
-      #   piece.unenhance  # (:K, :first, :enhanced) => (:K, :first, :normal)
+      # @return [Identifier] new identifier instance with normal state
       def unenhance
         return self unless enhanced?
 
         self.class.new(type, side, NORMAL_STATE)
       end
 
-      # Create a new piece with diminished state
+      # Create a new identifier with diminished state
       #
-      # @return [Piece] new piece instance with diminished state
-      # @example
-      #   piece.diminish  # (:K, :first, :normal) => (:K, :first, :diminished)
+      # @return [Identifier] new identifier instance with diminished state
       def diminish
         return self if diminished?
 
         self.class.new(type, side, DIMINISHED_STATE)
       end
 
-      # Create a new piece without diminished state
+      # Create a new identifier without diminished state
       #
-      # @return [Piece] new piece instance without diminished state
-      # @example
-      #   piece.undiminish  # (:K, :first, :diminished) => (:K, :first, :normal)
+      # @return [Identifier] new identifier instance with normal state
       def undiminish
         return self unless diminished?
 
         self.class.new(type, side, NORMAL_STATE)
       end
 
-      # Create a new piece with normal state (no modifiers)
+      # Create a new identifier with normal state (no modifiers)
       #
-      # @return [Piece] new piece instance with normal state
-      # @example
-      #   piece.normalize  # (:K, :first, :enhanced) => (:K, :first, :normal)
+      # @return [Identifier] new identifier instance with normal state
       def normalize
         return self if normal?
 
         self.class.new(type, side, NORMAL_STATE)
       end
 
-      # Create a new piece with opposite side
+      # Create a new identifier with opposite side
       #
-      # @return [Piece] new piece instance with opposite side
-      # @example
-      #   piece.flip  # (:K, :first, :normal) => (:K, :second, :normal)
+      # @return [Identifier] new identifier instance with opposite side
       def flip
         self.class.new(type, opposite_side, state)
       end
 
-      # Create a new piece with a different type (keeping same side and state)
+      # Create a new identifier with a different type
       #
       # @param new_type [Symbol] new type (:A to :Z)
-      # @return [Piece] new piece instance with different type
-      # @example
-      #   piece.with_type(:Q)  # (:K, :first, :normal) => (:Q, :first, :normal)
+      # @return [Identifier] new identifier instance with new type
       def with_type(new_type)
         self.class.validate_type(new_type)
         return self if type == new_type
@@ -229,12 +212,10 @@ module Sashite
         self.class.new(new_type, side, state)
       end
 
-      # Create a new piece with a different side (keeping same type and state)
+      # Create a new identifier with a different side
       #
-      # @param new_side [Symbol] :first or :second
-      # @return [Piece] new piece instance with different side
-      # @example
-      #   piece.with_side(:second)  # (:K, :first, :normal) => (:K, :second, :normal)
+      # @param new_side [Symbol] new side (:first or :second)
+      # @return [Identifier] new identifier instance with new side
       def with_side(new_side)
         self.class.validate_side(new_side)
         return self if side == new_side
@@ -242,12 +223,10 @@ module Sashite
         self.class.new(type, new_side, state)
       end
 
-      # Create a new piece with a different state (keeping same type and side)
+      # Create a new identifier with a different state
       #
-      # @param new_state [Symbol] :normal, :enhanced, or :diminished
-      # @return [Piece] new piece instance with different state
-      # @example
-      #   piece.with_state(:enhanced)  # (:K, :first, :normal) => (:K, :first, :enhanced)
+      # @param new_state [Symbol] new state (:normal, :enhanced, or :diminished)
+      # @return [Identifier] new identifier instance with new state
       def with_state(new_state)
         self.class.validate_state(new_state)
         return self if state == new_state
@@ -255,56 +234,54 @@ module Sashite
         self.class.new(type, side, new_state)
       end
 
-      # Check if the piece has enhanced state
+      # Check if the identifier has enhanced state
       #
       # @return [Boolean] true if enhanced
       def enhanced?
         state == ENHANCED_STATE
       end
 
-      # Check if the piece has diminished state
+      # Check if the identifier has diminished state
       #
       # @return [Boolean] true if diminished
       def diminished?
         state == DIMINISHED_STATE
       end
 
-      # Check if the piece has normal state (no modifiers)
+      # Check if the identifier has normal state
       #
-      # @return [Boolean] true if no modifiers are present
+      # @return [Boolean] true if normal
       def normal?
         state == NORMAL_STATE
       end
 
-      # Check if the piece belongs to the first player
+      # Check if the identifier belongs to the first player
       #
       # @return [Boolean] true if first player
       def first_player?
         side == FIRST_PLAYER
       end
 
-      # Check if the piece belongs to the second player
+      # Check if the identifier belongs to the second player
       #
       # @return [Boolean] true if second player
       def second_player?
         side == SECOND_PLAYER
       end
 
-      # Check if this piece is the same type as another (ignoring side and state)
+      # Check if this identifier is the same type as another
       #
-      # @param other [Piece] piece to compare with
+      # @param other [Identifier] identifier to compare with
       # @return [Boolean] true if same type
-      # @example
-      #   king1.same_type?(king2)  # (:K, :first, :normal) and (:K, :second, :enhanced) => true
       def same_type?(other)
         return false unless other.is_a?(self.class)
 
         type == other.type
       end
 
-      # Check if this piece belongs to the same side as another
+      # Check if this identifier has the same side as another
       #
-      # @param other [Piece] piece to compare with
+      # @param other [Identifier] identifier to compare with
       # @return [Boolean] true if same side
       def same_side?(other)
         return false unless other.is_a?(self.class)
@@ -312,9 +289,9 @@ module Sashite
         side == other.side
       end
 
-      # Check if this piece has the same state as another
+      # Check if this identifier has the same state as another
       #
-      # @param other [Piece] piece to compare with
+      # @param other [Identifier] identifier to compare with
       # @return [Boolean] true if same state
       def same_state?(other)
         return false unless other.is_a?(self.class)
@@ -325,7 +302,7 @@ module Sashite
       # Custom equality comparison
       #
       # @param other [Object] object to compare with
-      # @return [Boolean] true if pieces are equal
+      # @return [Boolean] true if identifiers are equal
       def ==(other)
         return false unless other.is_a?(self.class)
 
@@ -388,7 +365,7 @@ module Sashite
 
       private
 
-      # Get the opposite side of the current piece
+      # Get the opposite side of the current identifier
       #
       # @return [Symbol] :first if current side is :second, :second if current side is :first
       def opposite_side

data/lib/sashite/pin.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "pin/piece"
+require_relative "pin/identifier"
 
 module Sashite
   # PIN (Piece Identifier Notation) implementation for Ruby
@@ -18,7 +18,7 @@ module Sashite
   #   "+R" - First player rook (enhanced state)
   #   "-p" - Second player pawn (diminished state)
   #
-  # See: https://sashite.dev/specs/pin/1.0.0/
+  # @see https://sashite.dev/specs/pin/1.0.0/
   module Pin
     # Check if a string is a valid PIN notation
     #
@@ -32,35 +32,35 @@ module Sashite
     #   Sashite::Pin.valid?("KK")   # => false
     #   Sashite::Pin.valid?("++K")  # => false
     def self.valid?(pin_string)
-      Piece.valid?(pin_string)
+      Identifier.valid?(pin_string)
     end
 
-    # Parse a PIN string into a Piece object
+    # Parse a PIN string into an Identifier object
     #
     # @param pin_string [String] PIN notation string
-    # @return [Pin::Piece] new piece instance
+    # @return [Pin::Identifier] new identifier instance
     # @raise [ArgumentError] if the PIN string is invalid
     # @example
-    #   Sashite::Pin.parse("K")     # => #<Pin::Piece type=:K side=:first state=:normal>
-    #   Sashite::Pin.parse("+R")    # => #<Pin::Piece type=:R side=:first state=:enhanced>
-    #   Sashite::Pin.parse("-p")    # => #<Pin::Piece type=:P side=:second state=:diminished>
+    #   Sashite::Pin.parse("K")     # => #<Pin::Identifier type=:K side=:first state=:normal>
+    #   Sashite::Pin.parse("+R")    # => #<Pin::Identifier type=:R side=:first state=:enhanced>
+    #   Sashite::Pin.parse("-p")    # => #<Pin::Identifier type=:P side=:second state=:diminished>
     def self.parse(pin_string)
-      Piece.parse(pin_string)
+      Identifier.parse(pin_string)
     end
 
-    # Create a new piece instance
+    # Create a new identifier instance
     #
     # @param type [Symbol] piece type (:A to :Z)
     # @param side [Symbol] player side (:first or :second)
     # @param state [Symbol] piece state (:normal, :enhanced, or :diminished)
-    # @return [Pin::Piece] new piece instance
+    # @return [Pin::Identifier] new identifier instance
     # @raise [ArgumentError] if parameters are invalid
     # @example
-    #   Sashite::Pin.piece(:K, :first, :normal)     # => #<Pin::Piece type=:K side=:first state=:normal>
-    #   Sashite::Pin.piece(:R, :first, :enhanced)   # => #<Pin::Piece type=:R side=:first state=:enhanced>
-    #   Sashite::Pin.piece(:P, :second, :diminished) # => #<Pin::Piece type=:P side=:second state=:diminished>
-    def self.piece(type, side, state = :normal)
-      Piece.new(type, side, state)
+    #   Sashite::Pin.identifier(:K, :first, :normal)     # => #<Pin::Identifier type=:K side=:first state=:normal>
+    #   Sashite::Pin.identifier(:R, :first, :enhanced)   # => #<Pin::Identifier type=:R side=:first state=:enhanced>
+    #   Sashite::Pin.identifier(:P, :second, :diminished) # => #<Pin::Identifier type=:P side=:second state=:diminished>
+    def self.identifier(type, side, state)
+      Identifier.new(type, side, state)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sashite-pin
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Cyril Kato
@@ -10,13 +10,13 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
-  PIN (Piece Identifier Notation) provides an ASCII-based format for representing pieces
+  PIN (Piece Identifier Notation) provides a rule-agnostic format for identifying pieces
   in abstract strategy board games. This gem implements the PIN Specification v1.0.0 with
-  a modern Ruby interface featuring immutable piece objects and functional programming
-  principles. PIN translates piece attributes from the Game Protocol into a compact,
-  portable notation system using ASCII letters with optional state modifiers and
-  case-based side encoding. Perfect for game engines, board game notation systems,
-  and multi-game environments.
+  a modern Ruby interface featuring immutable identifier objects and functional programming
+  principles. PIN uses single ASCII letters with optional state modifiers and case-based
+  side encoding (A-Z for first player, a-z for second player), enabling precise and portable
+  identification of pieces across multiple games. Perfect for game engines, board game notation
+  systems, and hybrid gaming platforms requiring compact, stateful piece representation.
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -26,7 +26,7 @@ files:
 - README.md
 - lib/sashite-pin.rb
 - lib/sashite/pin.rb
-- lib/sashite/pin/piece.rb
+- lib/sashite/pin/identifier.rb
 homepage: https://github.com/sashite/pin.rb
 licenses:
 - MIT
@@ -53,6 +53,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: PIN (Piece Identifier Notation) implementation for Ruby with immutable piece
+summary: PIN (Piece Identifier Notation) implementation for Ruby with immutable identifier
   objects
 test_files: []