smart_types 0.1.0 → 0.6.0

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl::Chain::Result
+  # @return [SmartCore::Types::Primitive::invariantControl::Chain]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_chain
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :checked_value
+
+  # @param invariant_chain [SmartCore::Types::Primitive::invariantControl::Chain]
+  # @param checked_value [Any]
+  # @param invariant_results [Array<SmartCore::Types::Primitive::InvariantControl::Single::Result>]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(invariant_chain, checked_value, invariant_results)
+    @invariant_chain = invariant_chain
+    @checked_value = checked_value
+    @invariant_results = invariant_results
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def success?
+    invariant_results.all?(&:success?)
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def failure?
+    invariant_results.any?(&:failure?)
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.1.0
+  def error_codes
+    invariant_results.select(&:failure?).map do |invariant_result|
+      "#{invariant_chain.name}.#{invariant_result.invariant.name}".tap(&:freeze)
+    end
+  end
+
+  private
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Single::Result>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_results
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+# @version 0.3.0
+class SmartCore::Types::Primitive::InvariantControl::Chain
+  require_relative 'chain/result'
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :name
+
+  # @param name [String]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(name)
+    @name = name.dup.tap(&:freeze)
+    @invariants = []
+  end
+
+  # @param invariant [SmartCore::Types::Primitive::InvariantControl::Single]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def add_invariant(invariant)
+    invariants << invariant
+  end
+
+  # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
+  # @return [SmartCore::Types::Primitive::InvariantControl::Chain::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  # @version 0.3.0
+  def check(value, runtime_attributes)
+    invariant_results = [].tap do |results|
+      invariants.each do |invariant|
+        result = invariant.check(value, runtime_attributes).tap { |res| results << res }
+        break if result.failure?
+      end
+    end
+
+    SmartCore::Types::Primitive::InvariantControl::Chain::Result.new(
+      self, value, invariant_results
+    )
+  end
+
+  private
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Single>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariants
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl::Factory::ChainDefinitionContext
+  # @return [SmartCore::Types::Primitive::InvariantControl::Chain]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :___chain___
+
+  # @param chain_name [String]
+  # @return [void]
+  #
+  # @api privae
+  # @since 0.2.0
+  def initialize(chain_name)
+    @___chain___ = SmartCore::Types::Primitive::InvariantControl::Chain.new(chain_name)
+  end
+
+  # @param invariant_name [String, Symbol]
+  # @param invariant_definition [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def invariant(invariant_name, &invariant_definition)
+    SmartCore::Types::Primitive::Factory::DefinitionContext.vaildate_invariant_attributes!(
+      invariant_name,
+      &invariant_definition
+    )
+
+    ___chain___.add_invariant(
+      SmartCore::Types::Primitive::InvariantControl::Single.create(
+        invariant_name, invariant_definition
+      )
+    )
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module SmartCore::Types::Primitive::InvariantControl::Factory
+  require_relative 'factory/chain_definition_context'
+
+  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)
+      completed_invariant_chains = build_invariant_chains(invariant_chains)
+      completed_invariants = build_invariants(invariants)
+
+      SmartCore::Types::Primitive::InvariantControl.new(
+        completed_invariant_chains,
+        completed_invariants
+      )
+    end
+
+    private
+
+    # @param invariant_chains [Hash<String,Array<Proc>]
+    # @return [Array<SmartCore::Types::Primitive::InvariantControl::Chain>]
+    #
+    # @api private
+    # @since 0.2.0
+    def build_invariant_chains(invariant_chains)
+      invariant_chains.map do |chain_name, chain_invariants|
+        context = ChainDefinitionContext.new(chain_name)
+        chain_invariants.each { |invariant_logic| context.instance_eval(&invariant_logic) }
+        context.___chain___
+      end
+    end
+
+    # @param invariants [Hash<String,Proc>]
+    # @return [Array<SmartCore::Types::Primitive::InvariantControl::Single>]
+    #
+    # @api private
+    # @since 0.2.0
+    def build_invariants(invariants)
+      invariants.map do |invariant_name, invariant_logics|
+        SmartCore::Types::Primitive::InvariantControl::Single.create(
+          invariant_name,
+          invariant_logics
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl::Result
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Chain::Result>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :chain_results
+
+  # @return [Array<SmartCore::Types::Primitive::InvariantControl::Single::Result>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :single_results
+
+  # @param invariant_control [SmartCore::Types::Primitive::InvariantControl]
+  # @param checked_value [Any]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(invariant_control, checked_value)
+    @invariant_control = invariant_control
+    @checked_value = checked_value
+    @chain_results = []
+    @single_results = []
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.2.0
+  def invariant_errors
+    collect_invariant_errors
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def success?
+    chain_results.all(&:success?) && single_results.all?(&:success?)
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def failure?
+    !success?
+  end
+
+  # @param result [SmartCore::Types::Primitive::InvariantControl::Chain::Result]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def add_chain_result(result)
+    chain_results << result
+  end
+
+  # @param result [SmartCore::Types::Primitive::InvariantControl::Single::Result]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def add_single_result(result)
+    single_results << result
+  end
+
+  private
+
+  # @return [SmartCore::Types::Primitive::InvariantControl]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_control
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :checked_value
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.2.0
+  def collect_invariant_errors
+    [].tap do |invariant_errors|
+      # collect invariant errors from invariant chains
+      chain_results.select(&:failure?).each do |chain_result|
+        invariant_errors.concat(chain_result.error_codes)
+      end
+
+      # collect invariant errors from single invariants
+      single_results.select(&:failure?).each do |single_result|
+        invariant_errors.concat(single_result.error_codes)
+      end
+    end.tap(&:freeze)
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class SmartCore::Types::Primitive::InvariantControl::Single::Result
+  # @return [SmartCore::Types::Primitive::InvariantControl::Single]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :checked_value
+
+  # @param invariant [SmartCore::Types::Primitive::InvariantControl::Single]
+  # @param checked_value [Any]
+  # @param is_valid_check [Boolean]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(invariant, checked_value, is_valid_check)
+    @invariant = invariant
+    @checked_value = checked_value
+    @is_valid_check = is_valid_check
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def success?
+    is_valid_check
+  end
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  def failure?
+    !success?
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.2.0
+  def error_codes
+    success? ? [] : [invariant.name]
+  end
+
+  private
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :is_valid_check
+  alias_method :valid_check?, :is_valid_check
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+# @version 0.3.0
+class SmartCore::Types::Primitive::InvariantControl::Single
+  require_relative 'single/result'
+
+  class << self
+    # @param name [String, Symbol]
+    # @param invariant_checker [Proc]
+    # @return [SmartCore::Types::Primitive::InvariantControl::Single]
+    #
+    # @api private
+    # @since 0.2.0
+    def create(name, invariant_checker)
+      new(name.to_s, invariant_checker)
+    end
+  end
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :name
+
+  # @param name [String]
+  # @param invariant_checker [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.2.0
+  def initialize(name, invariant_checker)
+    @name = name.dup.tap(&:freeze)
+    @invariant_checker = invariant_checker
+  end
+
+  # @param value [Any]
+  # @param runtime_attributes [Array<Any>]
+  # @return [SmartCore::Types::Primitive::InvariantControl::Single::Result]
+  #
+  # @api private
+  # @since 0.2.0
+  # @version 0.3.0
+  def check(value, runtime_attributes)
+    validation_result = !!invariant_checker.call(value, runtime_attributes)
+    Result.new(self, value, validation_result)
+  end
+
+  private
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :invariant_checker
+end