nxt_schema 0.1.0 → 1.0.2

data/lib/nxt_schema.rb

@@ -1,69 +1,78 @@
-require "nxt_schema/version"
-require "pry"
-require "active_support/all"
+require 'nxt_schema/version'
+require 'active_support/all'
 require 'dry-types'
 require 'nxt_registry'
+require 'nxt_init'
 require 'yaml'
 
-require "nxt_schema/types"
-require "nxt_schema/undefined"
-require "nxt_schema/registry"
-require "nxt_schema/callable"
-require "nxt_schema/callable_or_value"
-require "nxt_schema/validators/registry"
-require "nxt_schema/node/validate_with_proxy"
+require_relative 'nxt_schema/types'
+require_relative 'nxt_schema/callable'
+require_relative 'nxt_schema/node'
+require_relative 'nxt_schema/undefined'
+require_relative 'nxt_schema/error'
+require_relative 'nxt_schema/errors/invalid'
+require_relative 'nxt_schema/errors/invalid_options'
+require_relative 'nxt_schema/errors/coercion_error'
 
-require "nxt_schema/errors"
-require "nxt_schema/errors/error"
-require "nxt_schema/errors/schema_not_applied_error"
-require "nxt_schema/errors/invalid_options_error"
+require_relative 'nxt_schema/validators/registry'
+require_relative 'nxt_schema/validators/validate_with_proxy'
+require_relative 'nxt_schema/validators/error_messages'
+require_relative 'nxt_schema/validators/validator'
+require_relative 'nxt_schema/validators/attribute'
+require_relative 'nxt_schema/validators/equal_to'
+require_relative 'nxt_schema/validators/optional_node'
+require_relative 'nxt_schema/validators/greater_than'
+require_relative 'nxt_schema/validators/greater_than_or_equal'
+require_relative 'nxt_schema/validators/less_than'
+require_relative 'nxt_schema/validators/less_than_or_equal'
+require_relative 'nxt_schema/validators/pattern'
+require_relative 'nxt_schema/validators/included_in'
+require_relative 'nxt_schema/validators/includes'
+require_relative 'nxt_schema/validators/excluded_in'
+require_relative 'nxt_schema/validators/excludes'
+require_relative 'nxt_schema/validators/query'
 
-require "nxt_schema/error_messages"
-require "nxt_schema/validators/validator"
-require "nxt_schema/validators/attribute"
-require "nxt_schema/validators/equality"
-require "nxt_schema/validators/optional_node"
-require "nxt_schema/validators/greater_than"
-require "nxt_schema/validators/greater_than_or_equal"
-require "nxt_schema/validators/less_than"
-require "nxt_schema/validators/less_than_or_equal"
-require "nxt_schema/validators/pattern"
-require "nxt_schema/validators/included"
-require "nxt_schema/validators/includes"
-require "nxt_schema/validators/excluded"
-require "nxt_schema/validators/excludes"
-require "nxt_schema/validators/query"
+require_relative 'nxt_schema/template/on_evaluator'
+require_relative 'nxt_schema/template/maybe_evaluator'
+require_relative 'nxt_schema/template/type_resolver'
+require_relative 'nxt_schema/template/type_system_resolver'
+require_relative 'nxt_schema/template/base'
+require_relative 'nxt_schema/template/sub_nodes'
+require_relative 'nxt_schema/template/has_sub_nodes'
+require_relative 'nxt_schema/template/any_of'
+require_relative 'nxt_schema/template/collection'
+require_relative 'nxt_schema/template/schema'
+require_relative 'nxt_schema/template/leaf'
 
