cmdx 1.9.0 → 1.9.1

data/lib/cmdx/validators/length.rb

@@ -51,6 +51,8 @@ module CMDx
       # @example Exclusion validation
       #   Length.call("short", not_in: 1..3)
       #   # => nil (validation passes - length 5 is not in excluded range)
+      #
+      # @rbs (untyped value, Hash[Symbol, untyped] options) -> nil
       def call(value, options = {})
         length = value&.length
 
@@ -87,6 +89,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] Always raised with appropriate message
+      #
+      # @rbs (Integer min, Integer max, Hash[Symbol, untyped] options) -> void
       def raise_within_validation_error!(min, max, options)
         message = options[:within_message] || options[:in_message] || options[:message]
         message %= { min:, max: } unless message.nil?
@@ -101,6 +105,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] Always raised with appropriate message
+      #
+      # @rbs (Integer min, Integer max, Hash[Symbol, untyped] options) -> void
       def raise_not_within_validation_error!(min, max, options)
         message = options[:not_within_message] || options[:not_in_message] || options[:message]
         message %= { min:, max: } unless message.nil?
@@ -114,6 +120,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] Always raised with appropriate message
+      #
+      # @rbs (Integer min, Hash[Symbol, untyped] options) -> void
       def raise_min_validation_error!(min, options)
         message = options[:min_message] || options[:message]
         message %= { min: } unless message.nil?
@@ -127,6 +135,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] Always raised with appropriate message
+      #
+      # @rbs (Integer max, Hash[Symbol, untyped] options) -> void
       def raise_max_validation_error!(max, options)
         message = options[:max_message] || options[:message]
         message %= { max: } unless message.nil?
@@ -140,6 +150,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] Always raised with appropriate message
+      #
+      # @rbs (Integer is, Hash[Symbol, untyped] options) -> void
       def raise_is_validation_error!(is, options)
         message = options[:is_message] || options[:message]
         message %= { is: } unless message.nil?
@@ -153,6 +165,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] Always raised with appropriate message
+      #
+      # @rbs (Integer is_not, Hash[Symbol, untyped] options) -> void
       def raise_is_not_validation_error!(is_not, options)
         message = options[:is_not_message] || options[:message]
         message %= { is_not: } unless message.nil?

data/lib/cmdx/validators/numeric.rb

@@ -48,6 +48,8 @@ module CMDx
       # @example Validate value exclusion
       #   Numeric.call(5, not_in: 1..10)
       #   # => nil (validation passes - 5 is not in 1..10)
+      #
+      # @rbs (Numeric value, Hash[Symbol, untyped] options) -> nil
       def call(value, options = {})
         case options
         in within:
@@ -82,6 +84,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] With appropriate error message
+      #
+      # @rbs (Numeric min, Numeric max, Hash[Symbol, untyped] options) -> void
       def raise_within_validation_error!(min, max, options)
         message = options[:within_message] || options[:in_message] || options[:message]
         message %= { min:, max: } unless message.nil?
@@ -96,6 +100,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] With appropriate error message
+      #
+      # @rbs (Numeric min, Numeric max, Hash[Symbol, untyped] options) -> void
       def raise_not_within_validation_error!(min, max, options)
         message = options[:not_within_message] || options[:not_in_message] || options[:message]
         message %= { min:, max: } unless message.nil?
@@ -109,6 +115,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] With appropriate error message
+      #
+      # @rbs (Numeric min, Hash[Symbol, untyped] options) -> void
       def raise_min_validation_error!(min, options)
         message = options[:min_message] || options[:message]
         message %= { min: } unless message.nil?
@@ -122,6 +130,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] With appropriate error message
+      #
+      # @rbs (Numeric max, Hash[Symbol, untyped] options) -> void
       def raise_max_validation_error!(max, options)
         message = options[:max_message] || options[:message]
         message %= { max: } unless message.nil?
@@ -135,6 +145,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] With appropriate error message
+      #
+      # @rbs (Numeric is, Hash[Symbol, untyped] options) -> void
       def raise_is_validation_error!(is, options)
         message = options[:is_message] || options[:message]
         message %= { is: } unless message.nil?
@@ -148,6 +160,8 @@ module CMDx
       # @param options [Hash] Validation options containing custom messages
       #
       # @raise [ValidationError] With appropriate error message
+      #
+      # @rbs (Numeric is_not, Hash[Symbol, untyped] options) -> void
       def raise_is_not_validation_error!(is_not, options)
         message = options[:is_not_message] || options[:message]
         message %= { is_not: } unless message.nil?

data/lib/cmdx/validators/presence.rb

@@ -38,6 +38,8 @@ module CMDx
       # @example Validate with custom message
       #   Presence.call(nil, message: "Value cannot be blank")
       #   # => raises ValidationError with custom message
+      #
+      # @rbs (untyped value, ?Hash[Symbol, untyped] options) -> nil
       def call(value, options = {})
         match =
           if value.is_a?(String)

data/lib/cmdx/version.rb

@@ -2,6 +2,9 @@
 
 module CMDx
 
-  VERSION = "1.9.0"
+  # @return [String] the version of the CMDx gem
+  #
+  # @rbs return: String
+  VERSION = "1.9.1"
 
 end

data/lib/cmdx/workflow.rb

@@ -20,6 +20,8 @@ module CMDx
       #     # This would raise an error:
       #     # def work; end
       #   end
+      #
+      # @rbs (Symbol method_name) -> void
       def method_added(method_name)
         raise "cannot redefine #{name}##{method_name} method" if method_name == :work
 
@@ -37,6 +39,8 @@ module CMDx
       #     task Task2
       #     puts pipeline.size # => 2
       #   end
+      #
+      # @rbs () -> Array[ExecutionGroup]
       def pipeline
         @pipeline ||= []
       end
@@ -55,6 +59,8 @@ module CMDx
       #     include CMDx::Workflow
       #     tasks ValidateTask, ProcessTask, NotifyTask, breakpoints: [:failure, :halt]
       #   end
+      #
+      # @rbs (*untyped tasks, **untyped options) -> void
       def tasks(*tasks, **options)
         pipeline << ExecutionGroup.new(
           tasks.map do |task|
@@ -83,6 +89,8 @@ module CMDx
     #     include CMDx::Workflow
     #     # Now has access to task, tasks, and work methods
     #   end
+    #
+    # @rbs (Class base) -> void
     def self.included(base)
       base.extend(ClassMethods)
     end
@@ -100,6 +108,8 @@ module CMDx
     #
     #   workflow = MyWorkflow.new
     #   result = workflow.work
+    #
+    # @rbs () -> void
     def work
       Pipeline.execute(self)
     end

data/lib/cmdx.rb

@@ -17,6 +17,14 @@ module CMDx
 
   extend self
 
+  # Returns the path to the CMDx gem.
+  #
+  # @return [Pathname] the path to the CMDx gem
+  #
+  # @example
+  #   CMDx.gem_path # => Pathname.new("/path/to/cmdx")
+  #
+  # @rbs return: Pathname
   def gem_path
     @gem_path ||= Pathname.new(__dir__).parent
   end

data/lib/generators/cmdx/locale_generator.rb

@@ -30,7 +30,6 @@ module Cmdx
     #   # Copy Spanish locale file
     #   rails generate cmdx:locale es
     #   # => Creates config/locales/es.yml
-    #
     def copy_locale_files
       copy_file("#{locale}.yml", "config/locales/#{locale}.yml")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmdx
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Juan Gomez