json_schema 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d133299adf9a9c71dad5525df64e25d4846e35e
-  data.tar.gz: 4d9aed1582b80eefcfc12656dddaf65b77fd894a
+  metadata.gz: 18987da218c27d388ff9125c52d5de7f134ca0bd
+  data.tar.gz: ccc08d794c3acca53bd41381ee93289725756948
 SHA512:
-  metadata.gz: 6f156d37e4067bae3bbd2e7a471f921d362afea8e2900c88c13278b383efd52a5f7fefd3129418c2dd406a0ec5a103b748aa7183238d7445e67dbbe969f63b4b
-  data.tar.gz: 9e118b7e172ed7c52b8b9cddd26a29e6a8e872e0f8782f6a57f34bdd323165b3996b4d405e8639441fb4a5f93fbb155f24b5fd59ecf98cfead00e4a49dee0ad6
+  metadata.gz: a6fd39a06bffa1e891ba948eafd12c8c1a6d79fc42307b334c455fe11d26a1ed5dab8d89e27e6b199b6a302bef947ceebc39405070f0f473e90b7ba8f69f28d0
+  data.tar.gz: 27679f000218340b5ed6d249ae0b1ca0217de4cde8fb57b5b1dd121d49390f1fec57f48697897b64ba1d52911657c5b9a21c71772838bcacde7aaccabe00eaa1

data/README.md

@@ -30,6 +30,9 @@ schema.validate!(data)
 schema.links.each do |link|
   puts "#{link.method} #{link.href}"
 end
