smart_initializer 0.1.0.alpha2 → 0.1.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f835709c40984d70109e260c33764194c3f63422f37dafa4ba32b8b3b29b745d
-  data.tar.gz: de748657c5ac079a378e916c24eb7781ecc40790b429c97d9af1bffc74129200
+  metadata.gz: 483a56f55f7fb7b8e67eb20b1779df0b59f33935544d19cd6c5cd0e018e9b3b1
+  data.tar.gz: 9b1fc252e8821e68b22d38fe06e0418e5792860bc6e583caafd4ff5f786f509a
 SHA512:
-  metadata.gz: 79232e232cf4f5148fd3f98e87093a6b06fbfbaf8773e497dff082dde601101dbc4fe7ca9ed10de55d4559a6d2d03eb30659299ac7d1018f296884fb7ab0f3ed
-  data.tar.gz: 9e8ac0af865c59a16535a70ae9006cd0de3cc9b680354401f81d9de8baba6524f2fd008cba0404600cd0b160cf21500dd3e5da63c02034e43ab2337e1c7d47c7
+  metadata.gz: d77018f9b4be1a8f0c7befa771313d01debf97144e2bdc0d10248f357347eedeb6c0734997e6946fa0a35b810a6d7a1b59c395c8855f9e708a48021f0a94c9e7
+  data.tar.gz: 9cf8e06b7d6c89951330beff5698cca00502183ed625b06c3e620a6e6df0d654db4b55788d26a68b9da390217d9eb42966b609a773ebd5baa3e71bfa6d838f17

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_initializer (0.1.0.alpha1)
+    smart_initializer (0.1.0.alpha2)
       smart_engine (~> 0.5)
       smart_types (~> 0.1.0.alpha6)
 

data/README.md

@@ -20,7 +20,45 @@ require 'smart_core/types'
 
 ---
 
-## Synopsis (DEMO)
+## Synopsis
+
+**Constructor definition**:
+
+- `param` - defines name-like attribute:
+  - `cast` - type-cast received value if value has invalid type;
+  - `privacy` - reader incapsulation level;
+  - `finalize` - value post-processing (receives method name or proc);
+  - (limitation) param has no `:default` option;
+- `option` - defined kwarg-like attribute:
+  - `cast` - type-cast received value if value has invalid type;
+  - `privacy` - reader incapsulation level;
+  - `finalize` - value post-processing (receives method name or proc);
+  - `default` - defalut value (if an attribute is not provided);
+- last `Hash` argument will be treated as `kwarg`s;
+
+`param` signautre:
+
+```ruby
+param <attribute_name>,
+      <type=SmartCore::Types::Value::Any>, # Any by default
+      cast: false, # false by default
+      privacy: :public, # :public by default
+      finalize: proc { |value| value } # no finalization by default
+```
+
+`option` signature:
+
+```ruby
+option <attribute_name>,
+       <type=SmartCore::Types::Value::Any>, # Any by default
+       cast: false, # false by default
+       privacy: :public, # :public by default
+       finalize: proc { |value| value }, # no finalization by default
+       default: 123 # no default value by default
+```
+
+Example:
+
 
 ```ruby
 class User
@@ -36,21 +74,19 @@ end
 User.new(1, 'John', 'test123', role: :admin, metadata: {}, enabled: false)
 ```
 
-**Limitations**:
-
-- `param` has no :default option (at all);
-- last hash argument will be treated as `kwarg`s;
+---
 
-**Type aliasing**:
+## Type aliasing
 
 ```ruby
+# define your own type alias
 SmartCore::Initializer.type_alias(:hash, SmartCore::Types::Value::Hash)
 
 class User
   include SmartCore::Initializer
 
-  param :data, :hash
-  option :metadata, :hash
+  param :data, :hash # use your new defined type alias
+  option :metadata, :hash # use your new defined type alias
 end
 ```
 

data/lib/smart_core/initializer/constructor.rb

@@ -13,8 +13,8 @@ class SmartCore::Initializer::Constructor
   def initialize(klass, arguments, block)
     @klass = klass
     @arguments = arguments
-    @passed_parameters, @passed_options = extract_attributes(arguments)
-    @passed_block = block
+    @parameters, @options = extract_attributes(arguments)
+    @block = block
   end
 
   # @return [Any]
