rspec-json_expectations 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba444e9c321897ecfaef00955d78b897f2132701
-  data.tar.gz: 381bfa291924bf00bf35993995df35eb7717cd97
+  metadata.gz: 635c0cad90f8b318d89952ee50c859dc7bc4110b
+  data.tar.gz: 430f157ca89a149f6f0c99e655ae6ebe40180ae1
 SHA512:
-  metadata.gz: 032cf41af9b2d4e74c966bcccf82a88d5389c517bc2b2d9180667224a3bae38105781acb608eb6d6539e32b8870dbb7751f830e56bf325194666db3487d5bf14
-  data.tar.gz: 8f295dce2669d24d8bf6bdaa33ca78644e49d27829c6bd56058fa70c9915dacad15be31a26bba2f67f462dccd95f631951cb20bd8df144826825921605f80cba
+  metadata.gz: 07b925d6f73e3478dae9b094e7bcf8a624c3b814e9d22b6c2b877bc628c9676d05bc628e5a0a344b48d16746184f93a2f578c1555502c9a39be4d79dc39048e1
+  data.tar.gz: 20ea442c480d27d1af256ea657d206e86f527b38171709aafa3710135565ff0f664a87c8ac981b924ad64d95287f33d2d83c937f9d63ef5d1cf7772c1789dd8e

data/features/rspec/json_expectations/unordered_array_support.feature

@@ -0,0 +1,200 @@
+Feature: Unordered array matching support for include_json matcher
+
+  As a developer extensively testing my APIs
+  I want to be able to match json parts with array
+  And I don't want to be explicit about the order of the elements
+
+  Background:
+    Given a file "spec/spec_helper.rb" with:
+          """ruby
+          require "rspec/json_expectations"
+
+          RSpec.configure do |c|
+            c.include RSpec::JsonExpectations::Matchers
+          end
+          """
+      And a local "JSON_WITH_ARRAY" with:
+          """json
+          {
+            "per_page": 3,
+            "count": 17,
+            "page": 2,
+            "page_count": 6,
+            "results": [
+              {
+                "id": 25,
+                "email": "john.smith@example.com",
+                "badges": ["first flight", "day & night"],
+                "name": "John"
+              },
+              {
+                "id": 26,
+                "email": "john.smith@example.com",
+                "badges": ["first flight"],
+                "name": "John"
+              },
+              {
+                "id": 27,
+                "email": "john.smith@example.com",
+                "badges": ["day & night"],
+                "name": "John"
+              }
+            ]
+          }
+          """
+      And a local "JSON_WITH_ROOT_ARRAY" with:
+          """json
+          [
+            "first flight",
+            "day & night"
+          ]
+          """
+
+  Scenario: Expecting json string to fully include json with arrays
+    Given a file "spec/nested_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{JSON_WITH_ARRAY}' }
+
+            it "has basic info about user" do
+              expect(subject).to include_json(
+                results: UnorderedArray(
+                  { id: 25, badges: ["first flight", "day & night"] },
+                  { id: 26, badges: ["first flight"] },
+                  { id: 27, badges: ["day & night"] }
+                )
+              )
+            end
+          end
+          """
+     When I run "rspec spec/nested_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json string to fully include json with arrays with different order
+    Given a file "spec/nested_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{JSON_WITH_ARRAY}' }
+
+            it "has basic info about user" do
+              expect(subject).to include_json(
+                results: UnorderedArray(
+                  { id: 26, badges: ["first flight"] },
+                  { id: 27, badges: ["day & night"] },
+                  { id: 25, badges: ["first flight", "day & night"] }
+                )
+              )
+            end
+          end
+          """
+     When I run "rspec spec/nested_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json string to fully include json with wrong values
+    Given a file "spec/nested_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{JSON_WITH_ARRAY}' }
+
+            it "has basic info about user" do
+              expect(subject).to include_json(
+                results: UnorderedArray(
+                  { id: 26, badges: ["first flight"] },
+                  { id: 35, badges: ["unknown", "badge"] },
+                  { id: 27, badges: ["day & night"] },
+                  { id: 25, badges: ["first flight", "day & night"] }
+                )
+              )
+            end
+          end
+          """
+     When I run "rspec spec/nested_example_spec.rb"
+     Then I see:
+          """
+                           json atom at path "results/1" is missing
+          """
+      And I see:
+          """
+                             expected: {:id=>35, :badges=>["unknown", "badge"]}
+                                  got: nil
+          """
+
+  Scenario: Expecting json string with array at root to fully include json with arrays
+    Given a file "spec/nested_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{JSON_WITH_ROOT_ARRAY}' }
+
+            it "has basic info about user" do
+              expect(subject).to include_json(
+                UnorderedArray( "first flight", "day & night" )
+              )
+            end
+          end
+          """
+     When I run "rspec spec/nested_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json string with array at root to fully include json with arrays with different order
+    Given a file "spec/nested_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{JSON_WITH_ROOT_ARRAY}' }
+
+            it "has basic info about user" do
+              expect(subject).to include_json(
+                UnorderedArray( "day & night", "first flight" )
+              )
+            end
+          end
+          """
+     When I run "rspec spec/nested_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json string with array at root to fully include json with wrong values
+    Given a file "spec/nested_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '%{JSON_WITH_ROOT_ARRAY}' }
+
+            it "has basic info about user" do
+              expect(subject).to include_json(
+                UnorderedArray( "day & night", "unknown", "first flight" )
+              )
+            end
+          end
+          """
+     When I run "rspec spec/nested_example_spec.rb"
+     Then I see:
+          """
+                           json atom at path "1" is missing
+          """
+      And I see:
+          """
+                             expected: "unknown"
+                                  got: nil
+          """