-require "nxt_schema/node"
-require "nxt_schema/node/type_resolver"
-require "nxt_schema/node/maybe_evaluator"
-require "nxt_schema/node/default_value_evaluator"
-require "nxt_schema/node/base"
-require "nxt_schema/node/error"
-require "nxt_schema/node/has_subnodes"
-require "nxt_schema/node/template_store"
-require "nxt_schema/node/schema"
-require "nxt_schema/node/collection"
-require "nxt_schema/node/leaf"
-require "nxt_schema/dsl"
+require_relative 'nxt_schema/node/errors/schema_error'
+require_relative 'nxt_schema/node/errors/validation_error'
+require_relative 'nxt_schema/node/error_store'
+require_relative 'nxt_schema/node/base'
+require_relative 'nxt_schema/node/any_of'
+require_relative 'nxt_schema/node/leaf'
+require_relative 'nxt_schema/node/collection'
+require_relative 'nxt_schema/node/schema'
+require_relative 'nxt_schema/dsl'
+require_relative 'nxt_schema/registry/proxy'
+require_relative 'nxt_schema/registry'
 
 module NxtSchema
-  def register_validator(validator, *keys)
-    keys.each do |key|
-      NxtSchema::Validators::Registry::VALIDATORS.register(key, validator)
-    end
+  extend Dsl
+
+  def register_error_messages(*paths)
+    Validators::ErrorMessages.load(paths)
   end
 
-  def register_type(key, type)
-    NxtSchema::Types.const_set(key.to_s, type)
+  def register_validator(validator, *keys)
+    keys.each { |key| NxtSchema::Validators::REGISTRY.register(key, validator) }
   end
 
-  def register_error_messages(*paths)
-    ErrorMessages.load(paths)
+  def register_type(key, type)
+    NxtSchema::Types.registry(:types).register(key, type)
   end
 
   # Load default messages
-  ErrorMessages.load
+  Validators::ErrorMessages.load
 
-  module_function :register_validator, :register_type, :register_error_messages
+  module_function :register_error_messages, :register_validator, :register_type
 end

data/lib/nxt_schema/callable.rb

@@ -1,74 +1,40 @@
 module NxtSchema
   class Callable
-    def initialize(callee)
-      @callee = callee
-
-      if callee.is_a?(Symbol)
-        self.type = :method
-      elsif callee.respond_to?(:call)
-        self.type = :proc
-        self.context = callee.binding
-      else
-        raise ArgumentError, "Callee is nor symbol nor a proc: #{callee}"
-      end
-    end
-
-    def bind!(execution_context)
-      self.context = execution_context
-      ensure_context_not_missing
-      self
+    def initialize(callable, target = nil, *args)
+      @callable = callable
+      @target = target
+      @args = args
     end
 
-    def bind(execution_context = nil)
-      return self if context
+    def call
+      return callable if value?
+      return callable.call(*args_from_arity) if proc?
 
-      self.context = execution_context
-      ensure_context_not_missing
-      self
+      target.send(callable, *args_from_arity)
     end
 
-    # NOTE: Currently we only allow arguments! Not keyword args or **options
-    # If we would allow **options and we would pass a hash as the only argument it would
-    # automatically be parsed as the options!
-    def call(*args)
-      ensure_context_not_missing
-
-      args = args.take(arity)
+    def method?
+      @method ||= callable.class.in?([Symbol, String]) && target.respond_to?(callable)
+    end
 
-      if method?
-        context.send(callee, *args)
-      else
-        context.instance_exec(*args, &callee)
-      end
+    def proc?
+      @proc ||= callable.respond_to?(:call)
     end
 
-    def arity
-      if proc?
-        callee.arity
-      elsif method?
-        method = context.send(:method, callee)
-        method.arity
-      else
-        raise ArgumentError, "Can't resolve arity from #{callee}"
-      end
+    def value?
+      !method? && !proc?
     end
 
     private
 
-    def proc?
-      type == :proc
-    end
+    attr_reader :callable, :target, :args
 
-    def method?
-      type == :method
+    def arity
+      proc? ? callable.arity : 0
     end
 
-    def ensure_context_not_missing
-      return if context
-
-      raise ArgumentError, "Missing context: #{context}"
+    def args_from_arity
+      @args_from_arity ||= ([target] + args).take(arity)
     end
-
-    attr_accessor :context, :callee, :type
   end
-end
+end

data/lib/nxt_schema/dsl.rb

@@ -1,38 +1,48 @@
 module NxtSchema
-  def schema(name = :root, **options, &block)
-    Node::Schema.new(name: name, parent_node: nil, **options, &block)
-  end
+  module Dsl
+    DEFAULT_OPTIONS = { type_system: NxtSchema::Types }.freeze
 
-  def collection(name = :roots, **options, &block)
-    Node::Collection.new(name: name, parent_node: nil, **options, &block)
-  end
+    def collection(name = :root, type: NxtSchema::Template::Collection::DEFAULT_TYPE, **options, &block)
+      NxtSchema::Template::Collection.new(
+        name: name,
+        type: type,
+        parent_node: nil,
+        **DEFAULT_OPTIONS.merge(options),
+        &block
+      )
+    end
 
-  def params(name = :root, **options, &block)
-    Node::Schema.new(
-      name: name,
-      parent_node: nil,
-      **options.merge(
-        type_system: NxtSchema::Types::Params,
-      ).reverse_merge(transform_keys: :to_sym),
-      &block
-    )
-  end
+    alias nodes collection
 
-  def json(name = :root, **options, &block)
-    Node::Schema.new(
-      name: name,
-      parent_node: nil,
-      **options.merge(
-        type_system: NxtSchema::Types::JSON,
-      ).reverse_merge(transform_keys: :to_sym),
-      &block
-    )
-  end
+    def schema(name = :roots, type: NxtSchema::Template::Schema::DEFAULT_TYPE, **options, &block)
+      NxtSchema::Template::Schema.new(
+        name: name,
+        type: type,
+        parent_node: nil,
+        **DEFAULT_OPTIONS.merge(options),
+        &block
+      )
+    end
+
+    def any_of(name = :roots, **options, &block)
+      NxtSchema::Template::AnyOf.new(
+        name: name,
+        parent_node: nil,
+        **DEFAULT_OPTIONS.merge(options),
+        &block
+      )
+    end
 
-  alias_method :node, :schema
-  alias_method :root, :schema
-  alias_method :nodes, :collection
-  alias_method :roots, :collection
+    # schema root with NxtSchema::Types::Params type system
 
-  module_function :root, :roots, :node, :nodes, :collection, :schema, :params
+    def params(name = :params, type: NxtSchema::Template::Schema::DEFAULT_TYPE, **options, &block)
+      NxtSchema::Template::Schema.new(
+        name: name,
+        type: type,
+        parent_node: nil,
+        **options.merge(type_system: NxtSchema::Types::Params),
+        &block
+      )
+    end
+  end
 end

data/lib/nxt_schema/error.rb

@@ -0,0 +1,4 @@
+module NxtSchema
+  class Error < StandardError
+  end
+end

data/lib/nxt_schema/errors/{error.rb → coercion_error.rb}

@@ -1,7 +1,6 @@
 module NxtSchema
   module Errors
-    class Error < StandardError
-
+    class CoercionError < Error
     end
   end
 end

data/lib/nxt_schema/errors/invalid.rb

@@ -0,0 +1,16 @@
+module NxtSchema
+  module Errors
+    class Invalid < NxtSchema::Error
+      def initialize(node)
+        @node = node
+        super(build_message)
+      end
+
+      attr_reader :node
+
+      def build_message
+        node.errors
+      end
+    end
+  end
+end

data/lib/nxt_schema/errors/invalid_options.rb

@@ -0,0 +1,6 @@
+module NxtSchema
+  module Errors
+    class InvalidOptions < NxtSchema::Error
+    end
+  end
+end

data/lib/nxt_schema/node/any_of.rb

