json_matchers 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7837005397def477004c328fc25ebf08f3442338
-  data.tar.gz: 6eabcabe3f0317d35ed02980b67d615e609933cd
+  metadata.gz: f804bef576b5eb020767f2b84e25692f5e14225e
+  data.tar.gz: d940ccbb14d096153d58bba091b0f663c155732a
 SHA512:
-  metadata.gz: 463f19a601e24f35a43ca210636c9e68f80c6f33b5c3e402d4116a5e3bd9c60748a4df8755da1edbde4d570b48453a15bbcd76dccc42d3a643a8d26fe87f5820
-  data.tar.gz: fba3346e93283c75f917bfa3ee9fd49a1680f1767ef97a701a439eb9aed4596400b929c78b95c0effffc59547eede894a2d1ae67710297ee2e8eef49632f7640
+  metadata.gz: 1616399a1d6caf634f18f4a59682fdf56b2fd9a1e257851fc06a904b7741b9cedd18f09e7b758ef8ed3ebb3df88bb1adf7f6b4d216902365a4bf334437810fb0
+  data.tar.gz: 5ed37b4b4c32cfe7ff89561690ba347b8f42827a58e32931643a69d23ebfadcd8f414abb255ed34e1a66e5b0f4910e4f4bb334fea2c0937e3997d3bba1cb60ea

data/NEWS.md

@@ -1,6 +1,14 @@
 master
 ======
 
