smart_types 0.4.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a77f7989b137f4e3e7c319ad0f825f4484329ec4ff87ad04d31b9decae9bdce7
-  data.tar.gz: 7e05552fb246042a12a708089065f0916eac5565bcc4de61e4bbea5cb4d76c21
+  metadata.gz: 272f5a15bb76008e456d87ad711a534518fa746369c3c64b8915f09265f75fea
+  data.tar.gz: 53ccc4912ec1577133ccfbe678dba4741a85c5a8521b72f2fca396823c31797d
 SHA512:
-  metadata.gz: 800dc2c99f6eeee87f522576483cb7583e8f63a21a98aa5ed6b7106499406336d31b4414a4146a33bd3be251268cf3f916236662398199c2e17ba5c11c4ab0d6
-  data.tar.gz: b771a4a428498a0bad62fc8f2cf67728117f3d47822da01086e70f386f822c4e001bb73ad609bc9ef049d06743ee3dfe13744db4d13964d4def5b058a323ad66
+  metadata.gz: 1bb710c2e0f11a8a267a2663fcb9ad75b60352d306b17a8bebad812013531ea1ee7fac4996bc342be245ac09939d862ca0f2dc2a4c26dfd5c9aa064ea41b270f
+  data.tar.gz: a2d03bcc580625b3af5ffe9535cd5b26e972b4d4b6189d71aceaa09c48f527cb2310c8aa68238803093357dee4f8b43817d3b95ddd5c912bd11dc9a6da2bbdf8

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - version: 2.5
+            continue-on-error: false
+          - version: 2.6
+            continue-on-error: false
+          - version: 2.7
+            continue-on-error: false
+          - version: 3.0
+            continue-on-error: false
+          - version: ruby-head
+            continue-on-error: true
+          - version: jruby-head
+            continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby.version }}
+      - name: Install dependencies
+        run: bundle install
+        continue-on-error: ${{ matrix.ruby.continue-on-error }}
+      - name: Run rubocop
+        run: bundle exec rubocop
+        continue-on-error: ${{ matrix.ruby.continue-on-error }}
+      - name: Run specs
+        run: bundle exec rspec
+        continue-on-error: ${{ matrix.ruby.continue-on-error }}
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        continue-on-error: true
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+# [0.7.1] - 2022-08-31
+### Fixed
+- (**TruffelRuby** fix) Fixed `NoMethodError: private method 'initialize_clone'` failing on type object duplication and cloning (`#dup` and `#clone`).
+  `TruffleRuby` implementation makes `initialize_clone` method private by default even if your manually defined method is implicitly public.
+  To fix this we should explicitly define our method as a public method (`public def initialize_clone`).
+  ```
+  NoMethodError: private method `initialize_clone' called for SmartCore::Types::Primitive::Factory::RuntimeTypeBuilder:Module
+  ```
+
+# [0.7.0] - 2021-11-22
+### Added
+- Added Github Actions CI;
+- Use `ArgumentError` instead of `DateError` in related type-casters;
+- Fix typos in documentation;
+
+# [0.6.0] - 2021-04-29
+### Added
+- New type of `SmartCode::Types::Variadic` category:
+  - `SmartCore::Types::Variadic::ArrayOf` (`Array` with element types validation)
+
+# [0.5.0] - 2021-01-28
+### Added
+- New types of `SmartCore::Types::Variadic` category:
+  - `SmartCore::Types::Variadic::Enum` (a simple enumeration on plain values);
+
 # [0.4.0] - 2021-01-18
 ### Added
 - Support for *Ruby 3*;
@@ -9,7 +34,7 @@ All notable changes to this project will be documented in this file.
 ### 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);
+  - Type definition 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
@@ -33,9 +58,9 @@ 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);
+  - globally refactored validation logic (with backward compatibility 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
+  - chained invariants will be invoked according to the definition order (second invocation
     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);

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_types (0.4.0)
+    smart_types (0.7.1)
       smart_engine (~> 0.11)
 
 GEM
@@ -81,16 +81,19 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
     simplecov_json_formatter (0.1.2)
-    smart_engine (0.11.0)
+    smart_engine (0.12.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-19
   x86_64-darwin-20
+  x86_64-darwin-21
 
 DEPENDENCIES
   armitage-rubocop (~> 1.7)
@@ -99,7 +102,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.10)
   simplecov (~> 0.21)
+  simplecov-lcov (~> 0.8)
   smart_types!
 
 BUNDLED WITH
-   2.2.3
+   2.2.31

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Rustam Ibragimov
+Copyright (c) 2020-2021 Rustam Ibragimov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,11 +1,21 @@
-# SmartCore::Types · [![Gem Version](https://badge.fury.io/rb/smart_types.svg)](https://badge.fury.io/rb/smart_types)
+# SmartCore::Types &middot; <a target="_blank" href="https://github.com/Cado-Labs"><img src="https://github.com/Cado-Labs/cado-labs-logos/raw/main/cado_labs_badge.svg" alt="Supported by Cado Labs" style="max-width: 100%; height: 20px"></a> &middot; [![Gem Version](https://badge.fury.io/rb/smart_types.svg)](https://badge.fury.io/rb/smart_types) ![ci](https://github.com/smart-rb/smart_types/workflows/ci/badge.svg?branch=master) [![coverage](https://coveralls.io/repos/github/smart-rb/smart_types/badge.svg?branch=master)](https://coveralls.io/github/smart-rb/smart_types?branch=master)
 
 > A set of objects that acts like types (type checking and type casting) with a support for basic type algebra.
 
-Minimalistic type system for any ruby project. Supports custom type definitioning,
+Minimalistic type system for any ruby project. Supports custom type definition,
 type validation, type casting and type categorizing. Provides a set of commonly used type
 categories and general purpose types. Has a flexible and simplest type definition toolchain.
 
+---
+
+<p>
+  <a href="https://github.com/Cado-Labs">
+    <img src="https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_supporting.svg" alt="Supported by Cado Labs" />
+  </a>
+</p>
+
+---
+
 ## Installation
 
 ```ruby
