smart_types 0.0.0 → 0.1.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0947505b9b53b32bdbe16484fd2f3649164ea15afbc563a66f9b4b057b4101a3'
-  data.tar.gz: 33808e34bdf040f9ff38d9a14c904981500beee5520e3bfc54f398a2b94adf65
+  metadata.gz: 984ff8c37feb29e6b3141b845c0f9f4266bdafc0c22fdf195ed9c4ab2036d7a9
+  data.tar.gz: 689d1cc015483cea2ca32cbd3c2e93c0e5cf486c31dc016f37d267171ec6f23a
 SHA512:
-  metadata.gz: 62ae3a3710966f62d31998a39272029189a13ec3b0cafb64409a8a79c6ab314d70c1efaab14fc0de7f6dc60abdc82e12a5abfd3c6a82eb05949e06bf0289b825
-  data.tar.gz: '08234057dcb0626c8eee23395bb6eb3aa68b7186928faf397410f2fa48a39944b1671846bd09ae6a2038834f3d14b1f966d7089554ce03af458079d1c4d2b1a3'
+  metadata.gz: dc955ee3f9f07f82be3a0144d382f949cdfce0b2c274e4ca3f229d1d4ca935eaea44ffe54d0d60a461cce43ab27a9a0bc357bd2e5ebf4d637b9450aca1b78e19
+  data.tar.gz: c0451f6106a9e7d59f10c187edcd9b9cc6a9bc8992df0b44fa3354d0456091cf479135e2ae7565f96922f0ddcef87b243c04b06ebefa35636a508c0a405fa659

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     smart_types (0.1.0)
-      smart_engine (~> 0.3)
+      smart_engine (~> 0.4)
 
 GEM
   remote: https://rubygems.org/
@@ -59,7 +59,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    smart_engine (0.3.0)
+    smart_engine (0.4.0)
     unicode-display_width (1.6.0)
 
 PLATFORMS

data/README.md

@@ -1,9 +1,13 @@
 # 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)
 
-Full-featured type system for any ruby project. Support for custom type definitioning,
+> A set of objects that acts like types (type checking and type casting) with a support for basic type algebra.
+
+Full-featured type system for any ruby project. Supports custom type definitioning,
 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.
 
+Just add and use :) Enjoy! :)
+
 ## Installation
 
 ```ruby
@@ -22,6 +26,18 @@ require 'smart_core/types'
 
 ---
 
+## Type Interface
+
+```ruby
+# documentation is coming
+
+type.valid?(value)
+type.cast(value)
+type.nilable
+type3 = type1 | type2
+type4 = type1 & type2
+```
+
 ## Supported types
 
 - Primitive Value Types:
@@ -44,6 +60,26 @@ SmartCore::Types::Value::Module
 
 ---
 
+## Nilable types
+
+```ruby
+SmartCore::Types::Value::Any.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::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
+```
+
+---
+
 ## Type validation and type casting
 
 ```ruby
@@ -60,6 +96,14 @@ SmartCore::Types::Value::Module
 
 ---
 
+## Basic type algebra
+
+```ruby
+# documentation is coming
+```
+
+---
+
 ## Type system integration
 
 ```ruby

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

@@ -27,7 +27,7 @@ module SmartCore::Types::Primitive::MultFactory
     # @pai private
     # @since 0.1.0
     def build_type_definitions(type_definition)
-      SmatCore::Types::Primitive::MultFactory::DefinitionContext.new.tap do |context|
+      SmartCore::Types::Primitive::MultFactory::DefinitionContext.new.tap do |context|
         context.instance_eval(&type_definition) if type_definition
       end
     end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Types::Primitive::NilableChecker
+  # @param checker [Checker, SumChecker, MultChecker, NilableChecker]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(checker)
+    @checker = checker
+  end
+
+  # @param value [Any]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(value)
+    # rubocop:disable Style/NilComparison
+    # NOTE: #nil? is not used cuz BasicObject has no #nil? method
+    (value == nil) ? true : checker.call(value)
+    # rubocop:enable Style/NilComparison
+  end
+
+  private
+
+  # @return [SmartCore::Types::Primitive::Checker]
+  # @return [SmartCore::Types::Primitive::MultChecker]
+  # @return [SmartCore::Types::Primitive::SumChecker]
+  # @return [SmartCore::Types::Primitive::NilableChecker]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :checker
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Types::Primitive::NilableFactory
+  class << self
+    # @param type [SmartCore::Types::Primitive]
+    # @return [SmartCore::Type::Primitive]
+    #
+    # @api private
+    # @since 0.1.0
+    def create_type(type)
+      type_checker = build_type_checker(type)
+      type_caster = build_type_caster(type)
+      build_type(type, type_checker, type_caster)
+    end
+
+    private
+
+    # @param type [SmartCore::Types::Primitive]
+    # @return [SmartCore::Types::Primitive::NilableChecker]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_type_checker(type)
+      SmartCore::Types::Primitive::NilableChecker.new(type.checker)
+    end
+
+    # @param type [SmartCore::Types::Primitive]
+    # @return [SmartCore::Types::Primitive::Caster]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_type_caster(type)
+      type.caster
+    end
+
+    # @param type [SmartCore::Types::Primitive]
+    # @param type_checler [SmartCore::Types::Primitive::NilableChecker]
+    # @param type_caster [SmartCore::Types::Caster]
+    # @return [SmartCore::Type::Primitive]
+    #
+    # @api private
+    # @since 0.1.0
+    def build_type(type, type_checker, type_caster)
+      Class.new(type.class).new(type_checker, type_caster)
+    end
+  end
+end

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

@@ -27,7 +27,7 @@ module SmartCore::Types::Primitive::SumFactory
     # @pai private
     # @since 0.1.0
     def build_type_definitions(type_definition)
-      SmatCore::Types::Primitive::SumFactory::DefinitionContext.new.tap do |context|
+      SmartCore::Types::Primitive::SumFactory::DefinitionContext.new.tap do |context|
         context.instance_eval(&type_definition) if type_definition
       end
     end

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

@@ -2,7 +2,16 @@
 
 # @api private
 # @since 0.1.0
-class SmartCore::Types::Primitive::UndefinedCaster
+class SmartCore::Types::Primitive::UndefinedCaster < SmartCore::Types::Primitive::Caster
+  # @param expression [NilClass, Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(expression = nil)
+    super
+  end
+
   # @param value [Any]
   # @return [void]
   #

data/lib/smart_core/types/primitive.rb

@@ -6,11 +6,13 @@ class SmartCore::Types::Primitive
   require_relative 'primitive/caster'
   require_relative 'primitive/undefined_caster'
   require_relative 'primitive/checker'
+  require_relative 'primitive/nilable_checker'
   require_relative 'primitive/sum_checker'
   require_relative 'primitive/mult_checker'
   require_relative 'primitive/factory'
   require_relative 'primitive/sum_factory'
   require_relative 'primitive/mult_factory'
+  require_relative 'primitive/nilable_factory'
 
   # @since 0.1.0
   include SmartCore::Types::System::ProducerDSL
@@ -29,13 +31,16 @@ class SmartCore::Types::Primitive
 
   # @param checker [SmartCore::Types::Primitive::Checker]
   # @param caster [SmartCore::Types::Primitive::Caster]
+  # @param nilable [SmartCore::Types::Primitive]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
   def initialize(checker, caster)
+    @lock = SmartCore::Engine::Lock.new
     @checker = checker
     @caster = caster
+    @nilable = nil
   end
 
   # @param value [Any]
@@ -56,13 +61,21 @@ class SmartCore::Types::Primitive
     caster.call(value)
   end
 
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api public
+  # @since 0.1.0
+  def nilable
+    lock.synchronize { @nilable ||= self.class::NilableFactory.create_type(self) }
+  end
+
   # @param another_primitive [SmartCore::Types::Primitive]
   # @return [SmartCore::Types::Primitive]
   #
   # @api public
   # @since 0.1.0
   def |(another_primitive)
-    self.class::SumFactory.create_type(self, another_primitive)
+    self.class::SumFactory.create_type([self, another_primitive])
   end
 
   # @param another_primitive [SmartCore::Types::Primitive]
@@ -71,6 +84,14 @@ class SmartCore::Types::Primitive
   # @api public
   # @since 0.1.0
   def &(another_primitive)
-    self.class::MultFactory.create_type(self, another_primitive)
+    self.class::MultFactory.create_type([self, another_primitive])
   end
+
+  private
+
+  # @return [SmartCore::Engine::Lock]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :lock
 end

data/lib/smart_core/types/struct.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+class SmartCore::Types::Struct < SmartCore::Types::Primitive
+end

data/lib/smart_core/types/system/definition_dsl.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module SmartCore::Types::System::DefinitionDSL
+  class << self
+    # @param base_klass [Class]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def included(base_klass)
+      base_klass.extend(ClassMethods)
+    end
+  end
+
+  # @api private
+  # @since 0.1.0
+  module ClassMethods
+    # @param types [Array<SmartCore::Types::Pirmitive>]
+    # @param type_definition [Block]
+    # @return [SmartCore::Types::Primitive]
+    #
+    # @api public
+    # @since 0.1.0
+    def type_sum(*types, &type_definition)
+      SmartCore::Types::Primitive::SumFactory.create_type(types, type_definition)
+    end
+
+    # @param types [Array<SmartCore::Types::Pirmitive>]
+    # @param type_definition [Block]
+    # @return [SmartCore::Types::Primitive]
+    #
+    # @api public
+    # @since 0.1.0
+    def type_mult(*types, &type_definition)
+      SmartCore::Types::Primitive::MultFactory.create_type(types, type_definition)
+    end
+  end
+end

data/lib/smart_core/types/system.rb

@@ -4,4 +4,8 @@
 # @since 0.1.0
 module SmartCore::Types::System
   require_relative 'system/producer_dsl'
+  require_relative 'system/definition_dsl'
+
+  # @since 0.1.0
+  include SmartCore::Types::System::DefinitionDSL
 end

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

@@ -2,7 +2,6 @@
 
 # @api public
 # @since 0.1.0
-
 SmartCore::Types::Value.define_type(:Any) do |type|
   type.define_checker do |value|
     true

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

@@ -2,10 +2,7 @@
 
 # @api public
 # @since 0.1.0
-SmartCore::Types::Value.define_type(:Text) do |type|
-  type.define_checker do |value|
-    value.is_a?(::String) || value.is_a?(::Symbol)
-  end
-
-  type.define_caster(&:to_s)
-end
+SmartCore::Types::Value::Text = SmartCore::Types::System.type_sum(
+  SmartCore::Types::Value::String,
+  SmartCore::Types::Value::Symbol
+) { |type| type.define_caster(&:to_s) }

data/lib/smart_core/types/version.rb

@@ -6,6 +6,7 @@ module SmartCore
     #
     # @api public
     # @since 0.1.0
-    VERSION = '0.0.0'
+    # @version 0.1.0
+    VERSION = '0.1.0.alpha'
   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. Support for custom type definitioning,
+    Full-featured type system for any ruby project. Supports custom type definitioning,
     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
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'smart_engine', '~> 0.3'
+  spec.add_dependency 'smart_engine', '~> 0.4'
 
   spec.add_development_dependency 'bundler',          '~> 2.1'
   spec.add_development_dependency 'rake',             '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_types
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0.alpha
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.17'
 description: |
-  Full-featured type system for any ruby project. Support for custom type definitioning,
+  Full-featured type system for any ruby project. Supports custom type definitioning,
   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:
@@ -127,11 +127,15 @@ files:
 - lib/smart_core/types/primitive/mult_checker.rb
 - lib/smart_core/types/primitive/mult_factory.rb
 - lib/smart_core/types/primitive/mult_factory/definition_context.rb
+- lib/smart_core/types/primitive/nilable_checker.rb
+- lib/smart_core/types/primitive/nilable_factory.rb
 - lib/smart_core/types/primitive/sum_checker.rb
 - lib/smart_core/types/primitive/sum_factory.rb
 - lib/smart_core/types/primitive/sum_factory/definition_context.rb
 - lib/smart_core/types/primitive/undefined_caster.rb
+- lib/smart_core/types/struct.rb
 - lib/smart_core/types/system.rb
+- lib/smart_core/types/system/definition_dsl.rb
 - lib/smart_core/types/system/producer_dsl.rb
 - lib/smart_core/types/value.rb
 - lib/smart_core/types/value/any.rb
@@ -167,9 +171,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: