dry-schema 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1867ad3cc77ca7f40338a9af423ebbdeb226c677e54fa2681af2efe43cc098e7
-  data.tar.gz: 2b0a981aaaab80619e4e79b5428961fa8f68e47796c171771531fa9263f3a487
+  metadata.gz: 5a4bd19052082cf526e57fca967abe2bbfbdcdfd4c1439c09acfb19bc3b25562
+  data.tar.gz: 82ffd3bf33409876cf372406e480ca25de8776dfad334ff634b0b041f2ca33ed
 SHA512:
-  metadata.gz: 8296a4a2e9d5972fcac050407a76c6c9ac477415f2abfeb2d5005f71a3ac6ee32101edfb785ef51048fdd1d6bf70ec24fcc53c5883004169ec20af2291e138b5
-  data.tar.gz: 88d64217d50a50c642a23713cd4f2a865ed16dd7da73a73dc085f7324daae9869c06c1e4024ecc2b973aea7097daae8037020fce7121cafab08732faa9362fa2
+  metadata.gz: dfde0da5889a34f7ef68699048cd755462f49d9d6249435fd5e0006a8d482dfa3a130e73397f02a83bbb11a4ad2c6e5c039e53154a0072d7f89e4a71ee89748b
+  data.tar.gz: dbc0e2f57947b69241c34451980af16b2c60be5cffb770c510f9ddce91daf58a9e6d900eac2884ca88f30c88dce415a4d6bd629d97922a3c79458458fd3ec289

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# v1.1.0 2019-05-30
+
+### Added
+
+* `Config` exposes `predicates` setting too (solnic)
+
+### Fixed
+
+* `filled` macro behavior results in `must be filled` error messages when appropriate - see PR #141 for more information (issue #134) (solnic)
+* Filter rules no longer cause keys to be added to input (issue #142) (solnic)
+* Filter rules work now with inheritance (solnic)
+* Inherited type schemas used by coercion are now properly configured as `lax` type (solnic)
+* `Config` is now finalized before instantiating schemas and properly dupped when its inherited (flash-gordon + solnic)
+* `Config#eql?` works as expected (solnic)
+* Predicates are properly inferred from array with a member type spec, ie `array[:integer]` results in `array? + each(:integer?)` (issue #140) (solnic)
+
+[Compare v1.0.3...v1.1.0](https://github.com/dry-rb/dry-schema/compare/v1.0.3...v1.1.0)
+
 # v1.0.3 2019-05-21
 
 ### Fixed

data/lib/dry/schema/config.rb

@@ -15,33 +15,50 @@ module Dry
     # @api public
     class Config
       include Dry::Configurable
-      include Dry::Equalizer(:predicates, :messages)
+      include Dry::Equalizer(:to_h, inspect: false)
 
+      # @!method predicates
+      #
+      # Return configured predicate registry
+      #
+      # @return [Schema::PredicateRegistry]
+      #
+      # @api public
       setting(:predicates, Schema::PredicateRegistry.new)
 
+      # @!method messages
+      #
+      # Return configuration for message backend
+      #
+      # @return [Dry::Configurable::Config]
+      #
+      # @api public
       setting(:messages) do
         setting(:backend, :yaml)
         setting(:namespace)
         setting(:load_paths, Set[DEFAULT_MESSAGES_PATH], &:dup)
         setting(:top_namespace, DEFAULT_MESSAGES_ROOT)
+        setting(:default_locale, nil)
       end
 
-      # Return configured predicate registry
-      #
-      # @return [Schema::PredicateRegistry]
-      #
-      # @api public
-      def predicates
-        config.predicates
+      # @api private
+      def respond_to_missing?(meth, include_private = false)
+        super || config.respond_to?(meth, include_private)
       end
 
-      # Return configuration for message backend
-      #
-      # @return [Dry::Configurable::Config]
+      # @api private
+      def inspect
+        "#<#{self.class} #{to_h.map { |k,v| ["#{k}=", v.inspect] }.map(&:join).join(' ')}>"
+      end
+
+      private
+
+      # Forward to the underlying config object
       #
-      # @api public
-      def messages
-        config.messages
+      # @api private
+      def method_missing(meth, *args, &block)
+        super unless config.respond_to?(meth)
+        config.public_send(meth, *args)
       end
     end
   end

data/lib/dry/schema/dsl.rb

@@ -111,6 +111,17 @@ module Dry
         self
       end
 
+      # Return a macro with the provided name
+      #
+      # @param [Symbol] name
+      #
+      # @return [Macros::Core]
+      #
+      # @api public
+      def [](name)
+        macros.detect { |macro| macro.name.equal?(name) }
+      end
+
       # Define a required key
       #
       # @example
@@ -164,7 +175,7 @@ module Dry
           name: name,
           compiler: compiler,
           schema_dsl: self,
-          filter_schema: filter_schema
+          filter_schema_dsl: filter_schema_dsl
         )
 
         macro.value(&block) if block
@@ -174,7 +185,7 @@ module Dry
 
       # Build a processor based on DSL's definitions
       #
-      # @return [Processor]
+      # @return [Processor, Params, JSON]
       #
       # @api private
       def call
@@ -182,7 +193,7 @@ module Dry
         steps << filter_schema.rule_applier if filter_rules?
         steps << value_coercer << rule_applier
 
-        processor_type.new { |processor| steps.each { |step| processor << step } }
+        processor_type.new(schema_dsl: self, steps: steps)
       end
 
       # Cast this DSL into a rule object
@@ -210,11 +221,8 @@ module Dry
       #
       # @api private
       def type_schema
-        if parent
-          parent.type_schema.schema(types)
-        else
-          type_registry['hash'].schema(types).lax
-        end
+        schema = type_registry['hash'].schema(types).lax
+        parent ? parent.type_schema.schema(schema.to_a) : schema
       end
 
       # Return a new DSL instance using the same processor type
@@ -222,8 +230,8 @@ module Dry
       # @return [Dry::Types::Safe]
       #
       # @api private
-      def new(&block)
-        self.class.new(processor_type: processor_type, &block)
+      def new(options = EMPTY_HASH, &block)
+        self.class.new(options.merge(processor_type: processor_type), &block)
       end
 
       # Set a type for the given key name
@@ -257,6 +265,27 @@ module Dry
         end
       end
 
+      # @api private
+      def filter_schema
+        filter_schema_dsl.call
+      end
+
+      # Build an input schema DSL used by `filter` API
+      #
+      # @see Macros::Value#filter
+      #
+      # @api private
+      def filter_schema_dsl
+        @filter_schema_dsl ||= new(parent: parent_filter_schema)
+      end
+
+      # Check if any filter rules were defined
+      #
+      # @api private
+      def filter_rules?
+        (instance_variable_defined?('@filter_schema_dsl') && !filter_schema_dsl.macros.empty?) || parent&.filter_rules?
+      end
+
       protected
 
       # Build a rule applier
@@ -265,7 +294,7 @@ module Dry
       #
       # @api protected
       def rule_applier
-        RuleApplier.new(rules, config: config)
+        RuleApplier.new(rules, config: config.finalize!)
       end
 
       # Build rules from defined macros
@@ -293,20 +322,11 @@ module Dry
 
       private
 
-      # Check if any filter rules were defined
-      #
       # @api private
-      def filter_rules?
-        instance_variable_defined?('@__filter_schema__') && !filter_schema.macros.empty?
-      end
+      def parent_filter_schema
+        return unless parent
 
-      # Build an input schema DSL used by `filter` API
-      #
-      # @see Macros::Value#filter
-      #
-      # @api private
-      def filter_schema
-        @__filter_schema__ ||= new
+        parent.filter_schema if parent.filter_rules?
       end
 
       # Build a key coercer

data/lib/dry/schema/json.rb

@@ -13,6 +13,7 @@ module Dry
     class JSON < Processor
       config.key_map_type = :stringified
       config.type_registry = config.type_registry.namespaced(:json)
+      config.filter_empty_string = false
     end
   end
 end

data/lib/dry/schema/macros/dsl.rb

@@ -66,9 +66,10 @@ module Dry
         # @return [Macros::Core]
         #
         # @api public
-        def filled(*args, &block)
+        def filled(*args, **opts, &block)
           append_macro(Macros::Filled) do |macro|
-            macro.call(*args, &block)
+            filter(:filled?) if opts[:type_spec] && macro.filter?
+            macro.call(*args, **opts, &block)
           end
         end
 

data/lib/dry/schema/macros/filled.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'dry/schema/primitive_inferrer'
 require 'dry/schema/macros/value'
 
 module Dry
@@ -9,8 +10,30 @@ module Dry
       #
       # @api private
       class Filled < Value
+        # @!attribute [r] primitive_inferrer
+        #   PrimitiveInferrer used to get a list of primitive classes from configured type
+        #   @return [PrimitiveInferrer]
+        #   @api private
+        option :primitive_inferrer, default: proc { PrimitiveInferrer.new }
+
         # @api private
         def call(*predicates, **opts, &block)
+          ensure_valid_predicates(predicates)
+
+          if opts[:type_spec]
+            if filter?
+              value(*predicates, **opts, &block)
+            else
+              value(predicates[0], :filled?, *predicates[1..predicates.size - 1], **opts, &block)
+            end
+          else
+            value(:filled?, *predicates, **opts, &block)
+          end
+        end
+
+        # @api private
+        # rubocop:disable Style/GuardClause
+        def ensure_valid_predicates(predicates)
           if predicates.include?(:empty?)
             raise ::Dry::Schema::InvalidSchemaError, 'Using filled with empty? predicate is invalid'
           end
@@ -18,12 +41,27 @@ module Dry
           if predicates.include?(:filled?)
             raise ::Dry::Schema::InvalidSchemaError, 'Using filled with filled? is redundant'
           end
+        end
+        # rubocop:enable Style/GuardClause
 
-          if opts[:type_spec]
-            value(predicates[0], :filled?, *predicates[1..predicates.size - 1], **opts, &block)
-          else
-            value(:filled?, *predicates, **opts, &block)
-          end
+        # @api private
+        def filter?
+          !primitives.include?(NilClass) && processor_config.filter_empty_string
+        end
+
+        # @api private
+        def processor_config
+          schema_dsl.processor_type.config
+        end
+
+        # @api private
+        def primitives
+          primitive_inferrer[schema_type]
+        end
+
+        # @api private
+        def schema_type
+          schema_dsl.types[name]
         end
       end
     end

data/lib/dry/schema/macros/key.rb

@@ -12,9 +12,10 @@ module Dry
       #
       # @api public
       class Key < DSL
-        # @return [Schema::DSL]
-        # @api private
-        option :filter_schema, optional: true, default: proc { schema_dsl&.new }
+        # @!attribute [r] filter_schema_dsl
+        #   @return [Schema::DSL]
+        #   @api private
+        option :filter_schema_dsl, default: proc { schema_dsl&.filter_schema_dsl }
 
         # Specify predicates that should be applied before coercion
         #
@@ -27,7 +28,7 @@ module Dry
         #
         # @api public
         def filter(*args, &block)
-          filter_schema.optional(name).value(*args, &block)
+          (filter_schema_dsl[name] || filter_schema_dsl.optional(name)).value(*args, &block)
           self
         end
 
@@ -54,7 +55,7 @@ module Dry
         # @api public
         def value(*args, **opts, &block)
           extract_type_spec(*args) do |*predicates, type_spec:|
-            super(*predicates, **opts, &block)
+            super(*predicates, type_spec: type_spec, **opts, &block)
           end
         end
 

data/lib/dry/schema/macros/value.rb

@@ -33,6 +33,9 @@ module Dry
             raise ArgumentError, 'wrong number of arguments (given 0, expected at least 1)'
           end
 
+          type_spec = opts[:type_spec]
+          each(type_spec.type.member) if type_spec.respond_to?(:member)
+
           self
         end
 

data/lib/dry/schema/messages/abstract.rb

@@ -18,6 +18,7 @@ module Dry
         include Dry::Configurable
         include Dry::Equalizer(:config)
 
+        setting :default_locale, nil
         setting :load_paths, Set[DEFAULT_MESSAGES_PATH]
         setting :top_namespace, DEFAULT_MESSAGES_ROOT
         setting :root, 'errors'
@@ -163,7 +164,7 @@ module Dry
 
         # @api private
         def default_locale
-          :en
+          config.default_locale
         end
 
         private

data/lib/dry/schema/messages/i18n.rb

@@ -55,7 +55,7 @@ module Dry
 
       # @api private
       def default_locale
-        I18n.locale || I18n.default_locale || super
+        super || I18n.locale || I18n.default_locale
       end
 
       # @api private

data/lib/dry/schema/messages/yaml.rb

@@ -30,6 +30,8 @@ module Dry
       # @api private
       def self.build(options = EMPTY_HASH)
         super do |config|
+          config.default_locale = :en unless config.default_locale
+
           config.root = "%<locale>s.#{config.root}"
 
           config.rule_lookup_paths = config.rule_lookup_paths.map { |path|

data/lib/dry/schema/params.rb

@@ -13,6 +13,7 @@ module Dry
     class Params < Processor
       config.key_map_type = :stringified
       config.type_registry = config.type_registry.namespaced(:params)
+      config.filter_empty_string = true
     end
   end
 end

data/lib/dry/schema/primitive_inferrer.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'dry/core/cache'
+
+module Dry
+  module Schema
+    # PrimitiveInferrer is used internally by `Macros::Filled`
+    # for inferring a list of possible primitives that a given
+    # type can handle.
+    #
+    # @api private
+    class PrimitiveInferrer
+      extend Dry::Core::Cache
+
+      # Compiler reduces type AST into a list of primitives
+      #
+      # @api private
+      class Compiler
+        # @api private
+        def visit(node)
+          meth, rest = node
+          public_send(:"visit_#{meth}", rest)
+        end
+
+        # @api private
+        def visit_nominal(node)
+          type, _ = node
+          type
+        end
+
+        # @api private
+        def visit_hash(_)
+          Hash
+        end
+
+        # @api private
+        def visit_array(_)
+          Array
+        end
+
+        # @api private
+        def visit_lax(node)
+          visit(node)
+        end
+
+        # @api private
+        def visit_constructor(node)
+          other, * = node
+          visit(other)
+        end
+
+        # @api private
+        def visit_enum(node)
+          other, * = node
+          visit(other)
+        end
+
+        # @api private
+        def visit_sum(node)
+          left, right = node
+
+          [visit(left), visit(right)].flatten(1)
+        end
+
+        # @api private
+        def visit_constrained(node)
+          other, * = node
+          visit(other)
+        end
+
+        # @api private
+        def visit_any(_)
+          Object
+        end
+      end
+
+      # @return [Compiler]
+      # @api private
+      attr_reader :compiler
+
+      # @api private
+      def initialize
+        @compiler = Compiler.new
+      end
+
+      # Infer predicate identifier from the provided type
+      #
+      # @return [Symbol]
+      #
+      # @api private
+      def [](type)
+        self.class.fetch_or_store(type.hash) do
+          Array(compiler.visit(type.to_ast)).freeze
+        end
+      end
+    end
+  end
+end

data/lib/dry/schema/processor.rb

@@ -29,8 +29,11 @@ module Dry
 
       setting :key_map_type
       setting :type_registry, TypeRegistry.new
+      setting :filter_empty_string, false
 
-      param :steps, default: -> { EMPTY_ARRAY.dup }
+      option :steps, default: -> { EMPTY_ARRAY.dup }
+
+      option :schema_dsl
 
       class << self
         # Return DSL configured via #define
@@ -60,9 +63,11 @@ module Dry
         # @return [Processor]
         #
         # @api public
-        def new(&block)
-          if block
-            super.tap(&block)
+        def new(options = nil, &block)
+          if options || block
+            processor = super
+            yield(processor) if block
+            processor
           elsif definition
             definition.call
           else
@@ -177,6 +182,20 @@ module Dry
         @rule_applier ||= steps.last
       end
       alias_method :to_rule, :rule_applier
+
+      # Check if there are filter rules
+      #
+      # @api private
+      def filter_rules?
+        @filter_rules_predicate ||= schema_dsl.filter_rules?
+      end
+
+      # Return filter schema
+      #
+      # @api private
+      def filter_schema
+        @filter_schema ||= schema_dsl.filter_schema
+      end
     end
   end
 end

data/lib/dry/schema/value_coercer.rb

@@ -22,6 +22,9 @@ module Dry
         else
           type_schema.each_with_object(EMPTY_HASH.dup) do |key, hash|
             name = key.name
+
+            next unless input.key?(name)
+
             value = input[name]
 
             hash[name] = input.error?(name) ? value : key[value]

data/lib/dry/schema/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Schema
-    VERSION = '1.0.3'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-schema
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2019-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -28,22 +28,22 @@ dependencies:
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +217,7 @@ files:
 - lib/dry/schema/predicate.rb
 - lib/dry/schema/predicate_inferrer.rb
 - lib/dry/schema/predicate_registry.rb
+- lib/dry/schema/primitive_inferrer.rb
 - lib/dry/schema/processor.rb
 - lib/dry/schema/result.rb
 - lib/dry/schema/rule_applier.rb