@@ -120,10 +130,18 @@ SmartCore::Types::Protocol::InstanceOf(::Time, ::DateTime, ::Date) # time or dat
 #### Variadic:
 
 ```ruby
+SmartCore::Types::Variadic::ArrayOf
+SmartCore::Types::Variadic::Enum
 SmartCore::Types::Variadic::Tuple
 ```
 
 ```ruby
+# example (SmartCore::Types::Variadic::ArrayOf):
+SmartCore::Types::Variadic::ArrayOf(::String, ::Array) # array of strings or arrays
+
+# example (SmartCore::Types::Variadic::Enum):
+SmartCore::Types::Variadic::Enum('string', 1337, :symbol) # one of enumerated values
+
 # 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>]
@@ -157,9 +175,9 @@ Invariant is a custom validation block that will work as a logical value checker
 
 Type invariants does not depends on each other (invariant defined out from 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.
+Invariants inside invariant chains will be invoked in order they was defined and each internal invariant depends on the valid previous invariant check.
 
-**!IMPORTANT!** Type sum and type multiplication does not support invariant checking and custom invariant definitioning at this moment.
+**!IMPORTANT!** Type sum and type multiplication does not support invariant checking and custom invariant definition 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:
@@ -224,7 +242,7 @@ SmartCore::Types::Value.define_type(:String) do |type|
     end
 
     # NOTE:
-    #   inside a chain each next invariant invokation
+    #   inside a chain each next invariant invocation
     #   depends on previous successful invariant check
   end
 end
@@ -241,14 +259,14 @@ Type validation reflects on two APIs:
 
 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.
+Invariants inside invariant chains will be invoked in order they was defined and each internal invariant depends on the valid previous invariant check.
 
-**!IMPORTANT!** Type sum and type multiplication does not support invariant checking and custom invariant definitioning at this moment.
+**!IMPORTANT!** Type sum and type multiplication does not support invariant checking and custom invariant definition 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:
+Type validation interface:
 
 - `valid?(value)` - validates value and returns `true` or `false`;
   - returns `ture` only if the type checker returns `true` and all invariants are valid;
@@ -425,6 +443,22 @@ SmartCore::Types::Value::Class.cast(123)
 
 - type refinements:
 
+```ruby
+SmartCore::Types.configure do |config|
+  config.warn_on_type_refinements = true # false by default
+end
+```
+
+```ruby
+SmartCore::Types::Value.refine(:Time) do |type|
+  # new type definition
+end
+
+SmartCore::Types::Value::Time.refine do |type|
+  # new type definition
+end
+```
+
 ```ruby
 SmartCore::Types::Value::Time.refine_checker do |value, original_checker|
   # new type checker
@@ -481,13 +515,14 @@ SmartCore::Types::Struct::JSONSchema
 SmartCore::Types::Struct::StrictArray
 SmartCore::Types::Struct::StrictHash
 SmartCore::Types::Struct::Map
-SmartCore::Types::Variadic::Enum
 SmartCore::Types::Protocol::Interface
 SmartCore::Types::Protocol::Ancestors
 SmartCore::Types::Protocol::Enumerable
 SmartCore::Types::Protocol::Comparable
 SmartCore::Types::Protocol::Forwardable
 SmartCore::Types::Protocol::Callable
+SmartCore::Types::Behavior::Truthy
+SmartCore::Types::Behavior::Falsy
 ```
 
 - `#sum` alias for `|` and `#mult` alias for `&` (with a support for type name definition and other API);
@@ -503,18 +538,18 @@ SmartCore::Types::Protocol::Callable
 
 - support for type of empty non-defined type (`SmartCore::Types::Primitive::Undefined`);
 - constrained types;
-- moudle-based type system integration;
+- module-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
+- support for invariant checking (and custom definition) in sum-types;
+  - to provide a type comparability and compatibility 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
+  - `type.reconcilable` should be accessible for type sum and type mult definitions;
+  - (**preliminarily**) invariants of the concrete passed type should be valid for successful invariant check;
+- support for invariant checking (and definition) in mult-types;
+  - to provide a type comparability and compatibility 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;
+  - `type.reconcilable` should be accessible for type sum and type mult definitions;
+  - (**preliminarily**) all invariants of all types should be valid for successful invariant check;
 
 ## Contributing
 
@@ -554,6 +589,12 @@ bundle exec rubocop -A
 
 Released under MIT License.
 
+## Supporting
+
+<a href="https://github.com/Cado-Labs">
+  <img src="https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_logo.png" alt="Supported by Cado Labs" />
+</a>
+
 ## Authors
 
 [Rustam Ibragimov](https://github.com/0exp)

data/lib/smart_core/types/primitive/factory/runtime_type_builder.rb

@@ -28,8 +28,9 @@ module SmartCore::Types::Primitive::Factory::RuntimeTypeBuilder
     #
     # @api private
     # @since 0.3.0
+    # @version 0.7.1
     # rubocop:disable Metrics/AbcSize, Layout/LineLength
-    def initialize_clone(new_instance, cloneable_instance)
+    public def initialize_clone(new_instance, cloneable_instance)
       name_clone = cloneable_instance.instance_variable_get(:@name)
       category_clone = cloneable_instance.instance_variable_get(:@category)
       validator_clone = cloneable_instance.instance_variable_get(:@validator).___copy_for___(new_instance)

data/lib/smart_core/types/primitive/factory.rb

@@ -47,7 +47,7 @@ class SmartCore::Types::Primitive::Factory
     # @api private
     # @since 0.1.0
     def build_type_definitions(type_definition)
-      raise 'Type definition is not provied' unless type_definition.is_a?(Proc)
+      raise 'Type definition is not provided' unless type_definition.is_a?(Proc)
       SmartCore::Types::Primitive::Factory::DefinitionContext.new.tap do |context|
         context.instance_eval(&type_definition)
       end.tap do |context|

data/lib/smart_core/types/value/date.rb

@@ -6,7 +6,7 @@ using SmartCore::Ext::BasicObjectAsObject
 
 # @api public
 # @since 0.1.0
-# @version 0.3.0
+# @version 0.7.0
 SmartCore::Types::Value.define_type(:Date) do |type|
   type.define_checker do |value|
     value.is_a?(::Date) || value == ::Date::Infinity
@@ -17,7 +17,7 @@ SmartCore::Types::Value.define_type(:Date) do |type|
 
     begin
       ::Date.parse(value)
-    rescue ::Date::Error, ::TypeError
+    rescue ::ArgumentError, ::TypeError
       raise(SmartCore::Types::TypeCastingError, 'Non-castable to Date')
     end
   end

data/lib/smart_core/types/value/date_time.rb

@@ -6,7 +6,7 @@ using SmartCore::Ext::BasicObjectAsObject
 
 # @api public
 # @since 0.1.0
-# @version 0.3.0
+# @version 0.7.0
 SmartCore::Types::Value.define_type(:DateTime) do |type|
   type.define_checker do |value|
     value.is_a?(::DateTime) || value == ::DateTime::Infinity
@@ -17,7 +17,7 @@ SmartCore::Types::Value.define_type(:DateTime) do |type|
 
     begin
       ::DateTime.parse(value)
-    rescue ::Date::Error, ::TypeError
+    rescue ::ArgumentError, ::TypeError
       raise(SmartCore::Types::TypeCastingError, 'Non-castable to DateTime')
     end
   end

data/lib/smart_core/types/variadic/array_of.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+using SmartCore::Ext::BasicObjectAsObject
+
+# @api public
+# @since 0.6.0
+SmartCore::Types::Variadic.define_type(:ArrayOf) do |type|
+  type.define_caster { |value| SmartCore::Types::Value::Array.cast(value) }
+
+  type.runtime_attributes_checker do |runtime_attrs|
+    runtime_attrs.any? && runtime_attrs.all? do |runtime_attr|
+      runtime_attr.is_a?(::Class)
+    end
+  end
+
+  type.define_checker do |value, expected_types|
+    next false unless SmartCore::Types::Value::Array.valid?(value)
+
+    value.all? do |elem|
+      expected_types.any? { |expected_type| elem.is_a?(expected_type) }
+    end
+  end
+end

data/lib/smart_core/types/variadic/enum.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+using SmartCore::Ext::BasicObjectAsObject
+
+# @api public
+# @since 0.5.0
+SmartCore::Types::Variadic.define_type(:Enum) do |type|
+  type.runtime_attributes_checker(&:any?)
+
+  type.define_checker { |value, enum| enum.include?(value) }
+end

data/lib/smart_core/types/variadic.rb

@@ -2,6 +2,9 @@
 
 # @api public
 # @since 0.3.0
+# @version 0.6.0
 class SmartCore::Types::Variadic < SmartCore::Types::Primitive
+  require_relative 'variadic/array_of'
+  require_relative 'variadic/enum'
   require_relative 'variadic/tuple'
 end

data/lib/smart_core/types/version.rb

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

data/smart_types.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Full-featured type system for any ruby project.'
   spec.description = <<~DESCRIPTION
-    Full-featured type system for any ruby project. Supports custom type definitioning,
+    Full-featured type system for any ruby project. Supports custom type definition,
     type validation, type casting and type categorizing. Provides a set of commonly used type
     categories and general purpose types. Has a flexible and simplest type definition toolchain.
   DESCRIPTION
@@ -39,5 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec',            '~> 3.10'
   spec.add_development_dependency 'armitage-rubocop', '~> 1.7'
   spec.add_development_dependency 'simplecov',        '~> 0.21'
+  spec.add_development_dependency 'simplecov-lcov',   '~> 0.8'
   spec.add_development_dependency 'pry',              '~> 0.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_types
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.13'
 description: |
-  Full-featured type system for any ruby project. Supports custom type definitioning,
+  Full-featured type system for any ruby project. Supports custom type definition,
   type validation, type casting and type categorizing. Provides a set of commonly used type
   categories and general purpose types. Has a flexible and simplest type definition toolchain.
 email:
@@ -118,6 +132,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -197,6 +212,8 @@ files:
 - lib/smart_core/types/value/time_based.rb
 - lib/smart_core/types/value/unbound_method.rb
 - lib/smart_core/types/variadic.rb
+- lib/smart_core/types/variadic/array_of.rb
+- lib/smart_core/types/variadic/enum.rb
 - lib/smart_core/types/variadic/tuple.rb
 - lib/smart_core/types/version.rb
 - smart_types.gemspec
@@ -222,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Full-featured type system for any ruby project.