smart_types 0.1.0.alpha3 → 0.2.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/errors.rb

@@ -21,6 +21,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,39 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.2.0
 class SmartCore::Types::Primitive
+  require_relative 'primitive/checker'
   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/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]
+    # @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
 
-  # @return [SmartCore::Types::Primitive::Checker]
+  # @note NilClass is suitable for sum-types, mult-types and nilable types.
+  # @return [String, NilClass]
   #
-  # @api private
-  # @since 0.1.0
-  attr_reader :checker
+  # @api public
+  # @since 0.2.0
+  attr_reader :name
 
   # @return [SmartCore::Types::Primitive::Caster]
   #
@@ -29,18 +42,34 @@ class SmartCore::Types::Primitive
   # @since 0.1.0
   attr_reader :caster
 
-  # @param checker [SmartCore::Types::Primitive::Checker]
+  # @return [SmartCore::Types::Primitive::Validator]
+  # @return [SmartCore::Types::Primitive::SumValidator]
+  # @return [SmartCore::Types::Primitive::MultValidator]
+  # @return [SmartCore::Types::primitive::NilableValidator]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :validator
+
+  # @param name [String, NilClass] NilClass is suitable for sum-types, mult-types and nilable types.
+  # @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 nilable [SmartCore::Types::Primitive]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize(checker, caster)
-    @lock = SmartCore::Engine::Lock.new
-    @checker = checker
+  # @version 0.2.0
+  def initialize(name, validator, caster)
+    @name = name
+    @validator = validator
     @caster = caster
     @nilable = nil
+    @lock = SmartCore::Engine::Lock.new
   end
 
   # @param value [Any]
@@ -48,20 +77,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 #{value.class}, expects #{self}-related)
-    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]

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.2.0
 class SmartCore::Types::Primitive::Factory
   require_relative 'factory/definition_context'
 
@@ -13,12 +14,17 @@ class SmartCore::Types::Primitive::Factory
     #
     # @api private
     # @since 0.1.0
+    # @version 0.2.0
     def create_type(type_category, type_name, type_definition)
       type_definitions = build_type_definitions(type_definition)
       type_checker = build_type_checker(type_definitions)
       type_caster = build_type_caster(type_definitions)
-      type = build_type(type_category, 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).tap do |type|
+        assign_type_validator(type, type_validator)
+        register_new_type(type_category, type_name, type)
+      end
     end
 
     private
@@ -37,11 +43,23 @@ 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::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,22 +75,44 @@ 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_checker [SmartCore::Types::Primitive::Checker]
+    # @param type_name [String, Symbol]
+    # @param type_validator [SmartCore::Types::Primitive::Validator]
     # @param type_caster [SmartCore::Types::Primitive::Caster]
     # @return [SmartCore::Types::Primitive]
     #
     # @api private
     # @since 0.1.0
-    def build_type(type_category, type_checker, type_caster)
-      Class.new(type_category).new(type_checker, type_caster)
+    # @version 0.2.0
+    def build_type(type_category, type_name, type_validator, type_caster)
+      Class.new(type_category).new(type_name, type_validator, type_caster)
+    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_category [Class<SmartCore::Types::Primitive>]

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

@@ -2,26 +2,93 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.2.0
 class SmartCore::Types::Primitive::Factory::DefinitionContext
-  # @return [Proc]
+  class << self
+    # @param name [String, Symbol]
+    # @param definition [Block]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.2.0
+    def vaildate_invariant_attributes!(name, &definition)
+      unless block_given?
+        raise(SmartCore::Types::ArgumentError, 'No invariant block')
+      end
+
+      unless name.is_a?(::String) || name.is_a?(::Symbol)
+        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+          Invariant name should be a type of string or symbol.
+        ERROR_MESSAGE
+      end
+
+      if name == '' || name == :""
+        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+          Invariant name can not be empty.
+        ERROR_MESSAGE
+      end
+    end
+
+    # @param chain_name [String, Symbol]
+    # @param definition [Block]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.3.0
+    def vaildate_invariant_chain_attributes!(chain_name, &definition)
+      unless block_given?
+        raise(SmartCore::Types::ArgumentError, 'No invariant chain block')
+      end
+
+      unless chain_name.is_a?(::String) || chain_name.is_a?(::Symbol)
+        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+          Invariant chain name should be a type of string or symbol.
+        ERROR_MESSAGE
+      end
+
+      if chain_name == '' || chain_name == :""
+        raise(SmartCore::Types::ArgumentError, <<~ERROR_MESSAGE)
+          Invariant chain name can not be empty.
+        ERROR_MESSAGE
+      end
+    end
+  end
+
+  # @return [Proc, NilClass]
   #
   # @api private
   # @since 0.1.0
   attr_reader :type_checker
 
-  # @return [Proc]
+  # @return [Proc, NilClass]
   #
   # @api private
   # @since 0.1.0
   attr_reader :type_caster
 
+  # @return [Hash<String,Array<Proc>>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :type_invariant_chains
+
+  # @return [Hash<String,Proc>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :type_invariants
+
   # @return [void]
   #
   # @api private
   # @since 0.1.0
+  # @version 0.2.0
   def initialize
+    @type_invariant_chains = Hash.new { |h, k| h[k] = [] }
+    @type_invariants = {}
     @type_checker = nil
     @type_caster = nil
+    @definition_lock = SmartCore::Engine::Lock.new
   end
 
   # @param checker [Block]
@@ -29,9 +96,12 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
   #
   # @api public
   # @since 0.1.0
+  # @version 0.2.0
   def define_checker(&checker)
-    raise 'No checker definition block' unless block_given?
-    @type_checker = checker
+    thread_safe do
+      raise(SmartCore::Types::ArgumentError, 'No checker definition block') unless block_given?
+      @type_checker = checker
+    end
   end
 
   # @param caster [Block]
@@ -39,8 +109,48 @@ class SmartCore::Types::Primitive::Factory::DefinitionContext
   #
   # @api public
   # @since 0.1.0
+  # @version 0.2.0
   def define_caster(&caster)
-    raise 'No caster definition block' unless block_given?
-    @type_caster = caster
+    thread_safe do
+      raise(SmartCore::Types::ArgumentError, 'No caster definition block') unless block_given?
+      @type_caster = caster
+    end
+  end
+
+  # @param chain_name [String, Symbol]
+  # @param definitions [Block]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.2.0
+  def invariant_chain(chain_name, &definitions)
+    thread_safe do
+      self.class.vaildate_invariant_chain_attributes!(chain_name, &definitions)
+      @type_invariant_chains[chain_name.to_s] << definitions
+    end
+  end
+
+  # @param name [String, Symbol]
+  # @param definition [Block]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.2.0
+  def invariant(name, &definition)
+    thread_safe do
+      self.class.vaildate_invariant_attributes!(name, &definition)
+      @type_invariants[name.to_s] = definition
+    end
+  end
+
+  private
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.2.0
+  def thread_safe(&block)
+    @definition_lock.synchronize(&block)
   end
 end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl
+  require_relative 'invariant_control/result'
+  require_relative 'invariant_control/single'
+  require_relative 'invariant_control/chain'
+  require_relative 'invariant_control/factory'
+
+  class << self
+    # @param invariant_chains [Hash<String,Array<Proc>>]
+    # @param invariants [Hash<String,Proc>]
+    # @return [SmartCore::Types::Primitive::InvariantControl]
+    #
+    # @api private
+    # @since 0.2.0
+    def create(invariant_chains, invariants)
+      Factory.create(invariant_chains, invariants)
+    end
+  end
+
+  # @param invariant_chains [Array<SmartCore::Types::Primitive::InvariantControl::Chain>]
+  # @param invariants [Array<SmartCore::Types::Primitive::InvariantControl::Single>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(invariant_chains, invariants)
+    @invariant_chains = invariant_chains
+    @invariants = invariants
+  end
+
+  # @param value [Any]
+  # @return [SmartCore::Types::Primitive::InvariantControl::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  def check(value)
+    Result.new(self, value).tap do |result|
+      invariant_chains.each do |chain|
+        result.add_chain_result(chain.check(value))
+      end
+
+      invariants.each do |invariant|
+        result.add_single_result(invariant.check(value))
+      end
+    end
+  end
+
+  private
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Chain>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_chains
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Single>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariants
+end