json-schema-rspec 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78897a15eee63f17fbe327166c1cc79a4cab7d98
-  data.tar.gz: 365ee5bf15d49a0d4a8c534122570babd2669613
+  metadata.gz: cf7ece58f4187556a3ef1ec8d53ba2154518a57b
+  data.tar.gz: c05ef489dab2371dca40d13c4dba36cc623e2968
 SHA512:
-  metadata.gz: 7bda5f7a71289c987070eef0212c03e12915cf8b5ac318a7c96c235a4f436a004279a1371dd1653f0695fb8f30a5c4d8ff4f00f6fd68dc9c1c892440538c564e
-  data.tar.gz: 23f7b5a39d5c14036eb49063736cb0dc941b9097e5e0568a134411184850c439b5bfaf885beda9101e0d526b773faed99672ca7bd1464d44eb830fe3c5ca01bd
+  metadata.gz: 45bafafc48779ae37292c05209f497ce1be413acfac7888d9eb9b9b9918b89ef285a70450bd8de2c5bbc6cb691eba1f6a7a667b934a5a85c1efc2a9e7b633ca5
+  data.tar.gz: 74dcb86009906ac8edc7fdd72248f9c64be523b9d2107285a1a2db89358cca74d0ba601dc63c75f923616a721d612783d1dbebaed5c7ed7fa025c7a73eab9128

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.0.3 / 2015-09-14
+==================
+
+  * Allow matcher class to be used as an argument matcher
+  * Update diff output to include helpful error information
+
 0.0.2 / 2015-05-06
 ==================
 

data/README.md

@@ -28,15 +28,26 @@ In your `spec_helper.rb`:
     config.json_schemas[:my_schema] = "path/to/schema.json"
     #inline
     config.json_schemas[:inline_schema] = '{"type": "string"}'
-    
+
 You can then write tests such as:
 
 	#passing spec
     expect('"hello world"').to match_json_schema(:inline_schema)
-    
+
     #failing spec
     expect('[1, 2, 3]').to match_json_schema(:inline_schema)
 
+It also works as an argument matcher:
+
+    expect(some_object).to receive(:some_method).with(object_matching_schema(:inline_schema))
+
+The argument matcher will match anything that the underlying JSON-Schema validator knows how to validate, so if you want to
+limit your argument to a certain class, you'll need to add a compound matcher for that.
+
+    expect(some_object).to receive(:some_method)
+      .with(an_instance_of(String).and(object_matching_schema(:inline_schema)))
+
+
 #### Strict schema validation
 
 If you wish to use strict schema validation you can do so by passing an additional argument to the matcher.
@@ -46,7 +57,7 @@ those explicitly defined in your schema
 ```
 expect(response.body).to match_json_schema(:my_schema, strict: true)
 ```