+
+# abort on first error, instead of listing them all:
+schema.validate!(data, fail_fast: true)
 ```
 
 Errors have a `message` (for humans), and `type` (for machines).
@@ -40,6 +43,11 @@ for more info.
 Non-bang methods return a two-element array, with `true`/`false` at index 0
 to indicate pass/fail, and an array of errors at index 1 (if any).
 
+Passing `fail_fast: true` (default: `false`) will cause the validator to abort
+on the first error it encounters and report just that. Even on fully valid data
+this can offer some speed improvement, since it doesn't have to collect error
+messages that might be later discarded (think of e.g. the `anyOf` directive).
+
 ## Development
 
 Run the test suite with:

data/bin/validate-schema

@@ -21,6 +21,9 @@ parser = OptionParser.new { |opts|
   opts.on("-s", "--schema SCHEMA", "Additional schema to use for references") do |s|
     command.extra_schemas << s
   end
+  opts.on("-f", "--fail-fast", "Abort after encountering the first validation error") do |s|
+    command.fail_fast = true
+  end
 }
 
 if $0 == __FILE__

data/lib/commands/validate_schema.rb

@@ -5,6 +5,7 @@ require_relative "../json_schema"
 module Commands
   class ValidateSchema
     attr_accessor :detect
+    attr_accessor :fail_fast
     attr_accessor :extra_schemas
 
     attr_accessor :errors
@@ -12,6 +13,7 @@ module Commands
 
     def initialize
       @detect = false
+      @fail_fast = false
       @extra_schemas = []
 
       @errors = []
@@ -46,7 +48,7 @@ module Commands
           end
         end
 
-        valid, errors = schema.validate(data)
+        valid, errors = schema.validate(data, fail_fast: fail_fast)
 
         if valid
           @messages += ["#{data_file} is valid."]

data/lib/json_schema/schema.rb

@@ -270,14 +270,14 @@ module JsonSchema
       end
     end
 
-    def validate(data)
+    def validate(data, fail_fast: false)
       validator = Validator.new(self)
-      valid = validator.validate(data)
+      valid = validator.validate(data, fail_fast: fail_fast)
       [valid, validator.errors]
     end
 
-    def validate!(data)
-      Validator.new(self).validate!(data)
+    def validate!(data, fail_fast: false)
+      Validator.new(self).validate!(data, fail_fast: fail_fast)
     end
 
     # Link subobject for a hyperschema.

data/lib/json_schema/validator.rb

@@ -8,15 +8,30 @@ module JsonSchema
       @schema = schema
     end
 
-    def validate(data)
+    def validate(data, fail_fast: false)
       @errors = []
       @visits = {}
-      validate_data(@schema, data, @errors, ['#'])
+      @fail_fast = fail_fast
+
+      # This dynamically creates the "strict_or_fast_and" method which is used
+      # throughout the validator to combine the previous validation result with
+      # another validation check.
+      # Logic wise, we could simply define this method without meta programming
+      # and decide every time to either call fast_and or strict_end.
+      # Unfortunately this has a small overhead, that adds up over the runtime
+      # of the validator – about 5% if we check @fail_fast everytime.
+      # For more details, please see https://github.com/brandur/json_schema/pull/96
+      and_operation = method(@fail_fast ? :fast_and : :strict_and)
+      define_singleton_method(:strict_or_fast_and, and_operation)
+
+      catch(:fail_fast) do
+        validate_data(@schema, data, @errors, ['#'])
+      end
       @errors.size == 0
     end
 
-    def validate!(data)
-      if !validate(data)
+    def validate!(data, fail_fast: false)
+      if !validate(data, fail_fast: fail_fast)
         raise AggregateError.new(@errors)
       end
     end
@@ -59,6 +74,11 @@ module JsonSchema
       valid_old && valid_new
     end
 
+    def fast_and(valid_old, valid_new)
+      throw :fail_fast, false if !valid_new
+      valid_old && valid_new
+    end
+
     def validate_data(schema, data, errors, path)
       valid = true
       # detect a validation loop
@@ -67,46 +87,46 @@ module JsonSchema
       end
 
       # validation: any
-      valid = strict_and valid, validate_all_of(schema, data, errors, path)
-      valid = strict_and valid, validate_any_of(schema, data, errors, path)
-      valid = strict_and valid, validate_enum(schema, data, errors, path)
-      valid = strict_and valid, validate_one_of(schema, data, errors, path)
-      valid = strict_and valid, validate_not(schema, data, errors, path)
-      valid = strict_and valid, validate_type(schema, data, errors, path)
+      valid = strict_or_fast_and valid, validate_all_of(schema, data, errors, path)
+      valid = strict_or_fast_and valid, validate_any_of(schema, data, errors, path)
+      valid = strict_or_fast_and valid, validate_enum(schema, data, errors, path)
+      valid = strict_or_fast_and valid, validate_one_of(schema, data, errors, path)
+      valid = strict_or_fast_and valid, validate_not(schema, data, errors, path)
+      valid = strict_or_fast_and valid, validate_type(schema, data, errors, path)
 
       # validation: array
       if data.is_a?(Array)
-        valid = strict_and valid, validate_items(schema, data, errors, path)
-        valid = strict_and valid, validate_max_items(schema, data, errors, path)
-        valid = strict_and valid, validate_min_items(schema, data, errors, path)
-        valid = strict_and valid, validate_unique_items(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_items(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_max_items(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_min_items(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_unique_items(schema, data, errors, path)
       end
 
       # validation: integer/number
       if data.is_a?(Float) || data.is_a?(Integer)
-        valid = strict_and valid, validate_max(schema, data, errors, path)
-        valid = strict_and valid, validate_min(schema, data, errors, path)
-        valid = strict_and valid, validate_multiple_of(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_max(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_min(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_multiple_of(schema, data, errors, path)
       end
 
       # validation: object
       if data.is_a?(Hash)
-        valid = strict_and valid, validate_additional_properties(schema, data, errors, path)
-        valid = strict_and valid, validate_dependencies(schema, data, errors, path)
-        valid = strict_and valid, validate_max_properties(schema, data, errors, path)
-        valid = strict_and valid, validate_min_properties(schema, data, errors, path)
-        valid = strict_and valid, validate_pattern_properties(schema, data, errors, path)
-        valid = strict_and valid, validate_properties(schema, data, errors, path)
-        valid = strict_and valid, validate_required(schema, data, errors, path, schema.required)
-        valid = strict_and valid, validate_strict_properties(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_additional_properties(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_dependencies(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_max_properties(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_min_properties(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_pattern_properties(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_properties(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_required(schema, data, errors, path, schema.required)
+        valid = strict_or_fast_and valid, validate_strict_properties(schema, data, errors, path)
       end
 
       # validation: string
       if data.is_a?(String)
-        valid = strict_and valid, validate_format(schema, data, errors, path)
-        valid = strict_and valid, validate_max_length(schema, data, errors, path)
-        valid = strict_and valid, validate_min_length(schema, data, errors, path)
-        valid = strict_and valid, validate_pattern(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_format(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_max_length(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_min_length(schema, data, errors, path)
+        valid = strict_or_fast_and valid, validate_pattern(schema, data, errors, path)
       end
 
       valid
@@ -139,7 +159,7 @@ module JsonSchema
       # there is some performance implication to producing each sub error.
       # Normally we can short circuit the validation after encountering only
       # one problem, but here we have to evaluate all subschemas every time.
-      if JsonSchema.configuration.all_of_sub_errors
+      if JsonSchema.configuration.all_of_sub_errors && !@fail_fast
         sub_errors = []
         valid = schema.all_of.map do |subschema|
           current_sub_errors = []
@@ -164,7 +184,10 @@ module JsonSchema
 
       sub_errors = schema.any_of.map do |subschema|
         current_sub_errors = []
-        return true if validate_data(subschema, data, current_sub_errors, path)
+        valid = catch(:fail_fast) do
+          validate_data(subschema, data, current_sub_errors, path)
+        end
+        return true if valid
         current_sub_errors
       end
 
@@ -254,12 +277,12 @@ module JsonSchema
           valid = true
           if data.size > schema.items.count && schema.additional_items.is_a?(Schema)
             (schema.items.count..data.count - 1).each do |i|
-              valid = strict_and valid,
+              valid = strict_or_fast_and valid,
                 validate_data(schema.additional_items, data[i], errors, path + [i])
             end
           end
           schema.items.each_with_index do |subschema, i|
-            valid = strict_and valid,
+            valid = strict_or_fast_and valid,
               validate_data(subschema, data[i], errors, path + [i])
           end
           valid
@@ -267,7 +290,7 @@ module JsonSchema
       else
         valid = true
         data.each_with_index do |value, i|
-          valid = strict_and valid,
+          valid = strict_or_fast_and valid,
             validate_data(schema.items, value, errors, path + [i])
         end
         valid
@@ -411,7 +434,9 @@ module JsonSchema
 
       num_valid = schema.one_of.count do |subschema|
         current_sub_errors = []
-        valid = validate_data(subschema, data, current_sub_errors, path)
+        valid = catch(:fail_fast) do
+          validate_data(subschema, data, current_sub_errors, path)
+        end
         sub_errors << current_sub_errors
         valid
       end
@@ -460,7 +485,7 @@ module JsonSchema
       schema.pattern_properties.each do |pattern, subschema|
         data.each do |key, value|
           if key =~ pattern
-            valid = strict_and valid,
+            valid = strict_or_fast_and valid,
               validate_data(subschema, value, errors, path + [key])
           end
         end
@@ -472,10 +497,9 @@ module JsonSchema
       return true if schema.properties.empty?
       valid = true
       schema.properties.each do |key, subschema|
-        if data.key?(key)
-          valid = strict_and valid,
-            validate_data(subschema, data[key], errors, path + [key])
-        end
+        next unless data.key?(key)
+        valid = strict_or_fast_and valid,
+          validate_data(subschema, data[key], errors, path + [key])
       end
       valid
     end
@@ -496,7 +520,7 @@ module JsonSchema
     def validate_strict_properties(schema, data, errors, path)
       return true if !schema.strict_properties
 
-      strict_and validate_extra(schema, data, errors, path),
+      strict_or_fast_and validate_extra(schema, data, errors, path),
         validate_required(schema, data, errors, path, schema.properties.keys)
     end
 

data/test/commands/validate_schema_test.rb

@@ -15,6 +15,16 @@ describe Commands::ValidateSchema do
     refute success
   end
 
+  it "runs successfully in fail fast mode" do
+    temp_file(basic_schema) do |path|
+      @command.fail_fast = true
+      success = @command.run([schema_path, path])
+      assert_equal [], @command.errors
+      assert_equal ["#{path} is valid."], @command.messages
+      assert success
+    end
+  end
+
   it "runs successfully in detect mode" do
     temp_file(basic_schema) do |path|
       @command.extra_schemas << schema_path

data/test/json_schema/validator_test.rb

@@ -8,7 +8,7 @@ describe JsonSchema::Validator do
   end
 
   it "can find data valid" do
-    assert validate
+    assert_valid
   end
 
   it "validates enum successfully" do
@@ -16,7 +16,7 @@ describe JsonSchema::Validator do
       "enum" => ["private", "public"]
     )
     data_sample["visibility"] = "public"
-    assert validate
+    assert_valid
   end
 
   it "validates enum unsuccessfully" do
@@ -24,7 +24,7 @@ describe JsonSchema::Validator do
       "enum" => ["private", "public"]
     )
     data_sample["visibility"] = "personal"
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{personal is not a member of ["private", "public"].}
     assert_includes error_types, :invalid_type
@@ -35,7 +35,7 @@ describe JsonSchema::Validator do
       "type" => ["object"]
     )
     @data_sample = { "name" => "cloudnasium" }
-    assert validate
+    assert_valid
   end
 
   it "validates type unsuccessfully" do
@@ -43,7 +43,7 @@ describe JsonSchema::Validator do
       "type" => ["object"]
     )
     @data_sample = 4
-    refute validate
+    refute_valid
     assert_includes error_messages, %{For 'definitions/app', 4 is not an object.}
     assert_includes error_types, :invalid_type
     assert_includes error_data, 4
@@ -54,7 +54,7 @@ describe JsonSchema::Validator do
       "type" => ["string"]
     )
     @data_sample = 4
-    refute validate
+    refute_valid
     assert_includes error_messages, %{For 'definitions/app', 4 is not a string.}
     assert_includes error_types, :invalid_type
 
@@ -62,7 +62,7 @@ describe JsonSchema::Validator do
       "type" => ["string", "null"]
     )
     @data_sample = 4
-    refute validate
+    refute_valid
     assert_includes error_messages, %{For 'definitions/app', 4 is not a string or null.}
     assert_includes error_types, :invalid_type
 
@@ -70,7 +70,7 @@ describe JsonSchema::Validator do
       "type" => ["object", "null", "string"]
     )
     @data_sample = 4
-    refute validate
+    refute_valid
     assert_includes error_messages, %{For 'definitions/app', 4 is not an object, null, or string.}
     assert_includes error_types, :invalid_type
   end
@@ -82,7 +82,7 @@ describe JsonSchema::Validator do
       }
     )
     data_sample["flags"] = ["websockets"]
-    assert validate
+    assert_valid
   end
 
   it "validates items with list unsuccessfully" do
@@ -92,7 +92,7 @@ describe JsonSchema::Validator do
       }
     )
     data_sample["flags"] = ["1337"]
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{1337 does not match /^[a-z][a-z\\-]*[a-z]$/.}
     assert_includes error_types, :pattern_failed
@@ -107,7 +107,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "https"]
-    assert validate
+    assert_valid
   end
 
   it "validates items with tuple with additionalItems boolean successfully" do
@@ -119,7 +119,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "https", "websockets"]
-    assert validate
+    assert_valid
   end
 
   it "validates items with tuple with additionalItems boolean unsuccessfully" do
@@ -131,7 +131,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "https", "websockets"]
-    refute validate
+    refute_valid
     assert_includes error_messages, %{No more than 2 items are allowed; 3 were supplied.}
     assert_includes error_types, :max_items_failed
     assert_includes error_data, ["cedar", "https", "websockets"]
@@ -146,7 +146,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "https", "websockets"]
-    assert validate
+    assert_valid
   end
 
   it "validates items with tuple with additionalItems schema unsuccessfully for non-conforming additional item" do
@@ -158,7 +158,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "https", "websockets"]
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{websockets is not a member of ["foo", "bar"].}
     assert_includes error_types, :invalid_type
@@ -174,7 +174,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "https", "websockets", "1337"]
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{websockets is not a member of ["foo", "bar"].}
     assert_includes error_types, :invalid_type
@@ -194,7 +194,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "1337", "websockets"]
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{websockets is not a member of ["foo", "bar"].}
     assert_includes error_types, :invalid_type
@@ -213,7 +213,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar"]
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{2 items required; only 1 was supplied.}
     assert_includes error_types, :min_items_failed
@@ -229,7 +229,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "https", "websockets"]
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{No more than 2 items are allowed; 3 were supplied.}
       assert_includes error_types, :max_items_failed
@@ -245,7 +245,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["flags"] = ["cedar", "1337"]
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{1337 is not a member of ["http", "https"].}
     assert_includes error_types, :invalid_type
@@ -257,7 +257,7 @@ describe JsonSchema::Validator do
       "maxItems" => 10
     )
     data_sample["flags"] = (0...10).to_a
-    assert validate
+    assert_valid
   end
 
   it "validates maxItems unsuccessfully" do
@@ -265,7 +265,7 @@ describe JsonSchema::Validator do
       "maxItems" => 10
     )
     data_sample["flags"] = (0...11).to_a
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{No more than 10 items are allowed; 11 were supplied.}
     assert_includes error_types, :max_items_failed
@@ -277,7 +277,7 @@ describe JsonSchema::Validator do
       "minItems" => 1
     )
     data_sample["flags"] = ["websockets"]
-    assert validate
+    assert_valid
   end
 
   it "validates minItems unsuccessfully" do
@@ -285,7 +285,7 @@ describe JsonSchema::Validator do
       "minItems" => 1
     )
     data_sample["flags"] = []
-    refute validate
+    refute_valid
     assert_includes error_messages, %{1 item required; only 0 were supplied.}
     assert_includes error_types, :min_items_failed
     assert_includes error_data, []
@@ -296,7 +296,7 @@ describe JsonSchema::Validator do
       "uniqueItems" => true
     )
     data_sample["flags"] = ["websockets"]
-    assert validate
+    assert_valid
   end
 
   it "validates uniqueItems unsuccessfully" do
@@ -304,7 +304,7 @@ describe JsonSchema::Validator do
       "uniqueItems" => true
     )
     data_sample["flags"] = ["websockets", "websockets"]
-    refute validate
+    refute_valid
     assert_includes error_messages, %{Duplicate items are not allowed.}
     assert_includes error_types, :unique_items_failed
     assert_includes error_data, ["websockets", "websockets"]
@@ -316,7 +316,7 @@ describe JsonSchema::Validator do
       "maximum"          => 10
     )
     data_sample["id"] = 11
-    refute validate
+    refute_valid
     assert_includes error_messages, %{11 must be less than or equal to 10.}
     assert_includes error_types, :max_failed
     assert_includes error_data, 11
@@ -328,7 +328,7 @@ describe JsonSchema::Validator do
       "maximum"          => 10
     )
     data_sample["id"] = 10
-    refute validate
+    refute_valid
     assert_includes error_messages, %{10 must be less than 10.}
     assert_includes error_types, :max_failed
   end
@@ -339,7 +339,7 @@ describe JsonSchema::Validator do
       "maximum"          => 10.0
     )
     data_sample["cost"] = 10.1
-    refute validate
+    refute_valid
     assert_includes error_messages, %{10.1 must be less than or equal to 10.0.}
     assert_includes error_types, :max_failed
   end
@@ -350,7 +350,7 @@ describe JsonSchema::Validator do
       "maximum"          => 10.0
     )
     data_sample["cost"] = 10.0
-    refute validate
+    refute_valid
     assert_includes error_messages, %{10.0 must be less than 10.0.}
     assert_includes error_types, :max_failed
   end
@@ -361,7 +361,7 @@ describe JsonSchema::Validator do
       "minimum"          => 1
     )
     data_sample["id"] = 0
-    refute validate
+    refute_valid
     assert_includes error_messages, %{0 must be greater than or equal to 1.}
     assert_includes error_types, :min_failed
     assert_includes error_data, 0
@@ -373,7 +373,7 @@ describe JsonSchema::Validator do
       "minimum"          => 1
     )
     data_sample["id"] = 1
-    refute validate
+    refute_valid
     assert_includes error_messages, %{1 must be greater than 1.}
   end
 
@@ -383,7 +383,7 @@ describe JsonSchema::Validator do
       "minimum"          => 0.0
     )
     data_sample["cost"] = -0.01
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{-0.01 must be greater than or equal to 0.0.}
     assert_includes error_types, :min_failed
@@ -395,7 +395,7 @@ describe JsonSchema::Validator do
       "minimum"          => 0.0
     )
     data_sample["cost"] = 0.0
-    refute validate
+    refute_valid
     assert_includes error_messages, %{0.0 must be greater than 0.0.}
     assert_includes error_types, :min_failed
   end
@@ -405,7 +405,7 @@ describe JsonSchema::Validator do
       "multipleOf" => 2
     )
     data_sample["id"] = 1
-    refute validate
+    refute_valid
     assert_includes error_messages, %{1 is not a multiple of 2.}
     assert_includes error_types, :multiple_of_failed
     assert_includes error_data, 1
@@ -416,7 +416,7 @@ describe JsonSchema::Validator do
       "multipleOf" => 0.01
     )
     data_sample["cost"] = 0.005
-    refute validate
+    refute_valid
     assert_includes error_messages, %{0.005 is not a multiple of 0.01.}
     assert_includes error_types, :multiple_of_failed
   end
@@ -426,7 +426,7 @@ describe JsonSchema::Validator do
       "additionalProperties" => true
     )
     data_sample["foo"] = "bar"
-    assert validate
+    assert_valid
   end
 
   it "validates additionalProperties boolean unsuccessfully" do
@@ -438,7 +438,7 @@ describe JsonSchema::Validator do
     )
     data_sample["foo"] = "bar"
     data_sample["matches_pattern"] = "yes!"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{"foo" is not a permitted key.}
     assert_includes error_types, :invalid_keys
   end
@@ -453,7 +453,7 @@ describe JsonSchema::Validator do
     data_sample["foo"] = "bar"
     data_sample["baz"] = "blah"
     data_sample["matches_pattern"] = "yes!"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{"baz", "foo" are not permitted keys.}
     assert_includes error_types, :invalid_keys
   end
@@ -465,7 +465,7 @@ describe JsonSchema::Validator do
       }
     )
     data_sample["foo"] = true
-    assert validate
+    assert_valid
   end
 
   it "validates additionalProperties schema unsuccessfully" do
@@ -479,7 +479,7 @@ describe JsonSchema::Validator do
     )
     data_sample["foo"] = 4
     data_sample["matches_pattern"] = "yes!"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{For 'additionalProperties', 4 is not a boolean.}
     assert_includes error_types, :invalid_type
   end
@@ -489,7 +489,7 @@ describe JsonSchema::Validator do
       "production" => "ssl"
     )
     data_sample["production"] = true
-    refute validate
+    refute_valid
     assert_includes error_messages,
       %{"ssl" wasn't supplied.}
   end
@@ -506,7 +506,7 @@ describe JsonSchema::Validator do
     )
     data_sample["cost"] = 10.0
     data_sample["ssl"] = true
-    refute validate
+    refute_valid
     assert_includes error_messages, %{10.0 must be greater than or equal to 20.0.}
     assert_includes error_types, :min_failed
   end
@@ -516,7 +516,7 @@ describe JsonSchema::Validator do
       "maxProperties" => 0
     )
     data_sample["name"] = "cloudnasium"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{No more than 0 properties are allowed; 1 was supplied.}
     assert_includes error_types, :max_properties_failed
     assert_includes error_data, { "name" => "cloudnasium" }
@@ -527,7 +527,7 @@ describe JsonSchema::Validator do
       "minProperties" => 2
     )
     data_sample["name"] = "cloudnasium"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{At least 2 properties are required; 1 was supplied.}
     assert_includes error_types, :min_properties_failed
     assert_includes error_data, { "name" => "cloudnasium" }
@@ -545,7 +545,7 @@ describe JsonSchema::Validator do
       ""    => 123,
       "KEY" => 456
     }
-    refute validate
+    refute_valid
     assert_includes error_messages, %{For 'definitions/config_vars', 456 is not a null or string.}
     assert_includes error_types, :invalid_type
   end
@@ -563,7 +563,7 @@ describe JsonSchema::Validator do
       "required" => ["name"]
     )
     data_sample.delete("name")
-    refute validate
+    refute_valid
     assert_includes error_messages, %{"name" wasn't supplied.}
     assert_includes error_types, :required_failed
     assert_includes error_data, ["name"]
@@ -573,7 +573,7 @@ describe JsonSchema::Validator do
     pointer("#/definitions/app").merge!(
       "strictProperties" => false
     )
-    assert validate
+    assert_valid
   end
 
   it "validates strictProperties unsuccessfully" do
@@ -585,7 +585,7 @@ describe JsonSchema::Validator do
     )
     data_sample["extra_key"] = "value"
     data_sample["matches_pattern"] = "yes!"
-    refute validate
+    refute_valid
     missing = @schema.properties.keys.sort - ["name"]
     assert_includes error_messages, %{"#{missing.join('", "')}" weren't supplied.}
     assert_includes error_messages, %{"extra_key" is not a permitted key.}
@@ -600,7 +600,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["contrived"] = "ab"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{Not all subschemas of "allOf" matched.}
     assert_includes error_types, :all_of_failed
   end
@@ -613,7 +613,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["contrived"] = "ab"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{At least 3 characters are required; only 2 were supplied.}
     assert_includes error_data, "ab"
   end
@@ -629,7 +629,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["contrived"] = "ab"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{Not all subschemas of "allOf" matched.}
     assert_includes error_types, :all_of_failed
     all_of_error = @validator.errors.find { |error| error.type == :all_of_failed }
@@ -649,7 +649,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["contrived"] = "ab"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{No subschema in "anyOf" matched.}
     assert_includes error_types, :any_of_failed
     any_of_error = @validator.errors.find { |error| error.type == :any_of_failed }
@@ -670,7 +670,7 @@ describe JsonSchema::Validator do
       ]
     )
     data_sample["contrived"] = "foo"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{More than one subschema in "oneOf" matched.}
     assert_includes error_types, :one_of_failed
     one_of_error = @validator.errors.find { |error| error.type == :one_of_failed }
@@ -686,7 +686,7 @@ describe JsonSchema::Validator do
       "not" => { "pattern" => "^$" }
     )
     data_sample["contrived"] = ""
-    refute validate
+    refute_valid
     assert_includes error_messages, %{Matched "not" subschema.}
     assert_includes error_types, :not_failed
     assert_includes error_data, ""
@@ -697,7 +697,7 @@ describe JsonSchema::Validator do
       "format" => "date"
     )
     data_sample["owner"] = "2014-05-13"
-    assert validate
+    assert_valid
   end
 
   it "validates date format unsuccessfully" do
@@ -705,7 +705,7 @@ describe JsonSchema::Validator do
       "format" => "date"
     )
     data_sample["owner"] = "13/05/2014"
-    refute validate
+    refute_valid
   end
 
   it "validates date-time format successfully" do
@@ -713,7 +713,7 @@ describe JsonSchema::Validator do
       "format" => "date-time"
     )
     data_sample["owner"] = "2014-05-13T08:42:40Z"
-    assert validate
+    assert_valid
   end
 
   it "validates date-time format with time zone successfully" do
@@ -721,7 +721,7 @@ describe JsonSchema::Validator do
       "format" => "date-time"
     )
     data_sample["owner"] = "2014-05-13T08:42:40-00:00"
-    assert validate
+    assert_valid
   end
 
   it "validates date-time format with time fraction successfully" do
@@ -729,7 +729,7 @@ describe JsonSchema::Validator do
       "format" => "date-time"
     )
     data_sample["owner"] = "2014-05-13T08:42:40.444Z"
-    assert validate
+    assert_valid
   end
 
   it "validates date-time format unsuccessfully" do
@@ -737,7 +737,7 @@ describe JsonSchema::Validator do
       "format" => "date-time"
     )
     data_sample["owner"] = "2014-05-13T08:42:40"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{2014-05-13T08:42:40 is not a valid date-time.}
     assert_includes error_types, :invalid_format
     assert_includes error_data, "2014-05-13T08:42:40"
@@ -748,7 +748,7 @@ describe JsonSchema::Validator do
       "format" => "email"
     )
     data_sample["owner"] = "dwarf@example.com"
-    assert validate
+    assert_valid
   end
 
   it "validates email format with long TLDs successfully" do
@@ -756,7 +756,7 @@ describe JsonSchema::Validator do
       "format" => "email"
     )
     data_sample["owner"] = "dwarf@example.technology"
-    assert validate
+    assert_valid
   end
 
   it "validates email format unsuccessfully" do
@@ -764,7 +764,7 @@ describe JsonSchema::Validator do
       "format" => "email"
     )
     data_sample["owner"] = "@example.com"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{@example.com is not a valid email.}
     assert_includes error_types, :invalid_format
   end
@@ -774,7 +774,7 @@ describe JsonSchema::Validator do
       "format" => "hostname"
     )
     data_sample["owner"] = "example.com"
-    assert validate
+    assert_valid
   end
 
   it "validates hostname format unsuccessfully" do
@@ -782,7 +782,7 @@ describe JsonSchema::Validator do
       "format" => "hostname"
     )
     data_sample["owner"] = "@example.com"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{@example.com is not a valid hostname.}
     assert_includes error_types, :invalid_format
   end
@@ -792,7 +792,7 @@ describe JsonSchema::Validator do
       "format" => "ipv4"
     )
     data_sample["owner"] = "1.2.3.4"
-    assert validate
+    assert_valid
   end
 
   it "validates ipv4 format unsuccessfully" do
@@ -800,7 +800,7 @@ describe JsonSchema::Validator do
       "format" => "ipv4"
     )
     data_sample["owner"] = "1.2.3.4.5"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{1.2.3.4.5 is not a valid ipv4.}
     assert_includes error_types, :invalid_format
   end
@@ -810,7 +810,7 @@ describe JsonSchema::Validator do
       "format" => "ipv6"
     )
     data_sample["owner"] = "1::3:4:5:6:7:8"
-    assert validate
+    assert_valid
   end
 
   it "validates ipv6 format unsuccessfully" do
@@ -818,7 +818,7 @@ describe JsonSchema::Validator do
       "format" => "ipv6"
     )
     data_sample["owner"] = "1::3:4:5:6:7:8:9"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{1::3:4:5:6:7:8:9 is not a valid ipv6.}
     assert_includes error_types, :invalid_format
   end
@@ -828,7 +828,7 @@ describe JsonSchema::Validator do
       "format" => "regex"
     )
     data_sample["owner"] = "^owner@heroku\.com$"
-    assert validate
+    assert_valid
   end
 
   it "validates regex format successfully" do
@@ -836,7 +836,7 @@ describe JsonSchema::Validator do
       "format" => "regex"
     )
     data_sample["owner"] = "^owner($"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{^owner($ is not a valid regex.}
     assert_includes error_types, :invalid_format
   end
@@ -846,7 +846,7 @@ describe JsonSchema::Validator do
       "format" => "uri"
     )
     data_sample["owner"] = "https://example.com"
-    assert validate
+    assert_valid
   end
 
   it "validates relative uri format successfully" do
@@ -854,7 +854,7 @@ describe JsonSchema::Validator do
       "format" => "uri"
     )
     data_sample["owner"] = "schemata/app"
-    assert validate
+    assert_valid
   end
 
   it "validates uri format unsuccessfully" do
@@ -862,7 +862,7 @@ describe JsonSchema::Validator do
       "format" => "uri"
     )
     data_sample["owner"] = "http://example.com[]"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{http://example.com[] is not a valid uri.}
     assert_includes error_types, :invalid_format
   end
@@ -872,7 +872,7 @@ describe JsonSchema::Validator do
       "format" => "uri-reference"
     )
     data_sample["owner"] = "https://example.com"
-    assert validate
+    assert_valid
   end
 
   it "validates relative uri format successfully" do
@@ -880,7 +880,7 @@ describe JsonSchema::Validator do
       "format" => "uri"
     )
     data_sample["owner"] = "#hello"
-    assert validate
+    assert_valid
   end
 
   it "validates uri format unsuccessfully" do
@@ -888,7 +888,7 @@ describe JsonSchema::Validator do
       "format" => "uri-reference"
     )
     data_sample["owner"] = "http://example.com[]"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{http://example.com[] is not a valid uri-reference.}
     assert_includes error_types, :invalid_format
   end
@@ -898,7 +898,7 @@ describe JsonSchema::Validator do
       "format" => "uuid"
     )
     data_sample["owner"] = "01234567-89ab-cdef-0123-456789abcdef"
-    assert validate
+    assert_valid
   end
 
   it "validates uuid format unsuccessfully" do
@@ -906,7 +906,7 @@ describe JsonSchema::Validator do
       "format" => "uuid"
     )
     data_sample["owner"] = "123"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{123 is not a valid uuid.}
     assert_includes error_types, :invalid_format
   end
@@ -916,7 +916,7 @@ describe JsonSchema::Validator do
       "maxLength" => 3
     )
     data_sample["name"] = "abcd"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{Only 3 characters are allowed; 4 were supplied.}
     assert_includes error_types, :max_length_failed
   end
@@ -926,7 +926,7 @@ describe JsonSchema::Validator do
       "minLength" => 3
     )
     data_sample["name"] = "ab"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{At least 3 characters are required; only 2 were supplied.}
     assert_includes error_types, :min_length_failed
   end
@@ -936,7 +936,7 @@ describe JsonSchema::Validator do
       "pattern" => "^[a-z][a-z0-9-]{3,30}$",
     )
     data_sample["name"] = "ab"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{ab does not match /^[a-z][a-z0-9-]{3,30}$/.}
     assert_includes error_types, :pattern_failed
     assert_includes error_data, "ab"
@@ -947,7 +947,7 @@ describe JsonSchema::Validator do
       "enum" => ["private", "public"]
     )
     data_sample["visibility"] = "personal"
-    refute validate
+    refute_valid
     assert_equal "#/visibility", @validator.errors[0].pointer
   end
 
@@ -957,7 +957,7 @@ describe JsonSchema::Validator do
       "not" => { "$ref" => "#/definitions/app" }
     )
     data_sample["visibility"] = "personal"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{Validation loop detected.}
   end
 =end
@@ -970,7 +970,7 @@ describe JsonSchema::Validator do
       "format" => "the-answer"
     )
     data_sample["owner"] = "42"
-    assert validate
+    assert_valid
   end
 
   it "validates custom formats unsuccessfully" do
@@ -981,7 +981,7 @@ describe JsonSchema::Validator do
       "format" => "the-answer"
     )
     data_sample["owner"] = "43"
-    refute validate
+    refute_valid
     assert_includes error_messages, %{43 is not a valid the-answer.}
     assert_includes error_types, :invalid_format
   end
@@ -1043,11 +1043,26 @@ describe JsonSchema::Validator do
     @schema_sample ||= DataScaffold.schema_sample
   end
 
-  def validate
+  def validator
     @schema = JsonSchema.parse!(schema_sample)
     @schema.expand_references!
     @schema = @schema.definitions["app"]
-    @validator = JsonSchema::Validator.new(@schema)
-    @validator.validate(data_sample)
+    JsonSchema::Validator.new(@schema)
+  end
+
+  # assert_valid asserts that both the "fail fast" and the "full error messages"
+  # code paths consider the data sample valid for the set schema.
+  def assert_valid
+    @validator = validator
+    assert @validator.validate(data_sample, fail_fast: true)
+    assert @validator.validate(data_sample, fail_fast: false)
+  end
+
+  # refute_valid asserts that both the "fail fast" and the "full error messages"
+  # code paths consider the data sample erroneous for the set schema.
+  def refute_valid
+    @validator = validator
+    refute @validator.validate(data_sample, fail_fast: true)
+    refute @validator.validate(data_sample, fail_fast: false)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schema
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Brandur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecma-re-validator