smart_types 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12c87a28e4cb88c84907c5d811253c4cb70e3e4aad462010c47c1a6d88c21d81
-  data.tar.gz: af0155909d10f02369aa5b60c97de4b0b91fbfad92ba79d1f94b5b3333ede373
+  metadata.gz: d5f0c7f2b54ceaa7fe20e85d7d280b64b8310eb5f4fa802d11052074e6b10f96
+  data.tar.gz: 021c3c6194fb4f54246f4a44a7c548ce9da0790a66b95e0a060547e73efeaf3f
 SHA512:
-  metadata.gz: aa5eb3001d7909b30e9fe2df27b92bff6ee22d9e92ef27f37dfbe11c18f968ee932cf0e064ecb2db808d8a0913d3c5fe7650d0d7b15af51bbe4591afeef39670
-  data.tar.gz: e0fa90c1783113d8d702414596cf001e0e54b786c6d21248e52f5e2401901eddebb09d182349abccda301998782242fa02d4a94e61eb2a3f301fe982a7d5ceff
+  metadata.gz: 6e2fc86bcea2292570d2c51e9b95ead6ecc30f8251db75a61fda088c1a84bdb15cea65fdc478728869fb5e5e56b7cddb774938cae38c60e4dee70197e6c1c7f3
+  data.tar.gz: c7b27e2f70f3f8eac851f63365b3287a2c7aeb8f7f999679daa715d5ff7de93b32bd6204ea67f6af2c2ea1e5ccd569027051674c9266c62ff7d425c55692619a

data/.rubocop.yml

@@ -5,7 +5,8 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.7.1
+  TargetRubyVersion: 2.7.2
+  NewCops: enable
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
@@ -17,3 +18,7 @@ AllCops:
 # NOTE: support for old ruby versions
 Style/RedundantBegin:
   Enabled: false
+
+# NOTE: used only in specs and it is ok in specs
+Lint/EmptyBlock:
+  Enabled: false

data/CHANGELOG.md

@@ -1,2 +1,19 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+
+## [0.2.0] - 2020-11-21
+### Added
+- Brand new **Type invariant API**:
+  - globally refactored validation logic (with backward compatability for `#valid?(value)` method);
+  - new type definition DSL: `.invariant(name)` and `.invariant_chain(name)`;
+  - chained invariants will be invoked according to the definition order (second invokation
+    depends on previous successful invariant check);
+  - new validation API: `validate(value)` (with `#errors` support based on invariant names);
+  - at this moment Invariant API is supported only by primitive types (type sum and type multiplication support coming soon);
+
+### Changed
+
+- Updated `smart_engine` dependency (to `~> 0.7`) (need `SmartCore::Engine::Atom`);
+
+## [0.1.0] - 2020-05-05
+- Release :)

data/Gemfile.lock

@@ -1,91 +1,102 @@
 PATH
   remote: .
   specs:
-    smart_types (0.1.0)
-      smart_engine (~> 0.6)
+    smart_types (0.2.0)
+      smart_engine (~> 0.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    armitage-rubocop (0.82.0.2)
-      rubocop (= 0.82.0)
-      rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.5.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    armitage-rubocop (1.3.1.1)
+      rubocop (= 1.3.1)
+      rubocop-performance (= 1.9.0)
+      rubocop-rails (= 2.8.1)
       rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 1.39.0)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
+      rubocop-rspec (= 2.0.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    i18n (1.8.2)
+    i18n (1.8.5)
       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)
-    rack (2.2.2)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.8.2)
     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.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       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.0)
       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.0)
+    rubocop (1.3.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
       rexml
+      rubocop-ast (>= 1.1.1)
       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.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.8.1)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
+      rubocop (>= 0.87.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    simplecov (0.19.1)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    smart_engine (0.6.0)
+    simplecov-html (0.12.3)
+    smart_engine (0.8.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.82)
+  armitage-rubocop (~> 1.3)
   bundler (~> 2.1)
+  pry (~> 0.13)
   rake (~> 13.0)
-  rspec (~> 3.9)
-  simplecov (~> 0.18)
+  rspec (~> 3.10)
+  simplecov (~> 0.19)
   smart_types!
 
 BUNDLED WITH

data/README.md

@@ -39,7 +39,7 @@ type4 = type1 & type2
 
 ## Supported types
 
-- Primitive Value Types:
+- Primitives
 
 ```ruby
 SmartCore::Types::Value::Any
@@ -67,45 +67,40 @@ SmartCore::Types::Value::TimeBased
 
 ## Nilable types
 
+- invoke `.nilable` on any type object:
+
 ```ruby
-SmartCore::Types::Value::Any.nilable
-SmartCore::Types::Value::Nil.nilable
 SmartCore::Types::Value::String.nilable
-SmartCore::Types::Value::Symbol.nilable
-SmartCore::Types::Value::Text.nilable
-SmartCore::Types::Value::Integer.nilable
-SmartCore::Types::Value::Float.nilable
-SmartCore::Types::Value::Numeric.nilable
-SmartCore::Types::Value::BigDecimal.nilable
-SmartCore::Types::Value::Boolean.nilable
-SmartCore::Types::Value::Array.nilable
-SmartCore::Types::Value::Hash.nilable
-SmartCore::Types::Value::Proc.nilable
-SmartCore::Types::Value::Class.nilable
-SmartCore::Types::Value::Module.nilable
-SmartCore::Types::Value::Time.nilable.nilable
-SmartCore::Types::Value::DateTime.nilable
-SmartCore::Types::Value::Date.nilable
-SmartCore::Types::Value::TimeBased
+# -- or --
+SmartCore::Types::Value::Time.nilable
+# and etc.
 ```
 
 ---
 
-## Type validation and type casting
+## Custom type definition
 
-```ruby
-# documentation is coming
+Type definition is a composition of:
 
-SmartCore::Types::Value::String.valid?('test') # => true
-SmartCore::Types::Value::String.valid?(123.45) # => false
+- type checker (required);
+- type caster (optional);
+- type invariants (optional);
+- type invariant chains (optional);
 
-SmartCore::Types::Value::String.cast(123) # => "123"
-SmartCore::Types::Value::Float.cast('55') # => 55.0
-```
+Invariant is a custom validation block that will work as a logical value checker. You can have as much invariants as you want.
 
----
+Type invariants does not depends on each other (invariant defined out from chain does not depends on other invariants);
 
-## Custom type definition
+Invariants inside invariant chains will be invoked in order they was defined and each internal invariant depends on the valid previous invairant check.
+
+**!IMPORTANT!** Type sum and type multiplication does not support invariant checking and custom invariant definitioning at this moment.
+Type sum and type mult ignores type invariants in their validation logic (currently this functionality in development yet).
+
+Invariant checking is a special validation layer (see [#type validation](#type-validation) readme section). Invariant error code pattern:
+  - for invariant chains: `TypeName.invariant_chain_name.invariant_name`;
+  - for single invariant: `TypeName.invariant_name`;
+
+#### Primitive type definition
 
 ```ruby
 # documentation is coming
@@ -122,12 +117,140 @@ SmartCore::Types::Value.define_type(:String) do |type|
 end
 ```
 
+#### With type invariants
+
+```ruby
+SmartCore::Types::Value.define_type(:String) do |type|
+  type.define_checker do |value|
+    value.is_a?(::String)
+  end
+
+  type.define_caster do |value|
+    value.to_s
+  end
+
+  # NOTE:
+  #    invariant defined out from chain does not depends on other invariants
+  type.invariant(:uncensored_content) do |value|
+    !value.include?('uncensored_word')
+  end
+
+  type.invariant(:filled) do |value|
+    value != ''
+  end
+
+  type.invariant_chain(:password) do
+    invariant(:should_present) { |value| value != '' }
+    invariant(:should_have_numbers) { |value| v.match?(/[0-9]+/) }
+    # NOTE:
+    #   inside a chain each next invariant invokation
+    #   depends on previous successful invariant check
+  end
+end
+```
+
+---
+
+## Type validation
+
+Type validation reflects on two APIs:
+
+- type checker ([how to define type checkers](#custom-type-definition));
+- type invariants (invariants and invariant chains) ([how to define type invariants](#custom-type-definition));
+
+Type invariants does not depends on each other (invariant defined out from the chain does not depends on other invariants);
+
+Invariants inside invariant chains will be invoked in order they was defined and each internal invariant depends on the valid previous invairant check.
+
+**!IMPORTANT!** Type sum and type multiplication does not support invariant checking and custom invariant definitioning at this moment.
+Type sum and type mult ignores type invariants in their validation logic (currently this functionality in development yet).
+
+Invariant checking is a special validation layer (see [#type validation](#type-validation) readme section) and represents a set of error codes in result object;
+
+Type valdiation interface:
+
+- `valid?(value)` - validates value and returns `true` or `false`;
+  - returns `ture` only if the type checker returns `true` and all invariants are valid;
+- `validate(value)` - validates value and returns the monadic result object:
+  - `SmartCore::Types::Primitive::Validator::Result` for primitive types;
+  - `SmartCore::Types::Primitive::SumValidator::Result` for sum-based types;
+  - `SmartCore::Types::Primitive::MultValidator::Result` for mult-based types;
+  - `SmartCore::Types::Primitive::NilableValidator::Result` for nilable types;
+- `validate!(value)` - validates value and returns nothing (for successful validation) or
+  raises an exception (`SmartCore::Types::TypeError`) (for unsuccessful validation);
+
+Validation result object interface:
+
+- `#success?` / `#failure?` (`#success?` is a combination of `valid_check? && valid_invariants?`; `#failure?` - is an opposite of `#success?`);
+- `#valid_check?` (valid type checker or not);
+- `#valid_invariants?` (`false` if at least one invariant is invalid);
+- `#errors` (the same as `#invariant_errors` and the same as `#error_codes`) - an array of failed invariant names;
+  - error code patterns:
+    - for invariant chains: `TypeName.invariant_chain_name.invariant_name`;
+    - for single invariant: `TypeName.invariant_name`;
+- `#checked_value` (the same as `#value`) - checked value :)
+
+
+```ruby
+SmartCore::Types::Value::String.valid?('test123') # => true
+SmartCore::Types::Value::String.valid?(123.45) # => false
+```
+
+```ruby
+result = SmartCore::Types::Value::String.validate('test')
+
+result.checked_value # => 'test'
+# --- same as: ---
+result.value
+
+result.success? # => false (valid_check? && valid_invariants?)
+result.failure? # => true
+
+result.valid_check? # => true
+result.valid_invariants? # => false
+
+# invariant errors:
+result.errors # => ['String.password.should_have_numbers']
+# -- same as: ---
+result.invariant_errors
+# -- same as: ---
+result.error_codes
+```
+
+```ruby
+result = SmartCore::Types::Value::String.validate('test1234')
+result.success? # => true
+result.errors # => []
+```
+
+```ruby
+SmartCore::Types::Value::String.validate!('test') # => SmartCore::Types::TypeError
+```
+
+---
+
+## Type casting
+
+```
+SmartCore::Types::Value::String.cast(123) # => "123"
+SmartCore::Types::Value::Float.cast('55') # => 55.0
+```
+
 ---
 
 ## Basic type algebra
 
+> (type sum and type multiplication does not support invariants at this moment (in development yet));
+
 ```ruby
 # documentation is coming
+
+# how to define primitive type sum:
+SmartCore::Types::Value::Text = SmartCore::Types::Value::String | SmartCore::Types::Value::Symbol
+SmartCore::Types::Value::Numeric = SmartCore::Types::Value::Float | SmartCore::Types::Value::Integer
+
+# how to define primitive type multiplication:
+SmartCore::Types::Value::CryptoString = SmartCore::Types::Value::NumberdString & SmartCore::Types::Value::SymbolicString
 ```
 
 ---
@@ -195,6 +318,9 @@ end
 SmartCore::Types::Value::Time.refine_caster do |value, original_caster|
   # new type caster
 end
+
+# .refine_invariant
+# .refine_invariant_chain
 ```
 
 - options for type casters:
@@ -218,7 +344,16 @@ SmartCore::Types::Value::Method
 SmartCore::Types::Value::UnboundMethod
 SmartCore::Types::Value::Enumerable
 SmartCore::Types::Value::Comparable
+SmartCore::Types::Value::Enumerator
+SmartCore::Types::Value::EnumeratorChain
+SmartCore::Types::Value::Range
+SmartCore::Types::Value::Rational
+SmartCore::Types::Value::Set
+SmartCore::Types::Value::SortedSet
+SmartCore::Types::Value::IO
+SmartCore::Types::Value::StringIO
 SmartCore::Types::Struct::Schema
+SmartCore::Types::Struct::JSONSchema
 SmartCore::Types::Struct::StrictArray
 SmartCore::Types::Struct::StrictHash
 SmartCore::Types::Struct::Map
@@ -230,11 +365,23 @@ SmartCore::Types::Protocol::Ancestors
 SmartCore::Types::Protocol::Enumerable
 SmartCore::Types::Protocol::Comparable
 SmartCore::Types::Protocol::Forwardable
+SmartCore::Types::Protocol::Callable
 ```
 
+- support for type of empty non-defined type (`SmartCore::Types::Primitive::Undefined`);
 - constrained types;
-
-- module-based integration;
+- moudle-based type system integration;
+- constructor implementation and support;
+- support for invariant checking (and custom definitioning) in sum-types;
+  - to provide a type comparability and compatability between all passed types
+    you should provide `type.reconcilable { |value, *types| .... }`  setting;
+  - `type.reconcilable` should be accesible for type sum and type mult definitions;
+  - (**preliminarily**) invariants of the concrete passed type should be valid for sucessful invariant check;
+- support for invariant checking (and definitioning) in mult-types;
+  - to provide a type comparability and compatability between all passed types
+    you should provide `type.reconcilable { |value, *types| .... }`  setting;
+  - `type.reconcilable` should be accesible for type sum and type mult definitions;
+  - (**preliminarily**) all invariants of all types should be valid for sucessful invariant check;
 
 ## Contributing