rspec-json_expectations 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 578ce36c168740a6cf33f28aa580b7eb9a3b2bda
-  data.tar.gz: b06d98b0d63db3bafa6aeca999c7716de7c92913
+  metadata.gz: 2c297902e9eca947b87a20ed364ba4b89df4999d
+  data.tar.gz: cbcad8557c7b4e6b868952a9fbd7a095a502f412
 SHA512:
-  metadata.gz: 4531142c7ea3c080f9cb3df97550346f7e9ff5e8bf009b1f1ee29d3ab2d5eb023619b51f69281dec5c9fa093e6b397596bc80e14e105ed7d9a8c5bdf8244d22b
-  data.tar.gz: a9ec4e356c69bb1a5ef5c2d5898b21ba95df8d24eff9b41669ee6c2790b0a52b8d45afdf0a2941d9141d74280e427c1e927a4aa4d426b8b9b25f9e871989c76b
+  metadata.gz: df339e78a810a408a580c4a80cff1990fc03ddd5ecda91f7fd195750cf1a25bcb57bc5afc4f0435b2b1a9781617c408ba36da0f476b10cc7c059648226087191
+  data.tar.gz: 69ebdd7402a814145b81567ab4e5ddcfd6d45b36680105d578470ca090c2e7af07ba4d1a5e8c2b196c273c067e158bb5f604a8bf14d551a3934654ce1fe1a123

data/.travis.yml

@@ -2,14 +2,11 @@ dist: trusty
 language: ruby
 
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1
   - 2.2
-  - "ruby-2.3.0"
+  - 2.3
 
 gemfile:
-  - gemfiles/rspec-2
   - gemfiles/rspec-3
 
 before_install:

data/features/rspec/json_expectations/match_unordered_json_matcher.feature