@@ -0,0 +1,39 @@
+module NxtSchema
+  module Node
+    class AnyOf < Node::Base
+      def valid?
+        valid_node.present?
+      end
+
+      def call
+        child_nodes.map(&:call)
+
+        if valid?
+          self.output = valid_node.output
+        else
+          child_nodes.each do |node|
+            merge_errors(node)
+          end
+        end
+
+        self
+      end
+
+      private
+
+      delegate :[], to: :child_nodes
+
+      def valid_node
+        child_nodes.find(&:valid?)
+      end
+
+      def child_nodes
+        @child_nodes ||= nodes.map { |node| node.build_node(input: input, context: context, parent: self) }
+      end
+
+      def nodes
+        @nodes ||= node.sub_nodes.values
+      end
+    end
+  end
+end

data/lib/nxt_schema/node/base.rb

@@ -1,317 +1,116 @@
 module NxtSchema
   module Node
     class Base
-      def initialize(name: name_from_index, type:, parent_node:, **options, &block)
-        @name = name
-        @parent_node = parent_node
-        @options = options
-        @type_system = resolve_type_system
-        @additional_keys_strategy = resolve_additional_keys_strategy
-        @type = type
-        @schema_errors_key = options.fetch(:schema_errors_key, :itself)
-        @validations = []
-        @level = parent_node ? parent_node.level + 1 : 0
-        @all_nodes = parent_node ? (parent_node.all_nodes || {}) : {}
-        @is_root = parent_node.nil?
-        @root = parent_node.nil? ? self : parent_node.root
-        @errors = {}
-        @context = nil
-        @applied = false
-        @input = nil
-        @value = NxtSchema::Undefined.new
-        @locale = options.fetch(:locale) { parent_node&.locale || 'en' }
+      def initialize(node:, input: Undefined.new, parent:, context:, error_key:)
+        @node = node
+        @input = input
+        @parent = parent
+        @output = nil
+        @error_key = error_key
+        @context = context || parent&.context
+        @coerced = false
+        @coerced_nodes = parent&.coerced_nodes || []
+        @is_root = parent.nil?
+        @root = parent.nil? ? self : parent.root
+        @errors = ErrorStore.new(self)
+        @locale = node.options.fetch(:locale) { parent&.locale || 'en' }.to_s
 
-        # Note that it is not possible to use present? on an instance of NxtSchema::Schema since it inherits from Hash
-        evaluate_block(block) if block_given?
+        @index = error_key
+        resolve_error_key(error_key)
       end
 
-      attr_accessor :name,
-                    :parent_node,
-                    :options,
-                    :type,
-                    :schema_errors,
-                    :namespace,
-                    :errors,
-                    :validations,
-                    :schema_errors_key,
-                    :level,
-                    :validation_errors,
-                    :all_nodes,
-                    :value,
-                    :type_system,
-                    :root,
-                    :context,
-                    :applied,
-                    :input,
-                    :additional_keys_strategy,
-                    :locale
+      attr_accessor :output, :node, :input
+      attr_reader :parent, :context, :error_key, :coerced, :coerced_nodes, :root, :errors, :locale, :index
 
-
-      alias_method :types, :type_system
-
-      def parent(level = 1)
-        level.times.inject(self) { |acc| acc.parent_node }
-      end
-
-      alias_method :up, :parent
-
-      def default(default_value, &block)
-        options.merge!(default: default_value)
-        evaluate_block(block) if block_given?
-        self
+      def call
+        raise NotImplementedError, 'Implement this in our sub class'
       end
 
-      def meta(value = NxtSchema::Undefined.new)
-        if value.is_a?(NxtSchema::Undefined)
-          @meta
-        else
-          @meta = value
-          self
-        end
-      end
-
-      def value_or_default_value(value)
-        if !value && options.key?(:default)
-          DefaultValueEvaluator.new(self, options.fetch(:default)).call
-        else
-          value
-        end
-      end
+      delegate :name, :options, to: :node
 
-      def maybe(maybe_value, &block)
-        options.merge!(maybe: maybe_value)
-        evaluate_block(block) if block_given?
-        self
+      def root?
+        @is_root
       end
 
