smart_initializer 0.7.0 → 0.9.1

data/lib/smart_core/initializer/attribute.rb

@@ -2,132 +2,10 @@
 
 # @api private
 # @since 0.1.0
-class SmartCore::Initializer::Attribute
-  require_relative 'attribute/parameters'
+# @version 0.8.0
+module SmartCore::Initializer::Attribute
+  require_relative 'attribute/value'
   require_relative 'attribute/list'
   require_relative 'attribute/finalizer'
   require_relative 'attribute/factory'
-
-  # @since 0.1.0
-  extend ::Forwardable
-
-  # @return [Symbol]
-  #
-  # @pai private
-  # @since 0.1.0
-  def_delegator :parameters, :name
-
-  # @return [SmartCore::Initializer::TypeSystem::Interop]
-  #
-  # @pai private
-  # @since 0.1.0
-  def_delegator :parameters, :type
-
-  # @return [Class<SmartCore::Initializer::TypeSystem::Interop>]
-  #
-  # @api private
-  # @since 0.1.0
-  def_delegator :parameters, :type_system
-
-  # @return [Symbol]
-  #
-  # @pai private
-  # @since 0.1.0
-  def_delegator :parameters, :privacy
-
-  # @return [SmartCore::Initializer::Attribute::Finalizer::AnonymousBlock/InstanceMethod]
-  #
-  # @pai private
-  # @since 0.1.0
-  def_delegator :parameters, :finalizer
-
-  # @return [Boolean]
-  #
-  # @pai private
-  # @since 0.1.0
-  def_delegators :parameters, :cast, :cast?
-
-  # @return [Any]
-  #
-  # @api private
-  # @since 0.1.0
-  def_delegator :parameters, :default
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def_delegator :parameters, :has_default?
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.4.0
-  def_delegator :parameters, :read_only
-
-  # @return [String, Symbol, NilClass]
-  #
-  # @api private
-  # @since 0.4.0
-  def_delegator :parameters, :as
-
-  # @param name [Symbol]
-  # @param type [SmartCore::Initializer::TypeSystem::Interop]
-  # @param type_system [Class<SmartCore::Initializer::TypeSystem::Interop>]
-  # @param privacy [Symbol]
-  # @param finalizer [SmartCore::Initializer::Attribute::Finalizer::AnonymousBlock/InstanceMethod]
-  # @param cast [Boolean]
-  # @param read_only [Boolean]
-  # @param as [String, Symbol, NilClass]
-  # @param dynamic_options [Hash<Symbol,Any>]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(name, type, type_system, privacy, finalizer, cast, read_only, as, dynamic_options)
-    @parameters = SmartCore::Initializer::Attribute::Parameters.new(
-      name, type, type_system, privacy, finalizer, cast, read_only, as, dynamic_options
-    )
-  end
-
-  # @param value [Any]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.5.1
-  def validate!(value)
-    type.validate!(value)
-  rescue => error
-    raise SmartCore::Initializer::IncorrectTypeError,
-          "Validation of attribute '#{name}' (#{type.identifier}, got #{value.class}) failed: " \
-          "#{error.message}"
-  end
-
-  # @return [SmartCore::Initializer::Attribute]
-  #
-  # @api private
-  # @since 0.1.0
-  # rubocop:disable Metrics/AbcSize
-  def dup
-    self.class.new(
-      parameters.name.dup,
-      parameters.type,
-      parameters.type_system,
-      parameters.privacy,
-      parameters.finalizer.dup,
-      parameters.cast,
-      parameters.read_only,
-      parameters.as,
-      parameters.dynamic_options.dup
-    )
-  end
-  # rubocop:enable Metrics/AbcSize
-
-  private
-
-  # @return [SmartCore::Initializer::Attribute::Parameters]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :parameters
 end

data/lib/smart_core/initializer/configuration.rb

@@ -25,14 +25,18 @@ module SmartCore::Initializer::Configuration
 
   # @since 0.1.0
   configuration do
+    # @since 0.?.0
     setting :default_type_system, :smart_types
     validate :default_type_system do |value|
       SmartCore::Initializer::TypeSystem.resolve(value) rescue false
     end
 
+    # @since 0.?.0
     setting :strict_options, true
-    validate :strict_options do |value|
-      !!value == value # check if it's a boolean value
-    end
+    validate :strict_options, :boolean
+
+    # @since 0.8.0
+    setting :auto_cast, false
+    validate :auto_cast, :boolean
   end
 end

data/lib/smart_core/initializer/constructor/definer.rb

@@ -31,13 +31,13 @@ class SmartCore::Initializer::Constructor::Definer
   # @param privacy [String, Symbol]
   # @param finalize [String, Symbol, Proc]
   # @param cast [Boolean]
-  # @param read_only [Boolean]
+  # @param mutable [Boolean]
   # @param as [String, Symbol, NilClass]
-  # @param dynamic_options [Hash<Symbol,Any>]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
+  # @version 0.8.0
   def define_parameter(
     name,
     type,
@@ -45,21 +45,19 @@ class SmartCore::Initializer::Constructor::Definer
     privacy,
     finalize,
     cast,
-    read_only,
-    as,
-    dynamic_options
+    mutable,
+    as
   )
     thread_safe do
-      attribute = build_attribute(
+      attribute = build_param_attribute(
         name,
         type,
         type_system,
         privacy,
         finalize,
         cast,
-        read_only,
-        as,
-        dynamic_options
+        mutable,
+        as
       )
       prevent_option_overlap(attribute)
       add_parameter(attribute)
@@ -67,23 +65,25 @@ class SmartCore::Initializer::Constructor::Definer
   end
 
   # @param names [Array<String, Symbol>]
+  # @option mutable [Boolean]
+  # @option privacy [String, Symbol]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def define_parameters(*names)
+  # @version 0.8.0
+  def define_parameters(*names, mutable:, privacy:)
     thread_safe do
       names.map do |name|
-        build_attribute(
+        build_param_attribute(
           name,
           klass.__initializer_settings__.generic_type_object,
           klass.__initializer_settings__.type_system,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_PRIVACY_MODE,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_FINALIZER,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_CAST_BEHAVIOUR,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_READ_ONLY,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_AS,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_DYNAMIC_OPTIONS.dup
+          privacy,
+          SmartCore::Initializer::Attribute::Value::Param::DEFAULT_FINALIZER,
+          klass.__initializer_settings__.auto_cast,
+          mutable,
+          SmartCore::Initializer::Attribute::Value::Param::DEFAULT_AS
         ).tap do |attribute|
           prevent_option_overlap(attribute)
         end
@@ -99,13 +99,15 @@ class SmartCore::Initializer::Constructor::Definer
   # @param privacy [String, Symbol]
   # @param finalize [String, Symbol, Proc]
   # @param cast [Boolean]
-  # @param read_only [Boolean]
+  # @param mutable [Boolean]
   # @param as [String, Symbol, NilClass]
-  # @param dynamic_options [Hash<Symbol,Any>]
+  # @param default [Proc, Any]
+  # @param optional [Boolean]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
+  # @version 0.8.0
   def define_option(
     name,
     type,
@@ -113,21 +115,23 @@ class SmartCore::Initializer::Constructor::Definer
     privacy,
     finalize,
     cast,
-    read_only,
+    mutable,
     as,
-    dynamic_options
+    default,
+    optional
   )
     thread_safe do
-      attribute = build_attribute(
+      attribute = build_option_attribute(
         name,
         type,
         type_system,
         privacy,
         finalize,
         cast,
-        read_only,
+        mutable,
         as,
-        dynamic_options
+        default,
+        optional
       )
       prevent_parameter_overlap(attribute)
       add_option(attribute)
@@ -135,23 +139,27 @@ class SmartCore::Initializer::Constructor::Definer
   end
 
   # @param names [Array<String, Symbol>]
+  # @option mutable [Boolean]
+  # @option privacy [String, Symbol]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def define_options(*names)
+  # @version 0.8.0
+  def define_options(*names, mutable:, privacy:)
     thread_safe do
       names.map do |name|
-        build_attribute(
+        build_option_attribute(
           name,
           klass.__initializer_settings__.generic_type_object,
           klass.__initializer_settings__.type_system,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_PRIVACY_MODE,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_FINALIZER,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_CAST_BEHAVIOUR,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_READ_ONLY,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_AS,
-          SmartCore::Initializer::Attribute::Parameters::DEFAULT_DYNAMIC_OPTIONS.dup
+          privacy,
+          SmartCore::Initializer::Attribute::Value::Option::DEFAULT_FINALIZER,
+          klass.__initializer_settings__.auto_cast,
+          mutable,
+          SmartCore::Initializer::Attribute::Value::Option::DEFAULT_AS,
+          SmartCore::Initializer::Attribute::Value::Option::UNDEFINED_DEFAULT,
+          SmartCore::Initializer::Attribute::Value::Option::DEFAULT_OPTIONAL
         ).tap do |attribute|
           prevent_parameter_overlap(attribute)
         end
@@ -175,26 +183,57 @@ class SmartCore::Initializer::Constructor::Definer
   # @param privacy [String, Symbol]
   # @param finalize [String, Symbol, Proc]
   # @param cast [Boolean]
-  # @param read_only [Boolean]
+  # @param mutable [Boolean]
+  # @param as [String, Symbol, NilClass]
+  # @return [SmartCore::Initializer::Attribute::Value::Param]
+  #
+  # @api private
+  # @since 0.1.0
+  # @version 0.8.0
+  def build_param_attribute(
+    name,
+    type,
+    type_system,
+    privacy,
+    finalize,
+    cast,
+    mutable,
+    as
+  )
+    SmartCore::Initializer::Attribute::Factory::Param.create(
+      name, type, type_system, privacy, finalize, cast, mutable, as
+    )
+  end
+
+  # @param name [String, Symbol]
+  # @param type [String, Symbol, Any]
+  # @param type_system [String, Symbol]
+  # @param privacy [String, Symbol]
+  # @param finalize [String, Symbol, Proc]
+  # @param cast [Boolean]
+  # @param mutable [Boolean]
   # @param as [String, Symbol, NilClass]
-  # @param dynamic_options [Hash<Symbol,Any>]
-  # @return [SmartCore::Initializer::Attribute]
+  # @param default [Proc, Any]
+  # @param optional [Boolean]
+  # @return [SmartCore::Initializer::Attribute::Value::Option]
   #
   # @api private
   # @since 0.1.0
-  def build_attribute(
+  # @version 0.8.0
+  def build_option_attribute(
     name,
     type,
     type_system,
     privacy,
     finalize,
     cast,
-    read_only,
+    mutable,
     as,
-    dynamic_options
+    default,
+    optional
   )
-    SmartCore::Initializer::Attribute::Factory.create(
-      name, type, type_system, privacy, finalize, cast, read_only, as, dynamic_options
+    SmartCore::Initializer::Attribute::Factory::Option.create(
+      name, type, type_system, privacy, finalize, cast, mutable, as, default, optional
     )
   end
 
@@ -207,27 +246,77 @@ class SmartCore::Initializer::Constructor::Definer
     SmartCore::Initializer::Extensions::ExtInit.new(block)
   end
 
-  # @param parameter [SmartCore::Initializer::Attribute]
+  # @param parameter [SmartCore::Initializer::Attribute::Value::Param]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
+  # @version 0.8.0
+  # rubocop:disable Metrics/AbcSize
   def add_parameter(parameter)
     klass.__params__ << parameter
-    klass.send(:attr_reader, parameter.name)
-    klass.send(parameter.privacy, parameter.name)
+    klass.__send__(:attr_reader, parameter.name)
+    klass.__send__(parameter.privacy, parameter.name)
+
+    if parameter.mutable?
+      # NOTE:
+      #   code evaluation approach is used instead of `define_method` approach in order
+      #   to avoid the `clojure`-context binding inside the new method (this context can
+      #   access the current context or the current variable set and the way to avoid this by
+      #   ruby method is more diffcult to support and read insead of the real `code` evaluation)
+      klass.class_eval(<<~METHOD_CODE, __FILE__, __LINE__ + 1)
+        #{parameter.privacy} def #{parameter.name}=(new_value)
+          self.class.__params__[:#{parameter.name}].validate!(new_value)
+          @#{parameter.name} = new_value
+        end
+      METHOD_CODE
+    end
+
+    if parameter.as
+      klass.__send__(:alias_method, parameter.as, parameter.name)
+      klass.__send__(:alias_method, "#{parameter.as}=", "#{parameter.name}=") if parameter.mutable?
+
+      klass.__send__(parameter.privacy, parameter.as)
+      klass.__send__(parameter.privacy, "#{parameter.as}=") if parameter.mutable?
+    end
   end
+  # rubocop:enable Metrics/AbcSize
 
-  # @param option [SmartCore::Initializer::Attribute]
+  # @param option [SmartCore::Initializer::Attribute::Value::Option]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
+  # @version 0.8.0
+  # rubocop:disable Metrics/AbcSize
   def add_option(option)
     klass.__options__ << option
-    klass.send(:attr_reader, option.name)
-    klass.send(option.privacy, option.name)
+    klass.__send__(:attr_reader, option.name)
+    klass.__send__(option.privacy, option.name)
+
+    if option.mutable?
+      # NOTE:
+      #   code evaluation approach is used instead of `define_method` approach in order
+      #   to avoid the `clojure`-context binding inside the new method (this context can
+      #   access the current context or the current variable set and the way to avoid this by
+      #   ruby method is more diffcult to support and read insead of the real `code` evaluation)
+      klass.class_eval(<<~METHOD_CODE, __FILE__, __LINE__ + 1)
+        #{option.privacy} def #{option.name}=(new_value)
+          self.class.__options__[:#{option.name}].validate!(new_value)
+          @#{option.name} = new_value
+        end
+      METHOD_CODE
+    end
+
+    if option.as
+      klass.__send__(:alias_method, option.as, option.name)
+      klass.__send__(:alias_method, "#{option.as}=", "#{option.name}=") if option.mutable?
+
+      klass.__send__(option.privacy, option.as)
+      klass.__send__(option.privacy, "#{option.as}=") if option.mutable?
+    end
   end
+  # rubocop:enable Metrics/AbcSize
 
   # @param extension [SmartCore::Initializer::Extensions::ExtInit]
   # @return [void]

data/lib/smart_core/initializer/constructor.rb

@@ -72,7 +72,7 @@ class SmartCore::Initializer::Constructor
   #
   # @api private
   # @since 0.1.0
-  # @version 0.7.0
+  # @version 0.8.0
   # rubocop:disable Metrics/AbcSize
   def prevent_attribute_insufficiency
     required_parameter_count = klass.__params__.size
@@ -83,8 +83,8 @@ class SmartCore::Initializer::Constructor
       "(given #{parameters.size}, expected #{required_parameter_count})"
     ) unless parameters.size == required_parameter_count
 
-    required_options = klass.__options__.reject(&:has_default?).map(&:name)
-    missing_options  = required_options.reject { |option| options.key?(option) }
+    required_options = klass.__options__.reject(&:has_default?).reject(&:optional?).map(&:name)
+    missing_options  = required_options.reject { |option_name| options.key?(option_name) }
 
     raise(
       SmartCore::Initializer::OptionArgumentError,
@@ -97,7 +97,7 @@ class SmartCore::Initializer::Constructor
     raise(
       SmartCore::Initializer::OptionArgumentError,
       "Unknown options: #{unknown_options.join(', ')}"
-    ) if unknown_options.any? && SmartCore::Initializer::Configuration[:strict_options]
+    ) if klass.__initializer_settings__.strict_options && unknown_options.any?
   end
   # rubocop:enable Metrics/AbcSize
 
@@ -124,8 +124,9 @@ class SmartCore::Initializer::Constructor
       end
 
       attribute.validate!(parameter_value)
-
       final_value = attribute.finalizer.call(parameter_value, instance)
+      attribute.validate!(final_value)
+
       instance.instance_variable_set("@#{attribute.name}", final_value)
     end
   end
@@ -135,21 +136,34 @@ class SmartCore::Initializer::Constructor
   #
   # @api private
   # @since 0.1.0
-  # @version 0.5.1
+  # @version 0.8.0
+  # rubocop:disable Metrics/AbcSize
   def initialize_options(instance)
     klass.__options__.each do |attribute|
-      option_value = options.fetch(attribute.name) { attribute.default }
-
-      if !attribute.type.valid?(option_value) && attribute.cast?
-        option_value = attribute.type.cast(option_value)
+      option_value = options.fetch(attribute.name) do
+        # NOTE: `nil` case is a case when an option is `optional`
+        attribute.has_default? ? attribute.default : nil
       end
 
-      attribute.validate!(option_value)
+      # NOTE: (if-block: what if `if` receives `false`?):
+      #   For other case passed `attribute` is optional and
+      #   should not be type-checked/type-casted/etc.
+      #   But optional attributes with defined `default` setting should be
+      #   type-checked and type-casted.
+      if options.key?(attribute.name) || attribute.has_default?
+        if !attribute.type.valid?(option_value) && attribute.cast?
+          option_value = attribute.type.cast(option_value)
+        end
+
+        attribute.validate!(option_value)
+        option_value = attribute.finalizer.call(option_value, instance)
+        attribute.validate!(option_value)
+      end
 
-      final_value = attribute.finalizer.call(option_value, instance)
-      instance.instance_variable_set("@#{attribute.name}", final_value)
+      instance.instance_variable_set("@#{attribute.name}", option_value)
     end
   end
+  # rubocop:enable Metrics/AbcSize
 
   # @param instance [Any]
   # @return [void]
@@ -157,7 +171,7 @@ class SmartCore::Initializer::Constructor
   # @api private
   # @since 0.1.0
   def process_original_initializer(instance)
-    instance.send(:initialize, *arguments, &block)
+    instance.__send__(:initialize, *arguments, &block)
   end
 
   # @param instance [Any]

data/lib/smart_core/initializer/dsl.rb

@@ -108,37 +108,42 @@ module SmartCore::Initializer::DSL
     # @option cast [Boolean]
     # @option privacy [String, Symbol]
     # @option finalize [String, Symbol, Proc]
-    # @option read_only [Boolean]
+    # @option mutable [Boolean]
     # @option as [NilClass, String, Symbol]
-    # @param dynamic_options [Hash<Symbol,Any>]
     # @return [void]
     #
     # @api public
     # @since 0.1.0
-    # @version 0.4.0
+    # @version 0.8.0
     def param(
       name,
       type = __initializer_settings__.generic_type_object,
-      privacy: SmartCore::Initializer::Attribute::Parameters::DEFAULT_PRIVACY_MODE,
-      finalize: SmartCore::Initializer::Attribute::Parameters::DEFAULT_FINALIZER,
-      cast: SmartCore::Initializer::Attribute::Parameters::DEFAULT_CAST_BEHAVIOUR,
+      privacy: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE,
+      finalize: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_FINALIZER,
+      cast: __initializer_settings__.auto_cast,
       type_system: __initializer_settings__.type_system,
-      read_only: SmartCore::Initializer::Attribute::Parameters::DEFAULT_READ_ONLY,
-      as: SmartCore::Initializer::Attribute::Parameters::DEFAULT_AS,
-      **dynamic_options
+      mutable: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE,
+      as: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_AS
     )
       __definer__.define_parameter(
-        name, type, type_system, privacy, finalize, cast, read_only, as, dynamic_options
+        name, type, type_system, privacy, finalize, cast, mutable, as
       )
     end
 
     # @param names [Array<String, Symbol>]
+    # @option mutable [Boolean]
+    # @option privacy [String, Symbol]
     # @return [void]
     #
     # @api public
     # @since 0.1.0
-    def params(*names)
-      __definer__.define_parameters(*names)
+    # @verison 0.8.0
+    def params(
+      *names,
+      mutable: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE,
+      privacy: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE
+    )
+      __definer__.define_parameters(*names, mutable: mutable, privacy: privacy)
     end
 
     # @param name [String, Symbol]
@@ -147,37 +152,46 @@ module SmartCore::Initializer::DSL
     # @option privacy [String, Symbol]
     # @option finalize [String, Symbol, Proc]
     # @option type_system [String, Symbol]
-    # @option read_only [Boolean]
+    # @option mutable [Boolean]
     # @option as [NilClass, String, Symbol]
-    # @param dynamic_options [Hash<Symbol,Any>]
+    # @option default [Proc, Any]
+    # @option optional [Boolean]
     # @return [void]
     #
     # @api public
     # @since 0.1.0
-    # @version 0.4.0
+    # @version 0.8.0
     def option(
       name,
       type = __initializer_settings__.generic_type_object,
-      privacy: SmartCore::Initializer::Attribute::Parameters::DEFAULT_PRIVACY_MODE,
-      finalize: SmartCore::Initializer::Attribute::Parameters::DEFAULT_FINALIZER,
-      cast: SmartCore::Initializer::Attribute::Parameters::DEFAULT_CAST_BEHAVIOUR,
+      privacy: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE,
+      finalize: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_FINALIZER,
+      cast: __initializer_settings__.auto_cast,
       type_system: __initializer_settings__.type_system,
-      read_only: SmartCore::Initializer::Attribute::Parameters::DEFAULT_READ_ONLY,
-      as: SmartCore::Initializer::Attribute::Parameters::DEFAULT_AS,
-      **dynamic_options
+      mutable: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE,
+      as: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_AS,
+      default: SmartCore::Initializer::Attribute::Value::Option::UNDEFINED_DEFAULT,
+      optional: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_OPTIONAL
     )
       __definer__.define_option(
-        name, type, type_system, privacy, finalize, cast, read_only, as, dynamic_options
+        name, type, type_system, privacy, finalize, cast, mutable, as, default, optional
       )
     end
 
     # @param names [Array<String, Symbol>]
+    # @option mutable [Boolean]
+    # @option privacy [String, Symbol]
     # @return [void]
     #
     # @api public
     # @since 0.1.0
-    def options(*names)
-      __definer__.define_options(*names)
+    # @version 0.8.0
+    def options(
+      *names,
+      mutable: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE,
+      privacy: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE
+    )
+      __definer__.define_options(*names, mutable: mutable, privacy: privacy)
     end
 
     # @param block [Block]