smart_initializer 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bd642b208f012f92391fa7564b1726eced30ef64ed7bcd31a1a7a2c5ef1c5fc
-  data.tar.gz: c1645e91c921429d8dd4314c730bd28c7be981f21f0a90fcee224c267e410fb4
+  metadata.gz: e7a9f30c8b223f8e66bc1ac23dfd183cd80d32c0620fd929ecdc42a534381635
+  data.tar.gz: eee561816ebbacf1a4f583d5038da3bb3478c10790a95e6c01ca8569a065174d
 SHA512:
-  metadata.gz: 65b8419d5b08f2fd53044963cf0451f903d4b69a030f6ccb38a462e3055d22d6e1ed416ca7872d195b569d15cc0acc5cb087b91af6180a42305eb1e656afaded
-  data.tar.gz: cdf0ef362116f807c603384008c9a829220879a9e27b1120d6de673779092740c12d906c0dd4923a4c4429f7ee7aac6418f248388b02d7d3a293cf9737403bbf
+  metadata.gz: 2e1c9e0b9f6b84cf6ad9fc5e84107fcddcc684ea80fb4c7f4fcf93f388d95cee0d7f36cae96106d19766964b79ae247f24c263ce51df81dabbef482204c04da8
+  data.tar.gz: 1ecac9ea5d30974515fdc8b3aac16d4b72c922f3d1c837353006200167f203ccb5ee8c94f8b6ea517dad9b86c80deb8818ae18471ad098339595b15d7aa6ee07

data/.rubocop.yml

@@ -5,15 +5,22 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.7.1
+  TargetRubyVersion: 3.0.0
+  NewCops: enable
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
     - Gemfile
     - Rakefile
     - smart_initializer.gemspec
+    - gemfiles/*.gemfile
     - bin/console
 
 # NOTE: It is not suitable for infrastracture-level frameworks
 Metrics/ParameterLists:
   Enabled: false
+
+# NOTE: It is ok to use empty blocks in specs (inside simple test cases)
+Lint/EmptyBlock:
+  Exclude:
+    - spec/**/*.rb

data/CHANGELOG.md

@@ -1,6 +1,35 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2021-01-18
+## Changed
+- Updated `smart_types` dependency (`~> 0.4.0`) to guarantee **Ruby@3** compatibility;
+
+## [0.4.0] - 2021-01-18
+### Added
+- Support for **Ruby 3**;
+
+### Changed
+- Moved from `TravisCI` to nothing (todo: migrate to `GitHub Actions`).
+  Temporary: we must run test cases locally.
+- Updated development dependencies;
+
+## [0.3.2] - 2020-07-12
+### Fixed
+- Deeply inherited entities lose their `__initializer_settings__` entitiy;
+
+## [0.3.1] - 2020-07-12
+### Fixed
+- Deeply inherited entities lose their class attribute definers;
+
+## [0.3.0] - 2020-07-11
+### Added
+- `extend_initialization_flow` alias method for `SmartCore::Initializer.ext_init`;
+- Access methods to the instance attribute lists (`#__params`, `#__options__`, `#__attributes__`);
+
+### Changed
+- Updated development dependencies;
+
 ## [0.2.0] - 2020-05-16
 ### Changed
 - **Constructor**: disallow unknown option attributes;

data/Gemfile.lock

@@ -1,95 +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)
+    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.83.0)
-      rubocop (= 0.83.0)
-      rubocop-performance (= 1.5.2)
-      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.2)
+      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.2)
-      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)
+    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.83.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.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      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.83)
-  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/README.md

@@ -1,4 +1,4 @@
-# SmartCore::Initializer · [![Gem Version](https://badge.fury.io/rb/smart_initializer.svg)](https://badge.fury.io/rb/smart_initializer) [![Build Status](https://travis-ci.org/smart-rb/smart_initializer.svg?branch=master)](https://travis-ci.org/smart-rb/smart_initializer)
+# SmartCore::Initializer · [![Gem Version](https://badge.fury.io/rb/smart_initializer.svg)](https://badge.fury.io/rb/smart_initializer)
 
 A simple and convenient way to declare complex constructors with a support for various commonly used type systems.
  (**in active development**).
