smart_initializer 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e16ae20c546597ce7c44382a790934260b44b1ebff59a51c7c7eb366205d969f
-  data.tar.gz: 14af5a449ae56ecf8b38d22c3ea0957f4896070556fec3c280a4b265e78f63de
+  metadata.gz: 9ef704918e8e3d81bfb2dd551b96f4e68f2a0f2cefacfdbced95ae9cce1a6b0b
+  data.tar.gz: 3960c509958efb9a0886d959ff3a55b6965bb916f80bd32bf04e0977d58b7560
 SHA512:
-  metadata.gz: cecc3bc1e93570d2c8cb0cc11c1b409c24d6b401a9a8225de4676a10915c7e08a1bf869315650f9ddf66c7b5dc4602e96d2a0717a83289b6fec79cb795d5dde9
-  data.tar.gz: 6ed53102d9c016fbdad65a3f4ad2b2aec6ad567596ec3e255f33a55f979eab5180138ae496f1ff5eafae3ae71019229ea8840d9fc1608ddcbb821a6f2aeffae5
+  metadata.gz: 329ebcfc66cab98ab6e35b392c425df04eb5d03260b3bcefceb6c9cffa8863bad1fafce5d3b822c4fd0d39e0caab36a502b38a8ed15ecba1f0157908a6bbbc0d
+  data.tar.gz: 31f8259c26367c56961dc70cd086dcae7e96f3eafa206b3395b2f4afc0cb25afc3bba6d55a94251d1495bb13fd27c3c590ca67ace17bba1af226b48ceacfb7a9

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.9.0] - 2021-12-19
+### Changed
+- `:finalize` block is not invoked on the `option` with `optional: true` flag;
+
 ## [0.8.0] - 2021-12-04
 ### Added
 - New options for option and param attributes:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_initializer (0.8.0)
+    smart_initializer (0.9.0)
       qonfig (~> 0.24)
       smart_engine (~> 0.11)
       smart_types (~> 0.4)
@@ -84,7 +84,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    smart_engine (0.11.0)
+    smart_engine (0.12.0)
     smart_types (0.7.0)
       smart_engine (~> 0.11)
     tzinfo (2.0.4)
@@ -107,4 +107,4 @@ DEPENDENCIES
   smart_initializer!
 
 BUNDLED WITH
-   2.2.31
+   2.2.32

data/README.md

