smart_types 0.1.0 → 0.2.0

data/lib/smart_core/types/primitive/sum_validator/result.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::SumValidator::Result
+  # @return [Array]
+  #
+  # @api private
+  # @since 0.2.0
+  NO_INVARIANT_ERRORS = [].freeze
+
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :type
+
+  # @return concrete_validation_result [
+  #   SmartCore::Types::Primitive::Validator::Result,
+  #   SmartCore::Types::Primitive::SumValidator::Result,
+  #   SmartCore::Types::Primitive::MultValidator::Result,
+  #   SmartCore::Types::Primitive::NilableValidator::Result
+  # ]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :concrete_validation_result
+
+  # @return [Array<String>]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :invariant_errors
+  alias_method :errors, :invariant_errors
+  alias_method :error_codes, :invariant_errors
+
+  # @param type [SmartCore::Types::Primitive]
+  # @param concrete_validation_result [
+  #   Boolean, (TEMPORARY)
+  #   SmartCore::Types::Primitive::Validator::Result,
+  #   SmartCore::Types::Primitive::SumValidator::Result,
+  #   SmartCore::Types::Primitive::MultValidator::Result,
+  #   SmartCore::Types::Primitive::NilableValidator::Result
+  # ]
+  # @param invariant_errors [Array<String>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(type, concrete_validation_result, invariant_errors = NO_INVARIANT_ERRORS.dup)
+    @type = type
+    @concrete_validation_result = concrete_validation_result
+    @invariant_errors = invariant_errors.dup.tap(&:freeze)
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def valid_invariants?
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.valid_invariants?
+    true
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def is_valid_check
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.is_valid_check
+    concrete_validation_result
+  end
+  alias_method :valid_check?, :is_valid_check
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def success?
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.success?
+    concrete_validation_result
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def failure?
+    # NOTE: at this moment type sum does not support invariant checking
+    # TODO (0.x.0):
+    #   concrete_validation_result.failure?
+    !success?
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::Validator
+  require_relative 'validator/result'
+
+  # @return [SmartCore::Type::Primitive]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :type
+
+  # @return [SmartCore::Types::Primitive::Checker]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :type_checker
+
+  # @return [SmartCore::Types::Primitive::InvariantControl]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_control
+
+  # @param type_checker [
+  #   SmartCore::Types::Primitive::Checker,
+  #   SmartCore::Types::Primitive::MultChecker,
+  #   SmartCore::Types::Primitive::SumChecker
+  # ]
+  # @param invariant_control [SmartCore::Types::Primitive::InvariantControl]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(type_checker, invariant_control)
+    @type = nil
+    @type_checker = type_checker
+    @invariant_control = invariant_control
+  end
+
+  # @param type [SmartCore::Types::Primitive]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def ___assign_type___(type)
+    @type = type
+  end
+
+  # @param value [Any]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def valid?(value)
+    validate(value).success?
+  end
+
+  # @param value [Any]
+  # @return [SmartCore::Types::Primitive::Validator::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  def validate(value)
+    checker_result = type_checker.call(value) # => Boolean
+    return Result.new(type, value, checker_result) unless checker_result
+    invariant_result = invariant_control.check(value)
+    invariant_errors = invariant_result.invariant_errors.map { |error| "#{type.name}.#{error}" }
+    Result.new(type, value, checker_result, invariant_errors)
+  end
+
+  # @param value [Any]
+  # @return [void]
+  #
+  # @raise [SmartCore::Types::TypeError]
+  #
+  # @api private
+  # @since 0.2.0
+  def validate!(value)
+    return if validate(value).success?
+    raise(SmartCore::Types::TypeError, 'Invalid type')
+  end
+end

