smart_types 0.1.0.alpha5 → 0.4.0

data/Rakefile

@@ -11,8 +11,8 @@ require 'rubocop-rake'
 RuboCop::RakeTask.new(:rubocop) do |t|
   config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
   t.options = ['--config', config_path]
-  t.requires << 'rubocop-performance'
   t.requires << 'rubocop-rspec'
+  t.requires << 'rubocop-performance'
   t.requires << 'rubocop-rake'
 end
 

data/bin/console

@@ -4,5 +4,5 @@
 require 'bundler/setup'
 require 'smart_core/types'
 
-require 'irb'
-IRB.start(__FILE__)
+require 'pry'
+Pry.start

data/lib/smart_core/types.rb

@@ -10,4 +10,6 @@ module SmartCore::Types
   require_relative 'types/system'
   require_relative 'types/primitive'
   require_relative 'types/value'
+  require_relative 'types/protocol'
+  require_relative 'types/variadic'
 end

data/lib/smart_core/types/errors.rb

@@ -13,6 +13,18 @@ module SmartCore::Types
   # @since 0.1.0
   NameError = Class.new(SmartCore::NameError)
 
+  # @api public
+  # @since 0.3.0
+  TypeDefinitionError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.3.0
+  IncorrectRuntimeAttributesError = Class.new(TypeDefinitionError)
+
+  # @api public
+  # @since 0.3.0
+  RuntimeAttriburtesUnsupportedError = Class.new(TypeDefinitionError)
+
   # @api public
   # @since 0.1.0
   TypeError = Class.new(SmartCore::TypeError)
@@ -21,6 +33,10 @@ module SmartCore::Types
   # @since 0.1.0
   TypeCastingError = Class.new(Error)
 
+  # @api public
+  # @since 0.1.0
+  TypeCastingUnsupportedError = Class.new(TypeCastingError)
+
   # @api public
   # @since 0.1.0
   NoCheckerDefinitionError = Class.new(Error)

data/lib/smart_core/types/primitive.rb

@@ -2,26 +2,61 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive
+  require_relative 'primitive/checker'
   require_relative 'primitive/caster'
+  require_relative 'primitive/runtime_attributes_checker'
   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/invariant_control'
+  require_relative 'primitive/validator'
   require_relative 'primitive/factory'
+  require_relative 'primitive/sum_validator'
   require_relative 'primitive/sum_factory'
+  require_relative 'primitive/mult_validator'
   require_relative 'primitive/mult_factory'
+  require_relative 'primitive/nilable_validator'
   require_relative 'primitive/nilable_factory'
 
-  # @since 0.1.0
-  include SmartCore::Types::System::ProducerDSL
+  class << self
+    # @param type_name [String, Symbol]
+    # @param type_definition [Block]
+    # @yield [type]
+    # @yieldparam type [SmartCore::Types::Primitive::DefinitionContext]
+    # @yieldreturn [void]
+    # @return [SmartCore::Types::Primitive]
+    #
+    # @api public
+    # @since 0.1.0
+    def define_type(type_name, &type_definition)
+      self::Factory.create_type(self, type_name, type_definition)
+    end
+  end
+
+  # @note NilClass is suitable for sum-types, mult-types and nilable types.
+  # @return [String, NilClass]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :name
 
-  # @return [SmartCore::Types::Primitive::Checker]
+  # @return [Class<SmartCore::Types::Primitive>]
   #
   # @api private
-  # @since 0.1.0
-  attr_reader :checker
+  # @since 0.3.0
+  attr_reader :category
+
+  # @return [Array<Any>]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :runtime_attributes
+
+  # @return [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+  #
+  # @api private
+  # @since 0.3.0
+  attr_reader :runtime_attributes_checker
 
   # @return [SmartCore::Types::Primitive::Caster]
   #
@@ -29,25 +64,53 @@ class SmartCore::Types::Primitive
   # @since 0.1.0
   attr_reader :caster
 
-  # @return [String]
+  # @return [SmartCore::Types::Primitive::Validator]
+  # @return [SmartCore::Types::Primitive::SumValidator]
+  # @return [SmartCore::Types::Primitive::MultValidator]
+  # @return [SmartCore::Types::primitive::NilableValidator]
   #
   # @api private
-  # @since 0.1.0
-  attr_reader :name
+  # @since 0.2.0
+  attr_reader :validator
 
-  # @param checker [SmartCore::Types::Primitive::Checker]
+  # @param name [String, NilClass] NilClass is suitable for sum-types, mult-types and nilable types.
+  # @param category [Class<SmartCore::Types::Primitive>, NilClass]
+  # @param validator [
+  #   SmartCore::Types::Primitive::Validator,
+  #   SmartCore::Types::Primitive::SumValidator,
+  #   SmartCore::Types::Primitive::MultValidator,
+  #   SmartCore::Types::Primitive::NilableValidator
+  # ]
   # @param caster [SmartCore::Types::Primitive::Caster]