@@ -12,11 +12,11 @@ gem 'smart_initializer'
 ```shell
 bundle install
 # --- or ---
-gem install smart_types
+gem install smart_initializer
 ```
 
 ```ruby
-require 'smart_core/types'
+require 'smart_core/initializer'
 ```
 
 ---
@@ -24,11 +24,14 @@ require 'smart_core/types'
 ## Table of contents
 
 - [Synopsis](#synopsis)
-- [Type Aliasing](#type-aliasing)
+- [Access to the instance attributes](#access-to-the-instance-attributes)
+- [Configuration](#configuration)
+- [Type aliasing](#type-aliasing)
 - [Initialization extension](#initialization-extension)
 - [Plugins](#plugins)
   - [thy-types](#plugin-thy-types)
-- [How to run tests](#how-to-run-tests)
+- [Roadmap](#roadmap)
+- [Build](#build)
 
 ---
 
@@ -122,6 +125,31 @@ User.new(1, 'John', 'test123', role: :admin, metadata: {}, enabled: false)
 
 ---
 
+## Access to the instance attributes
+
+- `#__params__` - returns a list of initialized params;
+- `#__options__` - returns a list of initialized options;
+- `#__attributes__` - returns a list of merged params and options;
+
+```ruby
+class User
+  include SmartCore::Initializer
+
+  param :first_name, 'string'
+  param :second_name, 'string'
+  option :age, 'numeric'
+  option :is_admin, 'boolean', default: true
+end
+
+user = User.new('Rustam', 'Ibragimov', age: 28)
+
+user.__params__ # => { first_name: 'Rustam', second_name: 'Ibragimov' }
+user.__options__ # => { age: 28, is_admin: true }
+user.__attributes__ # => { first_name: 'Rustam', second_name: 'Ibragimov', age: 28, is_admin: true }
+```
+
+---
+
 ## Configuration
 
 - based on `Qonfig` gem;
@@ -183,6 +211,7 @@ SmartCore::Initializer::TypeSystem::ThyTypes.type_aliases
 - `ext_init(&block)`:
   - you can define as many extensions as you want;
   - extensions are invoked in the order they are defined;
+  - alias method: `extend_initialization_flow`;
 
 ```ruby
 class User
@@ -258,7 +287,18 @@ User.new(123, 'test', { admin: true, age: 22 })
 
 ---
 
-## How to run tests
+## Roadmap
+
+- (in development) Attribue Definition DSL
+  - Support for specifying the attribute accessor type (`read_only` parameter);
+  - Support for attribute aliasing (`as` parameter);
+- Migrate from `TravisCI` to `GitHub Actions`;
+
+---
+
+## Build
+
+### Tests Running
 
 - with plugin tests:
 
@@ -269,7 +309,7 @@ bin/rspec -w
 - without plugin tests:
 
 ```shell
-bin/rspec -g
+bin/rspec -n
 ```
 
 - help message:
@@ -278,6 +318,20 @@ bin/rspec -g
 bin/rspec -h
 ```
 
+### Code Style Checking
+
+- without auto-correction:
+
+```shell
+bundle exec rake rubocop
+```
+
+- with auto-correction:
+
+```shell
+bundle exec rake rubocop -A
+```
+
 ---
 
 ## Contributing

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'smart_core/initializer'
+require 'smart_core'
 
-require 'irb'
-IRB.start(__FILE__)
+require 'pry'
+Pry.start

data/bin/rspec

@@ -23,7 +23,7 @@ module SmartCoreInitializerRSpecRunner
           run_with_plugin_tests!
         end
 
-        opts.on('-g', '--without-plugins', 'Run general tests (without plugin tests') do
+        opts.on('-n', '--without-plugins', 'Run general tests (without plugin tests') do
           run_without_plugin_tests!
         end
       end.parse!

data/gemfiles/with_external_deps.gemfile.lock

@@ -1,99 +1,111 @@
 PATH
   remote: ..
   specs:
-    smart_initializer (0.1.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)
+    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.82.0.2)
-      rubocop (= 0.82.0)
-      rubocop-performance (= 1.5.2)
-      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.2)
+      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)
-    jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      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)
+    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.82.0)
-      jaro_winkler (~> 1.5.1)
+      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.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      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)
+      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)
     thy (0.1.4)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    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.81)
-  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!
   thy (~> 0.1.4)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3