@@ -26,6 +26,7 @@ class SmartCore::Initializer::Constructor
       prevent_attribute_insufficiency
       initialize_parameters(instance)
       initialize_options(instance)
+      process_original_initializer(instance)
     end
   end
 
@@ -47,19 +48,19 @@ class SmartCore::Initializer::Constructor
   #
   # @api private
   # @since 0.1.0
-  attr_reader :passed_parameters
+  attr_reader :parameters
 
   # @return [Hash<Symbol,Any>]
   #
   # @api private
   # @since 0.1.0
-  attr_reader :passed_options
+  attr_reader :options
 
   # @return [Proc, NilClass]
   #
   # @api private
   # @since 0.1.0
-  attr_reader :passed_block
+  attr_reader :block
 
   # @return [void]
   #
@@ -75,10 +76,10 @@ class SmartCore::Initializer::Constructor
     raise(
       SmartCore::Initializer::ParameterArgumentError,
       "Wrong number of parameters " \
-      "(given #{passed_parameters.size}, expected #{required_parameter_count})"
-    ) unless passed_parameters.size == required_parameter_count
+      "(given #{parameters.size}, expected #{required_parameter_count})"
+    ) unless parameters.size == required_parameter_count
 
-    missing_options = required_options.reject { |option| passed_options.key?(option) }
+    missing_options = required_options.reject { |option| options.key?(option) }
 
     raise(
       SmartCore::Initializer::OptionArgumentError,
@@ -100,7 +101,7 @@ class SmartCore::Initializer::Constructor
   # @api private
   # @since 0.1.0
   def initialize_parameters(instance)
-    parameter_definitions = Hash[klass.__params__.zip(passed_parameters)]
+    parameter_definitions = Hash[klass.__params__.zip(parameters)]
 
     parameter_definitions.each_pair do |attribute, parameter_value|
       parameter_value = attribute.type.cast(parameter_value) if attribute.cast?
@@ -121,7 +122,7 @@ class SmartCore::Initializer::Constructor
   # @since 0.1.0
   def initialize_options(instance)
     klass.__options__.each do |attribute|
-      option_value = passed_options.fetch(attribute.name) { attribute.default }
+      option_value = options.fetch(attribute.name) { attribute.default }
       option_value = attribute.type.cast(option_value) if attribute.cast?
 
       # TODO: fail with SmartCore::Initializer::ArgumentError
@@ -133,26 +134,35 @@ class SmartCore::Initializer::Constructor
     end
   end
 
+  # @param instance [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def process_original_initializer(instance)
+    instance.send(:initialize, *arguments, &block)
+  end
+
   # @param arguments [Array<Any>]
   # @return [Array<Array<Any>,Hash<Symbol,Any>>]
   #
   # @api private
   # @since 0.1.0
   def extract_attributes(arguments)
-    parameters = []
-    options = {}
+    extracted_parameters = []
+    extracted_options = {}
 
     if (
       klass.__options__.size >= 1 &&
       arguments.last.is_a?(Hash) &&
       arguments.last.keys.all? { |key| key.is_a?(Symbol) }
     )
-      parameters = arguments[0..-2]
-      options = arguments.last
+      extracted_parameters = arguments[0..-2]
+      extracted_options = arguments.last
     else
-      parameters = arguments
+      extracted_parameters = arguments
     end
 
-    [parameters, options]
+    [extracted_parameters, extracted_options]
   end
 end

data/lib/smart_core/initializer/version.rb

@@ -6,6 +6,6 @@ module SmartCore
     #
     # @api public
     # @since 0.1.0
-    VERSION = '0.1.0.alpha2'
+    VERSION = '0.1.0.alpha3'
   end
 end

data/lib/smart_core/initializer.rb

@@ -28,6 +28,12 @@ module SmartCore::Initializer
     end
   end
 
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(*); end
+
   type_alias(:nil,     SmartCore::Types::Value::Nil)
   type_alias(:string,  SmartCore::Types::Value::String)
   type_alias(:symbol,  SmartCore::Types::Value::Symbol)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_initializer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha2
+  version: 0.1.0.alpha3
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine