smart_types 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f0c7f2b54ceaa7fe20e85d7d280b64b8310eb5f4fa802d11052074e6b10f96
-  data.tar.gz: 021c3c6194fb4f54246f4a44a7c548ce9da0790a66b95e0a060547e73efeaf3f
+  metadata.gz: fdcbf29c692c77b4968df1ad7cbc629164de818da1859fc871c776b8e94152b1
+  data.tar.gz: 3fe9ffe11f8d84b11a3b274a59c1d826a2d8a64eb9c289c1bf5166690d379f31
 SHA512:
-  metadata.gz: 6e2fc86bcea2292570d2c51e9b95ead6ecc30f8251db75a61fda088c1a84bdb15cea65fdc478728869fb5e5e56b7cddb774938cae38c60e4dee70197e6c1c7f3
-  data.tar.gz: c7b27e2f70f3f8eac851f63365b3287a2c7aeb8f7f999679daa715d5ff7de93b32bd6204ea67f6af2c2ea1e5ccd569027051674c9266c62ff7d425c55692619a
+  metadata.gz: d8dd2d8a3e397c02caf8a6b32347105b2f2b860c3847a8f08d5713d5e1791845aa8a598a21b3dc8be63c526e63d323349e144366836518a74409c39904140eef
+  data.tar.gz: 5ead029c27b2b4aae1a6b509e0e268f92cf85fc34c207f5af76b4b79cdb72a494bb61d16a5e50d979c61a4d6b161983b45bd013207ca047f4b5852601c7bd088

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2020-12-22
+### Added
+- Extended **Type Definition API**: support for **runtime attributes**:
+  - Type checkers, type casters and type invariants now receives runtime attributes (you can omit these);
+  - Type definitioning extended with `runtime_attribute_checker`-checker definition (runtime attributes validator);
+  - Types with incorrect runtime attributes will raise `SmartCore::Types::IncorrectRuntimeAttributesError` exception;
+  - Types which has no support for runtime attributes will raise `SmartCore::Types::RuntimeAttributesUnsupportedError` excpetion;
+  - All types by default has a method alias (`()`) which does not allow runtime attributes (for example: `SmartCore::Types::Value::String` has
+    a runtime-based alias `SmartCore::Types::Value::String()` which does not accept any attribute
+    (`SmartCore::Types::Value::String('test')` will raise `SmartCore::Types::RuntimeAttributesUnsupportedError` respectively));
+- Extended Internal **Type Development API**:
+  - all types has a reference to it's type category;
+- Brand new `SmartCore::Types::Protocol` type category and new types:
+  - `SmartCore::Types::Protocol::InstanceOf` (runtime-based type);
+- Brand new `SmartCore::Types::Variadic` type category and new types:
+  - `SmartCore::Types::Variadic::Tuple` (runtime-based type);
+- New types of `SmartCore::Types::Value` category:
+  - `SmartCore::Types::Value::Set` (based on `Set` type with a support for type casting);
+- Support for BasicObject values inside type checkers that can not be checked correctly via `#is_a?/#kind_of?` before;
+
+### Changed
+- Updated development dependencies;
+- Drop `Travis CI` (TODO: migrate to `Github Actions`);
+- **Ruby@2.4** is no longer supported;
+
 ## [0.2.0] - 2020-11-21
 ### Added
 - Brand new **Type invariant API**:

data/Gemfile.lock

@@ -1,34 +1,34 @@
 PATH
   remote: .
   specs:
-    smart_types (0.2.0)
-      smart_engine (~> 0.7)
+    smart_types (0.3.0)
+      smart_engine (~> 0.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.0)
       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 (1.3.1.1)
-      rubocop (= 1.3.1)
-      rubocop-performance (= 1.9.0)
-      rubocop-rails (= 2.8.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    armitage-rubocop (1.6.1)
+      rubocop (= 1.6.1)
+      rubocop-performance (= 1.9.1)
+      rubocop-rails (= 2.9.0)
       rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.0.0)
+      rubocop-rspec (= 2.0.1)
     ast (2.4.1)
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
-    docile (1.3.2)
+    docile (1.3.3)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.2)
-    parallel (1.20.0)
+    parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
@@ -36,8 +36,8 @@ GEM
       method_source (~> 1.0)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.2)
+    rake (13.0.3)
+    regexp_parser (2.0.1)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -52,51 +52,52 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.3.1)
+    rubocop (1.6.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.1.1)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
+    rubocop-ast (1.3.0)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.9.0)
+    rubocop-performance (1.9.1)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.8.1)
+    rubocop-rails (2.9.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.87.0)
+      rubocop (>= 0.90.0, < 2.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (2.0.0)
+    rubocop-rspec (2.0.1)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.19.1)
+    simplecov (0.20.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    smart_engine (0.8.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
+    simplecov_json_formatter (0.1.2)
+    smart_engine (0.10.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
-    zeitwerk (2.4.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 1.3)
+  armitage-rubocop (~> 1.6)
   bundler (~> 2.1)
   pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.10)
-  simplecov (~> 0.19)
+  simplecov (~> 0.20)
   smart_types!
 
 BUNDLED WITH

data/README.md

@@ -1,4 +1,4 @@
-# SmartCore::Types · [![Gem Version](https://badge.fury.io/rb/smart_types.svg)](https://badge.fury.io/rb/smart_types) [![Build Status](https://travis-ci.org/smart-rb/smart_types.svg?branch=master)](https://travis-ci.org/smart-rb/smart_types)
+# SmartCore::Types · [![Gem Version](https://badge.fury.io/rb/smart_types.svg)](https://badge.fury.io/rb/smart_types)
 
 > A set of objects that acts like types (type checking and type casting) with a support for basic type algebra.
 
@@ -24,6 +24,25 @@ require 'smart_core/types'
 
 ---
 
+## Usage
+
+- [Type interface](#type-interface)
+- [Basic type algebra](#basic-type-algebra)
+- [Supported types](#supported-types)
+- [Nilable types](#nilable-types)
+- [Custom type definition](#custom-type-definition)
+  - [Primitive type definition](#primitive-type-definition)
+  - [With type invariants](#with-type-invariants)
+- [Type validation](#type-validation)
+- [Type casting](#type-casting)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+- [Build](#build)
+- [License](#license)
+- [Authors](#authors)
+
+---
+
 ## Type Interface
 
 ```ruby
@@ -37,6 +56,21 @@ type3 = type1 | type2
 type4 = type1 & type2
 ```
 
+Types with runtime:
+
+```ruby
+# get a type object with a custom runtime (instances of String or Symbol):
+type = SmartCore::Types::Protocol::InstanceOf(::String, ::Symbol)
+type.valid?(:test) # => true
+type.valid?('test') # => true
+type.valid?(123.456) # => false
+
+# another type object with a custom runtime (tuple (String, Integer, Time)):
+type = SmartCore::Types::Variadic::Tuple(::String, ::Integer, ::DateTime)
+type.valid?(['test', 1, DateTime.new]) # => true
+type.valid?([:test, 2]) # => false
+```
+
 ## Supported types
 
 - Primitives
@@ -53,6 +87,7 @@ SmartCore::Types::Value::Numeric
 SmartCore::Types::Value::BigDecimal
 SmartCore::Types::Value::Boolean
 SmartCore::Types::Value::Array
+SmartCore::Types::Value::Set
 SmartCore::Types::Value::Hash
 SmartCore::Types::Value::Proc
 SmartCore::Types::Value::Class
@@ -63,6 +98,31 @@ SmartCore::Types::Value::Date
 SmartCore::Types::Value::TimeBased
 ```
 
+- Protocols:
+
+```ruby
+SmartCore::Types::Protocol::InstanceOf
+```
+
+```ruby
+# examples (SmartCore::Types::Protocol::InstanceOf):
+SmartCore::Types::Protocol::InstanceOf(::Integer) # only integer
+SmartCore::Types::Protocol::InstanceOf(::String, ::Symbol) # string or symbol
+SmartCore::Types::Protocol::InstanceOf(::Time, ::DateTime, ::Date) # time or datetime or date
+```
+
+- Variadic:
+
+```ruby
+SmartCore::Types::Variadic::Tuple
+```
+
+```ruby
+# examples (SmartCore::Types::Variadic::Tuple):
+SmartCore::Types::Variadic::Tuple(::String, ::Integer, ::Time) # array with signature [<string>, <integer>, <time>]
+SmartCore::Types::Variadic::Tuple(::Symbol, ::Float) # array with signature [<symbol>, <float>]
+```
+
 ---
 
 ## Nilable types
@@ -107,41 +167,56 @@ Invariant checking is a special validation layer (see [#type validation](#type-v
 
 # example:
 SmartCore::Types::Value.define_type(:String) do |type|
-  type.define_checker do |value|
+  type.define_checker do |value, runtime_attrs| # runtime attributes are optional
     value.is_a?(::String)
   end
 
-  type.define_caster do |value|
+  type.define_caster do |value, runtime_attrs| # runtime attributes are optional
     value.to_s
   end
 end
+
+# get a type object:
+SmartCore::Types::Value::String
+# --- or ---
+SmartCore::Types::Value::String() # without runtime attributes
+# --- or ---
+SmartCore::Types::Value::String('some_attr', :another_attr) # with runtime attributes
+
+# work with type object: see documentation below
 ```
 
 #### With type invariants
 
 ```ruby
 SmartCore::Types::Value.define_type(:String) do |type|
-  type.define_checker do |value|
+  type.define_checker do |value, runtime_attrs|
     value.is_a?(::String)
   end
 
-  type.define_caster do |value|
+  type.define_caster do |value, runtime_attrs|
     value.to_s
   end
 
   # NOTE:
   #    invariant defined out from chain does not depends on other invariants
-  type.invariant(:uncensored_content) do |value|
+  type.invariant(:uncensored_content) do |value, runtime_attrs|
     !value.include?('uncensored_word')
   end
 
-  type.invariant(:filled) do |value|
+  type.invariant(:filled) do |value, runtime_attrs|
     value != ''
   end
 
   type.invariant_chain(:password) do
-    invariant(:should_present) { |value| value != '' }
-    invariant(:should_have_numbers) { |value| v.match?(/[0-9]+/) }
+    invariant(:should_present) do |value, runtime_attrs|
+      value != ''
+    end
+
+    invariant(:should_have_numbers) do |value, runtime_attrs|
+      v.match?(/[0-9]+/)
+    end
+
     # NOTE:
     #   inside a chain each next invariant invokation
     #   depends on previous successful invariant check
@@ -190,6 +265,36 @@ Validation result object interface:
     - for single invariant: `TypeName.invariant_name`;
 - `#checked_value` (the same as `#value`) - checked value :)
 
+---
+
+Imagine that we have `String` type like this:
+
+```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
+
+  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]+/) }
+  end
+end
+```
+
+Validation interface and usage:
 
 ```ruby
 SmartCore::Types::Value::String.valid?('test123') # => true
@@ -231,7 +336,7 @@ SmartCore::Types::Value::String.validate!('test') # => SmartCore::Types::TypeErr
 
 ## Type casting
 
-```
+```ruby
 SmartCore::Types::Value::String.cast(123) # => "123"
 SmartCore::Types::Value::Float.cast('55') # => 55.0
 ```
@@ -257,6 +362,10 @@ SmartCore::Types::Value::CryptoString = SmartCore::Types::Value::NumberdString &
 
 ## Roadmap
 
+- migrate to `Github Actions`;
+
+- support for `block`-attribute in runtime attributes;
+
 - type configuration:
 
 ```ruby
@@ -319,8 +428,17 @@ SmartCore::Types::Value::Time.refine_caster do |value, original_caster|
   # new type caster
 end
 
-# .refine_invariant
-# .refine_invariant_chain
+SmartCore::Types::Value::Time.refine_runtime_attributes_checker do |value, original_checker|
+  # new runtime attribute checker
+end
+
+SmartCore::Types::Value::Time.refine_invariant(:name) do |value|
+  # new invariant
+end
+
+SmartCore::Types::Value::Time.refine_invariant_chain(:chain_name) do
+  # new invariant chain
+end
 ```
 
 - options for type casters:
@@ -348,18 +466,16 @@ 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::Value::BasicObject
 SmartCore::Types::Struct::Schema
 SmartCore::Types::Struct::JSONSchema
 SmartCore::Types::Struct::StrictArray
 SmartCore::Types::Struct::StrictHash
 SmartCore::Types::Struct::Map
-SmartCore::Types::Variative::Enum
-SmartCore::Types::Variative::Variant
-SmartCore::Types::Protocol::InstanceOf
+SmartCore::Types::Variadic::Enum
 SmartCore::Types::Protocol::Interface
 SmartCore::Types::Protocol::Ancestors
 SmartCore::Types::Protocol::Enumerable
@@ -368,6 +484,17 @@ SmartCore::Types::Protocol::Forwardable
 SmartCore::Types::Protocol::Callable
 ```
 
+- `#sum` alias for `|` and `#mult` alias for `&` (with a support for type name definition and other API);
+
+- type category in invariant error codes:
+```ruby
+# before:
+'String.password.should_contain_numbers' # `String` type from `Value` category
+
+# after:
+'Value.String.password.should_contain_numbers' # `Value::String`
+```
+
 - support for type of empty non-defined type (`SmartCore::Types::Primitive::Undefined`);
 - constrained types;
 - moudle-based type system integration;
@@ -391,6 +518,24 @@ SmartCore::Types::Protocol::Callable
 - Push to the branch (`git push origin feature/my-new-feature`)
 - Create new Pull Request
 
+## Build
+
+- run tests:
+
+```shell
+bundle exec rake rspec
+# --- or ---
+bundle exec rspec
+```
+
+- run code stye linting:
+
+```shell
+bundle exec rake rubocop
+# --- or ---
+bundle exec rubocop
+```
+
 ## License
 
 Released under MIT License.