validy 1.0.9 → 1.0.99

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 475280444f31f47490b4dd28429c4003991c76d369e80527701a13587473327a
-  data.tar.gz: 678f9a4d43a4865ef90693f91b1d16b090ce55c4b0b604bcddd464d124aad2b7
+  metadata.gz: d89bc7ec77c5a43d71df94fa67ed470ec6865eb251779ece8e4cf8d34dd85247
+  data.tar.gz: 3e8e93f9566766992b46c30db7e9b1013eb55d758b3a8524775545ed7c0bdad2
 SHA512:
-  metadata.gz: e7c134c99e20b1092defd3c4fd83662f700822067975466e3a988d52798b2dbb483ecb7b336ef7f07eaf90a4d22f3664b43169b80d947e9aa4024b3340a8c810
-  data.tar.gz: '0289be294713079964b006512ec6f8dbf503b24b65011ca7e5a48b114452e13a57c426dede5cdfa407dab219042ceb6ec5211ecfbc8f3058abc5a5c3d045039f'
+  metadata.gz: 9eb955a7874c1df5da04f1f5ab99a8f5d5c84bbbc58f12532f8f69ba728559af93adcd48f4a85bb1117c569586683b9f608bacfba5654a1449b7a0db6850a9ea
+  data.tar.gz: f3c7310ee04b5d41dbf35188afb4ba73a8ac779013636f485caa89afd803e580e846839387bf04e663944de20a561afc4d1b6dd3db5c7a357007fc2a43318f92

data/lib/validy.rb

@@ -30,6 +30,8 @@ module Validy
   end
 
   module ClassMethods
+    # @param [String] method - indicates custom, must be implemented method for which will be triggered for defining
+    # validation state
     def validy_on(method:)
       method_with_bang_name = (method[-1] == '!' ? method.to_s : "#{method}!")
       method_without_bang_name = method_with_bang_name.gsub('!', '')
@@ -79,6 +81,9 @@ module Validy
     end
 
     # "condition" evaluates either passed block or instance method represented in the instance
+    # @param [String|block] method or callable object which will be triggered for validation
+    # @param [String|Hash] error definition
+    # @param [Proc] block
     def condition(method, error = nil, &block)
       return self unless valid?
 
@@ -88,6 +93,9 @@ module Validy
     end
 
     # "required" checks presence of the variable
+    # @param [String] attribute a target one
+    # @param [String|Hash] error custom defined error message
+    # @param [Proc] block
     def required(attribute, error = nil, &block)
       return self unless valid?
 
@@ -97,6 +105,7 @@ module Validy
     end
 
     # "optional" starts void validation for the given attribute
+    # @param [String] attribute a target one
     def optional(attribute)
       return self unless valid?
 
@@ -105,6 +114,9 @@ module Validy
     end
 
     # "type" validates type of the instance variable
+    # @param [Object] clazz for checking type of the target attribute
+    # @param [nil] error custom defined error message
+    # @param [Proc] block
     def type(clazz, error = nil, &block)
       return self unless valid?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validy
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.99
 platform: ruby
 authors:
 - Oleg Saltykov