data/lib/smart_core/types/primitive/validator/result.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::Validator::Result
+  # @return [Array]
+  #
+  # @api private
+  # @since 0.2.0
+  NO_INVARIANT_ERRORS = [].freeze
+
+  # @return [SmartCore::Types::Primitive]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :type
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :is_valid_check
+  alias_method :valid_check?, :is_valid_check
+
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :checked_value
+  alias_method :value, :checked_value
+
+  # @return [Array<String>]
+  #
+  # @api public
+  # @since 0.2.0
+  attr_reader :invariant_errors
+  alias_method :errors, :invariant_errors
+  alias_method :error_codes, :invariant_errors
+
+  # @param type [SmartCore::Types::Primitive]
+  # @param checked_value [Any]
+  # @param is_valid_check [Boolean]
+  # @param invariant_errors [Array<String>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(type, checked_value, is_valid_check, invariant_errors = NO_INVARIANT_ERRORS.dup)
+    @type = type
+    @checked_value = checked_value
+    @is_valid_check = is_valid_check
+    @invariant_errors = invariant_errors.tap(&:freeze)
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def valid_invariants?
+    invariant_errors.empty?
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def success?
+    valid_check? && invariant_errors.empty?
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.2.0
+  def failure?
+    !success?
+  end
+end

data/lib/smart_core/types/value.rb

@@ -5,6 +5,7 @@
 class SmartCore::Types::Value < SmartCore::Types::Primitive
   require_relative 'value/nil'
   require_relative 'value/string'
+  require_relative 'value/string_io'
   require_relative 'value/symbol'
   require_relative 'value/text'
   require_relative 'value/integer'
@@ -13,6 +14,7 @@ class SmartCore::Types::Value < SmartCore::Types::Primitive
   require_relative 'value/boolean'
   require_relative 'value/array'
   require_relative 'value/hash'
+  require_relative 'value/io'
   require_relative 'value/proc'
   require_relative 'value/class'
   require_relative 'value/module'
@@ -22,6 +24,13 @@ class SmartCore::Types::Value < SmartCore::Types::Primitive
   require_relative 'value/date_time'
   require_relative 'value/time_based'
   require_relative 'value/enumerable'
+  require_relative 'value/enumerator'
+  require_relative 'value/enumerator_chain'
   require_relative 'value/comparable'
   require_relative 'value/big_decimal'
+  require_relative 'value/range'
+  require_relative 'value/method'
+  require_relative 'value/unbound_method'
+  require_relative 'value/set'
+  require_relative 'value/rational'
 end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:Enumerator) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+
+  type.define_caster do |value|
+    # TODO: realize
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:EnumeratorChain) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+
+  type.define_caster do |value|
+    # TODO: realize
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:IO) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+
+  type.define_caster do |value|
+    # TODO: realize
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:Method) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+end

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

@@ -4,8 +4,6 @@
 # @since 0.1.0
 SmartCore::Types::Value.define_type(:Nil) do |type|
   type.define_checker do |value|
-    # rubocop:disable Style/NilComparison
     value == nil # NOTE: #nil? is not used cuz BasicObject hasn't #nil? method
-    # rubocop:enable Style/NilComparison
   end
 end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:Range) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:Rational) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+
+  type.define_caster do |value|
+    # TODO: realize
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:Set) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+
+  type.define_caster do |value|
+    # TODO: realize
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:StringIO) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+
+  type.define_caster do |value|
+    # TODO: realize
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.x.0
+SmartCore::Types::Value.define_type(:UnboundMethod) do |type|
+  type.define_checker do |value|
+    # TODO: realize
+  end
+end

data/lib/smart_core/types/version.rb

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

data/smart_types.gemspec

@@ -32,11 +32,12 @@ 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.6'
+  spec.add_dependency 'smart_engine', '~> 0.7'
 
   spec.add_development_dependency 'bundler',          '~> 2.1'
   spec.add_development_dependency 'rake',             '~> 13.0'
-  spec.add_development_dependency 'rspec',            '~> 3.9'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.82'
-  spec.add_development_dependency 'simplecov',        '~> 0.18'
+  spec.add_development_dependency 'rspec',            '~> 3.10'
+  spec.add_development_dependency 'armitage-rubocop', '~> 1.3'
+  spec.add_development_dependency 'simplecov',        '~> 0.19'
+  spec.add_development_dependency 'pry',              '~> 0.13'
 end