smart_initializer 0.1.0.alpha2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f835709c40984d70109e260c33764194c3f63422f37dafa4ba32b8b3b29b745d
-  data.tar.gz: de748657c5ac079a378e916c24eb7781ecc40790b429c97d9af1bffc74129200
+  metadata.gz: 5134f8c4bce2fc85b936310f04e67bf2d065205a29a34a53435eca06efba17f6
+  data.tar.gz: b4de1f15734ca61d124c944aeaca4f87fb6e5c1d5e4f8d92a3c7b63516ce708e
 SHA512:
-  metadata.gz: 79232e232cf4f5148fd3f98e87093a6b06fbfbaf8773e497dff082dde601101dbc4fe7ca9ed10de55d4559a6d2d03eb30659299ac7d1018f296884fb7ab0f3ed
-  data.tar.gz: 9e8ac0af865c59a16535a70ae9006cd0de3cc9b680354401f81d9de8baba6524f2fd008cba0404600cd0b160cf21500dd3e5da63c02034e43ab2337e1c7d47c7
+  metadata.gz: 86e1523cec71037f80aa99a6e36a5ffe06ca0da34d90f97e836dafdcd096cadceaebcb147499a636d1ce0f6868b0781e22ba21e0d589fb127cdfe41ff4882940
+  data.tar.gz: 4b9e5b9f6e3742cfa38fb969a7b3d0d2a5e85d49cd94a7f498d6302cdb1ac3910642772f5c9246a51fb4bf1ab4231af3c8a2a8328c4b343471a4e2563b3e9cd6

data/.rubocop.yml

@@ -5,7 +5,7 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.4.9
+  TargetRubyVersion: 2.7.1
   Include:
     - lib/**/*.rb
     - spec/**/*.rb

data/.travis.yml

@@ -2,19 +2,50 @@
 language: ruby
 cache: bundler
 os: linux
-before_install: gem install bundler -v 2.1.2
+dist: xenial
+before_install: gem install bundler
 script:
 - bundle exec rake rubocop
 - bundle exec rake rspec
 jobs:
   fast_finish: true
   include:
-  - rvm: 2.4.9
-  - rvm: 2.5.7
-  - rvm: 2.6.5
-  - rvm: 2.7.0
+  - rvm: 2.4.10
+    gemfile: gemfiles/with_external_deps.gemfile
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 2.5.8
+    gemfile: gemfiles/with_external_deps.gemfile
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 2.6.6
+    gemfile: gemfiles/with_external_deps.gemfile
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 2.7.1
+    gemfile: gemfiles/with_external_deps.gemfile
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
   - rvm: ruby-head
+    gemfile: gemfiles/with_external_deps.gemfile
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
   - rvm: jruby-head
+    gemfile: gemfiles/with_external_deps.gemfile
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: truffleruby
+    gemfile: gemfiles/with_external_deps.gemfile
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 2.4.10
+    gemfile: gemfiles/without_external_deps.gemfile
+  - rvm: 2.5.8
+    gemfile: gemfiles/without_external_deps.gemfile
+  - rvm: 2.6.6
+    gemfile: gemfiles/without_external_deps.gemfile
+  - rvm: 2.7.1
+    gemfile: gemfiles/without_external_deps.gemfile
+  - rvm: ruby-head
+    gemfile: gemfiles/without_external_deps.gemfile
+  - rvm: jruby-head
+    gemfile: gemfiles/without_external_deps.gemfile
+  - rvm: truffleruby
+    gemfile: gemfiles/without_external_deps.gemfile
   allow_failures:
   - rvm: ruby-head
   - rvm: jruby-head
+  - rvm: truffleruby

data/CHANGELOG.md

@@ -1,2 +1,17 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+
+## [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;
+
+## [0.1.0] - 2020-05-10
+- Release :)

data/Gemfile.lock

@@ -1,80 +1,100 @@
 PATH
   remote: .
   specs:
