otoroshi 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b84f923c9c4e6ea666ec899e051c3e58deff635fe00a8fe116faff2dd0c81b3
-  data.tar.gz: 34899b93e6efa7e257821b553ea4ae9d84510b47734a396e7674cf540e6ded9b
+  metadata.gz: e31c6e00090297fb9709600d1580a24a4729ee1a9af094015ea7c197fde884d3
+  data.tar.gz: 033526ab6473e809a19c812104cf05cadba29485d617161c1799f6664777f9fc
 SHA512:
-  metadata.gz: c44a2deba36e4ab2faf479162c40fba26643a5aab8666e1e2a7b287ce4fc4d33ab1b41f33639f5bd5b6b93a26891c663a00af971e50160a40bdee3df49997c63
-  data.tar.gz: f4893e22addea6e851d6a6fc21eb6d5c5188a95c66f52e12b16ff44afc3a9340b33bf3aa472d3962bad572e42f412028d0887d6f5bf09d71efb435e66a84a848
+  metadata.gz: a5e9595b7c246dde6897fc4f314cdf0c9ef00576dd042cc9c4e34c60de249d4d346ebc2f661f1190708a26211cacbdd1a9f457a9e5802e57049b5f5d831dc9d1
+  data.tar.gz: 42aace4283c39b3d956022e643635d73a9b3a5feb74070f0dd441d8ef165b5d9c76475a7bd274b94e4da8f85aa0ecb08868116842c6af98b1cdf4112a93bbe77

data/lib/otoroshi/sanctuary.rb

@@ -3,6 +3,7 @@
 module Otoroshi
   # This module is designed to be included in a class. This will provide
   # the "property" ({Sanctuary::ClassMethods.property}) method for defining class properties.
+  #
   # @example
   #   class Importer
   #     include Otoroshi::Sanctuary
@@ -23,12 +24,15 @@ module Otoroshi
     # Class methods extended for the base class
     module ClassMethods
       # Adds a new "property" to the class
+      #
       # @param name [Symbol] the property name
       # @param type [Class] the expected value type
       # @param validate [Proc] a lambda processing the value and returning true or false
       # @param allow_nil [true, false] allow nil as a value
       # @param default [Object] default value if not set on initialization
+      #
       # @return [void]
+      #
       # @example
       #   property name, type: String, validate: ->(v) { v.length > 3 }, allow_nil: true
       # @example
@@ -43,7 +47,9 @@ module Otoroshi
       end
 
       # Returns the class properties
+      #
       # @return [Hash]
+      #
       # @note this method will be updated by {add_to_properties}
       def properties
         {}
@@ -52,6 +58,7 @@ module Otoroshi
       private
 
       # Updates {properties} to add new property to the returned ones
+      #
       # @return [void]
       def add_to_properties(name, allow_nil, default)
         current_state = properties
@@ -60,10 +67,13 @@ module Otoroshi
       end
 
       # Defines a private method that raises an error if type is not respected
+      #
       # @param name [Symbol] the property name
       # @param type [Class] the type to test against
       # @param allow_nil [true, false] allow nil as a value
+      #
       # @return [void]
+      #
       # @example
       #   define_validate_type!(score, Integer, false) => def validate_score_type!(value) ...
       # @example Generated method
@@ -85,8 +95,11 @@ module Otoroshi
       end
 
       # Defines a lambda to be call to validate that value matches the type
+      #
       # @param type [Class] the type to test against
+      #
       # @return [Proc] the lambda to use in order to test the value matches the type
+      #
       # @example
       #   type_validation(Integer) #=> ->(v) { v.is_a? Integer }
       # @example
@@ -100,10 +113,13 @@ module Otoroshi
       end
 
       # Defines a private method that raises an error if validate block returns false
+      #
       # @param name [Symbol] the property name
       # @param validate [Proc] a lambda processing the value and returning true or false
       # @param allow_nil [true, false] allow nil as a value
+      #
       # @return [void]
+      #
       # @example
       #   define_validate_lambda!("score", ->(v) { v >= 0 }, false) #=> def validate_score_lambda!(value) ...
       # @example Generated instance method
@@ -124,8 +140,11 @@ module Otoroshi
       end
 
       # Defines a getter method for the property
+      #
       # @param name [Symbol] the property name
+      #
       # @return [void]
+      #
       # @example
       #   define_getter(:score) #=> def score ...
       # @example Generated instance method
@@ -137,8 +156,11 @@ module Otoroshi
       end
 
       # Defines a setter method for the property
+      #
       # @param name [Symbol] the property name
+      #
       # @return [void]
+      #
       # @example
       #   define_getter(:score) #=> def score=(value) ...
       # @example Generated instance method
@@ -156,8 +178,11 @@ module Otoroshi
       end
 
       # Redefines initialize method
+      #
       # @return [void]
+      #
       # @note method is defined with `class_eval`
+      #
       # @example Generated method
       #   def initialize(foo:, bar: 0)
       #     self.foo = foo
@@ -172,7 +197,9 @@ module Otoroshi
       end
 
       # Defines initialize method parameters
+      #
       # @return [String]
+      #
       # @example Given properties { foo: { allow_nil: false, default: nil }, { allow_nil: true, default: 0 } }
       #   redefine_initialize #=> "foo:, bar: 0"
       def initialize_parameters
@@ -185,8 +212,11 @@ module Otoroshi
       end
 
       # Defines the default value of a parameter depending on options
+      #
       # @param options [Hash]
+      #
       # @return [String]
+      #
       # @example when nil is allowed and default is set
       #   default_parameter_for(true, 0) #=> " 0"
       # @example when nil is allowed and default is not set
@@ -200,7 +230,9 @@ module Otoroshi
       end
 
       # Defines initialize method body
+      #
       # @return [String]
+      #
       # @example Given properties { foo: { allow_nil: false, default: nil }, { allow_nil: true, default: 0 } }
       #   initialize_body #=> "self.foo = foo\nself.bar = bar"
       def initialize_body

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: otoroshi
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Edouard Piron