-  # @param name [String]
+  # @param runtime_attributes_checker [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+  # @param runtime_attributes [Array<Any>]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize(checker, caster, name)
-    @lock = SmartCore::Engine::Lock.new
-    @checker = checker
+  # @version 0.3.0
+  # rubocop:disable Metrics/ParameterLists
+  def initialize(name, category, validator, caster, runtime_attributes_checker, *runtime_attributes)
+    @name = name
+    @category = category
+    @validator = validator
     @caster = caster
     @nilable = nil
-    @name = name.freeze
+    @runtime_attributes_checker = runtime_attributes_checker
+    @runtime_attributes = runtime_attributes
+    @lock = SmartCore::Engine::Lock.new
+  end
+  # rubocop:enable Metrics/ParameterLists
+
+  # @param cloneable_instance [SmartCore::Types::Primitive]
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api private
+  # @since 0.3.0
+  def initialize_copy(cloneable_instance)
+    lock.synchronize do
+      self.class::Factory::RuntimeTypeBuilder.initialize_clone(self, cloneable_instance)
+    end
   end
 
   # @param value [Any]
@@ -55,20 +118,38 @@ class SmartCore::Types::Primitive
   #
   # @api public
   # @since 0.1.0
+  # @since 0.2.0
   def valid?(value)
-    checker.call(value)
+    validator.valid?(value)
   end
 
+  # @param value [Any]
   # @return [void]
   #
-  # @raise [SmartCore::TypeError]
+  # @raise [SmartCore::Types::TypeError]
+  # @see SmartCore::Primitive::Validator
+  # @see SmartCore::Primitive::MultValidator
+  # @see SmartCore::Primitive::SumValidator
+  # @see SmartCore::Primitive::NilableValidator
   #
   # @api public
   # @since 0.1.0
+  # @version 0.2.0
   def validate!(value)
-    valid?(value) || raise(SmartCore::Types::TypeError, <<~ERROR_MESSAGE)
-      Invalid type (given #{(class << value; superclass; end).name}, expects #{name}/SmartCore)
-    ERROR_MESSAGE
+    validator.validate!(value)
+  end
+
+  # @return [SmartCore::Types::Primitive::Validator::Result]
+  #
+  # @see SmartCore::Primitive::Validator
+  # @see SmartCore::Primitive::MultValidator
+  # @see SmartCore::Primitive::SumValidator
+  # @see SmartCore::Primitive::NilableValidator
+  #
+  # @api public
+  # @since 0.2.0
+  def validate(value)
+    validator.validate(value)
   end
 
   # @param value [Any]
@@ -76,8 +157,12 @@ class SmartCore::Types::Primitive
   #
   # @api public
   # @since 0.1.0
+  # @version 0.3.0
   def cast(value)
-    caster.call(value)
+    # TODO (0.x.0):
+    #   refactor with ValueTransformer with internal reference to the type object
+    #   in Validator manner (in order to avoid explicit #runtime_attributes passing)
+    caster.call(value, runtime_attributes)
   end
 
   # @return [SmartCore::Types::Primitive]

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::Caster
   # @param expression [Proc]
   # @return [void]
@@ -13,12 +14,14 @@ class SmartCore::Types::Primitive::Caster
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [Any]
   #
   # @api private
   # @since 0.1.0
-  def call(value)
-    expression.call(value)
+  # @version 0.3.0
+  def call(value, runtime_attributes)
+    expression.call(value, runtime_attributes)
   end
 
   private

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::Checker
   # @param expression [Proc]
   # @return [void]
@@ -13,12 +14,14 @@ class SmartCore::Types::Primitive::Checker
   end
 
   # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
   # @return [Boolean]
   #
   # @api private
   # @since 0.1.0
-  def call(value)
-    !!expression.call(value)
+  # @version 0.3.0
+  def call(value, runtime_attributes)
+    !!expression.call(value, runtime_attributes)
   end
 
   private

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

@@ -2,8 +2,10 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Types::Primitive::Factory
   require_relative 'factory/definition_context'
+  require_relative 'factory/runtime_type_builder'
 
   class << self
     # @param type_category [Class<SmartCore::Types::Primitive>]
@@ -13,12 +15,26 @@ class SmartCore::Types::Primitive::Factory
     #
     # @api private
     # @since 0.1.0
+    # @version 0.3.0
     def create_type(type_category, type_name, type_definition)
       type_definitions = build_type_definitions(type_definition)
+      type_runtime_attributes_checker = build_type_runtime_attributes_checker(type_definitions)
       type_checker = build_type_checker(type_definitions)
       type_caster = build_type_caster(type_definitions)
-      type = build_type(type_category, type_name, type_checker, type_caster)
-      type.tap { register_new_type(type_category, type_name, type) }
+      type_invariant_control = build_type_invariant_control(type_definitions)
+      type_validator = build_type_validator(type_checker, type_invariant_control)
+      build_type(
+        type_category,
+        type_name,
+        type_validator,
+        type_caster,
+        type_runtime_attributes_checker
+      ).tap do |type|
+        assign_type_validator(type, type_validator)
+        assign_type_runtime_attributes_checker(type, type_runtime_attributes_checker)
+        register_new_type(type_category, type_name, type)
+        register_runtime_type_builder(type_category, type_name)
+      end
     end
 
     private
@@ -37,11 +53,34 @@ class SmartCore::Types::Primitive::Factory
       end.tap do |context|
         raise(
           SmartCore::Types::NoCheckerDefinitionError,
-          'Type checker is not provided (use .define_checker for it)'
-        ) if context.type_checker.nil?
+          'Type checker is not provided. You should define it via .define_checker(&block)'
+        ) if context.type_checker == nil
       end
     end
 
+    # @param type_definitions [SmartCore::Types::Primitive::Factory::DefinitionContext]
+    # @return [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+    #
+    # @api private
+    # @since 0.3.0
+    def build_type_runtime_attributes_checker(type_definitions)
+      SmartCore::Types::Primitive::RuntimeAttributesChecker.new(
+        type_definitions.type_runtime_attributes_checker
+      )
+    end
+
+    # @param type_definitions [SmartCore::Types::Primitive::Factory::DefinitionContext]
+    # @return [SmartCore::Types::Primitive::InvariantControl]
+    #
+    # @api private
+    # @since 0.2.0
+    def build_type_invariant_control(type_definitions)
+      SmartCore::Types::Primitive::InvariantControl.create(
+        type_definitions.type_invariant_chains,
+        type_definitions.type_invariants
+      )
+    end
+
     # @param type_definitions [SmartCore::Types::Primitive::Factory::DefinitionContext]
     # @return [SmartCore::Types::Primitive::Checker]
     #
@@ -57,23 +96,67 @@ class SmartCore::Types::Primitive::Factory
     # @api private
     # @since 0.1.0
     def build_type_caster(type_definitions)
-      if type_definitions.type_caster.nil?
+      if type_definitions.type_caster == nil
         SmartCore::Types::Primitive::UndefinedCaster.new
       else
         SmartCore::Types::Primitive::Caster.new(type_definitions.type_caster)
       end
     end
 
+    # @param checker [SmartCore::Types::Primitive::Checker]
+    # @param invariant_control [SmartCore::Types::Primitive::InvariantControl]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def build_type_validator(type_checker, type_invariant_control)
+      SmartCore::Types::Primitive::Validator.new(type_checker, type_invariant_control)
+    end
+
     # @param type_klass [Class<SmartCore::Types::Primitive>]
     # @param type_name [String, Symbol]
-    # @param type_checker [SmartCore::Types::Primitive::Checker]
+    # @param type_validator [SmartCore::Types::Primitive::Validator]
     # @param type_caster [SmartCore::Types::Primitive::Caster]
+    # @param type_runtime_attributes_checker [SmartCore::Types::Primitive::RuntimeAttributesChecker]
     # @return [SmartCore::Types::Primitive]
     #
     # @api private
     # @since 0.1.0
-    def build_type(type_category, type_name, type_checker, type_caster)
-      Class.new(type_category).new(type_checker, type_caster, type_name.to_s)
+    # @version 0.3.0
+    def build_type(
+      type_category,
+      type_name,
+      type_validator,
+      type_caster,
+      type_runtime_attributes_checker
+    )
+      Class.new(type_category).new(
+        type_name,
+        type_category,
+        type_validator,
+        type_caster,
+        type_runtime_attributes_checker
+      )
+    end
+
+    # @param type [SmartCore::Types::Primitive]
+    # @param type_validator [SmartCore::Types::Primitive::Validator]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def assign_type_validator(type, type_validator)
+      type_validator.___assign_type___(type)
+    end
+
+    # @param type [SmartCore::Types::Primitive]
+    # @param type_runtime_attributes_checker [SmartCore::Types::Primitive::RuntimeAttributesChecker]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def assign_type_runtime_attributes_checker(type, type_runtime_attributes_checker)
+      type_runtime_attributes_checker.___assign_type___(type)
     end
 
     # @param type_category [Class<SmartCore::Types::Primitive>]
@@ -93,5 +176,19 @@ class SmartCore::Types::Primitive::Factory
         "Incorrect constant name for new type (#{type_name})"
       )
     end
+
+    # @param type_category [Class<SmartCore::Types::Primitive>]
+    # @param type_name [String, Symbol]
+    # @return [void]
+    #
+    # @raise [SmartCore::Types::IncorrectTypeNameError]
+    #
+    # @api private
+    # @since 0.3.0
+    def register_runtime_type_builder(type_category, type_name)
+      type_category.define_singleton_method(type_name) do |*runtime_attributes|
+        RuntimeTypeBuilder.build_with_runtime(type_name, type_category, runtime_attributes)
+      end
+    end
   end
 end