-    smart_initializer (0.1.0.alpha1)
-      smart_engine (~> 0.5)
-      smart_types (~> 0.1.0.alpha6)
+    smart_initializer (0.2.0)
+      qonfig (~> 0.24)
+      smart_engine (~> 0.7)
+      smart_types (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    armitage-rubocop (0.79.0)
-      rubocop (= 0.79.0)
-      rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.4.1)
-      rubocop-rake (= 0.5.0)
-      rubocop-rspec (= 1.37.1)
-    ast (2.4.0)
-    diff-lcs (1.3)
+    activesupport (6.0.3.2)
+      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.87.1.2)
+      rubocop (= 0.87.1)
+      rubocop-performance (= 1.7.0)
+      rubocop-rails (= 2.6.0)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 1.42.0)
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    rack (2.1.1)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    qonfig (0.24.1)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    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.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.87.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.4.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.0)
+      rubocop (>= 0.82.0)
+    rubocop-rails (2.6.0)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rake (0.5.0)
+      rubocop (>= 0.82.0)
+    rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.37.1)
-      rubocop (>= 0.68.1)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    smart_engine (0.5.0)
-    smart_types (0.1.0.alpha6)
-      smart_engine (~> 0.5)
-    unicode-display_width (1.6.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    smart_engine (0.7.0)
+    smart_types (0.1.0)
+      smart_engine (~> 0.6)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.78)
+  armitage-rubocop (~> 0.87)
   bundler (~> 2.1)
   rake (~> 13.0)
   rspec (~> 3.9)
-  simplecov (~> 0.17)
+  simplecov (~> 0.18)
   smart_initializer!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -1,6 +1,7 @@
 # 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)
 
-A simple and convenient way to declare complex constructors (**in active development**).
+A simple and convenient way to declare complex constructors with a support for various commonly used type systems.
+ (**in active development**).
 
 ## Installation
 
@@ -11,20 +12,105 @@ gem 'smart_initializer'
 ```shell
 bundle install
 # --- or ---
-gem install smart_types
+gem install smart_initializer
 ```
 
 ```ruby
-require 'smart_core/types'
+require 'smart_core/initializer'
 ```
 
 ---
 
-## Synopsis (DEMO)
+## Table of contents
+
+- [Synopsis](#synopsis)
+- [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)
+
+---
+
+## Synopsis
+
+**Initialization flow**:
+
+1. Parameter + Option definitioning;
+2. Original #initialize invokation;
+3. Initialization extensions invokation;
+
+**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);
+  - `type_system` - differently chosen type system for the current attribute;
+  - (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);
+  - `type_system` - differently chosen type system for the current attribute;
+- last `Hash` argument will be treated as `kwarg`s;
+
+#### initializer integration
+
+```ruby
+# with pre-configured type system (:smart_types, see Configuration doc)
+
+class MyStructure
+  include SmartCore::Initializer
+end
+```
+
+```ruby
+# with manually chosen type system
+
+class MyStructure
+  include SmartCore::Initializer(type_system: :smart_types)
+end
+
+class AnotherStructure
+  include SmartCore::Initializer(type_system: :thy_types)
+end
+```
+
+#### `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
+      type_system: :smart_types # used 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
+       type_system: :smart_types # used by default
+```
+
+Example:
+
 
 ```ruby
 class User
   include SmartCore::Initializer
+  # --- or ---
+  include SmartCore::Initializer(type_system: :smart_types)
 
   param :user_id, SmartCore::Types::Value::Integer, cast: false, privacy: :public
   option :role, default: :user, finalize: -> { |value| Role.find(name: value) }
