smart_initializer 0.3.1 → 0.7.0

data/gemfiles/without_external_deps.gemfile.lock

@@ -1,100 +1,109 @@
 PATH
   remote: ..
   specs:
-    smart_initializer (0.2.0)
+    smart_initializer (0.5.0)
       qonfig (~> 0.24)
-      smart_engine (~> 0.6)
-      smart_types (~> 0.1.0)
+      smart_engine (~> 0.11)
+      smart_types (~> 0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    armitage-rubocop (0.85.0)
-      rubocop (= 0.85.0)
-      rubocop-performance (= 1.6.1)
-      rubocop-rails (= 2.5.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 (= 1.39.0)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    i18n (1.8.3)
+      rubocop-rspec (= 2.1.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    qonfig (0.24.1)
-    rack (2.2.2)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    qonfig (0.25.0)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.85.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-performance (1.6.1)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.5.2)
-      activesupport
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
+      rubocop (>= 0.90.0, < 2.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    smart_engine (0.6.0)
-    smart_types (0.1.0)
-      smart_engine (~> 0.6)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    smart_engine (0.11.0)
+    smart_types (0.4.0)
+      smart_engine (~> 0.11)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.85)
-  bundler (~> 2.1)
+  armitage-rubocop (~> 1.7)
+  bundler (~> 2.2)
+  pry (~> 0.13)
   rake (~> 13.0)
-  rspec (~> 3.9)
-  simplecov (~> 0.18)
+  rspec (~> 3.10)
+  simplecov (~> 0.21)
   smart_initializer!
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/lib/smart_core/initializer.rb

@@ -23,9 +23,6 @@ module SmartCore
     require_relative 'initializer/instance_attribute_accessing'
     require_relative 'initializer/functionality'
 
-    # @since 0.3.0
-    include SmartCore::Initializer::InstanceAttributeAccessing
-
     class << self
       # @param base_klass [Class]
       # @return [void]

data/lib/smart_core/initializer/attribute.rb

@@ -59,27 +59,55 @@ class SmartCore::Initializer::Attribute
   # @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, dynamic_options)
+  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, dynamic_options
+      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,
@@ -88,9 +116,12 @@ class SmartCore::Initializer::Attribute
       parameters.privacy,
       parameters.finalizer.dup,
       parameters.cast,
+      parameters.read_only,
+      parameters.as,
       parameters.dynamic_options.dup
     )
   end
+  # rubocop:enable Metrics/AbcSize
 
   private
 

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# rubocop:disable Metrics/ClassLength
 class SmartCore::Initializer::Attribute::Factory
   class << self
     # @param name [String, Symbol]
@@ -10,18 +11,22 @@ class SmartCore::Initializer::Attribute::Factory
     # @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, dynamic_options)
+    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(
@@ -31,6 +36,8 @@ class SmartCore::Initializer::Attribute::Factory
         prepared_privacy,
         prepared_finalize,
         prepared_cast,
+        prepared_read_only,
+        prepared_as,
         prepared_dynamic_options
       )
     end
@@ -118,6 +125,36 @@ class SmartCore::Initializer::Attribute::Factory
       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>]
     #
@@ -155,10 +192,13 @@ class SmartCore::Initializer::Attribute::Factory
     #
     # @api private
     # @since 0.1.0
-    def create_attribute(name, type, type_system, privacy, finalize, cast, dynamic_options)
+    # 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, dynamic_options
+        name, type, type_system, privacy, finalize, cast, read_only, as, dynamic_options
       )
     end
+    # rubocop:enable Layout/LineLength
   end
 end
+# rubocop:enable Metrics/ClassLength

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

@@ -37,6 +37,18 @@ class SmartCore::Initializer::Attribute::Parameters
   # @since 0.1.0
   DEFAULT_DYNAMIC_OPTIONS = {}.freeze
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.4.0
+  DEFAULT_READ_ONLY = true
+
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.4.0
+  DEFAULT_AS = nil
+
   # @return [Symbol]
   #
   # @api private
@@ -81,25 +93,42 @@ class SmartCore::Initializer::Attribute::Parameters
   # @since 0.1.0
   attr_reader :dynamic_options
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.4.0
+  attr_reader :read_only
+
+  # @return [String, Symbol, NilClass]
+  #
+  # @api private
+  # @since 0.4.0
+  attr_reader :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::AnonymousBlock/InstanceMethod]
   # @param cast [Boolean]
+  # @param read_only [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
-  def initialize(name, type, type_system, privacy, finalizer, cast, dynamic_options)
+  # @version 0.4.0
+  def initialize(name, type, type_system, privacy, finalizer, cast, read_only, as, dynamic_options)
     @name = name
     @type = type
     @type_system = type_system
     @privacy = privacy
     @finalizer = finalizer
     @cast = cast
+    @read_only = read_only
+    @as = as
     @dynamic_options = dynamic_options
   end
 

data/lib/smart_core/initializer/configuration.rb

@@ -29,5 +29,10 @@ module SmartCore::Initializer::Configuration
     validate :default_type_system do |value|
       SmartCore::Initializer::TypeSystem.resolve(value) rescue false
     end
+
+    setting :strict_options, true
+    validate :strict_options do |value|
+      !!value == value # check if it's a boolean value
+    end
   end
 end

data/lib/smart_core/initializer/constructor.rb

@@ -72,6 +72,7 @@ class SmartCore::Initializer::Constructor
   #
   # @api private
   # @since 0.1.0
+  # @version 0.7.0
   # rubocop:disable Metrics/AbcSize
   def prevent_attribute_insufficiency
     required_parameter_count = klass.__params__.size
@@ -96,7 +97,7 @@ class SmartCore::Initializer::Constructor
     raise(
       SmartCore::Initializer::OptionArgumentError,
       "Unknown options: #{unknown_options.join(', ')}"
-    ) if unknown_options.any?
+    ) if unknown_options.any? && SmartCore::Initializer::Configuration[:strict_options]
   end
   # rubocop:enable Metrics/AbcSize
 
@@ -113,15 +114,16 @@ class SmartCore::Initializer::Constructor
   #
   # @api private
   # @since 0.1.0
+  # @version 0.5.1
   def initialize_parameters(instance)
-    parameter_definitions = Hash[klass.__params__.zip(parameters)]
+    parameter_definitions = klass.__params__.zip(parameters).to_h
 
     parameter_definitions.each_pair do |attribute, parameter_value|
       if !attribute.type.valid?(parameter_value) && attribute.cast?
         parameter_value = attribute.type.cast(parameter_value)
       end
 
-      attribute.type.validate!(parameter_value)
+      attribute.validate!(parameter_value)
 
       final_value = attribute.finalizer.call(parameter_value, instance)
       instance.instance_variable_set("@#{attribute.name}", final_value)
@@ -133,7 +135,7 @@ class SmartCore::Initializer::Constructor
   #
   # @api private
   # @since 0.1.0
-  # rubocop:disable Metrics/AbcSize
+  # @version 0.5.1
   def initialize_options(instance)
     klass.__options__.each do |attribute|
       option_value = options.fetch(attribute.name) { attribute.default }
@@ -142,13 +144,12 @@ class SmartCore::Initializer::Constructor
         option_value = attribute.type.cast(option_value)
       end
 
-      attribute.type.validate!(option_value)
+      attribute.validate!(option_value)
 
       final_value = attribute.finalizer.call(option_value, instance)
       instance.instance_variable_set("@#{attribute.name}", final_value)
     end
   end
-  # rubocop:enable Metrics/AbcSize
 
   # @param instance [Any]
   # @return [void]