@@ -32,19 +32,19 @@ require 'smart_core/initializer'
 - [Synopsis](#synopsis)
   - [Initialization flow](#initialization-flow)
   - [Attribute value definition flow](#attribute-value-definition-flow-during-object-allocation-and-construction)
-  - [Constructor definition](#constructor-definition)
+  - [Constructor definition DSL](#constructor-definition-dsl)
     - [param](#param)
     - [option](#option)
     - [params](#params)
     - [options](#options)
-    - [param and params signature](#param-and-params-signature)
+    - [param and params signature](#param-and-params-signautre)
     - [option and options signature](#option-and-options-signature)
 - [Initializer integration](#initializer-integration)
 - [Basic Example](#basic-example)
 - [Access to the instance attributes](#access-to-the-instance-attributes)
 - [Configuration](#configuration)
 - [Type aliasing](#type-aliasing)
-- [Type auto-casting](#type-auto-casting)
+- [Type casting](#type-casting)
 - [Initialization extension](#initialization-extension)
 - [Plugins](#plugins)
   - [thy-types](#plugin-thy-types)
@@ -57,11 +57,11 @@ require 'smart_core/initializer'
 
 #### Initialization flow
 
-1. Parameter + Option definitioning and initialization;
+1. Parameter + Option definitioning and initialization (custom object allocator and constructor);
 2. Original **#initialize** invokation;
 3. Initialization extensions invokation;
 
-**NOTE!**: original constructor is called after **SmarteCore::Initializer**'s constructor
+**NOTE!**:  **SmarteCore::Initializer**'s constructor is invoked first
 in order to guarantee the validity of the SmartCore::Initializer's functionality
 (such as `attribute overlap chek`, `instant type checking`, `value post-processing by finalize`, etc)
 
@@ -71,7 +71,30 @@ in order to guarantee the validity of the SmartCore::Initializer's functionality
 2. *(if defined)*: `default value` (default value is used when `original value` is not defined)
 3. *(if defined)*: `finalize`;
 
----
+**NOTE**: `:finalize` block are not invoked on omitted `optional: true` attributes
+which has no `:default` definition bock and which are not passed to the constructor. Example:
+
+```ruby
+# without :default
+
+class User
+  include SmartCore::Initializer
+  option :age, :string, optional: true, finalize: -> (val) { "#{val}_years" }
+end
+
+User.new.age # => nil
+```
+
+```ruby
+# with :default
+
+class User
+  include SmartCore::Initializer
+  option :age, :string, optional: true, default: '0', finalize: -> (val) { "#{val}_years" }
+end
+
+User.new.age # => '0_years'
+```
 
 ### Constructor definition DSL
 
@@ -90,7 +113,7 @@ in order to guarantee the validity of the SmartCore::Initializer's functionality
 
 #### option
 
-- `option` - defined kwarg-like attribute:
+- `option` - defines kwarg-like attribute:
   - `cast` (optional) - type-cast received value if value has invalid type;
   - `privacy` (optional) - reader incapsulation level;
   - `as` (optional) - attribute alias (be careful with naming aliases that overlap the names of other attributes);
@@ -106,13 +129,13 @@ in order to guarantee the validity of the SmartCore::Initializer's functionality
 
 #### params
 
-- `params` - define a series of parameters;
+- `params` - defines a series of parameters;
   - `:mutable` (optional) - (`false` by default);
   - `:privacy` (optional) - (`:public` by default);
 
 #### options
 
-- `options` - define a series of options;
+- `options` - defines a series of options;
   - `:mutable` (optional) - (`false` by default);
   - `:privacy` (optional) - (`:public` by default);
 
@@ -499,7 +522,10 @@ User.new(123, 'test', { admin: true, age: 22 })
 
 ## Roadmap
 
-- (**thinking** / **discussing**) Finalize should be invoked on `mutable` attributes after mutation too;
+- More semantic attribute declaration errors (more domain-related attribute error objects);
+  - incorrect `:finalize` argument type: `ArgumentError` => `FinalizeArgumentError`;
+  - incorrect `:as` argument type: `ArguemntError` => `AsArgumentError`;
+  - etc;
 - Support for `RSpec` doubles and instance_doubles inside the type system integration;
 - Specs restructuring;
 - Migrate from `TravisCI` to `GitHub Actions`;

data/gemfiles/without_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,38 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (7.0.0)
       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.15.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
       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.2.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -55,29 +54,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.15.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)
@@ -85,25 +83,25 @@ GEM
       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.12.0)
+    smart_types (0.7.0)
       smart_engine (~> 0.11)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
 
 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)
   smart_initializer!
 
 BUNDLED WITH
-   2.2.3
+   2.2.32

data/lib/smart_core/initializer/constructor.rb

@@ -145,26 +145,22 @@ class SmartCore::Initializer::Constructor
         attribute.has_default? ? attribute.default : nil
       end
 
+      # NOTE: (if-block: what if `if` receives `false`?):
+      #   For other case passed `attribute` is optional and
+      #   should not be type-checked/type-casted/etc.
+      #   But optional attributes with defined `default` setting should be
+      #   type-checked and type-casted.
       if options.key?(attribute.name) || attribute.has_default?
         if !attribute.type.valid?(option_value) && attribute.cast?
           option_value = attribute.type.cast(option_value)
         end
 
         attribute.validate!(option_value)
+        option_value = attribute.finalizer.call(option_value, instance)
+        attribute.validate!(option_value)
       end
-      # NOTE: (if-block: what if `if` receives `false`?):
-      #   For other case passed `attribute` is optional and
-      #   should not be type-checked/type-casted/etc.
-      #   But optional attributes with defined `default` setting should be
-      #   type-checked and type-casted.
-      #
-      #   TODO: it should be covered by tests
-
-      final_value = attribute.finalizer.call(option_value, instance)
-      # NOTE: validae `final_value` if only the `option` is provided (passed to constructor)
-      attribute.validate!(final_value) if options.key?(attribute.name)
 
-      instance.instance_variable_set("@#{attribute.name}", final_value)
+      instance.instance_variable_set("@#{attribute.name}", option_value)
     end
   end
   # rubocop:enable Metrics/AbcSize

data/lib/smart_core/initializer/version.rb

@@ -6,7 +6,7 @@ module SmartCore
     #
     # @api public
     # @since 0.1.0
-    # @version 0.8.0
-    VERSION = '0.8.0'
+    # @version 0.9.0
+    VERSION = '0.9.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_initializer
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine
@@ -246,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Initializer DSL