otoroshi 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cded2f7b556f68f150dbccb50c566a6b131dac220eedd220b039ee96f17fb083
-  data.tar.gz: 2ab1413e813f5cf917bed90e0bd8f7c6928827af24acdf6618e1f29e66c82dc9
+  metadata.gz: fba1623080c055e87c2055001a7f2370e459b5fe1a28774375cef3dd9e7da802
+  data.tar.gz: 4c01c52a123157e572b4fdcef7c2e7eb6f0cc6ef2162e49237b5a49785708b70
 SHA512:
-  metadata.gz: 11a8543961a2de58d5004968557c68db65f85251403a552a5f7a50c5b946234f215d812859f72a7fa044a03f4116d61b14b01116f9986676a0d0945a9f8f719f
-  data.tar.gz: e27749e5ce0065a0ae3ee551538a1bbf7f191bb33a29f34cdcad1f173b463d429e846b1973d2b096b5004bce450a625ffbe8d407a301535eca51d8ff6f618dab
+  metadata.gz: 8b89127bff4d54b14be27fe723db61e6f0786b7f0f9f6d4df612ed49b3d86d59f1a1df55038178662e5ce247c4b2f6af16b35e05650730d8b9889debd354ed48
+  data.tar.gz: 177fbc07e846a1cb9cbc7b3e595ce5c0878ff153d6293d9e0ccf986745a0b898e3b2a9be144218b97425ad87b78b4170848b20496ca39bf232ee898f5b1fcb19

data/lib/otoroshi/exceptions.rb

@@ -9,11 +9,11 @@ module Otoroshi
     #
     # @param property [Symbol] name of the property
     # @param type [Class] class to match
-    # @param array [true, false] define if it is an array
-    def initialize(property, type, array: false)
+    # @param collection [true, false] define if it is a collection
+    def initialize(property, type, collection: false)
       expected_type = type.is_a?(Array) ? type.first || Object : type
       msg =
-        if array
+        if collection
           ":#{property} contains elements that are not instances of #{expected_type}"
         else
           ":#{property} is not an instance of #{expected_type}"
@@ -22,7 +22,7 @@ module Otoroshi
     end
   end
 
-  # Manages errors raised when value should be an array
+  # Manages errors raised when value should be an collection
   class NotAnArray < Error
     # Initialize an error
     #
@@ -39,13 +39,13 @@ module Otoroshi
     #
     # @param property [Symbol] name of the property
     # @param accepted_values [Array] accepted values
-    # @param array [true, false] define if it is an array
-    def initialize(property, accepted_values, array: false)
+    # @param collection [true, false] define if it is an collection
+    def initialize(property, accepted_values, collection: false)
       # reintegrate the colon for symbols which is lost during interpolation
       to_s = ->(v) { v.is_a?(Symbol) ? ":#{v}" : v }
       accepted_values_list = accepted_values.map { |v| to_s.call(v) }.join(', ')
       msg =
-        if array
+        if collection
           ":#{property} contains elements that are not included in [#{accepted_values_list}]"
         else
           ":#{property} is not included in [#{accepted_values_list}]"
@@ -59,10 +59,10 @@ module Otoroshi
     # Initialize an error
     #
     # @param property [Symbol] name of the property
-    # @param array [true, false] define if it is an array
-    def initialize(property, array: false)
+    # @param collection [true, false] define if it is an collection
+    def initialize(property, collection: false)
       msg =
-        if array
+        if collection
           ":#{property} contains elements that do not respect the assertion"
         else
           ":#{property} does not respect the assertion"

data/lib/otoroshi/initializer.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Otoroshi
+  # Drawing of #initialize method
+  #
+  class Initializer
+    class << self
+      # Draw a stringified initialize method
+      #
+      # @param properties [Hash] a description of the class properties
+      #
+      # @return [String]
+      #
+      # @example
+      #   <<-RUBY
+      #   def initialize(foo:, bar: 0)
+      #     self.foo = foo
+      #     self.bar = bar
+      #   end
+      #   RUBY
+      def draw(properties)
+        new(properties).draw
+      end
+    end
+
+    # Initialize an instance
+    #
+    # @param properties [Hash] a description of the class properties
+    def initialize(properties = {})
+      @properties = properties
+    end
+
+    # Draws a stringified initialize method
+    #
+    # @return [String]
+    #
+    # @example
+    #   <<-RUBY
+    #   def initialize(foo:, bar: 0)
+    #     self.foo = foo
+    #     self.bar = bar
+    #   end
+    #   RUBY
+    def draw
+      <<-RUBY
+        def initialize(#{initialize_parameters})
+          #{initialize_assignments}
+          #{initialize_push_singletons}
+        end
+      RUBY
+    end
+
+    private
+
+    attr_reader :properties
+
+    # Generates 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
+      parameters =
+        properties.map do |key, options|
+          "#{key}:#{default_parameter_for(options)}"
+        end
+      parameters.join(', ')
+    end
+
+    # Fixes the default value of a parameter depending on options
+    #
+    # @return [String]
+    #
+    # @example when nil is allowed and default is set
+    #   default_parameter_for #=> " 0"
+    # @example when nil is allowed and default is not set
+    #   default_parameter_for #=> " nil"
+    # @example when nil is not allowed
+    #   default_parameter_for #=> ""
+    def default_parameter_for(options)
+      default, allow_nil = options.values_at(:default, :allow_nil)
+      if default
+        symbol_prefix = default.is_a?(Symbol) ? ':' : ''
+        " #{symbol_prefix}#{default}"
+      else
+        allow_nil ? ' nil' : ''
+      end
+    end
+
+    # Generates initialize method assignments
+    #
+    # @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_assignments
+      assignments =
+        properties.keys.map do |name|
+          "self.#{name} = #{name}"
+        end
+      assignments.join("\n")
+    end
+
+    # Generates push singleton for each array property
+    #
+    # @return [String]
+    def initialize_push_singletons
+      collections =
+        properties.select do |_, options|
+          options[:type].is_a?(Array) || options[:type] == Array
+        end
+      singletons =
+        collections.keys.map do |name|
+          initialize_push_singleton(name)
+        end
+      singletons.join("\n")
+    end
+
+    # Generates singleton on collection instance variable to overide <<
+    # so value is validated before being added to the collection
+    #
+    # @return [String]
+    def initialize_push_singleton(name)
+      <<-RUBY
+      bind = self
+      @#{name}.singleton_class.send(:define_method, :<<) do |v|
+        bind.send(:"validate_#{name}_type!", [v])
+        bind.send(:"validate_#{name}_inclusion!", [v])
+        bind.send(:"validate_#{name}_assertion!", [v])
+
+        push(v)
+      end
+      RUBY
+    end
+  end
+end

data/lib/otoroshi/sanctuary.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'awesome_print'
+require_relative 'initializer'
 
 module Otoroshi
   # This module is designed to be included in a class. This will provide
@@ -16,7 +16,7 @@ module Otoroshi
   #     property :positive_number, Integer, verify: ->(v) { v >= 0 }
   #     property :number_or_nil, Integer, allow_nil: true
   #     property :number_with_default, Integer, default: 42
-  #     property :number_from_collection, Integer, one_of: [1, 2, 3, 5, 8, 13, 21, 34]
+  #     property :number_in_collection, Integer, one_of: [1, 2, 3, 5, 8, 13, 21, 34]
   #   end
   module Sanctuary
     class << self
@@ -27,7 +27,7 @@ module Otoroshi
     end
 
     # Class methods extended for the base class
-    module ClassMethods # rubocop:disable Metrics/ModuleLength
+    module ClassMethods
       # Adds a new "property" to the class
       #
       # @param name [Symbol] the property name
@@ -43,30 +43,15 @@ module Otoroshi
       #   property name, type: String, assert: ->(v) { v.length > 3 }, allow_nil: true
       # @example
       #   property scores, type: [Integer], assert: ->(v) { v >= 0 }, default: []
-      def property( # rubocop:disable Metrics/ParameterLists
-        name,
-        type = Object,
-        one_of: nil,
-        assert: ->(_) { true },
-        allow_nil: false,
-        default: nil
-      )
-        add_to_properties(name, type, one_of, assert, allow_nil, default)
-        define_validate_type!(name, type, allow_nil)
-        define_validate_inclusion!(name, type, one_of, allow_nil)
-        define_validate_assertion!(name, type, assert, allow_nil)
+      def property(name, type = Object, one_of: nil, assert: ->(_) { true }, allow_nil: false, default: nil)
+        add_to_properties(name, type, allow_nil, default)
+        collection = type == Array || type.is_a?(Array)
+        define_validate_type!(name, type, collection, allow_nil)
+        define_validate_inclusion!(name, collection, one_of, allow_nil)
+        define_validate_assertion!(name, collection, assert, allow_nil)
         define_getter(name)
         define_setter(name)
-        redefine_initialize
-      end
-
-      # Checks the type is an array
-      #
-      # @param type [Class, Array<Class>] the tested type
-      #
-      # @return [true, false]
-      def collection?(type)
-        type == Array || type.is_a?(Array)
+        class_eval Initializer.draw(properties), __FILE__, __LINE__ + 1
       end
 
       # Returns the class properties
@@ -83,12 +68,10 @@ module Otoroshi
       # Updates {properties} to add new property to the returned ones
       #
       # @return [void]
-      def add_to_properties(name, type, one_of, assert, allow_nil, default) # rubocop:disable Metrics/ParameterLists
+      def add_to_properties(name, type, allow_nil, default)
         current_state = properties
         current_state[name] = {
           type: type,
-          one_of: one_of,
-          assert: assert,
           allow_nil: allow_nil,
           default: default
         }
@@ -97,48 +80,42 @@ module Otoroshi
 
       # 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 array [true, false] define if the value is an array
-      # @param allow_nil [true, false] allow nil as a value
-      #
       # @return [void]
       #
       # @example
-      #   define_validate_type!(score, Integer, false) => def validate_score_type!(value) ...
+      #   define_validate_type!(:score, Integer, false) => def validate_score_type!(value) ...
       # @example Generated method
+      #   # given name: :score, type: Integer, allow_nil: false
       #   def validate_score_type!(value)
       #     return if Integer.nil? || false && value.nil?
       #     return if value.is_a? Integer
       #
       #     raise ArgumentError, ":score does not match required type"
       #   end
-      def define_validate_type!(name, type, allow_nil)
+      def define_validate_type!(name, type, collection, allow_nil)
         lambda = type_validation(type)
-        is_array = collection?(type)
-        check_array = ->(v) { v.is_a?(Array) || raise(Otoroshi::NotAnArray, name) }
+        check_collection = ->(v) { v.is_a?(Array) || raise(Otoroshi::NotAnArray, name) }
         define_method :"validate_#{name}_type!" do |value|
           return if allow_nil && value.nil?
 
-          is_array && check_array.call(value)
+          collection && check_collection.call(value)
           return if lambda.call(value)
 
-          raise Otoroshi::WrongTypeError.new(name, type, array: is_array)
+          raise Otoroshi::WrongTypeError.new(name, type, collection: collection)
         end
         private :"validate_#{name}_type!"
       end
 
       # Defines a lambda to be called to validate that value matches the type
       #
-      # @param type [Class] the type to test against
-      # @param array [true, false] define if the value is an array
-      #
       # @return [Proc] the lambda to use in order to test that the value matches the type
       #
       # @example
       #   type_validation(Integer) #=> ->(v) { v.is_a? Integer }
       # @example
       #   type_validation([String, Symbol]) #=> ->(v) { [String, Symbol].any? { |t| v.is_a? t } }
+      #
+      # @note params are used for binding in define_method scope
       def type_validation(type)
         if type == Array
           # no expected type for each element, return nil
@@ -158,25 +135,22 @@ module Otoroshi
 
       # Defines a private method that raises an error if value is not included in the accepted ones
       #
-      # @param name [Symbol] the property name
-      # @param array [true, false] define if the value is an array
-      # @param values [Array, nil] the values to test against
-      # @param allow_nil [true, false] allow nil as a value
-      #
       # @return [void]
       #
       # @example
-      #   define_validate_inclusion!(side, [:left, :right], false) => def validate_side_type!(value) ...
+      #   # given @name = :side
+      #   define_validate_inclusion!(:side, ...) => def validate_side_type!(value) ...
       # @example Generated method
+      #   # given name: :side, collection: false, one_of: [:left, :right], allow_nil: false
       #   def validate_side_type!(value)
       #     return if false && value.nil?
       #     return if [:left, :right].include? value
       #
       #     raise ArgumentError, ":side is not included in accepted values"
       #   end
-      def define_validate_inclusion!(name, type, values, allow_nil)
-        validator = collection?(type) ? each_inside?(name, values) : inside?(name, values)
-        if values
+      def define_validate_inclusion!(name, collection, one_of, allow_nil)
+        validator = collection ? each_inside?(name, one_of) : inside?(name, one_of)
+        if one_of
           define_method(:"validate_#{name}_inclusion!") do |value|
             allow_nil && value.nil? || validator.call(value)
           end
@@ -188,47 +162,38 @@ module Otoroshi
 
       # Defines a lambda to be called to validate that value is included in accepted ones
       #
-      # @param name [Symbol] the property name
-      # @param values [Array, nil] the values to test against
-      #
       # @return [Proc] the lambda to use in order to test that value is included in accepted ones
-      def inside?(name, values)
+      def inside?(name, one_of)
         lambda do |v|
-          values.include?(v) || raise(Otoroshi::NotAcceptedError.new(name, values))
+          one_of.include?(v) || raise(Otoroshi::NotAcceptedError.new(name, one_of))
         end
       end
 
       # Defines a lambda to be called to validate that each value is included in accepted ones
       #
-      # @param name [Symbol] the property name
-      # @param values [Array, nil] the values to test against
-      #
       # @return [Proc] the lambda to use in order to test that each value is included in accepted ones
-      def each_inside?(name, values)
+      def each_inside?(name, one_of)
         lambda do |v|
-          v.all? { |e| values.include? e } || raise(Otoroshi::NotAcceptedError.new(name, values, array: true))
+          v.all? { |e| one_of.include? e } || raise(Otoroshi::NotAcceptedError.new(name, one_of, collection: true))
         end
       end
 
       # Defines a private method that raises an error if assert lambda returns false
       #
-      # @param name [Symbol] the property name
-      # @param assert [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_assertion!("score", ->(v) { v >= 0 }, false) #=> def validate_score_assertion!(value) ...
+      #   define_validate_assertion!(:score, ...) #=> def validate_score_assertion!(value) ...
       # @example Generated instance method
+      #   # given name: :score, assert: >(v) { v >= 0 }, allow_nil: false
       #   def validate_score_assertion!(value)
       #     return if false && value.nil?
       #     return if value >= 0
       #
       #     raise ArgumentError, ":score does not match validation"
       #   end
-      def define_validate_assertion!(name, type, assert, allow_nil)
-        validator = collection?(type) ? each_assert?(name, assert) : assert?(name, assert)
+      def define_validate_assertion!(name, collection, assert, allow_nil)
+        validator = collection ? each_assert?(name, assert) : assert?(name, assert)
         define_method :"validate_#{name}_assertion!" do |value|
           allow_nil && value.nil? || validator.call(value)
         end
@@ -237,57 +202,46 @@ module Otoroshi
 
       # Defines a lambda to be called to validate that value respects the specific
       #
-      # @param name [Symbol] the property name
-      # @param assert [Proc] a lambda processing the value and returning true or false
-      #
       # @return [Proc] the lambda to use in order to test that value respects the specific
       def assert?(name, assert)
         lambda do |value|
-          return if instance_exec(value, &assert)
-
-          raise Otoroshi::AssertionError, name
+          instance_exec(value, &assert) || raise(Otoroshi::AssertionError, name)
         end
       end
 
       # Defines a lambda to be called to validate that value respects the specific
       #
-      # @param name [Symbol] the property name
-      # @param validate [Proc] a lambda processing the value and returning true or false
-      #
       # @return [Proc] the lambda to use in order to test that each value respects the specific
-      def each_assert?(name, validate)
+      def each_assert?(name, assert)
         lambda do |value|
-          return if value.all? { |e| instance_exec(e, &validate) }
-
-          raise Otoroshi::AssertionError.new(name, array: true)
+          value.all? { |e| instance_exec(e, &assert) } ||
+            raise(Otoroshi::AssertionError.new(name, collection: true))
         end
       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
-      #     def score
-      #       instance_variable_get(@score)
-      #     end
+      #   # given name: :score
+      #   def score
+      #     instance_variable_get(@score)
+      #   end
       def define_getter(name)
         define_method(name) { instance_variable_get("@#{name}") }
       end
 
       # Defines a setter method for the property
       #
-      # @param name [Symbol] the property name
-      #
       # @return [void]
       #
       # @example
-      #   define_getter(:score) #=> def score=(value) ...
+      #   define_setter(:score) #=> def score=(value) ...
       # @example Generated instance method
+      #   # given name: :score
       #   def score=(value)
       #     validate_score_type!(value)
       #     validate_score!(value)
@@ -301,99 +255,6 @@ module Otoroshi
           instance_variable_set("@#{name}", value)
         end
       end
-
-      # Redefines initialize method
-      #
-      # @return [void]
-      #
-      # @note method is defined with `class_eval`
-      #
-      # @example Generated method
-      #   def initialize(foo:, bar: 0)
-      #     self.foo = foo
-      #     self.bar = bar
-      #   end
-      def redefine_initialize
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def initialize(#{initialize_parameters})
-            #{initialize_assignments}
-            #{initialize_push_singletons}
-          end
-        RUBY
-      end
-
-      # Generates 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
-        parameters =
-          properties.map do |key, options|
-            allow_nil, default = options.values
-            "#{key}:#{default_parameter_for(allow_nil, default)}"
-          end
-        parameters.join(', ')
-      end
-
-      # Fixes 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
-      #   default_parameter_for(true, nil) #=> " nil"
-      # @example when nil is not allowed
-      #   default_parameter_for(false, nil) #=> ""
-      def default_parameter_for(allow_nil, default)
-        if default
-          symbol_prefix = default.is_a?(Symbol) ? ':' : ''
-          " #{symbol_prefix}#{default}"
-        else
-          allow_nil ? ' nil' : ''
-        end
-      end
-
-      # Generates initialize method assignments
-      #
-      # @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_assignments
-        properties.keys.map { |name| "self.#{name} = #{name}" }.join("\n")
-      end
-
-      # Generates push singleton for each array property
-      #
-      # @return [String]
-      def initialize_push_singletons
-        collections = properties.select { |_, options| collection?(options[:type]) }
-        singletons =
-          collections.keys.map { |name| initialize_push_singleton(name) }
-        singletons.join("\n")
-      end
-
-      # Generates singleton on array instance variable to overide <<
-      # so value is validated before being added to the array
-      #
-      # @return [String]
-      def initialize_push_singleton(name)
-        <<-RUBY
-        bind = self
-        @#{name}.singleton_class.send(:define_method, :<<) do |v|
-          bind.send(:"validate_#{name}_type!", [v])
-          bind.send(:"validate_#{name}_inclusion!", [v])
-          bind.send(:"validate_#{name}_assertion!", [v])
-
-          push(v)
-        end
-        RUBY
-      end
     end
   end
 end