smart_initializer 0.4.0 → 0.8.0

data/lib/smart_core/initializer/attribute/factory.rb

@@ -2,203 +2,9 @@
 
 # @api private
 # @since 0.1.0
-# rubocop:disable Metrics/ClassLength
-class SmartCore::Initializer::Attribute::Factory
-  class << self
-    # @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 read_only [Boolean]
-    # @param as [String, Symbol, NilClass]
-    # @param dynamic_options [Hash<Symbol,Any>]
-    # @return [SmartCore::Initializer::Attribute]
-    #
-    # @api private
-    # @since 0.1.0
-    def create(name, type, type_system, privacy, finalize, cast, read_only, as, dynamic_options)
-      prepared_name            = prepare_name_param(name)
-      prepared_privacy         = prepare_privacy_param(privacy)
-      prepared_finalize        = prepare_finalize_param(finalize)
-      prepared_cast            = prepare_cast_param(cast)
-      prepared_type_system     = prepare_type_system_param(type_system)
-      prepared_type            = prepare_type_param(type, prepared_type_system)
-      prepared_read_only       = prepare_read_only_param(read_only)
-      prepared_as              = preapre_as_param(as)
-      prepared_dynamic_options = prepare_dynamic_options_param(dynamic_options)
-
-      create_attribute(
-        prepared_name,
-        prepared_type,
-        prepared_type_system,
-        prepared_privacy,
-        prepared_finalize,
-        prepared_cast,
-        prepared_read_only,
-        prepared_as,
-        prepared_dynamic_options
-      )
-    end
-
-    private
-
-    # @param name [String, Symbol]
-    # @return [Symbol]
-    #
-    # @api private
-    # @since 0.1.0
-    def prepare_name_param(name)
-      unless name.is_a?(String) || name.is_a?(Symbol)
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Attribute name should be a type of String or Symbol
-        ERROR_MESSAGE
-      end
-
-      name.to_sym
-    end
-
-    # @param type [String, Symbol, Any]
-    # @param type_system [Class<SmartCore::Initializer::TypeSystem::Interop>]
-    # @return [SmartCore::Initializer::TypeSystem::Interop]
-    #
-    # @api private
-    # @since 0.1.0
-    def prepare_type_param(type, type_system)
-      type_primitive =
-        if type.is_a?(String) || type.is_a?(Symbol)
-          type_system.type_from_alias(type)
-        else
-          type
-        end
-
-      type_system.create(type_primitive)
-    end
-
-    # @param cast [Boolean]
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.1.0
-    def prepare_cast_param(cast)
-      unless cast.is_a?(TrueClass) || cast.is_a?(FalseClass)
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Attribute cast should be a type of boolean
-        ERROR_MESSAGE
-      end
-
-      cast
-    end
-
-    # @param privacy [String, Symbol]
-    # @return [Symbol]
-    #
-    # @api private
-    # @since 0.1.0
-    def prepare_privacy_param(privacy)
-      unless privacy.is_a?(String) || privacy.is_a?(Symbol)
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Attribute privacy should be a type of String or Symbol
-        ERROR_MESSAGE
-      end
-
-      SmartCore::Initializer::Attribute::Parameters::PRIVACY_MODES.fetch(privacy.to_sym) do
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Incorrect attribute privacy identifier "#{privacy}"
-        ERROR_MESSAGE
-      end
-    end
-
-    # @param finalize [String, Symbol, Proc]
-    # @return [SmartCore::Initializer::Attribute::Finalizer::AnonymousBlock/InstanceMethod]
-    #
-    # @api private
-    # @since 0.1.0
-    def prepare_finalize_param(finalize)
-      unless finalize.is_a?(String) || finalize.is_a?(Symbol) || finalize.is_a?(Proc)
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Attribute finalizer should be a type of String, Symbol or Proc
-        ERROR_MESSAGE
-      end
-
-      SmartCore::Initializer::Attribute::Finalizer.create(finalize)
-    end
-
-    # @param read_only [Boolean]
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.4.0
-    def prepare_read_only_param(read_only)
-      unless read_only.is_a?(FalseClass) || read_only.is_a?(TrueClass)
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          :read_only attribute should be a type of boolean
-        ERROR_MESSAGE
-      end
-
-      read_only
-    end
-
-    # @param [String, Symbol, NilClass]
-    # @return [String, Symbol, NilClass]
-    #
-    # @api private
-    # @since 0.4.0
-    def preapre_as_param(as)
-      unless as.is_a?(NilClass) || as.is_a?(String) || as.is_a?(Symbol)
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Attribute alias should be a type of String or Symbol
-        ERROR_MESSAGE
-      end
-
-      as
-    end
-
-    # @param dynamic_options [Hash<Symbol,Any>]
-    # @return [Hash<Symbol,Any>]
-    #
-    # @api private
-    # @since 0.1.0
-    def prepare_dynamic_options_param(dynamic_options)
-      # :nocov:
-      unless dynamic_options.is_a?(Hash)
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Attribute dynamic options should be a type of Hash
-        ERROR_MESSAGE
-      end
-      # :nocov:
-
-      dynamic_options
-    end
-
-    # @param type_system [String, Symbol]
-    # @return [Class<SmartCore::Initializer::TypeSystem::Interop>]
-    #
-    # @api private
-    # @since 0.1.0
-    def prepare_type_system_param(type_system)
-      SmartCore::Initializer::TypeSystem.resolve(type_system)
-    end
-
-    # @param name [String]
-    # @param type [SmartCore::Initializer::TypeSystem::Interop]
-    # @param type_system [Class<SmartCore::Initializer::TypeSystem::Interop>]
-    # @param privacy [Symbol]
-    # @param finalize [SmartCore::Initializer::Attribute::Finalizer::AnonymousBlock/InstanceMethod]
-    # @param cast [Boolean]
-    # @param dynamic_options [Hash<Symbol,String>]
-    # @return [SmartCore::Initializer::Attribute]
-    #
-    # @api private
-    # @since 0.1.0
-    # rubocop:disable Layout/LineLength
-    def create_attribute(name, type, type_system, privacy, finalize, cast, read_only, as, dynamic_options)
-      SmartCore::Initializer::Attribute.new(
-        name, type, type_system, privacy, finalize, cast, read_only, as, dynamic_options
-      )
-    end
-    # rubocop:enable Layout/LineLength
-  end
+# @version 0.8.0
+module SmartCore::Initializer::Attribute::Factory
+  require_relative 'factory/base'
+  require_relative 'factory/option'
+  require_relative 'factory/param'
 end