+0.6.1
+=====
+
+* Configure default options for all matchers.
+* Use `JSON.pretty_generate` to format error messages. [#44]
+
+[#44]: https://github.com/thoughtbot/json_matchers/pull/44
+
 0.6.0
 =====
 

data/README.md

@@ -103,7 +103,24 @@ describe "GET /posts" do
 end
 ```
 
-A list of available options can be found [here][options]
+A list of available options can be found [here][options].
+
+[options]: https://github.com/ruby-json-schema/json-schema/blob/2.2.4/lib/json-schema/validator.rb#L160-L162
+
+### Default matcher options
+
+To configure the default options passed to *all* matchers, call
+`JsonMatchers.configure`:
+
+```rb
+# spec/support/json_matchers.rb
+
+JsonMatchers.configure do |config|
+  config.options[:strict] = true
+end
+```
+
+A list of available options can be found [here][options].
 
 [options]: https://github.com/ruby-json-schema/json-schema/blob/2.2.4/lib/json-schema/validator.rb#L160-L162
 

data/lib/json_matchers/configuration.rb

@@ -0,0 +1,17 @@
+module JsonMatchers
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_reader :options
+
+    def initialize
+      @options = {}
+    end
+  end
+end

data/lib/json_matchers/matcher.rb

@@ -2,9 +2,9 @@ require "json-schema"
 
 module JsonMatchers
   class Matcher
-    def initialize(schema_path, **options)
+    def initialize(schema_path, options = {})
       @schema_path = schema_path
-      @options = options
+      @options = default_options.merge(options)
     end
 
     def matches?(response)
@@ -35,5 +35,9 @@ module JsonMatchers
         response
       end
     end
+
+    def default_options
+      JsonMatchers.configuration.options || {}
+    end
   end
 end

data/lib/json_matchers/rspec.rb

@@ -11,39 +11,43 @@ module JsonMatchers
     end
 
     def failure_message(response)
-      <<-FAIL.strip_heredoc
-      expected
+      <<-FAIL
+#{validation_failure_message}
 
-      #{response.body}
+---
 
-      to match schema "#{schema_name}":
+expected
 
-      #{schema_body}
+#{pretty_json(response.body)}
 
-      ---
+to match schema "#{schema_name}":
 
-      #{validation_failure_message}
+#{pretty_json(schema_body)}
 
       FAIL
     end
 
     def failure_message_when_negated(response)
-      <<-FAIL.strip_heredoc
-      expected
+      <<-FAIL
+#{validation_failure_message}
 
-      #{response.body}
+---
 
-      not to match schema "#{schema_name}":
+expected
 
-      #{schema_body}
+#{pretty_json(response.body)}
 
-      ---
+not to match schema "#{schema_name}":
 
-      #{validation_failure_message}
+#{pretty_json(schema_body)}
 
       FAIL
     end
 
+    def pretty_json(json_string)
+      JSON.pretty_generate(JSON.parse(json_string.to_s))
+    end
+
     def schema_path
       JsonMatchers.path_to_schema(schema_name)
     end

data/lib/json_matchers/version.rb

@@ -1,3 +1,3 @@
 module JsonMatchers
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/json_matchers.rb

@@ -1,4 +1,5 @@
 require "json_matchers/version"
+require "json_matchers/configuration"
 require "json_matchers/matcher"
 require "json_matchers/errors"
 require "active_support/all"

data/spec/json_matchers/match_response_schema_spec.rb

@@ -22,23 +22,6 @@ describe JsonMatchers, "#match_response_schema" do
     expect(response_for({})).not_to match_response_schema("foo_schema")
   end
 
-  it "accepts options for the validator" do
-    create_schema("foo_schema", {
-      "type" => "object",
-      "required" => [
-        "id",
-      ],
-      "properties" => {
-        "id" => { "type" => "number" },
-        "title" => {"type" => "string"},
-      },
-      "additionalProperties" => false,
-    })
-
-    expect(response_for({ "id" => 1, "title" => "bar" })).
-      to match_response_schema("foo_schema", strict: false)
-  end
-
   it "validates a JSON string" do
     create_schema("foo_schema", {
       "type" => "object",
@@ -72,7 +55,7 @@ describe JsonMatchers, "#match_response_schema" do
 
     expect {
       expect(response_for("bar" => 5)).to match_response_schema("foo")
-    }.to raise_error(/{"bar":5}/)
+    }.to raise_formatted_error(%{{ "bar": 5 }})
   end
 
   it "contains the body in the failure message when negated" do
@@ -80,7 +63,7 @@ describe JsonMatchers, "#match_response_schema" do
 
     expect {
       expect(response_for([])).not_to match_response_schema("foo")
-    }.to raise_error(/\[\]/)
+    }.to raise_formatted_error("[ ]")
   end
 
   it "contains the schema in the failure message" do
@@ -89,7 +72,7 @@ describe JsonMatchers, "#match_response_schema" do
 
     expect {
       expect(response_for("bar" => 5)).to match_response_schema("foo")
-    }.to raise_error(/#{schema.to_json}/)
+    }.to raise_formatted_error(%{{ "type": "array" }})
   end
 
   it "contains the schema in the failure message when negated" do
@@ -98,7 +81,7 @@ describe JsonMatchers, "#match_response_schema" do
 
     expect {
       expect(response_for([])).not_to match_response_schema("foo")
-    }.to raise_error(/#{schema.to_json}/)
+    }.to raise_formatted_error(%{{ "type": "array" }})
   end
 
   it "does not fail when the schema matches" do
@@ -129,4 +112,54 @@ describe JsonMatchers, "#match_response_schema" do
     expect(valid_response).to match_response_schema("collection")
     expect(invalid_response).not_to match_response_schema("collection")
   end
+
+  context "when options are passed directly to the matcher" do
+    it "forwards options to the validator" 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", strict: true)
+      expect(response_for({ "id" => 1 })).
+        not_to match_response_schema("foo_schema", strict: true)
+    end
+  end
+
+  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
+      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)
+      end
+    end
+  end
+
+  def raise_formatted_error(error_message)
+    raise_error do |error|
+      expect(error.message.squish).to include(error_message)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_matchers
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -113,6 +113,7 @@ files:
 - Rakefile
 - json_matchers.gemspec
 - lib/json_matchers.rb
+- lib/json_matchers/configuration.rb
 - lib/json_matchers/errors.rb
 - lib/json_matchers/matcher.rb
 - lib/json_matchers/rspec.rb
@@ -148,4 +149,3 @@ test_files:
 - spec/json_matchers/match_response_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/file_helpers.rb
-has_rdoc: