sashite-snn 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c75eb6af8fa8c0ff0a9791e0ecc0fe49b7e6c0827733e96f2e37e552ddca50b0
-  data.tar.gz: 2ac49000ca7ff3f2ae01e0a7d240f2fb99d5cab34a915b9799a5088c7461b4f3
+  metadata.gz: c3327ae1106ccede78736585e812180c12d7a56852a82ae70b7745e233ef5496
+  data.tar.gz: ba5892640791f51341e52c883f52f9f21bac64e21001052e1fcbc17965a156a7
 SHA512:
-  metadata.gz: 9ec03703cf421329344a597f91d4157e4b44f1d5347cb4f8eea1a5c9e79e6800ad0880f6d9a8ad003df18d48ab5afb084d6526ffcbf6df14323b21ee751fc54e
-  data.tar.gz: e95c9a8e58fbe6254e546456a5de92a79de1eeb33688292ec1c58f58ba30b6a94357a61d1396a1a639e0051c772b888af355e421a3726b2faf3ae7179450afd6
+  metadata.gz: 1798b7aec7b88cc2baddcd9fa7f3518c2d97bf16343caac92ec84f9bfad3dc0ac20830d95144984ea27795d867e80c008a090f9de7fc8d284ac853f9c326b144
+  data.tar.gz: a6a548c819cf763b914cc1b70ce82ba86d86b7973f0231df5075931788d19fb2732d4138896b347cf6a1842c554116578e59cdfb619408acb370c2c43d469753

data/README.md

@@ -89,6 +89,7 @@ black_shogi.to_s                            # => "shogi"
 
 ### Regular Expression
 ```ruby
+# Pattern accessible via Sashite::Snn::Style::SNN_PATTERN
 /\A([A-Z][A-Z0-9]*|[a-z][a-z0-9]*)\z/
 ```
 
@@ -216,8 +217,12 @@ style2.to_s    # => "chess" (lowercase display)
 - `#same_side?(other)` - Check if same side
 - `#==(other)` - Full equality comparison
 
-### Constants
-- `Sashite::Snn::SNN_REGEX` - Regular expression for SNN validation
+### Style Class Constants
+
+- `Sashite::Snn::Style::FIRST_PLAYER` - Symbol for first player (:first)
+- `Sashite::Snn::Style::SECOND_PLAYER` - Symbol for second player (:second)
+- `Sashite::Snn::Style::VALID_SIDES` - Array of valid sides
+- `Sashite::Snn::Style::SNN_PATTERN` - Regular expression for SNN validation
 
 ## Advanced Usage
 
