json_matchers 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa337859deb80396749bed9a9c4d32d7079a81ab
-  data.tar.gz: 3a8dc313f1854e2c1e41cd0bafa66855319bb06e
+  metadata.gz: cf14bd2b66049174e62c9b50f750692f761cb66c
+  data.tar.gz: 1ceafe472e8e7225bb194ad49fa5c17676800a13
 SHA512:
-  metadata.gz: c22878991190e76a633c836dbdc45eb95cc5ce26664c13acf19579940653b4939ea67f212f81c12f2760198716b4347c71803e9135de943e952066cc1f75392f
-  data.tar.gz: 706d1bfd640fd52d8743a90cddc3bd2727736167c6dc4deed8137b95b5651bdc880134c43a27a089e367daa76de342aa508ed3ed19c72b4f28949043ab330e57
+  metadata.gz: 58d81f70e226218c2fe359f131414cb8740963156ebc16b0616b43b5e7d2f976a3c2b465b4b4460dc0853cb69a91866697f0e06e1397c43fc478a532f0c3e8d5
+  data.tar.gz: 3a0d68faa322b689dc8331cf238bb5779e943d7854078b75b0627fac0e9037024627dfd6d49227a4b4e4e12e0405a87672cbe856c9e4e208c6086d53ba42a816

data/NEWS.md

@@ -1,6 +1,15 @@
 master
 ======
 
+0.7.0
+=====
+
+* Default `record_errors: true` [#52]
+* Add support for configuring `record_errors` [#51]
+
+[#52]: https://github.com/thoughtbot/json_matchers/pull/52
+[#51]: https://github.com/thoughtbot/json_matchers/pull/51
+
 0.6.3
 =====
 

data/json_matchers.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency("json-schema", "~> 2.6.0")
+  spec.add_dependency("json-schema", "~> 2.7")
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "pry"

data/lib/json_matchers/configuration.rb

@@ -11,7 +11,9 @@ module JsonMatchers
     attr_reader :options
 
     def initialize
-      @options = {}
+      @options = {
+        record_errors: true,
+      }
     end
   end
 end

data/lib/json_matchers/matcher.rb

@@ -1,5 +1,5 @@
 require "json-schema"
-require "json_matchers/payload"
+require "json_matchers/validator"
 
 module JsonMatchers
   class Matcher
@@ -9,28 +9,37 @@ module JsonMatchers
     end
 
     def matches?(response)
-      JSON::Validator.validate!(
-        schema_path.to_s,
-        Payload.new(response).to_s,
-        options,
-      )
-    rescue JSON::Schema::ValidationError => ex
-      @validation_failure_message = ex.message
+      validator = build_validator(response)
+
+      self.errors = validator.validate!
+
+      errors.empty?
+    rescue JSON::Schema::ValidationError => error
+      self.errors = [error.message]
       false
     rescue JSON::Schema::JsonParseError
       raise InvalidSchemaError
     end
 
     def validation_failure_message
-      @validation_failure_message.to_s
+      errors.first.to_s
     end
 
     private
 
     attr_reader :schema_path, :options
+    attr_accessor :errors
 
     def default_options
       JsonMatchers.configuration.options || {}
     end
+
+    def build_validator(response)
+      Validator.new(
+        options: options,
+        response: response,
+        schema_path: schema_path,
+      )
+    end
   end
 end

data/lib/json_matchers/validator.rb

@@ -0,0 +1,38 @@
+require "json-schema"
+require "json_matchers/payload"
+
+module JsonMatchers
+  class Validator
+    def initialize(options:, response:, schema_path:)
+      @options = options.dup
+      @payload = Payload.new(response).to_s
+      @schema_path = schema_path.to_s
+    end
+
+    def validate!
+      if recording_errors?
+        validate_recording_errors
+      else
+        validate
+      end
+    end
+
+    private
+
+    attr_reader :options, :payload, :schema_path
+
+    def recording_errors?
+      options.fetch(:record_errors, false)
+    end
+
+    def validate_recording_errors
+      JSON::Validator.fully_validate(schema_path, payload, options)
+    end
+
+    def validate
+      JSON::Validator.validate!(schema_path, payload, options)
+
+      []
+    end
+  end
+end

data/lib/json_matchers/version.rb

@@ -1,3 +1,3 @@
 module JsonMatchers
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

data/spec/json_matchers/match_response_schema_spec.rb

@@ -142,27 +142,42 @@ describe JsonMatchers, "#match_response_schema" do
 
   context "when options are configured globally" do
     it "forwards them to the validator" do
-      create_schema("foo_schema", {
-        "type" => "object",
-        "properties" => {
-          "id" => { "type" => "number" },
-          "title" => { "type" => "string" },
-        },
-      })
-
-      JsonMatchers.configure do |config|
-        config.options[:strict] = true
+      with_options(strict: true) do
+        create_schema("foo_schema", {
+          "type" => "object",
+          "properties" => {
+            "id" => { "type" => "number" },
+            "title" => { "type" => "string" },
+          },
+        })
+
+        expect(response_for({ "id" => 1, "title" => "bar" })).
+          to match_response_schema("foo_schema")
+        expect(response_for({ "id" => 1 })).
+          not_to match_response_schema("foo_schema")
       end
-
-      expect(response_for({ "id" => 1, "title" => "bar" })).
-        to match_response_schema("foo_schema")
-      expect(response_for({ "id" => 1 })).
-        not_to match_response_schema("foo_schema")
     end
 
-    after do
-      JsonMatchers.configure do |config|
-        config.options.delete(:strict)
+    context "when configured to record errors" do
+      it "includes the reasons for failure in the exception's message" do
+        with_options(record_errors: true) do
+          create_schema("foo_schema", {
+            "type" => "object",
+            "properties" => {
+              "username" => {
+                "allOf": [
+                  { "type": "string" },
+                  { "minLength": 5 }
+                ]
+              }
+            }
+          })
+          invalid_payload = response_for({ "username" => "foo" })
+
+          expect {
+            expect(invalid_payload).to match_response_schema("foo_schema")
+          }.to raise_error(/minimum/)
+        end
       end
     end
   end

data/spec/support/configuration.rb

@@ -0,0 +1,20 @@
+module ConfigurationHelpers
+  def with_options(options)
+    original_options = JsonMatchers.configuration.options.dup
+
+    JsonMatchers.configure do |config|
+      config.options.merge!(options)
+    end
+
+    yield
+
+    JsonMatchers.configure do |config|
+      config.options.clear
+      config.options.merge!(original_options)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include ConfigurationHelpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_matchers
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,9 +104,11 @@ files:
 - lib/json_matchers/matcher.rb
 - lib/json_matchers/payload.rb
 - lib/json_matchers/rspec.rb
+- lib/json_matchers/validator.rb
 - lib/json_matchers/version.rb
 - spec/json_matchers/match_response_schema_spec.rb
 - spec/spec_helper.rb
+- spec/support/configuration.rb
 - spec/support/file_helpers.rb
 homepage: https://github.com/thoughtbot/json_matchers
 licenses:
@@ -135,4 +137,5 @@ summary: Validate your Rails JSON API's JSON
 test_files:
 - spec/json_matchers/match_response_schema_spec.rb
 - spec/spec_helper.rb
+- spec/support/configuration.rb
 - spec/support/file_helpers.rb