smart_core 0.4.0 → 0.5.0

data/lib/smart_core/{operation → initializer}/attribute_set.rb

@@ -1,58 +1,58 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.2.0
-class SmartCore::Operation::AttributeSet
-  # @since 0.2.0
+# @since 0.5.0
+class SmartCore::Initializer::AttributeSet
+  # @since 0.5.0
   include Enumerable
 
-  # @return [Hash<Symbol, SmartCore::Operation::Attribute>]
+  # @return [Hash<Symbol, SmartCore::Initializer::Attribute>]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   attr_reader :attributes
 
   # @return [void]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   def initialize
     @attributes = {}
     @access_lock = Mutex.new
   end
 
-  # @param attribute [SmartCore::Operation::Attribute]
+  # @param attribute [SmartCore::Initializer::Attribute]
   # @return [void]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   def add_attribute(attribute)
     thread_safe { attributes[attribute.name] = attribute }
   end
   alias_method :<<, :add_attribute
 
-  # @param attribute_set [SmartCore::Operation::AttributeSet]
+  # @param attribute_set [SmartCore::Initializer::AttributeSet]
   # @return [void]
   #
   # @api private
-  # @sinec 0.2.0
+  # @sinec 0.5.0
   def concat(attribute_set)
     thread_safe { attributes.merge!(attribute_set.dup.attributes) }
   end
 
-  # @param attribute [SmartCore::Operation::Attribute]
+  # @param attribute [SmartCore::Initializer::Attribute]
   # @return [Boolean]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   def conflicts_with?(attribute)
     thread_safe { attributes.key?(attribute.name) }
   end
 
-  # @return [SmartCore::Operation::AttributeSet]
+  # @return [SmartCore::Initializer::AttributeSet]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   def dup
     thread_safe do
       self.class.new.tap do |duplicate|
@@ -66,7 +66,7 @@ class SmartCore::Operation::AttributeSet
   # @return [Integer]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   def size
     thread_safe { attributes.size }
   end
@@ -74,7 +74,7 @@ class SmartCore::Operation::AttributeSet
   # @return [Enumerable]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   def each(&block)
     thread_safe { block_given? ? attributes.each_value(&block) : attributes.each_value }
   end
@@ -85,7 +85,7 @@ class SmartCore::Operation::AttributeSet
   # @return [Any]
   #
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   def thread_safe(&block)
     @access_lock.synchronize(&block)
   end

data/lib/smart_core/initializer/exceptions.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer
+  # @api public
+  # @since 0.5.0
+  Error = Class.new(SmartCore::Error)
+
+  # @api public
+  # @since 0.5.0
+  ArgumentError = Class.new(SmartCore::ArgumentError)
+
+  # @api public
+  # @since 0.5.0
+  IncompatibleFinalizerTypeError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.5.0
+  ParameterError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.5.0
+  ParamOverlapError = Class.new(ParameterError)
+
+  # @api public
+  # @since 0.5.0
+  OptionError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.5.0
+  OptionOverlapError = Class.new(OptionError)
+
+  # @api public
+  # @since 0.5.0
+  IncorrectAttributeNameError = Class.new(Error)
+
+  # @api public
+  # @since 0.5.0
+  UnregisteredTypeError = Class.new(Error)
+
+  # @api public
+  # @since 0.5.0
+  UnsupportedAttributePrivacyError = Class.new(Error)
+
+  # @api public
+  # @since 0.5.0
+  TypeError = Class.new(ArgumentError)
+end

data/lib/smart_core/initializer/extension.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Initializer::Extension
+  # @param additional_initialization_flow [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def initialize(additional_initialization_flow)
+    @additional_initialization_flow = additional_initialization_flow
+  end
+
+  # @param instance [Object]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def call(instance)
+    additional_initialization_flow.call(instance)
+  end
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def dup
+    self.class.new(additional_initialization_flow)
+  end
+
+  private
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :additional_initialization_flow
+end

data/lib/smart_core/initializer/extension_definer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Initializer::ExtensionDefiner
+  # @param processed_klass [Class]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def initialize(processed_klass)
+    @processed_klass = processed_klass
+    @definition_lock = Mutex.new
+  end
+
+  # @param raw_extension [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def append_extension(raw_extension)
+    thread_safe do
+      extension = build_extension(raw_extension)
+      extend_initialization_flow(extension)
+    end
+  end
+
+  private
+
+  # @return [Class]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :processed_klass
+
+  # @param raw_extension [Proc]
+  # @return [SmartCore::Initializar::Extension]
+  #
+  # @api private
+  # @since 0.5.0
+  def build_extension(raw_extension)
+    SmartCore::Initializer::Extension.new(raw_extension)
+  end
+
+  # @param extension [SmartCore::Initializer::Extension]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def extend_initialization_flow(extension)
+    processed_klass.__initialization_extensions__ << extension
+  end
+
+  # @param block [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def thread_safe(&block)
+    @definition_lock.synchronize(&block)
+  end
+end

data/lib/smart_core/initializer/extension_set.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Initializer::ExtensionSet
+  # @since 0.5.0
+  include Enumerable
+
+  # @return [Array<SmartCore::Initializer::InitializationExtension>]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :extensions
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def initialize
+    @extensions = []
+    @access_lock = Mutex.new
+  end
+
+  # @param extension [SmartCore::Initializer::InitializationExtension]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def add_extension(extension)
+    thread_safe { extensions << extension }
+  end
+  alias_method :<<, :add_extension
+
+  # @return [SmartCore::Initializer::ExtensionSet]
+  #
+  # @api private
+  # @since 0.5.0
+  def dup
+    thread_safe do
+      self.class.new.tap do |duplicate|
+        extensions.each do |extension|
+          duplicate.add_extension(extension.dup)
+        end
+      end
+    end
+  end
+
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.5.0
+  def each(&block)
+    thread_safe { block_given? ? extensions.each(&block) : extensions.each }
+  end
+
+  # @param extension_set [SmartCore::Initializer::ExtensionSet]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def concat(extension_set)
+    thread_safe { extensions.concat(extension_set.dup.extensions) }
+  end
+
+  private
+
+  # @param block [Proc]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.5.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
+  end
+end

data/lib/smart_core/{operation → initializer}/initialization_dsl.rb

@@ -1,36 +1,46 @@
 # frozen_string_literal: true
 
-class SmartCore::Operation
+module SmartCore::Initializer
   # @api private
-  # @since 0.2.0
+  # @since 0.5.0
   module InitializationDSL
     class << self
       # @param base_klass [Class]
       # @return [void]
       #
       # @api private
-      # @since 0.2.0
+      # @since 0.5.0
       def included(base_klass) # rubocop:disable Metrics/AbcSize
-        base_klass.extend(DSLMethods)
-        base_klass.singleton_class.prepend(InitializationMethods)
-
+        # rubocop:disable Metrics/LineLength
+        base_klass.instance_variable_set(:@__initialization_extension_definer__, ExtensionDefiner.new(base_klass))
+        base_klass.instance_variable_set(:@__initialization_extensions__, ExtensionSet.new)
         base_klass.instance_variable_set(:@__attr_definer__, AttributeDefiner.new(base_klass))
         base_klass.instance_variable_set(:@__params__, AttributeSet.new)
         base_klass.instance_variable_set(:@__options__, AttributeSet.new)