-    
+
 ### Schema in a file
 You can also use rails path utilities such as `Rails.root.join("spec/support/schemas/my_business_object.schema.json").to_s` when defining schema locations. This gem is backed by the [json-schema](http://github.com/hoxworth/json-schema) gem, so whatever that validator accepts  for paths should work.
 

data/lib/json-schema-rspec/matchers/json_schema_matcher.rb

@@ -15,15 +15,10 @@ module JSON
 
       def matches?(actual)
         @actual = actual
+
         schema = schema_for_name(@schema_name)
         if schema.nil?
-          @errors = [
-            "No schema defined for #{@schema_name}",
-            "Add a line to your RSpec.configure block to define the schema:",
-            "  RSpec.configure do |config|",
-            "    config.json_schemas[:my_remote_schema] = 'path/to/schema'",
-            "    config.json_schemas[:my_inline_schema] = '{\"json\": \"schema\"}'",
-            "  end"]
+          @errors = [ "No schema defined for #{@schema_name}.  Available schemas are #{RSpec.configuration.json_schemas.keys}." ]
           return false
         end
         @errors = JSON::Validator.fully_validate(schema_for_name(@schema_name), @actual, @validation_opts)
@@ -36,6 +31,20 @@ module JSON
         end
       end
 
+      def inspect
+        if @errors.any?
+          failure_message
+        else
+          super
+        end
+      end
+
+      alias_method :to_s, :inspect
+
+      def ===(other)
+        matches?(other)
+      end
+
       def failure_message
         @errors.join("\n")
       end
@@ -45,7 +54,12 @@ module JSON
       end
 
       def description
-        "match JSON schema identified by #{@schema_name}"
+        if @errors.any?
+          # ignore the preamble in a diff
+          @errors[1..-1].join("\n")
+        else
+          "match JSON schema identified by #{@schema_name}"
+        end
       end
 
       def schema_for_name(schema)
@@ -56,5 +70,7 @@ module JSON
     def match_json_schema(schema_name, validation_opts = {})
       MatchJsonSchemaMatcher.new(schema_name, validation_opts)
     end
+
+    alias_method :object_matching_schema, :match_json_schema
   end
 end

data/lib/json-schema-rspec/version.rb

@@ -1,7 +1,7 @@
 module Json
   module Schema
     module Rspec
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
     end
   end
 end

data/spec/json-schema-rspec/matchers/json_schema_matcher_spec.rb

@@ -18,7 +18,57 @@ describe JSON::SchemaMatchers::MatchJsonSchemaMatcher do
     specify 'assigns a failure message' do
       matcher = match_json_schema(unconfigured_schema)
       expect(matcher.matches?(valid_json)).to eq(false)
-      expect(matcher.failure_message).to match(/^No schema defined for #{unconfigured_schema}/)
+      expect(matcher.failure_message)
+        .to match(/^No schema defined for #{unconfigured_schema}/)
+        .and match(/Available schemas are/)
+    end
+  end
+
+  context 'when being used as a argument matcher' do
+    before :each do
+      RSpec.configuration.json_schemas[:inline_schema] = inline_schema
+    end
+
+    let(:dummy) { double }
+
+    # prevent the mock verify from saying we didn't call the method
+    # BECAUSE IT LIES
+    after(:each) { RSpec::Mocks.space.proxy_for(dummy).reset }
+
+    context 'when the argument is a hash' do
+      let(:inline_schema) { '{"type": "object", "properties": { "name" : { "type" : "string" } } }' }
+      let(:valid_hash) { { name: 'bob' } }
+
+      it 'still succeeds' do
+        expect(dummy).to receive(:method_call).with(object_matching_schema(:inline_schema))
+        dummy.method_call(valid_hash)
+      end
+
+      it 'can filter with compound matchers' do
+        expect {
+          expect(dummy).to receive(:method_call).with(an_instance_of(String).and(object_matching_schema(:inline_schema)))
+          dummy.method_call(valid_hash)
+        }.to fail_including("unexpected arguments")
+      end
+    end
+
+    it 'works as an argument matcher' do
+      expect(dummy).to receive(:method_call).with(object_matching_schema(:inline_schema))
+      dummy.method_call(valid_json)
+    end
+
+    it 'does something useful as an argument matcher when it does not match' do
+      expect {
+        expect(dummy).to receive(:method_call).with(object_matching_schema(:inline_schema))
+        dummy.method_call(invalid_json)
+      }.to fail_including("The property '#/' of type Hash did not match the following type: string in schema")
+    end
+
+    it 'can be used as a deeply nested matcher' do
+      expect {
+        expect(dummy).to receive(:method_call).with({a: 1, b: 2, c: object_matching_schema(:inline_schema)})
+        dummy.method_call(a:1, b:2, c: invalid_json)
+      }.to fail_including("The property '#/' of type Hash did not match the following type: string in schema")
     end
   end
 

data/spec/spec_helper.rb

@@ -1,5 +1,28 @@
 require 'json-schema-rspec'
 
+# Copyright (c) 2012 David Chelimsky, Myron Marston
+# Copyright (c) 2006 David Chelimsky, The RSpec Development Team
+# Copyright (c) 2005 Steven Baker
+# Shamelessly stolen from rspec-mocks
+module RSpec
+  module ExpectationFailMatchers
+    def fail(&block)
+      raise_error(RSpec::Mocks::MockExpectationError, &block)
+    end
+
+    def fail_with(*args, &block)
+      raise_error(RSpec::Mocks::MockExpectationError, *args, &block)
+    end
+
+    def fail_including(*snippets)
+      raise_error(
+        RSpec::Mocks::MockExpectationError,
+        a_string_including(*snippets)
+      )
+    end
+  end
+end
+
 Dir[File.expand_path("../../spec/support/**/*.rb",__FILE__)].each { |f| require f }
 
 RSpec.configure do |config|
@@ -11,4 +34,5 @@ RSpec.configure do |config|
   config.filter_run_excluding wip: true
 
   config.include JSON::SchemaMatchers
+  config.include RSpec::ExpectationFailMatchers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-schema-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sharethrough Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: JSON Schema RSpec matchers