-# rubocop:enable Metrics/ClassLength

data/lib/smart_core/initializer/attribute/finalizer/abstract.rb

@@ -19,7 +19,9 @@ class SmartCore::Initializer::Attribute::Finalizer::Abstract
   # @api private
   # @since 0.1.0
   def call(value, instance)
+    # :nocov:
     raise NoMethodError
+    # :nocov:
   end
 
   # @return [SmartCore::Initializer::Attribute::Finalizer::Abstract]

data/lib/smart_core/initializer/attribute/finalizer/instance_method.rb

@@ -20,7 +20,7 @@ module SmartCore::Initializer::Attribute::Finalizer
     # @pai private
     # @since 0.1.0
     def call(value, instance)
-      instance.send(finalizer, value)
+      instance.__send__(finalizer, value)
     end
 
     private

data/lib/smart_core/initializer/attribute/finalizer.rb

@@ -14,6 +14,7 @@ module SmartCore::Initializer::Attribute::Finalizer
     #
     # @api private
     # @since 0.1.0
+    # @version 0.8.0
     def create(finalization_approach)
       case finalization_approach
       when String, Symbol
@@ -21,11 +22,10 @@ module SmartCore::Initializer::Attribute::Finalizer
       when Proc
         AnonymousBlock.new(finalization_approach)
       else
-        # :nocov:
-        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
-          Finalization approach should be a type of Proc, Symbol or String'
-        ERROR_MESSAGE
-        # :nocov:
+        raise(
+          SmartCore::Initializer::ArgumentError,
+          'Finalization approach object should be a type of Proc, Symbol or String'
+        )
       end
     end
   end

data/lib/smart_core/initializer/attribute/list.rb

@@ -15,6 +15,26 @@ class SmartCore::Initializer::Attribute::List
     @lock = SmartCore::Engine::Lock.new
   end
 
+  # @param attribute_name [Symbol]
+  # @return [SmartCore::Initializer::Atribute]
+  #
+  # @raise [SmartCore::Initializer::UndefinedAttributeError]
+  #
+  # @api private
+  # @since 0.8.0
+  def fetch(attribute_name)
+    thread_safe do
+      attributes.fetch(attribute_name)
+    rescue ::KeyError
+      raise(
+        ::SmartCore::Initializer::UndefinedAttributeError,
+        "Attribute with `#{attribute_name}` name is not defined in your constructor. " \
+        "Please, check your attribute definitions inside your class."
+      )
+    end
+  end
+  alias_method :[], :fetch
+
   # @param attribute [SmartCore::Initializer::Attribute]
   # @return [void]
   #

data/lib/smart_core/initializer/attribute/{parameters.rb → value/base.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
-class SmartCore::Initializer::Attribute::Parameters
+# @since 0.8.0
+class SmartCore::Initializer::Attribute::Value::Base
   # @return [Hash<Symbol,Symbol>]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   PRIVACY_MODES = {
     public:    :public,
     protected: :protected,
@@ -16,93 +16,76 @@ class SmartCore::Initializer::Attribute::Parameters
   # @return [Symbol]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   DEFAULT_PRIVACY_MODE = PRIVACY_MODES[:public]
 
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  DEFAULT_CAST_BEHAVIOUR = false
-
   # @return [Proc]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   DEFAULT_FINALIZER = proc { |value| value }.freeze
 
-  # @return [Hash]
+  # @return [NilClass]
   #
   # @api private
-  # @since 0.1.0
-  DEFAULT_DYNAMIC_OPTIONS = {}.freeze
+  # @since 0.8.0
+  DEFAULT_AS = nil
 
   # @return [Boolean]
   #
   # @api private
-  # @since 0.4.0
-  DEFAULT_READ_ONLY = true
-
-  # @return [NilClass]
-  #
-  # @api private
-  # @since 0.4.0
-  DEFAULT_AS = nil
+  # @since 0.8.0
+  DEFAULT_MUTABLE = false
 
   # @return [Symbol]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   attr_reader :name
 
   # @return [SmartCore::Initializer::TypeSystem::Interop]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   attr_reader :type
 
   # @return [Class<SmartCore::Initilizer::TypeSystem::Interop>]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   attr_reader :type_system
 
   # @return [Symbol]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   attr_reader :privacy
 
   # @return [SmartCore::Initializer::Attribute::Finalizer::AnonymousBlock]
   # @return [SmartCore::Initializer::Attribute::Finalizer::InstanceMethod]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   attr_reader :finalizer
 
   # @return [Boolean]
   #
   # @api private
-  # @since 0.1.0
+  # @since 0.8.0
   attr_reader :cast
   alias_method :cast?, :cast
 
-  # @return [Hash<Symbol,Any>]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :dynamic_options
-
   # @return [Boolean]
   #
   # @api private
-  # @since 0.4.0
-  attr_reader :read_only
+  # @since 0.8.0
+  attr_reader :mutable
+  alias_method :mutable?, :mutable
 
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.4.0
+  # @since 0.8.0
   attr_reader :as
 
   # @param name [Symbol]
@@ -111,48 +94,35 @@ class SmartCore::Initializer::Attribute::Parameters
   # @param privacy [Symbol]
   # @param finalizer [SmartCore::Initializer::Attribute::AnonymousBlock/InstanceMethod]
   # @param cast [Boolean]
-  # @param read_only [Boolean]
+  # @param mutable [Boolean]
   # @param as [NilClass, Symbol, String]
-  # @param dynamic_options [Hash<Symbol,Any>]
-  #   - :default - default value (Proc value will be called)
   # @return [void]
   #
   # @api private
-  # @since 0.1.0
-  # @version 0.4.0
-  def initialize(name, type, type_system, privacy, finalizer, cast, read_only, as, dynamic_options)
+  # @since 0.8.0
+  def initialize(name, type, type_system, privacy, finalizer, cast, mutable, as)
     @name = name
     @type = type
     @type_system = type_system
     @privacy = privacy
     @finalizer = finalizer
     @cast = cast
-    @read_only = read_only
+    @mutable = mutable
     @as = as
-    @dynamic_options = dynamic_options
   end
 
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def has_default?
-    dynamic_options.key?(:default)
-  end
-
-  # @return [Any]
-  #
-  # @raise [SmartCore::Initializer::NoDefaultValueError]
+  # @param value [Any]
+  # @return [void]
   #
   # @api private
-  # @since 0.1.0
-  def default
-    default_value = dynamic_options.fetch(:default) do
-      raise(SmartCore::Initializer::NoDefaultValueError, <<~ERROR_MESSAGE)
-        Attribute #{name} has no default value
-      ERROR_MESSAGE
-    end
-
-    default_value.is_a?(Proc) ? default_value.call : default_value
+  # @since 0.8.0
+  def validate!(value)
+    type.validate!(value)
+  rescue => error # TODO: move to typesystem interop
+    raise(
+      SmartCore::Initializer::IncorrectTypeError,
+      "Validation of attribute `#{name}` failed:" \
+      "(expected: #{type.identifier}, got: #{value.class}) \"#{error.message}\""
+    )
   end
 end

data/lib/smart_core/initializer/attribute/value/option.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer::Attribute::Value
+  # @api private
+  # @since 0.8.0
+  class Option < Base
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.8.0
+    UNDEFINED_DEFAULT = ::Object.new.tap(&:freeze)
+
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.8.0
+    DEFAULT_OPTIONAL = false
+
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.8.0
+    attr_reader :optional
+    alias_method :optional?, :optional
+
+    # @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::AnonymousBlock/InstanceMethod]
+    # @param cast [Boolean]
+    # @param mutable [Boolean]
+    # @param as [NilClass, Symbol, String]
+    # @param default [Proc, Any]
+    # @param optional [Boolean]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.8.0
+    def initialize(
+      name,
+      type,
+      type_system,
+      privacy,
+      finalizer,
+      cast,
+      mutable,
+      as,
+      default,
+      optional
+    )
+      super(name, type, type_system, privacy, finalizer, cast, mutable, as)
+      @default = default
+      @optional = optional
+    end
+
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.8.0
+    def has_default?
+      !@default.equal?(UNDEFINED_DEFAULT)
+    end
+
+    # @return [Any]
+    #
+    # @raise [SmartCore::Initializer::NoDefaultValueError]
+    #
+    # @api private
+    # @since 0.8.0
+    def default
+      raise(
+        SmartCore::Initializer::NoDefaultValueError,
+        "Attribute #{name} has no default value"
+      ) if @default.equal?(UNDEFINED_DEFAULT)
+
+      @default.is_a?(Proc) ? @default.call : @default.dup
+    end
+
+    # @return [SmartCore::Initializer::Attribute::Value::Option]
+    #
+    # @api private
+    # @since 0.8.0
+    def dup
+      default = @default.equal?(UNDEFINED_DEFAULT) ? @default : @default.dup
+
+      self.class.new(
+        name.dup,
+        type,
+        type_system,
+        privacy,
+        finalizer.dup,
+        cast,
+        mutable,
+        as,
+        default,
+        optional
+      )
+    end
+  end
+end

data/lib/smart_core/initializer/attribute/value/param.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer::Attribute::Value
+  # @api private
+  # @since 0.8.0
+  class Param < Base
+    # @return [SmartCore::Initializer::Attribute::Value::Param]
+    #
+    # @api private
+    # @since 0.8.0
+    def dup
+      self.class.new(
+        name.dup,
+        type,
+        type_system,
+        privacy,
+        finalizer.dup,
+        cast,
+        mutable,
+        as
+      )
+    end
+  end
+end

data/lib/smart_core/initializer/attribute/value.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.8.0
+module SmartCore::Initializer::Attribute::Value
+  require_relative 'value/base'
+  require_relative 'value/param'
+  require_relative 'value/option'
+end