@@ -0,0 +1,145 @@
+Feature: match_unordered_json matcher
+
+  As a developer extensively testing my APIs with RSpec
+  I want to have a suitable tool to test my API responses
+  And I want to use simple ruby hashes to describe the parts of response
+  For that I need a custom matcher
+
+  Scenario: Expecting json array to match expected array
+    Given a file "spec/simple_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '[1, 2, 3]' }
+
+            it "matches when the order is equal and the size is equal" do
+              expect(subject).to match_unordered_json([1, 2, 3])
+            end
+          end
+          """
+     When I run "rspec spec/simple_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json array to match expected array with different order
+    Given a file "spec/simple_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '[1, 2, 3]' }
+
+            it "matches when the order is different but the size is equal" do
+              expect(subject).to match_unordered_json([2, 3, 1])
+            end
+          end
+          """
+     When I run "rspec spec/simple_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json array to not match a subcollection
+    Given a file "spec/simple_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '[1, 2, 3]' }
+
+            it "doesn't match if the size is different" do
+              expect(subject).to match_unordered_json([1, 2])
+            end
+          end
+          """
+     When I run "rspec spec/simple_example_spec.rb"
+     Then I see:
+          """
+                 json atom at path "" does not match the expected size:
+          """
+     And I see:
+          """
+                   expected collection contained:  [1, 2]
+          """
+     And I see:
+          """
+                   actual collection contained:    [1, 2, 3]
+          """
+     And I see:
+          """
+                   the extra elements were:        [3]
+          """
+
+
+  Scenario: Expecting json array to not match a subcollection
+    Given a file "spec/simple_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '[1, 2, 3]' }
+
+            it "doesn't match if the order is different and size is different" do
+              expect(subject).to match_unordered_json([3, 1])
+            end
+          end
+          """
+     When I run "rspec spec/simple_example_spec.rb"
+     Then I see:
+          """
+                 json atom at path "" does not match the expected size:
+          """
+     And I see:
+          """
+                   expected collection contained:  [3, 1]
+          """
+     And I see:
+          """
+                   actual collection contained:    [1, 2, 3]
+          """
+     And I see:
+          """
+                   the extra elements were:        [2]
+          """
+
+  Scenario: Expecting json array to successfully not match when the arrays do not match
+    Given a file "spec/simple_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '[1, 2]' }
+
+            it "successfully does not match when the the size is unequal" do
+              expect(subject).to_not match_unordered_json([1, 2, 3])
+            end
+          end
+          """
+     When I run "rspec spec/simple_example_spec.rb"
+     Then I see:
+          """
+          1 example, 0 failures
+          """
+
+  Scenario: Expecting json array to fail to not match when the arrays do match
+    Given a file "spec/simple_example_spec.rb" with:
+          """ruby
+          require "spec_helper"
+
+          RSpec.describe "A json response" do
+            subject { '[1, 2, 3]' }
+
+            it "fails to not match when the arrays do match" do
+              expect(subject).to_not match_unordered_json([1, 2, 3])
+            end
+          end
+          """
+     When I run "rspec spec/simple_example_spec.rb"
+     Then I see:
+          """
+          1 example, 1 failure
+          """

data/lib/rspec/json_expectations/failure_presenter.rb

@@ -12,6 +12,7 @@ module RSpec
 
         def render_error(path, error, negate=false)
           [
+            render_size_mismatch(path, error, negate),
             render_no_key(path, error, negate),
             render_not_eq(path, error, negate),
             render_not_match(path, error, negate),
@@ -19,6 +20,17 @@ module RSpec
           ].select { |e| e }.first
         end
 
+        def render_size_mismatch(path, error, negate=false)
+          %{
+          json atom at path "#{path}" does not match the expected size:
+
+            expected collection contained:  #{error[:expected].inspect}
+            actual collection contained:    #{error[:actual].inspect}
+            the extra elements were:        #{error[:extra_elements].inspect}
+
+          } if error_is_size_mismatch?(error)
+        end
+
         def render_no_key(path, error, negate=false)
           %{
           json atom at path "#{path}" is missing
@@ -58,6 +70,10 @@ module RSpec
           end.join("\n")
         end
 
+        def error_is_size_mismatch?(error)
+          error.is_a?(Hash) && error.has_key?(:_size_mismatch_error)
+        end
+
         def error_is_not_eq?(error)
           error.is_a?(Hash) && error.has_key?(:expected) && !error[:expected].is_a?(Regexp)
         end

data/lib/rspec/json_expectations/json_traverser.rb

@@ -9,16 +9,16 @@ module RSpec
     # json atom paths.
     class JsonTraverser
       HANDLED_BY_SIMPLE_VALUE_HANDLER = [String, Numeric, FalseClass, TrueClass, NilClass]
-      RSPECMATCHERS = defined?(RSpec::Matchers) ? [RSpec::Matchers::BuiltIn::BaseMatcher] : []
+      RSPECMATCHERS = [RSpec::Matchers::BuiltIn::BaseMatcher]
       SUPPORTED_VALUES = [Hash, Regexp, Array, Matchers::UnorderedArrayMatcher] +
         HANDLED_BY_SIMPLE_VALUE_HANDLER + RSPECMATCHERS
 
       class << self
-        def traverse(errors, expected, actual, negate=false, prefix=[])
+        def traverse(errors, expected, actual, negate=false, prefix=[], options={})
           [
             handle_hash(errors, expected, actual, negate, prefix),
             handle_array(errors, expected, actual, negate, prefix),
-            handle_unordered(errors, expected, actual, negate, prefix),
+            handle_unordered(errors, expected, actual, negate, prefix, options),
             handle_value(errors, expected, actual, negate, prefix),
             handle_regex(errors, expected, actual, negate, prefix),
             handle_rspec_matcher(errors, expected, actual, negate, prefix),
@@ -53,13 +53,31 @@ module RSpec
           handle_keyvalue(errors, transformed_expected, actual, negate, prefix)
         end
 
-        def handle_unordered(errors, expected, actual, negate=false, prefix=[])
+        def handle_unordered(errors, expected, actual, negate=false, prefix=[], options={})
           return nil unless expected.is_a?(Matchers::UnorderedArrayMatcher)
 
-          conditionally_negate(
-            expected.match(errors, actual, prefix),
-            negate
-          )
+          match_size_assertion_result = \
+            match_size_of_collection(errors, expected, actual, prefix, options)
+
+          if match_size_assertion_result == false
+            conditionally_negate(false, negate)
+          else
+            conditionally_negate(expected.match(errors, actual, prefix), negate)
+          end
+        end
+
+        def match_size_of_collection(errors, expected, actual, prefix, options)
+          match_size = options[:match_size]
+          return nil unless match_size
+          return nil if expected.size == actual.size
+
+          errors[prefix.join("/")] = {
+            _size_mismatch_error: true,
+            expected: expected.unwrap_array,
+            actual: actual,
+            extra_elements: actual - expected.unwrap_array,
+          }
+          false
         end
 
         def handle_value(errors, expected, actual, negate=false, prefix=[])

data/lib/rspec/json_expectations/matchers.rb

@@ -41,11 +41,40 @@ RSpec::JsonExpectations::MatcherFactory.new(:include_unordered_json).define_matc
   end
 end
 
+RSpec::JsonExpectations::MatcherFactory.new(:match_unordered_json).define_matcher do
+  def traverse(expected, actual, negate=false)
+    unless expected.is_a?(Array)
+      raise ArgumentError,
+        "Expected value must be a array for match_unordered_json matcher"
+    end
+
+    actual_json = actual
+    actual_json = JSON.parse(actual) if String === actual
+
+    expected_wrapped_in_unordered_array = \
+      RSpec::JsonExpectations::Matchers::UnorderedArrayMatcher.new(expected)
+
+    RSpec::JsonExpectations::JsonTraverser.traverse(
+      @include_json_errors = { _negate: negate },
+      expected_wrapped_in_unordered_array,
+      actual_json,
+      negate,
+      [],
+      { match_size: true }
+    )
+  end
+end
+
 module RSpec
   module JsonExpectations
     module Matchers
       class UnorderedArrayMatcher
+        extend Forwardable
+
         attr_reader :array
+
+        def_delegators :array, :size
+
         def initialize(array)
           @array = array
         end
@@ -75,6 +104,10 @@ module RSpec
         def all?(&blk)
           array.each_with_index.all?(&blk)
         end
+
+        def unwrap_array
+          array
+        end
       end
 
       def UnorderedArray(*array)

data/lib/rspec/json_expectations/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module JsonExpectations
-    VERSION = "1.4.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-json_expectations
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Oleksii Fedorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2017-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,6 @@ email:
 - waterlink000@gmail.com
 executables:
 - build
-- with-rspec-2
 - with-rspec-3
 extensions: []
 extra_rdoc_files: []
@@ -56,10 +55,10 @@ files:
 - README.md
 - Rakefile
 - bin/build
-- bin/with-rspec-2
 - bin/with-rspec-3
 - features/rspec/json_expectations/array_support.feature
 - features/rspec/json_expectations/include_json_matcher.feature
+- features/rspec/json_expectations/match_unordered_json_matcher.feature
 - features/rspec/json_expectations/negation_matching.feature
 - features/rspec/json_expectations/nested_json_support.feature
 - features/rspec/json_expectations/regular_expressions_support.feature
@@ -68,7 +67,6 @@ files:
 - features/rspec/json_expectations/unordered_array_support.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
-- gemfiles/rspec-2
 - gemfiles/rspec-3
 - lib/rspec/json_expectations.rb
 - lib/rspec/json_expectations/failure_presenter.rb
@@ -106,6 +104,7 @@ summary: Set of matchers and helpers to allow you test your APIs responses like
 test_files:
 - features/rspec/json_expectations/array_support.feature
 - features/rspec/json_expectations/include_json_matcher.feature
+- features/rspec/json_expectations/match_unordered_json_matcher.feature
 - features/rspec/json_expectations/negation_matching.feature
 - features/rspec/json_expectations/nested_json_support.feature
 - features/rspec/json_expectations/regular_expressions_support.feature

data/bin/with-rspec-2

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-BUNDLE_GEMFILE=gemfiles/rspec-2 bundle $*

data/gemfiles/rspec-2

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rspec-json_expectations.gemspec
-gemspec path: '..'
-
-group :test do
-  gem 'cucumber'
-  gem 'rspec', '~> 2.14.0'
-end
-