smart_initializer 0.7.0 → 0.8.0

data/gemfiles/with_external_deps.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    smart_initializer (0.5.0)
+    smart_initializer (0.8.0)
       qonfig (~> 0.24)
       smart_engine (~> 0.11)
       smart_types (~> 0.4)
@@ -9,39 +9,39 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    armitage-rubocop (1.7.0.1)
-      rubocop (= 1.7.0)
-      rubocop-performance (= 1.9.1)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.1.0)
-    ast (2.4.1)
+    armitage-rubocop (1.23.0.1)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+      rubocop-rails (= 2.12.4)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.6.0)
+    ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     docile (1.3.5)
-    i18n (1.8.7)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.3)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.3.1)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    qonfig (0.25.0)
+    qonfig (0.26.0)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -55,29 +55,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.7.0)
+    rubocop (1.23.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.1)
-      rubocop (>= 0.90.0, < 2.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.12.4)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.1.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -86,21 +85,22 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
     smart_engine (0.11.0)
-    smart_types (0.4.0)
+    smart_types (0.7.0)
       smart_engine (~> 0.11)
     thy (0.1.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-21
 
 DEPENDENCIES
-  armitage-rubocop (~> 1.7)
+  armitage-rubocop (~> 1.23)
   bundler (~> 2.2)
-  pry (~> 0.13)
+  pry (~> 0.14)
   rake (~> 13.0)
   rspec (~> 3.10)
   simplecov (~> 0.21)
@@ -108,4 +108,4 @@ DEPENDENCIES
   thy (~> 0.1.4)
 
 BUNDLED WITH
-   2.2.3
+   2.2.31

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.8.0
+class SmartCore::Initializer::Attribute::Factory::Base
+  class << self
+    # @!method create(*params)
+    #   @param params [Any] List of appropriated attributes for the corresponding factory
+    #   @return [SmartCore::Initializer::Attribute::Base]
+
+    private
+
+    # @param name [String, Symbol]
+    # @return [Symbol]
+    #
+    # @api private
+    # @since 0.8.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.8.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.8.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.8.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::Value::Base::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.8.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
+
+      # rubocop:disable Style/SoleNestedConditional
+      if finalize.is_a?(::Proc) && finalize.lambda?
+        unless (finalize.arity == 1 || finalize.arity == -1)
+          raise(
+            SmartCore::Initializer::ArgumentError,
+            'Lambda-based finalizer should have arity equal to 1 or equal to -1 ' \
+            '(your lambda object should require one attribute)'
+          ) # TODO: show the name of attribute in error message (if the name is a valid, of course)
+        end
+      end
+      # rubocop:enable Style/SoleNestedConditional
+
+      SmartCore::Initializer::Attribute::Finalizer.create(finalize)
+    end
+
+    # @param mutable [Boolean]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.4.0
+    def prepare_mutable_param(mutable)
+      unless mutable.is_a?(::FalseClass) || mutable.is_a?(::TrueClass)
+        raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
+          :mutable attribute should be a type of boolean
+        ERROR_MESSAGE
+      end
+
+      mutable
+    end
+
+    # @param as [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 type_system [String, Symbol]
+    # @return [Class<SmartCore::Initializer::TypeSystem::Interop>]
+    #
+    # @api private
+    # @since 0.8.0
+    def prepare_type_system_param(type_system)
+      SmartCore::Initializer::TypeSystem.resolve(type_system)
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer::Attribute::Factory
+  # @api private
+  # @since 0.8.0
+  class Option < Base
+    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 mutable [Boolean]
+      # @param as [String, Symbol, NilClass]
+      # @param default [Proc, Any]
+      # @param optional [Boolean]
+      # @return [SmartCore::Initializer::Attribute::Value::Option]
+      #
+      # @api private
+      # @since 0.8.0
+      def create(name, type, type_system, privacy, finalize, cast, mutable, as, default, optional)
+        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_mutable     = prepare_mutable_param(mutable)
+        prepared_as          = preapre_as_param(as)
+        prepared_default     = prepare_default_param(default)
+        prepared_optional    = prepare_optional_param(optional)
+
+        create_attribute(
+          prepared_name,
+          prepared_type,
+          prepared_type_system,
+          prepared_privacy,
+          prepared_finalize,
+          prepared_cast,
+          prepared_mutable,
+          prepared_as,
+          prepared_default,
+          prepared_optional
+        )
+      end
+
+      private
+
+      # @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::Abstract]
+      # @param cast [Boolean]
+      # @param mutable [Boolean]
+      # @param as [String, Symbol]
+      # @param default [Proc, Any]
+      # @param optional [Boolean]
+      # @return [SmartCore::Initializer::Attribute::Value::Option]
+      #
+      # @api private
+      # @since 0.8.0
+      def create_attribute(
+        name,
+        type,
+        type_system,
+        privacy,
+        finalize,
+        cast,
+        mutable,
+        as,
+        default,
+        optional
+      )
+        SmartCore::Initializer::Attribute::Value::Option.new(
+          name, type, type_system, privacy, finalize, cast, mutable, as, default, optional
+        )
+      end
+
+      # @param default [Proc, Any]
+      # @return [Proc, Any]
+      #
+      # @api private
+      # @since 0.8.0
+      def prepare_default_param(default)
+        # NOTE: this "strange" approach is used to comply the default Factory methods approach here
+        default
+      end
+
+      # @param optional [Boolean]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.8.0
+      def prepare_optional_param(optional)
+        unless optional.is_a?(::TrueClass) || optional.is_a?(::FalseClass)
+          raise(SmartCore::Initializer::ArgumentError, <<~ERROR_MESSAGE)
+            :optional attribute should be a type of boolean
+          ERROR_MESSAGE
+        end
+
+        optional
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module SmartCore::Initializer::Attribute::Factory
+  # @api private
+  # @since 0.8.0
+  class Param < Base
+    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 mutable [Boolean]
+      # @param as [String, Symbol, NilClass]
+      # @return [SmartCore::Initializer::Attribute::Value::Param]
+      #
+      # @api private
+      # @since 0.8.0
+      def create(name, type, type_system, privacy, finalize, cast, mutable, as)
+        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_mutable     = prepare_mutable_param(mutable)
+        prepared_as          = preapre_as_param(as)
+
+        create_attribute(
+          prepared_name,
+          prepared_type,
+          prepared_type_system,
+          prepared_privacy,
+          prepared_finalize,
+          prepared_cast,
+          prepared_mutable,
+          prepared_as
+        )
+      end
+
+      private
+
+      # @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::Abstract]
+      # @param cast [Boolean]
+      # @param mutable [Boolean]
+      # @param as [String, Symbol]
+      # @return [SmartCore::Initializer::Attribute::Value::Param]
+      #
+      # @api private
+      # @since 0.8.0
+      def create_attribute(name, type, type_system, privacy, finalize, cast, mutable, as)
+        SmartCore::Initializer::Attribute::Value::Param.new(
+          name, type, type_system, privacy, finalize, cast, mutable, as
+        )
+      end
+    end
+  end
+end

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