-      def optional(optional_value, &block)
-        raise ArgumentError, 'Optional nodes can only exist within schemas' unless parent.is_a?(NxtSchema::Node::Schema)
-
-        options.merge!(optional: optional_value)
-        evaluate_block(block) if block_given?
-        self
+      def valid?
+        errors.empty?
       end
 
-      def presence(presence_value, &block)
-        raise ArgumentError, 'Present nodes can only exist within schemas' unless parent.is_a?(NxtSchema::Node::Schema)
-
-        options.merge!(presence: presence_value)
-        evaluate_block(block) if block_given?
-        self
+      def add_error(error)
+        errors.add_validation_error(message: error)
       end
 
-      def presence?
-        @presence ||= begin
-          presence_option = options[:presence]
-
-          options[:presence] = if presence_option.respond_to?(:call)
-            Callable.new(presence_option).call(self, value)
-          else
-            presence_option
-          end
-        end
+      def add_schema_error(error)
+        errors.add_schema_error(message: error)
       end
 
-      def validate(key, *args, &block)
-        if key.is_a?(Symbol)
-          validator = validator(key, *args)
-        elsif key.respond_to?(:call)
-          validator = key
-        else
-          raise ArgumentError, "Don't know how to resolve validator from: #{key}"
-        end
-
-        add_validators(validator)
-        evaluate_block(block) if block_given?
-        self
+      def merge_errors(node)
+        errors.merge_errors(node)
       end
 
-      def add_error(error, index = schema_errors_key)
-        validation_errors[index] ||= []
-        validation_errors[index] << error
-        false
-      end
+      def run_validations
+        return false unless coerced?
 
-      def validate_all_nodes
-        sorted_nodes = all_nodes.values.sort do |node, other_node|
-          [node.level, (!node.leaf?).to_s] <=> [other_node.level, (!other_node.leaf?).to_s]
+        node.validations.each do |validation|
+          args = [self, input]
+          validation.call(*args.take(validation.arity))
         end
-
-        # we have to start from the bottom, leafs before others on the same level
-        sorted_nodes.reverse_each(&:apply_validations)
       end
 
-      def apply_validations
-        # We don't run validations in case there are schema errors
-        # to avoid weird errors
-        # First reject empty schema_errors
-        schema_errors.reject! { |_, v| v.empty? }
-
-        # TODO: Is this correct? - Do not apply validations when maybe criteria applies?
-        unless schema_errors[schema_errors_key]&.any? && !maybe_criteria_applies?(value)
-          build_validations
+      def up(levels = 1)
+        0.upto(levels - 1).inject(self) do |acc, _|
+          parent = acc.send(:parent)
+          break acc unless parent
 
-          validations.each do |validation|
-            args = [self, value]
-            validation.call(*args.take(validation.arity))
-          end
+          parent
         end
-
-        if self.is_a?(NxtSchema::Node::Collection) && value.respond_to?(:each)
-          value.each_with_index do |item, index|
-            validation_errors[index]&.reject! { |_, v| v.empty? }
-          end
-        end
-
-        validation_errors.reject! { |_, v| v.empty? }
-
-        self
-      end
-
-      def build_validations
-        validations_from_options = Array(options.fetch(:validate, []))
-        self.validations = validations_from_options
-      end
-
-      def schema_errors?
-        schema_errors.reject! { |_, v| v.empty? }
-        schema_errors.any?
-      end
-
-      def validation_errors?
-        validation_errors.reject! { |_, v| v.empty? }
-        validation_errors.any?
-      end
-
-      def root?
-        @is_root
-      end
-
-      def leaf?
-        false
-      end
-
-      def valid?
-        raise SchemaNotAppliedError, 'Schema was not applied yet' unless applied?
-
-        validation_errors.empty?
-      end
-
-      def add_validators(validator)
-        options[:validate] ||= []
-        options[:validate] = Array(options.fetch(:validate, []))
-        options[:validate] << validator
-      end
-
-      def validator(key, *args)
-        Validators::Registry::VALIDATORS.resolve(key).new(*args).build
-      end
-
-      def validate_with(&block)
-        add_validators(
-          ->(node) { NxtSchema::Node::ValidateWithProxy.new(node).validate(&block) }
-        )
       end
 
       private
 
-      def register_node(context)
-        return if all_nodes.key?(object_id)
+      attr_writer :coerced, :root
 
-        self.context = context
-        all_nodes[object_id] = self
-      end
+      def coerce_input
+        output = input.is_a?(Undefined) && node.omnipresent? ? input : node.type.call(input)
+        self.output = output
 
-      def applied?
-        @applied
+      rescue Dry::Types::CoercionError, NxtSchema::Errors::CoercionError => error
+        add_schema_error(error.message)
       end
 
-      def mark_as_applied
-        self.applied = true
+      def apply_on_evaluators
+        node.on_evaluators.each { |evaluator| evaluator.call(input, self, context) { |result| self.input = result } }
       end
 
-      def add_schema_error(error, index = schema_errors_key)
-        schema_errors[index] ||= []
-        schema_errors[index] << error
+      def maybe_evaluator_applies?
+        @maybe_evaluator_applies ||= node.maybe_evaluators.inject(false) do |acc, evaluator|
+          result = (acc || evaluator.call(input, self, context))
 
-        add_error(error, index)
-      end
-
-      def maybe_criteria_applies?(value)
-        @maybe_criteria_applies ||= begin
-          options.key?(:maybe) && MaybeEvaluator.new(self, options.fetch(:maybe), value).call
-        end
-      end
-
-      def self_without_empty_schema_errors
-        schema_errors.reject! { |_, v| v.empty? }
-        validate_all_nodes if root?
-        self.errors = flat_validation_errors(validation_errors, name)
-        self
-      end
-
-      def flat_validation_errors(errors, namespace, acc = {})
-        errors.each_with_object(acc) do |(key, val), acc|
-          current_namespace = [namespace, key].reject { |namespace| namespace == schema_errors_key }.compact.join('.')
-
-          if val.is_a?(::Hash)
-            flat_validation_errors(val, current_namespace, acc)
-          else
-            acc[current_namespace] ||= []
-            acc[current_namespace] += Array(val)
-          end
-        end
-      end
-
-      def name_from_index
-        if parent_node
-          if parent_node.is_a?(NxtSchema::Node::Collection)
-            size + 1
+          if result
+            self.output = input
+            break true
           else
-            raise ArgumentError, "Nodes with parent_node: #{parent_node} cannot be anonymous"
+            false
           end
-        else
-          :root
         end
       end
 
-      def evaluate_block(block)
-        if block.arity.zero?
-          instance_exec(&block)
-        else
-          evaluator_args = [self, value]
-          block.call(*evaluator_args.take(block.arity))
-        end
-      end
-
-      def resolve_type_system
-        type_system = options.fetch(:type_system) { parent_node&.type_system }
+      def register_as_coerced_when_no_errors
+        return unless valid?
 
-        self.type_system = if type_system.is_a?(Module)
-          type_system
-        elsif type_system.is_a?(Symbol) || type_system.is_a?(String)
-          "NxtSchema::Types::#{type_system.to_s.classify}".constantize
-        else
-          NxtSchema::Types
-        end
+        self.coerced = true
+        coerced_nodes << self
       end
 
-      def resolve_additional_keys_strategy
-        options.fetch(:additional_keys) { parent_node&.send(:resolve_additional_keys_strategy) || :ignore }
-      end
-
-      def type_resolver
-        @type_resolver ||= begin
-          if root?
-            TypeResolver.new
-          else
-            raise NoMethodError, 'type_resolver is only available on root node'
-          end
-        end
+      def resolve_error_key(key)
+        parts = [parent&.error_key].compact
+        parts << (key.present? ? "#{node.name}[#{key}]" : node.name)
+        @error_key = parts.join('.')
       end
 
-      def coerce_value(value)
-        type[value]
+      def coerced?(&block)
+        block.call(self) if @coerced && block_given?
+        @coerced
       end
     end
   end