rspec-json_expectations 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7be8f6d84a11ad85c20dfdb8a792db48587ed6e
-  data.tar.gz: fce85bc76ad20f75eeb897eae740841e2ffd9fec
+  metadata.gz: 1983e0ca2363deb0443b471931f99b0d8d02dc1a
+  data.tar.gz: 71b98df45860660e1ec5d496657915ef33975b7c
 SHA512:
-  metadata.gz: e06b381b60dc36b9153f80bc8840c8d60d332cc4d03025155b2966408475719d9ebbdfea1b59207f662730a5bf36adb7df9f6a00ff82997df544900ad298cb42
-  data.tar.gz: 14f572322abeeb992f142360504a659984d351d1837f4e94b033546b2119a2a294e69976ad33952f38e196f6617f4769c8a5f7d02376dd4f041bbaa04e21b449
+  metadata.gz: b1ad5e58d0b7f8d27dab022070a7da4e2e6358fffa072e6196b8b98c8a67a1fd8a79d19ac3325d3b9ed8683bcf4b58390c83f7803bf749f1992053ab7d3229dc
+  data.tar.gz: 17ebe93df1ddbc066ce55d1908be380458bc9d84f300116395a99846f105764aa4eefb15c7ea2334c6a99fbe74b48def359c066270fabeed6e2dff8c6f84ff4b

data/features/rspec/json_expectations/rspec_matchers_support.feature

@@ -0,0 +1,76 @@
+Feature: RSpec matcher support for include_json matcher
+
+  As a developer extensively testing my APIs
+  I want to utilize the power of available RSpec matchers
+
+  Background:
+    Given a file "spec/spec_helper.rb" with:
+          """ruby
+          require "rspec"
+          require "rspec/expectations"
+          require "rspec/json_expectations"
+          """
+      And a local "SIMPLE_JSON" with:
+          """json
+          {
+            "id": 25,
+            "email": "john.smith@example.com",
+            "name": "John",
+            "score": 55
+          }
+          """
+
+  Scenario: Expecting json string to include simple json using an rspec matcher
+    Given a file "spec/matcher_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{SIMPLE_JSON}' }
+
+            it "has basic info about user" do
+              expect(subject).to include_json(
+                id: 25,
+                email: "john.smith@example.com",
+                name: "John",
+                score: (be > 30)
+              )
+            end
+          end
+          """
+     When I run "rspec spec/matcher_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json string to include simple json using an rspec matcher with failure
+    Given a file "spec/matcher_example_fail_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{SIMPLE_JSON}' }
+
+            it "has basic info about user" do
+              matcher = be < 30
+              puts "\'matcher.inspect\'"
+              expect(subject).to include_json(
+                id: 25,
+                email: "john.smith@example.com",
+                name: "John",
+                score: (be < 30)
+              )
+            end
+          end
+          """
+     When I run "rspec spec/matcher_example_fail_spec.rb"
+     Then I see:
+          """
+                             expected: "be < 30"
+                                  got: 55
+          """
+      And I see:
+          """
+          1 example, 1 failure
+          """

data/lib/rspec/json_expectations/json_traverser.rb

@@ -8,7 +8,8 @@ module RSpec
     # json atom paths.
     class JsonTraverser
       HANDLED_BY_SIMPLE_VALUE_HANDLER = [String, Numeric, FalseClass, TrueClass, NilClass]
-      SUPPORTED_VALUES = [Hash, Regexp, Array] + HANDLED_BY_SIMPLE_VALUE_HANDLER
+      RSPECMATCHERS = defined?(RSpec::Matchers) ? [RSpec::Matchers::BuiltIn::BaseMatcher] : []
+      SUPPORTED_VALUES = [Hash, Regexp, Array] + HANDLED_BY_SIMPLE_VALUE_HANDLER + RSPECMATCHERS
 
       class << self
         def traverse(errors, expected, actual, negate=false, prefix=[])
@@ -17,6 +18,7 @@ module RSpec
             handle_array(errors, expected, actual, negate, prefix),
             handle_value(errors, expected, actual, negate, prefix),
             handle_regex(errors, expected, actual, negate, prefix),
+            handle_rspec_matcher(errors, expected, actual, negate, prefix),
             handle_unsupported(expected)
           ].any?
         end
@@ -80,6 +82,21 @@ module RSpec
           end
         end
 
+        def handle_rspec_matcher(errors, expected, actual, negate=false, prefix=[])
+          return nil unless defined?(RSpec::Matchers)
+          return nil unless expected.is_a?(RSpec::Matchers::BuiltIn::BaseMatcher)
+
+          if conditionally_negate(!!expected.matches?(actual), negate)
+            true
+          else
+            errors[prefix.join("/")] = {
+              actual: actual,
+              expected: expected.description
+            }
+            false
+          end
+        end
+
         def handle_unsupported(expected)
           unless SUPPORTED_VALUES.any? { |type| expected.is_a?(type) }
             raise NotImplementedError,

data/lib/rspec/json_expectations/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module JsonExpectations
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-json_expectations
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Alexey Fedorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ files:
 - features/rspec/json_expectations/negation_matching.feature
 - features/rspec/json_expectations/nested_json_support.feature
 - features/rspec/json_expectations/regular_expressions_support.feature
+- features/rspec/json_expectations/rspec_matchers_support.feature
 - features/rspec/json_expectations/simple_hash_match.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
@@ -104,6 +105,8 @@ test_files:
 - features/rspec/json_expectations/negation_matching.feature
 - features/rspec/json_expectations/nested_json_support.feature
 - features/rspec/json_expectations/regular_expressions_support.feature
+- features/rspec/json_expectations/rspec_matchers_support.feature
 - features/rspec/json_expectations/simple_hash_match.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
+has_rdoc: