dry-schema 0.1.0

data/lib/dry/schema/result.rb

@@ -0,0 +1,164 @@
+require 'dry/initializer'
+require 'dry/equalizer'
+
+module Dry
+  module Schema
+    # Processing result
+    #
+    # @see Processor#call
+    #
+    # @api public
+    class Result
+      include Dry::Equalizer(:output, :errors)
+
+      extend Dry::Initializer
+
+      # @api private
+      param :output
+      alias_method :to_h, :output
+      alias_method :to_hash, :output
+
+      # @api private
+      param :results, default: -> { EMPTY_ARRAY.dup }
+
+      # @api private
+      option :message_compiler
+
+      # @api private
+      def self.new(*args)
+        result = super
+        yield(result)
+        result.freeze
+      end
+
+      # @api private
+      def replace(hash)
+        @output = hash
+        self
+      end
+
+      # @api private
+      def concat(other)
+        results.concat(other)
+        result_ast.concat(other.map(&:to_ast))
+        self
+      end
+
+      # Read value from the output hash
+      #
+      # @param [Symbol] name
+      #
+      # @return [Object]
+      #
+      # @api public
+      def [](name)
+        output[name]
+      end
+
+      # Check if a given key is present in the output
+      #
+      # @param [Symbol] name
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def key?(name)
+        output.key?(name)
+      end
+
+      # Check if a given key resulted in an error
+      #
+      # @param [Symbol] name
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def error?(name)
+        errors.key?(name)
+      end
+
+      # Check if the result is successful
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def success?
+        results.empty?
+      end
+
+      # Check if the result is not successful
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def failure?
+        !success?
+      end
+
+      # Get human-readable error representation
+      #
+      # @see #message_set
+      #
+      # @return [Hash<Symbol=>Array>]
+      #
+      # @api public
+      def errors(options = EMPTY_HASH)
+        message_set(options.merge(hints: false)).dump
+      end
+
+      # Get all messages including hints
+      #
+      # @see #message_set
+      #
+      # @return [Hash<Symbol=>Array>]
+      #
+      # @api public
+      def messages(options = EMPTY_HASH)
+        message_set(options.merge(hints: true)).dump
+      end
+
+      # Get hints exclusively without errors
+      #
+      # @see #message_set
+      #
+      # @return [Hash<Symbol=>Array>]
+      #
+      # @api public
+      def hints(options = EMPTY_HASH)
+        message_set(options.merge(failures: false)).dump
+      end
+
+      # Return the message set
+      #
+      # @param [Hash] options
+      # @option options [Symbol] :locale Alternative locale (default is :en)
+      # @option options [Boolean] :hints Whether to include hint messages or not
+      # @option options [Boolean] :full Whether to generate messages that include key names
+      #
+      # @return [MessageSet]
+      #
+      # @api public
+      def message_set(options = EMPTY_HASH)
+        message_compiler.with(options).(result_ast)
+      end
+
+      # Return a string representation of the result
+      #
+      # @return [String]
+      #
+      # @api public
+      def inspect
+        "#<#{self.class}#{to_h.inspect} errors=#{errors.inspect}>"
+      end
+
+      private
+
+      # A list of failure ASTs produced by rule result objects
+      #
+      # @api private
+      def result_ast
+        @__result__ast ||= results.map(&:to_ast)
+      end
+    end
+  end
+end

data/lib/dry/schema/rule_applier.rb

@@ -0,0 +1,45 @@
+require 'dry/initializer'
+
+require 'dry/schema/constants'
+require 'dry/schema/config'
+require 'dry/schema/result'
+require 'dry/schema/messages'
+require 'dry/schema/message_compiler'
+
+module Dry
+  module Schema
+    # Applies rules defined within the DSL
+    #
+    # @api private
+    class RuleApplier
+      extend Dry::Initializer
+
+      # @api private
+      param :rules
+
+      # @api private
+      option :config, default: proc { Config.new }
+
+      # @api private
+      option :message_compiler, default: proc { MessageCompiler.new(Messages.setup(config)) }
+
+      # @api private
+      def call(input)
+        results = EMPTY_ARRAY.dup
+
+        rules.each do |name, rule|
+          next if input.error?(name)
+          result = rule.(input)
+          results << result if result.failure?
+        end
+
+        input.concat(results)
+      end
+
+      # @api private
+      def to_ast
+        [:set, rules.values.map(&:to_ast)]
+      end
+    end
+  end
+end

data/lib/dry/schema/trace.rb

@@ -0,0 +1,103 @@
+require 'dry/schema/constants'
+require 'dry/schema/compiler'
+require 'dry/schema/predicate'
+
+module Dry
+  module Schema
+    # Captures predicates defined within the DSL
+    #
+    # @api private
+    class Trace < BasicObject
+      INVALID_PREDICATES = %i[key?].freeze
+
+      include ::Dry::Equalizer(:compiler, :captures)
+
+      undef eql?
+
+      # @api private
+      attr_reader :compiler
+
+      # @api private
+      attr_reader :captures
+
+      # @api private
+      def initialize(compiler = Compiler.new)
+        @compiler = compiler
+        @captures = []
+      end
+
+      # @api private
+      def evaluate(*predicates, **opts, &block)
+        predicates.each do |predicate|
+          if predicate.respond_to?(:call)
+            append(predicate)
+          elsif predicate.is_a?(::Array)
+            append(predicate.map { |pred| __send__(pred) }.reduce(:|))
+          else
+            append(__send__(predicate))
+          end
+        end
+
+        opts.each do |predicate, *args|
+          append(__send__(predicate, *args))
+        end
+
+        self
+      end
+
+      # @api private
+      def append(op)
+        captures << op
+        self
+      end
+      alias_method :<<, :append
+
+      # @api private
+      def to_rule(name = nil)
+        return if captures.empty?
+
+        if name
+          compiler.visit([:key, [name, to_ast]])
+        else
+          reduced_rule
+        end
+      end
+
+      # @api private
+      def to_ast
+        reduced_rule.to_ast
+      end
+
+      # @api private
+      def class
+        ::Dry::Schema::Trace
+      end
+
+      private
+
+      # @api private
+      def reduced_rule
+        captures.map(&:to_ast).map(&compiler.method(:visit)).reduce(:and)
+      end
+
+      # @api private
+      def method_missing(meth, *args, &block)
+        if meth.to_s.end_with?(QUESTION_MARK)
+          if ::Dry::Schema::Trace::INVALID_PREDICATES.include?(meth)
+            ::Kernel.raise InvalidSchemaError, "#{meth} predicate cannot be used in this context"
+          end
+
+          unless compiler.supports?(meth)
+            ::Kernel.raise ::ArgumentError, "#{meth} predicate is not defined"
+          end
+
+          predicate = Predicate.new(compiler, meth, args, block)
+          predicate.ensure_valid
+          predicate
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dry/schema/type_registry.rb

@@ -0,0 +1,42 @@
+require 'dry/schema/constants'
+require 'dry/schema/types'
+
+module Dry
+  module Schema
+    # A simple wrapper around Dry::Types registry
+    #
+    # This is used internally by specialized processor sub-classes
+    #
+    # @api private
+    class TypeRegistry
+      # @api private
+      attr_reader :types
+
+      # @api private
+      attr_reader :namespace
+
+      # @api private
+      def self.new(types = Dry::Types, namespace = nil)
+        super
+      end
+
+      # @api private
+      def initialize(types, namespace = nil)
+        @types = types
+        @namespace = namespace
+      end
+
+      # @api private
+      def namespaced(ns)
+        self.class.new(types, ns)
+      end
+
+      # @api private
+      def [](name)
+        key = [namespace, name].compact.join(DOT)
+        type = types.registered?(key) ? types[key] : types[name.to_s]
+        type
+      end
+    end
+  end
+end

data/lib/dry/schema/types.rb

@@ -0,0 +1,12 @@
+require 'dry/types'
+
+module Dry
+  module Schema
+    # Schema's own type registry
+    #
+    # @api public
+    module Types
+      include Dry::Types.module
+    end
+  end
+end

data/lib/dry/schema/value_coercer.rb

@@ -0,0 +1,27 @@
+require 'dry/initializer'
+
+module Dry
+  module Schema
+    # Used by the processors to coerce values in the input hash
+    #
+    # @api private
+    class ValueCoercer
+      extend Dry::Initializer
+
+      # @api private
+      param :type_schema
+
+      # @api private
+      def call(input)
+        if input.success?
+          type_schema[Hash(input)]
+        else
+          type_schema.member_types.reduce(EMPTY_HASH.dup) do |hash, (name, type)|
+            hash[name] = input.error?(name) ? input[name] : type[input[name]]
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/schema/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module Schema
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: dry-schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Solnica
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: dry-logic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- piotr.solnica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- config/errors.yml
+- lib/dry-schema.rb
+- lib/dry/schema.rb
+- lib/dry/schema/compiler.rb
+- lib/dry/schema/config.rb
+- lib/dry/schema/constants.rb
+- lib/dry/schema/dsl.rb
+- lib/dry/schema/extensions.rb
+- lib/dry/schema/extensions/monads.rb
+- lib/dry/schema/json.rb
+- lib/dry/schema/key.rb
+- lib/dry/schema/key_coercer.rb
+- lib/dry/schema/key_map.rb
+- lib/dry/schema/macros.rb
+- lib/dry/schema/macros/core.rb
+- lib/dry/schema/macros/dsl.rb
+- lib/dry/schema/macros/each.rb
+- lib/dry/schema/macros/filled.rb
+- lib/dry/schema/macros/hash.rb
+- lib/dry/schema/macros/key.rb
+- lib/dry/schema/macros/maybe.rb
+- lib/dry/schema/macros/optional.rb
+- lib/dry/schema/macros/required.rb
+- lib/dry/schema/macros/value.rb
+- lib/dry/schema/message.rb
+- lib/dry/schema/message_compiler.rb
+- lib/dry/schema/message_compiler/visitor_opts.rb
+- lib/dry/schema/message_set.rb
+- lib/dry/schema/messages.rb
+- lib/dry/schema/messages/abstract.rb
+- lib/dry/schema/messages/i18n.rb
+- lib/dry/schema/messages/namespaced.rb
+- lib/dry/schema/messages/yaml.rb
+- lib/dry/schema/params.rb
+- lib/dry/schema/predicate.rb
+- lib/dry/schema/predicate_inferrer.rb
+- lib/dry/schema/predicate_registry.rb
+- lib/dry/schema/processor.rb
+- lib/dry/schema/result.rb
+- lib/dry/schema/rule_applier.rb
+- lib/dry/schema/trace.rb
+- lib/dry/schema/type_registry.rb
+- lib/dry/schema/types.rb
+- lib/dry/schema/value_coercer.rb
+- lib/dry/schema/version.rb
+homepage: https://github.com/dry-rb/dry-schema
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Schema coercion and validation
+test_files: []