+        # rubocop:enable Metrics/LineLength
+
+        base_klass.extend(ClassMethods)
+        base_klass.extend(DSLMethods)
+        base_klass.singleton_class.prepend(InitializationMethods)
 
         base_klass.singleton_class.prepend(Module.new do
           # @param child_klass [Class]
           # @return [void]
           #
           # @api private
-          # @since 0.2.0
-          def inherited(child_klass)
-            child_klass.singleton_class.prepend(InitializationMethods)
-
+          # @since 0.5.0
+          def inherited(child_klass) # rubocop:disable Metrics/AbcSize
+            # rubocop:disable Metrics/LineLength
+            child_klass.instance_variable_set(:@__initialization_extension_definer__, ExtensionDefiner.new(child_klass))
+            child_klass.instance_variable_set(:@__initialization_extensions__, ExtensionSet.new)
             child_klass.instance_variable_set(:@__attr_definer__, AttributeDefiner.new(child_klass))
             child_klass.instance_variable_set(:@__params__, AttributeSet.new)
             child_klass.instance_variable_set(:@__options__, AttributeSet.new)
+            # rubocop:enable Metrics/LineLength
+
+            child_klass.singleton_class.prepend(InitializationMethods)
 
+            child_klass.__initialization_extensions__.concat(__initialization_extensions__)
             child_klass.__params__.concat(__params__)
             child_klass.__options__.concat(__options__)
 
@@ -41,14 +51,14 @@ class SmartCore::Operation
     end
 
     # @api private
-    # @since 0.2.0
+    # @since 0.5.0
     module InitializationMethods
       # @param parameters [Any]
       # @param options [Hash<Symbol,Any>]
       # @return [Any]
       #
       # @api public
-      # @since 0.2.0
+      # @since 0.5.0
       def new(*parameters, **options)
         allocate.tap do |object|
           InstanceBuilder.call(object, self, parameters, options)
@@ -57,22 +67,67 @@ class SmartCore::Operation
     end
 
     # @api private
-    # @since 0.2.0
+    # @since 0.5.0
+    module ClassMethods
+      # @return [SmartCore::Initializer::AttributeSet]
+      #
+      # @api private
+      # @since 0.5.0
+      def __params__
+        @__params__
+      end
+
+      # @return [SmartCore::Initializer::AttributeSet]
+      #
+      # @api private
+      # @since 0.5.0
+      def __options__
+        @__options__
+      end
+
+      # @return [SmartCore::Initializer::AttributeDefiner]
+      #
+      # @api private
+      # @since 0.5.0
+      def __attr_definer__
+        @__attr_definer__
+      end
+
+      # @return [SmartCore::Initializer::ExtensionSet]
+      #
+      # @api private
+      # @since 0.5.0
+      def __initialization_extensions__
+        @__initialization_extensions__
+      end
+
+      # @return [SmartCore::Initializer::ExtensionDefiner]
+      #
+      # @api private
+      # @since 0.5.0
+      def __initialization_extension_definer__
+        @__initialization_extension_definer__
+      end
+    end
+
+    # @api private
+    # @since 0.5.0
     module DSLMethods
       # @param param_name [String, Symbol]
+      # @param options [Hash<Symbol,Any>]
       # @return [void]
       #
       # @api public
-      # @since 0.2.0
-      def param(param_name)
-        __attr_definer__.define_param(param_name)
+      # @since 0.5.0
+      def param(param_name, type = :__any__, **options)
+        __attr_definer__.define_param(param_name, type, **options)
       end
 
       # @param param_names [Array<String, Symbol>]
       # @return [void]
       #
       # @api public
-      # @since 0.2.0
+      # @since 0.5.0
       def params(*param_names)
         __attr_definer__.define_params(*param_names)
       end
@@ -82,42 +137,27 @@ class SmartCore::Operation
       # @return [void]
       #
       # @api public
-      # @since 0.2.0
-      def option(option_name, **options)
-        __attr_definer__.define_option(option_name, **options)
+      # @since 0.5.0
+      def option(option_name, type = :__any__, **options)
+        __attr_definer__.define_option(option_name, type, **options)
       end
 
       # @param option_names [Array<String, Symbol>]
       # @return [void]
       #
       # @api public
-      # @since 0.2.0
+      # @since 0.5.0
       def options(*option_names)
         __attr_definer__.define_options(*option_names)
       end
 
-      # @return [SmartCore::Operation::AttributeSet]
-      #
-      # @api private
-      # @since 0.2.0
-      def __params__
-        @__params__
-      end
-
-      # @return [SmartCore::Operation::AttributeSet]
-      #
-      # @api private
-      # @since 0.2.0
-      def __options__
-        @__options__
-      end
-
-      # @return [SmartCore::Operation::AttributeDefiner]
+      # @param block [Proc]
+      # @return [void]
       #
-      # @api private
-      # @since 0.2.0
-      def __attr_definer__
-        @__attr_definer__
+      # @api public
+      # @since 0.5.0
+      def extend_initialization_flow(&block)
+        __initialization_extension_definer__.append_extension(block)
       end
     end
   end

data/lib/smart_core/initializer/instance_attribute_accessing.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+module SmartCore::Initializer::InstanceAttributeAccessing
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api public
+  # @since 0.5.0
+  def params
+    __collect_params__
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api public
+  # @since 0.5.0
+  def options
+    __collect_options__
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api public
+  # @since 0.5.0
+  def attributes
+    __collect_params__.merge(__collect_options__)
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api private
+  # @since 0.5.0
+  def __collect_params__
+    self.class.__params__.each_with_object({}) do |param, memo|
+      memo[param.name] = instance_variable_get("@#{param.name}")
+    end
+  end
+
+  # @return [Hash<Symbol,Any>]
+  #
+  # @api private
+  # @since 0.5.0
+  def __collect_options__
+    self.class.__options__.each_with_object({}) do |option, memo|
+      memo[option.name] = instance_variable_get("@#{option.name}")
+    end
+  end
+end