@@ -36,22 +122,188 @@ end
 User.new(1, 'John', 'test123', role: :admin, metadata: {}, enabled: false)
 ```
 
-**Limitations**:
+---
+
+## 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;
+- you can read config values via `[]` or `.config.settings` or `.config[key]`;
+- setitngs:
+  - `default_type_system` - default type system (`smart_types` by default);
+
+```ruby
+# configure:
+SmartCore::Initializer::Configuration.configure do |config|
+  config.default_type_system = :smart_types # default setting value
+end
+```
+
+```ruby
+# read:
+SmartCore::Initializer::Configuration[:default_type_system]
+SmartCore::Initializer::Configuration.config[:default_type_system]
+SmartCore::Initializer::Configuration.config.settings.default_type_system
+```
+
+---
+
+## Type aliasing
+
+- Usage:
+
+```ruby
+# for smart_types:
+SmartCore::Initializer::TypeSystem::SmartTypes.type_alias('hsh', SmartCore::Types::Value::Hash)
+
+# for thy:
+SmartCore::Initializer::TypeSystem::ThyTypes.type_alias('int', Thy::Tyhes::Integer)
+
+class User
+  include SmartCore::Initializer
+
+  param :data, 'hsh' # use your new defined type alias
+  option :metadata, :hsh # use your new defined type alias
 
-- `param` has no :default option (at all);
-- last hash argument will be treated as `kwarg`s;
+  param :age, 'int', type_system: :thy_types
+end
+```
 
-**Type aliasing**:
+- Predefined aliases:
 
 ```ruby
-SmartCore::Initializer.type_alias(:hash, SmartCore::Types::Value::Hash)
+# for smart_types:
+SmartCore::Initializer::TypeSystem::SmartTypes.type_aliases
+
+# for thy_types:
+SmartCore::Initializer::TypeSystem::ThyTypes.type_aliases
+```
+
+---
+
+## Initialization extension
 
+- `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
   include SmartCore::Initializer
 
-  param :data, :hash
-  option :metadata, :hash
+  option :name, :name
+  option :age, :integer
+
+  ext_init { |instance| instance.define_singleton_method(:extra) { :ext1 } }
+  ext_init { |instance| instance.define_singleton_method(:extra2) { :ext2 } }
 end
+
+user = User.new(name: 'keka', age: 123)
+user.name # => 'keka'
+user.age # => 123
+user.extra # => :ext1
+user.extra2 # => :ext2
+```
+
+---
+
+## Plugins
+
+- [thy-types](#plugin-thy-types)
+
+---
+
+## Plugin: thy-types
+
+Support for `Thy::Types` type system ([gem](https://github.com/akxcv/thy))
+
+- install `thy` types (`gem install thy`):
+
+```ruby
+gem 'thy'
+```
+
+```shell
+bundle install
+```
+
+- enable `thy_types` plugin:
+
+```ruby
+require 'thy'
+SmartCore::Initializer::Configuration.plugin(:thy_types)
+```
+
+- usage:
+
+```ruby
+class User
+  include SmartCore::Initializer(type_system: :thy_types)
+
+  param :nickname, 'string'
+  param :email, 'value.text', type_system: :smart_types # mixing with smart_types
+  option :admin, Thy::Types::Boolean, default: false
+  option :age, (Thy::Type.new { |value| value > 18 }) # custom thy type is supported too
+end
+
+# valid case:
+User.new('daiver', 'iamdaiver@gmail.com', { admin: true, age: 19 })
+# => new user object
+
+# invalid case (invalid age)
+User.new('daiver', 'iamdaiver@gmail.com', { age: 17 })
+# SmartCore::Initializer::ThyTypeValidationError
+
+# invaldi case (invalid nickname)
+User.new(123, 'test', { admin: true, age: 22 })
+# => SmartCore::Initializer::ThyTypeValidationError
+```
+
+---
+
+## How to run tests
+
+- with plugin tests:
+
+```shell
+bin/rspec -w
+```
+
+- without plugin tests:
+
+```shell
+bin/rspec -n
+```
+
+- help message:
+
+```shell
+bin/rspec -h
 ```
 
 ---