@@ -377,7 +382,7 @@ Following the [Game Protocol](https://sashite.dev/game-protocol/):
 
 | Protocol Attribute | SNN Encoding | Examples | Notes |
 |-------------------|--------------|----------|-------|
-| **Style** | Alphanumeric identifier | `CHESS`, `SHOGI`, `XIANGQI` | Name is always stored as uppercase symbol |
+| **Style** | Alphanumeric identifier | `CHESS`, `SHOGI`, `XIANGQI` | Name is always stored with proper capitalization |
 | **Side** | Case encoding | `CHESS` = First player, `chess` = Second player | Case is determined by side during rendering |
 
 **Name Convention**: All style names are internally represented with proper capitalization (first letter uppercase, rest lowercase). The display case is determined by the `side` attribute: first player styles display as uppercase, second player styles as lowercase.

data/lib/sashite/snn/style.rb

@@ -53,12 +53,12 @@ module Sashite
       # Parse an SNN string into a Style object
       #
       # @param snn_string [String] SNN notation string
-      # @return [Style] new style instance
+      # @return [Style] parsed style object with normalized name and inferred side
       # @raise [ArgumentError] if the SNN string is invalid
-      # @example
-      #   Snn::Style.parse("CHESS")     # => #<Snn::Style name=:Chess side=:first>
-      #   Snn::Style.parse("chess")     # => #<Snn::Style name=:Chess side=:second>
-      #   Snn::Style.parse("SHOGI")     # => #<Snn::Style name=:Shogi side=:first>
+      # @example Parse SNN strings with case normalization
+      #   Sashite::Snn::Style.parse("CHESS") # => #<Snn::Style name=:Chess side=:first>
+      #   Sashite::Snn::Style.parse("chess") # => #<Snn::Style name=:Chess side=:second>
+      #   Sashite::Snn::Style.parse("SHOGI") # => #<Snn::Style name=:Shogi side=:first>
       def self.parse(snn_string)
         string_value = String(snn_string)
         matches = match_pattern(string_value)
@@ -74,21 +74,36 @@ module Sashite
         new(style_name, style_side)
       end
 
+      # Check if a string is a valid SNN notation
+      #
+      # @param snn_string [String] the string to validate
+      # @return [Boolean] true if valid SNN, false otherwise
+      #
+      # @example Validate SNN strings
+      #   Sashite::Snn::Style.valid?("CHESS") # => true
+      #   Sashite::Snn::Style.valid?("chess") # => true
+      #   Sashite::Snn::Style.valid?("Chess") # => false
+      def self.valid?(snn_string)
+        return false unless snn_string.is_a?(::String)
+
+        snn_string.match?(SNN_PATTERN)
+      end
+
       # Convert the style to its SNN string representation
       #
-      # @return [String] SNN notation string
-      # @example
-      #   style.to_s  # => "CHESS"
-      #   style.to_s  # => "chess"
-      #   style.to_s  # => "SHOGI"
+      # @return [String] SNN notation string with case based on side
+      # @example Display different sides
+      #   style.to_s  # => "CHESS" (first player)
+      #   style.to_s  # => "chess" (second player)
+      #   style.to_s  # => "SHOGI" (first player)
       def to_s
         first_player? ? name.to_s.upcase : name.to_s.downcase
       end
 
       # Create a new style with opposite ownership (side)
       #
-      # @return [Style] new style instance with flipped side
-      # @example
+      # @return [Style] new immutable style instance with flipped side
+      # @example Flip player sides
       #   style.flip  # (:Chess, :first) => (:Chess, :second)
       def flip
         self.class.new(name, opposite_side)
@@ -97,8 +112,8 @@ module Sashite
       # Create a new style with a different name (keeping same side)
       #
       # @param new_name [Symbol] new name (with proper capitalization)
-      # @return [Style] new style instance with different name
-      # @example
+      # @return [Style] new immutable style instance with different name
+      # @example Change style name
       #   style.with_name(:Shogi)  # (:Chess, :first) => (:Shogi, :first)
       def with_name(new_name)
         self.class.validate_name(new_name)
@@ -110,8 +125,8 @@ module Sashite
       # Create a new style with a different side (keeping same name)
       #
       # @param new_side [Symbol] :first or :second
-      # @return [Style] new style instance with different side
-      # @example
+      # @return [Style] new immutable style instance with different side
+      # @example Change player side
       #   style.with_side(:second)  # (:Chess, :first) => (:Chess, :second)
       def with_side(new_side)
         self.class.validate_side(new_side)
@@ -137,8 +152,8 @@ module Sashite
       # Check if this style has the same name as another
       #
       # @param other [Style] style to compare with
-      # @return [Boolean] true if same name
-      # @example
+      # @return [Boolean] true if both styles have the same name
+      # @example Compare style names
       #   chess1.same_name?(chess2)  # (:Chess, :first) and (:Chess, :second) => true
       def same_name?(other)
         return false unless other.is_a?(self.class)
@@ -149,7 +164,7 @@ module Sashite
       # Check if this style belongs to the same side as another
       #
       # @param other [Style] style to compare with
-      # @return [Boolean] true if same side
+      # @return [Boolean] true if both styles belong to the same side
       def same_side?(other)
         return false unless other.is_a?(self.class)
 
@@ -159,7 +174,7 @@ module Sashite
       # Custom equality comparison
       #
       # @param other [Object] object to compare with
-      # @return [Boolean] true if styles are equal
+      # @return [Boolean] true if both objects are styles with identical name and side
       def ==(other)
         return false unless other.is_a?(self.class)
 
@@ -171,7 +186,7 @@ module Sashite
 
       # Custom hash implementation for use in collections
       #
-      # @return [Integer] hash value
+      # @return [Integer] hash value based on class, name, and side
       def hash
         [self.class, name, side].hash
       end

data/lib/sashite/snn.rb

@@ -22,35 +22,27 @@ module Sashite
   #
   # See: https://sashite.dev/specs/snn/1.0.0/
   module Snn
-    # Regular expression for SNN validation
-    # Matches: uppercase alphanumeric identifier OR lowercase alphanumeric identifier
-    SNN_REGEX = /\A([A-Z][A-Z0-9]*|[a-z][a-z0-9]*)\z/
-
     # Check if a string is a valid SNN notation
     #
-    # @param snn [String] The string to validate
+    # @param snn_string [String] the string to validate
     # @return [Boolean] true if valid SNN, false otherwise
     #
-    # @example
-    #   Sashite::Snn.valid?("CHESS")    # => true
-    #   Sashite::Snn.valid?("chess")    # => true
-    #   Sashite::Snn.valid?("Chess")    # => false
-    #   Sashite::Snn.valid?("123")      # => false
-    def self.valid?(snn)
-      return false unless snn.is_a?(::String)
-
-      snn.match?(SNN_REGEX)
+    # @example Validate various SNN formats
+    #   Sashite::Snn.valid?("CHESS") # => true
+    #   Sashite::Snn.valid?("Chess") # => false
+    def self.valid?(snn_string)
+      Style.valid?(snn_string)
     end
 
     # Parse an SNN string into a Style object
     #
     # @param snn_string [String] SNN notation string
-    # @return [Snn::Style] new style instance
+    # @return [Snn::Style] parsed style object with name and side attributes
     # @raise [ArgumentError] if the SNN string is invalid
-    # @example
-    #   Sashite::Snn.parse("CHESS")     # => #<Snn::Style name=:Chess side=:first>
-    #   Sashite::Snn.parse("chess")     # => #<Snn::Style name=:Chess side=:second>
-    #   Sashite::Snn.parse("SHOGI")     # => #<Snn::Style name=:Shogi side=:first>
+    # @example Parse different SNN formats
+    #   Sashite::Snn.parse("CHESS") # => #<Snn::Style name=:Chess side=:first>
+    #   Sashite::Snn.parse("chess") # => #<Snn::Style name=:Chess side=:second>
+    #   Sashite::Snn.parse("SHOGI") # => #<Snn::Style name=:Shogi side=:first>
     def self.parse(snn_string)
       Style.parse(snn_string)
     end
@@ -59,11 +51,11 @@ module Sashite
     #
     # @param name [Symbol] style name (with proper capitalization)
     # @param side [Symbol] player side (:first or :second)
-    # @return [Snn::Style] new style instance
+    # @return [Snn::Style] new immutable style instance
     # @raise [ArgumentError] if parameters are invalid
-    # @example
-    #   Sashite::Snn.style(:Chess, :first)     # => #<Snn::Style name=:Chess side=:first>
-    #   Sashite::Snn.style(:Shogi, :second)    # => #<Snn::Style name=:Shogi side=:second>
+    # @example Create styles directly
+    #   Sashite::Snn.style(:Chess, :first)  # => #<Snn::Style name=:Chess side=:first>
+    #   Sashite::Snn.style(:Shogi, :second) # => #<Snn::Style name=:Shogi side=:second>
     def self.style(name, side)
       Style.new(name, side)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sashite-snn
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Cyril Kato