data/lib/rspec/json_expectations/failure_presenter.rb

@@ -14,7 +14,8 @@ module RSpec
           [
             render_no_key(path, error, negate),
             render_not_eq(path, error, negate),
-            render_not_match(path, error, negate)
+            render_not_match(path, error, negate),
+            render_missing(path, error, negate)
           ].select { |e| e }.first
         end
 
@@ -42,6 +43,21 @@ module RSpec
           } if error_is_not_match?(error)
         end
 
+        def render_missing(path, error, negate=false)
+          return unless error_is_missing?(error)
+
+          prefix = "#{path}/" if path && !path.empty?
+
+          items = error[:missing].map do |item|
+            %{
+          json atom at path "#{prefix}#{item[:index]}" is missing
+
+            expected: #{item[:item].inspect}
+                 got: nil
+            }
+          end.join("\n")
+        end
+
         def error_is_not_eq?(error)
           error.is_a?(Hash) && error.has_key?(:expected) && !error[:expected].is_a?(Regexp)
         end
@@ -49,6 +65,10 @@ module RSpec
         def error_is_not_match?(error)
           error.is_a?(Hash) && error.has_key?(:expected) && error[:expected].is_a?(Regexp)
         end
+
+        def error_is_missing?(error)
+          error.is_a?(Hash) && error.has_key?(:missing)
+        end
       end
     end
   end

data/lib/rspec/json_expectations/json_traverser.rb

@@ -1,4 +1,5 @@
 require "json"
+require "rspec/json_expectations/matchers"
 
 module RSpec
   module JsonExpectations
@@ -9,13 +10,15 @@ module RSpec
     class JsonTraverser
       HANDLED_BY_SIMPLE_VALUE_HANDLER = [String, Numeric, FalseClass, TrueClass, NilClass]
       RSPECMATCHERS = defined?(RSpec::Matchers) ? [RSpec::Matchers::BuiltIn::BaseMatcher] : []
-      SUPPORTED_VALUES = [Hash, Regexp, Array] + HANDLED_BY_SIMPLE_VALUE_HANDLER + RSPECMATCHERS
+      SUPPORTED_VALUES = [Hash, Regexp, Array, Matchers::UnorderedArrayMatcher] +
+        HANDLED_BY_SIMPLE_VALUE_HANDLER + RSPECMATCHERS
 
       class << self
         def traverse(errors, expected, actual, negate=false, prefix=[])
           [
             handle_hash(errors, expected, actual, negate, prefix),
             handle_array(errors, expected, actual, negate, prefix),
+            handle_unordered(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),
@@ -50,6 +53,15 @@ module RSpec
           handle_keyvalue(errors, transformed_expected, actual, negate, prefix)
         end
 
+        def handle_unordered(errors, expected, actual, negate=false, prefix=[])
+          return nil unless expected.is_a?(Matchers::UnorderedArrayMatcher)
+
+          conditionally_negate(
+            expected.match(errors, actual, prefix),
+            negate
+          )
+        end
+
         def handle_value(errors, expected, actual, negate=false, prefix=[])
           return nil unless handled_by_simple_value?(expected)
 

data/lib/rspec/json_expectations/matchers.rb

@@ -36,7 +36,9 @@ RSpec::Matchers.define :include_json do |expected|
   end
 
   def traverse(expected, actual, negate=false)
-    unless expected.is_a?(Hash) || expected.is_a?(Array)
+    unless expected.is_a?(Hash) ||
+        expected.is_a?(Array) ||
+        expected.is_a?(::RSpec::JsonExpectations::Matchers::UnorderedArrayMatcher)
       raise ArgumentError,
         "Expected value must be a json for include_json matcher"
     end
@@ -52,3 +54,46 @@ RSpec::Matchers.define :include_json do |expected|
     )
   end
 end
+
+module RSpec
+  module JsonExpectations
+    module Matchers
+      class UnorderedArrayMatcher
+        attr_reader :array
+        def initialize(array)
+          @array = array
+        end
+
+        def match(errors, actual, prefix)
+          missing_items = []
+          errors[prefix.join("/")] = { missing: missing_items }
+
+          all? do |expected_item, index|
+            match_one(missing_items, expected_item, index, actual)
+          end
+        end
+
+        def match_one(missing, item, index, actual)
+          check_for_missing(missing, item, index,
+            actual.any? do |actual_item|
+              JsonTraverser.traverse({}, item, actual_item, false)
+            end
+          )
+        end
+
+        def check_for_missing(missing, item, index, ok)
+          missing << { item: item, index: index } unless ok
+          ok
+        end
+
+        def all?(&blk)
+          array.each_with_index.all?(&blk)
+        end
+      end
+
+      def UnorderedArray(*array)
+        UnorderedArrayMatcher.new(array)
+      end
+    end
+  end
+end

data/lib/rspec/json_expectations/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module JsonExpectations
-    VERSION = "1.2.2"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-json_expectations
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Oleksii Fedorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - 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/rspec/json_expectations/unordered_array_support.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - gemfiles/rspec-2
@@ -108,6 +109,7 @@ test_files:
 - 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/rspec/json_expectations/unordered_array_support.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 has_rdoc: