sashite-pmn 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ebaf0b731c5fa324e1515369a8a98bc3fc4a6a8094d67023728a04c650a963
-  data.tar.gz: 6a4e1ba06a8afd9015ae8dcc89795fa9f28a7b573d4502b13e52d5ed380c3630
+  metadata.gz: a51482a92eec36293c9fe583574f7d4981bd953f36846459515ac1ba58a37dc6
+  data.tar.gz: 01a42bd2bc3ca44550d681573b96d821f67c58cacc2df0dd5b7bccc2a4f4801f
 SHA512:
-  metadata.gz: c6624a7cb869903504622c7a7a34f9a5a73a3c63967ed6c7d0ff89e9e4fe8782e806b94742ea3156fd41b54159cc81c5921e59e5cd27c97bf076ca90482148d2
-  data.tar.gz: 7d871f7cdc7509b9c8ec3ea77c0375652423940be53f157e60e4debebc604ed2a10558ecc7d0a9e6e7a892e9a771bbabab0151d2929127de87d81ee2ac5c332f
+  metadata.gz: 9b9775836efcc6db95dada230c631d78f6918c0efc3c9692f04c2d5a7d0c1041e90b390023d49fcb4e75ca6e166dc3af6f6821fa0563e54994a101e607f39e32
+  data.tar.gz: 7d46c954a1e4a1c696a6f9cd222dc80785b6c8a54b0c26210e0045c8ee8671562262e2074c2b14612e21fb24a359bd301d4422bceff73b8c80748c353b1fa6ba

data/lib/sashite/pmn/action.rb

@@ -30,8 +30,8 @@ module Sashite
       # @param source [String] CELL or "*"
       # @param destination [String] CELL or "*"
       # @param piece [String, nil] QPI string (optional)
-      # @raise [InvalidLocationError] if source/destination are invalid
-      # @raise [InvalidPieceError] if piece is provided but invalid
+      # @raise [Error::Location] if source/destination are invalid
+      # @raise [Error::Piece] if piece is provided but invalid
       def initialize(source, destination, piece = nil)
         validate_source!(source)
         validate_destination!(destination)
@@ -115,7 +115,7 @@ module Sashite
       end
 
       # @param other [Object]
-      # @return [Boolean] equality by {source, destination, piece}
+      # @return [Boolean] equality by source, destination, piece
       def ==(other)
         return false unless other.is_a?(Action)
 
@@ -156,28 +156,28 @@ module Sashite
       # ---------- Internal validation helpers -------------------------------
 
       # @param src [String]
-      # @raise [InvalidLocationError]
+      # @raise [Error::Location]
       def validate_source!(src)
         return if valid_location?(src)
 
-        raise InvalidLocationError, "Invalid source location: #{src.inspect}"
+        raise Error::Location, "Invalid source location: #{src.inspect}"
       end
 
       # @param dst [String]
-      # @raise [InvalidLocationError]
+      # @raise [Error::Location]
       def validate_destination!(dst)
         return if valid_location?(dst)
 
-        raise InvalidLocationError, "Invalid destination location: #{dst.inspect}"
+        raise Error::Location, "Invalid destination location: #{dst.inspect}"
       end
 
       # @param qpi [String, nil]
-      # @raise [InvalidPieceError]
+      # @raise [Error::Piece]
       def validate_piece!(qpi)
         return if qpi.nil?
         return if Qpi.valid?(qpi)
 
-        raise InvalidPieceError, "Invalid piece QPI format: #{qpi.inspect}"
+        raise Error::Piece, "Invalid piece QPI format: #{qpi.inspect}"
       end
 
       # @param location [String]

data/lib/sashite/pmn/error.rb

@@ -2,19 +2,52 @@
 
 module Sashite
   module Pmn
-    # Base class for all PMN-related errors
-    class Error < StandardError; end
+    # Base error namespace for PMN.
+    #
+    # Usage patterns:
+    #   rescue Sashite::Pmn::Error => e
+    #   rescue Sashite::Pmn::Error::Move
+    #   rescue Sashite::Pmn::Error::Location, Sashite::Pmn::Error::Piece
+    class Error < ::StandardError
+      # Raised when a PMN move (sequence) is malformed or invalid.
+      #
+      # @example
+      #   begin
+      #     Sashite::Pmn::Move.new("e2")  # Incomplete action
+      #   rescue Sashite::Pmn::Error::Move => e
+      #     warn "Invalid move sequence: #{e.message}"
+      #   end
+      class Move < Error; end
 
-    # Raised when a PMN move (sequence) is malformed or invalid
-    class InvalidMoveError < Error; end
+      # Raised when an atomic action is malformed or fails validation.
+      #
+      # @example
+      #   begin
+      #     Sashite::Pmn::Action.new("invalid", "e4", "C:P")
+      #   rescue Sashite::Pmn::Error::Action => e
+      #     warn "Invalid atomic action: #{e.message}"
+      #   end
+      class Action < Error; end
 
-    # Raised when an atomic action is malformed or fails validation
-    class InvalidActionError < Error; end
+      # Raised when a location is neither a valid CELL coordinate nor HAND ("*").
+      #
+      # @example
+      #   begin
+      #     Sashite::Pmn::Action.new("ZZ99", "e4", "C:P")
+      #   rescue Sashite::Pmn::Error::Location => e
+      #     warn "Invalid location: #{e.message}"
+      #   end
+      class Location < Action; end
 
-    # Raised when a location is neither a valid CELL coordinate nor HAND ("*")
-    class InvalidLocationError < InvalidActionError; end
-
-    # Raised when a piece identifier is not valid QPI
-    class InvalidPieceError < InvalidActionError; end
+      # Raised when a piece identifier is not valid QPI format.
+      #
+      # @example
+      #   begin
+      #     Sashite::Pmn::Action.new("e2", "e4", "NotQPI")
+      #   rescue Sashite::Pmn::Error::Piece => e
+      #     warn "Invalid piece QPI: #{e.message}"
+      #   end
+      class Piece < Action; end
+    end
   end
 end

data/lib/sashite/pmn/move.rb

@@ -23,7 +23,7 @@ module Sashite
       # Create a Move from PMN elements (variadic only).
       #
       # @param pmn_elements [Array<String>] passed as individual args
-      # @raise [InvalidMoveError] if called with a single Array or if invalid
+      # @raise [Error::Move] if called with a single Array or if invalid
       #
       # @example
       #   Move.new("e2","e4","C:P")
@@ -31,7 +31,7 @@ module Sashite
       def initialize(*pmn_elements)
         # single-array form is intentionally not supported (entropy reduction)
         if pmn_elements.size == 1 && pmn_elements.first.is_a?(Array)
-          raise InvalidMoveError,
+          raise Error::Move,
                 'PMN must be passed as individual arguments, e.g. Move.new("e2","e4","C:P")'
         end
 
@@ -170,14 +170,14 @@ module Sashite
       # Validation ------------------------------------------------------------
 
       def validate_array!(array)
-        raise InvalidMoveError, "PMN must be an array, got #{array.class}" unless array.is_a?(Array)
-        raise InvalidMoveError, "PMN array cannot be empty" if array.empty?
+        raise Error::Move, "PMN must be an array, got #{array.class}" unless array.is_a?(Array)
+        raise Error::Move, "PMN array cannot be empty" if array.empty?
 
-        raise InvalidMoveError, "All PMN elements must be strings" unless array.all?(String)
+        raise Error::Move, "All PMN elements must be strings" unless array.all?(String)
 
         return if valid_length?(array)
 
-        raise InvalidMoveError, "Invalid PMN array length: #{array.size}"
+        raise Error::Move, "Invalid PMN array length: #{array.size}"
       end
 
       # Valid lengths: (size % 3 == 0) OR (size % 3 == 2), minimum 2.
@@ -204,21 +204,21 @@ module Sashite
             actions << Action.new(array[index], array[index + 1], array[index + 2])
             index += 3
           else
-            raise InvalidMoveError, "Invalid action group at index #{index}"
+            raise Error::Move, "Invalid action group at index #{index}"
           end
         end
 
         actions
-      rescue InvalidActionError => e
+      rescue Error::Action => e
         # Normalize action-level errors as move-level errors during parsing
-        raise InvalidMoveError, "Invalid action while parsing move at index #{index}: #{e.message}"
+        raise Error::Move, "Invalid action while parsing move at index #{index}: #{e.message}"
       end
 
       def validate_actions!
         actions.each_with_index do |action, i|
           next if action.valid?
 
-          raise InvalidMoveError, "Invalid action at position #{i}: #{action.inspect}"
+          raise Error::Move, "Invalid action at position #{i}: #{action.inspect}"
         end
       end
     end

data/lib/sashite/pmn.rb

@@ -27,12 +27,12 @@ module Sashite
     #
     # @param pmn_array [Array<String>] flat array of PMN elements
     # @return [Sashite::Pmn::Move]
-    # @raise [Sashite::Pmn::InvalidMoveError] if the array or any action is invalid
+    # @raise [Sashite::Pmn::Error::Move] if the array or any action is invalid
     #
     # @example
     #   Sashite::Pmn.parse(["e2","e4","C:P"]).actions.size # => 1
     def self.parse(pmn_array)
-      raise InvalidMoveError, "PMN must be an array, got #{pmn_array.class}" unless pmn_array.is_a?(Array)
+      raise Error::Move, "PMN must be an array, got #{pmn_array.class}" unless pmn_array.is_a?(Array)
 
       Move.new(*pmn_array)
     end

metadata

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