rspec-resembles_json_matchers 0.7.2 → 0.9.1

data/lib/rspec/resembles_json_matchers.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 require "rspec/resembles_json_matchers/version"
 require "rspec/resembles_json_matchers/string_indent"
 
 module RSpec
   module ResemblesJsonMatchers
-    autoload :AttributeMatcher, "rspec/resembles_json_matchers/attribute_matcher"
-    autoload :JsonMatcher,      "rspec/resembles_json_matchers/json_matcher"
-    autoload :Helpers,          "rspec/resembles_json_matchers/helpers"
-
-    autoload :ResemblesAnyOfMatcher,   "rspec/resembles_json_matchers/resembles_any_of_matcher"
-    autoload :ResemblesRouteMatcher,   "rspec/resembles_json_matchers/resembles_route_matcher"
-    autoload :ResemblesDateMatcher,    "rspec/resembles_json_matchers/resembles_date_matcher"
-    autoload :ResemblesNumericMatcher, "rspec/resembles_json_matchers/resembles_numeric_matcher"
-    autoload :ResemblesStringMatcher,  "rspec/resembles_json_matchers/resembles_string_matcher"
-    autoload :ResemblesBooleanMatcher, "rspec/resembles_json_matchers/resembles_boolean_matcher"
-    autoload :ResemblesNilMatcher,     "rspec/resembles_json_matchers/resembles_nil_matcher"
-    autoload :ResemblesClassMatcher,   "rspec/resembles_json_matchers/resembles_class_matcher"
+    require "rspec/resembles_json_matchers/helpers"
+    require "rspec/resembles_json_matchers/attribute_matcher"
+    require "rspec/resembles_json_matchers/json_matcher"
+
+    require "rspec/resembles_json_matchers/resembles_any_of_matcher"
+    require "rspec/resembles_json_matchers/resembles_route_matcher"
+    require "rspec/resembles_json_matchers/resembles_date_matcher"
+    require "rspec/resembles_json_matchers/resembles_numeric_matcher"
+    require "rspec/resembles_json_matchers/resembles_string_matcher"
+    require "rspec/resembles_json_matchers/resembles_boolean_matcher"
+    require "rspec/resembles_json_matchers/resembles_nil_matcher"
+    require "rspec/resembles_json_matchers/resembles_class_matcher"
 
     def iso8601_timestamp
       match(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/)
@@ -32,7 +34,7 @@ module RSpec
 
     def self.resembles_matcher_candidates
       # Order matters
-      @candidates ||= [
+      @resembles_matcher_candidates ||= [
         JsonMatcher,
         ResemblesAnyOfMatcher,
         ResemblesRouteMatcher,
@@ -45,9 +47,8 @@ module RSpec
       ].freeze
     end
 
-    def self.resembles_matcher_for(expected, **a)
+    def self.resembles_matcher_for(expected, **_a)
       resembles_matcher_candidates.detect { |candidate| candidate.can_match?(expected) } || RSpec::Matchers::BuiltIn::Eq
     end
-
   end
 end

data/lib/rspec/resembles_json_matchers/attribute_differ.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/inflector"
 
 module RSpec::ResemblesJsonMatchers
@@ -47,59 +49,70 @@ module RSpec::ResemblesJsonMatchers
         @buffer.print NORMAL_COLOR
         @buffer.print prefix + "  " + "#{matcher.attribute_name.to_json}: "
         render(matcher.value_matcher, prefix: prefix + "  ")
-        @buffer.print(",") unless last
-        @buffer.puts
+      elsif nested_matcher?(matcher.value_matcher)
+        @buffer.print NORMAL_COLOR
+        @buffer.print prefix + "  " + "#{matcher.attribute_name.to_json}: "
+        render(matcher.value_matcher, prefix: prefix + "  ")
       else
-        if nested_matcher?(matcher.value_matcher)
-          if matcher.missing_attribute?
-            prefix = prefix + "- "
-            @buffer.print REMOVED_COLOR
-            @buffer.print prefix + "#{matcher.attribute_name.to_json}: "
-            render(matcher.value_matcher, prefix: prefix)
-            @buffer.print(",") unless last
-            @buffer.puts
-          else
-            @buffer.print NORMAL_COLOR
-            @buffer.print prefix + "  " + "#{matcher.attribute_name.to_json}: "
-            render(matcher.value_matcher, prefix: prefix + "  ")
-            @buffer.print(",") unless last
-            @buffer.puts
-          end
+        @buffer.print REMOVED_COLOR
+        @buffer.print prefix
+        if prefix.include? "-"
+          @buffer.print "  "
         else
-          @buffer.print REMOVED_COLOR
-          @buffer.print prefix
-          if prefix.include? "-"
-            @buffer.print "  "
-          else
-            @buffer.print "- "
-          end
-          @buffer.print "#{matcher.attribute_name.to_json}: "
-          render(matcher.value_matcher, prefix: prefix + "  ")
-          @buffer.print NORMAL_COLOR
-          @buffer.print(",") unless last
-          @buffer.puts
-          unless matcher.missing_attribute?
-            @buffer.print ADDED_COLOR
-            @buffer.print prefix + "+ #{matcher.attribute_name.to_json}: "
-            render(matcher.actual_value, prefix: prefix + "  ")
-            @buffer.print NORMAL_COLOR
-            @buffer.print(",") unless last
-            @buffer.puts
-          end
+          @buffer.print "- "
         end
+        @buffer.print "#{matcher.attribute_name.to_json}: "
+        render(matcher.value_matcher, prefix: prefix + "  ")
+        @buffer.print NORMAL_COLOR
+        @buffer.print(",") unless last
+        @buffer.puts
+        @buffer.print ADDED_COLOR
+        @buffer.print prefix + "+ #{matcher.attribute_name.to_json}: "
+        render(matcher.actual_value, prefix: prefix + "  ")
+        @buffer.print NORMAL_COLOR
       end
+      @buffer.print(",") unless last
+      @buffer.puts
+    end
+
+    def render_MissingAttributeMatcher(matcher, prefix: "", last: false)
+      prefix += (prefix.include?("-") ? "  " : "- ")
+      @buffer.print REMOVED_COLOR
+      @buffer.print prefix + "#{matcher.attribute_name.to_json}: "
+      render(matcher.value_matcher, prefix: prefix)
+      @buffer.print(",") unless last
+      @buffer.puts
+    end
+
+    def render_ExtraAttributeMatcher(matcher, prefix: "", last: false)
+      prefix += "+ "
+      @buffer.print ADDED_COLOR
+      @buffer.print prefix + matcher.attribute_name.to_json + ": "
+      render(matcher.actual_value, prefix: prefix)
+      @buffer.print "," unless last
+      @buffer.puts
     end
 
-    def render_ResemblesAnyOfMatcher(matcher, prefix: "", **opts)
+    def render_ResemblesAnyOfMatcher(matcher, prefix: "", **_opts)
       @buffer.puts "["
-      if matcher.actual.nil? || matcher.actual.empty?
-        example_matcher = matcher.expected.first
-        render example_matcher, prefix: prefix + "  ", starts_on_newline: true
-        @buffer.puts
+      if matcher.matched?
+        matcher.original_expected.each do |item|
+          @buffer.print JSON.pretty_generate(item).indent(1, NORMAL_COLOR + prefix + "- ")
+          last = (matcher.original_expected.last == item)
+          @buffer.print(",") unless last
+          @buffer.puts
+        end
+      elsif matcher.actual.nil? || matcher.actual.empty?
+        matcher.expected.each do |expected_matcher|
+          render expected_matcher, prefix: prefix + "  ", starts_on_newline: true
+          last = (matcher.expected.last == expected_matcher)
+          @buffer.print(",") unless last
+          @buffer.puts
+        end
       else
         matcher.attempted_matchers.each do |attempted_matcher|
-          last = (matcher.attempted_matchers.last == attempted_matcher)
           render attempted_matcher, prefix: prefix + "  ", starts_on_newline: true
+          last = (matcher.attempted_matchers.last == attempted_matcher)
           @buffer.print(",") unless last
           @buffer.puts
         end
@@ -107,36 +120,45 @@ module RSpec::ResemblesJsonMatchers
       @buffer.print prefix + "]"
     end
 
-    def render_ResemblesStringMatcher(matcher, **opts)
+    def render_ResemblesBooleanMatcher(matcher, **_opts)
       @buffer.print matcher.expected.to_json
     end
 
-    def render_ResemblesDateMatcher(matcher, **opts)
+    def render_ResemblesStringMatcher(matcher, **_opts)
       @buffer.print matcher.expected.to_json
     end
 
-    def render_ResemblesNumericMatcher(matcher, **opts)
+    def render_ResemblesDateMatcher(matcher, **_opts)
       @buffer.print matcher.expected.to_json
     end
 
-    def render_ResemblesClassMatcher(matcher, **opts)
+    def render_ResemblesNumericMatcher(matcher, **_opts)
+      @buffer.print matcher.expected.to_json
+    end
+
+    def render_ResemblesClassMatcher(matcher, **_opts)
       @buffer.print matcher.expected.inspect
     end
 
-    def render_ResemblesNilMatcher(matcher, **opts)
+    def render_ResemblesNilMatcher(_matcher, **_opts)
       @buffer.print "null"
     end
 
+    def render_ResemblesRouteMatcher(matcher, **_opts)
+      @buffer.print matcher.expected.inspect
+    end
+
     def method_missing(method_name, *args, &block)
       if method_name.to_s.start_with?("render_")
         raise NoMethodError, method_name if method_name.to_s.end_with?("Matcher")
+
         @buffer.print RSpec::Support::ObjectFormatter.format(args.first)
       else
         super
       end
     end
 
-    def respond_to_missing?(method_name, include_private = false)
+    def respond_to_missing?(method_name, _include_private = false)
       method_name.to_s.start_with?("render_")
     end
 
@@ -144,11 +166,9 @@ module RSpec::ResemblesJsonMatchers
       matcher.is_a?(JsonMatcher) || matcher.is_a?(ResemblesAnyOfMatcher)
     end
 
-    NORMAL_COLOR  = "\e[0m".freeze
-    REMOVED_COLOR = "\e[31m".freeze # Red
-    ADDED_COLOR   = "\e[32m".freeze # Green
-    NEUTRAL_COLOR = "\e[34m".freeze # Blue
-
+    NORMAL_COLOR  = "\e[0m"
+    REMOVED_COLOR = "\e[31m" # Red
+    ADDED_COLOR   = "\e[32m" # Green
+    NEUTRAL_COLOR = "\e[34m" # Blue
   end
 end
-

data/lib/rspec/resembles_json_matchers/attribute_matcher.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/try"
 
 module RSpec::ResemblesJsonMatchers
-
   class AttributeMatcher
     include RSpec::ResemblesJsonMatchers::Helpers
+    Undefined = Object.new # TODO use Dry::Core::Constants::Undefined
 
     attr_reader :attribute_name, :expected, :document
 
-    def initialize(attribute_name, expected = NullMatcher)
+    def initialize(attribute_name, expected = NullMatcher.new)
       @attribute_name, @expected = attribute_name, expected
     end
 
@@ -16,17 +19,13 @@ module RSpec::ResemblesJsonMatchers
     end
 
     def matches?(document)
-      @document = document.with_indifferent_access
+      @document = document.try(:with_indifferent_access)
 
-      @matched = !missing_attribute? && expected.matches?(actual_value)
+      @matched = document.key?(attribute_name) && expected.matches?(actual_value)
     end
 
     def failure_message
-      if missing_attribute?
-        %{Expected document to have attribute #{attribute_name.inspect}}
-      else
-        %{Expected attribute #{attribute_name.inspect} to #{value_matcher.description}, but it was #{actual_value.inspect}}
-      end
+      %{Expected attribute #{attribute_name.inspect} to #{value_matcher.description}, but it was #{actual_value.inspect}}
     end
 
     def matched?
@@ -45,14 +44,6 @@ module RSpec::ResemblesJsonMatchers
       document.fetch(attribute_name, nil)
     end
 
-    def missing_attribute?
-      !has_attribute?
-    end
-
-    def has_attribute?
-      document && document.key?(attribute_name)
-    end
-
     NullMatcher = Class.new do
       def matches?(*_args)
         true
@@ -70,7 +61,36 @@ module RSpec::ResemblesJsonMatchers
       def ===(_other)
         true
       end
-    end.new
+    end
+  end
 
+  class MissingAttributeMatcher < AttributeMatcher
+    def matches?(document)
+      @document = document.try(:with_indifferent_access)
+      false
+    end
+
+    def failure_message
+      "Document had is missing attribute #{attribute_name.inspect}"
+    end
+
+    def description
+      "be present"
+    end
+  end
+
+  class ExtraAttributeMatcher < AttributeMatcher
+    def matches?(document)
+      @document = document.try(:with_indifferent_access)
+      false
+    end
+
+    def failure_message
+      "Document had unexpected attribute #{attribute_name.inspect}"
+    end
+
+    def description
+      "not be present"
+    end
   end
 end

data/lib/rspec/resembles_json_matchers/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 module RSpec::ResemblesJsonMatchers
@@ -14,16 +16,15 @@ module RSpec::ResemblesJsonMatchers
     end
 
     def matcherize(expected)
-      if is_matcher? expected
+      if matcher?(expected)
         expected
       else
         RSpec::ResemblesJsonMatchers.resembles_matcher_for(expected).new(expected)
       end
     end
 
-    def is_matcher?(obj)
+    def matcher?(obj)
       obj.respond_to?(:matches?) && obj.respond_to?(:description)
     end
-
   end
 end

data/lib/rspec/resembles_json_matchers/json_matcher.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/hash/keys" # stringify_keys
 require "json"
 
+require "rspec/matchers"
 require "rspec/resembles_json_matchers/attribute_differ"
 
 module RSpec::ResemblesJsonMatchers
@@ -12,17 +15,18 @@ module RSpec::ResemblesJsonMatchers
       hash.is_a? Hash
     end
 
-    attr_reader :expected, :actual
+    attr_reader :expected
 
     def initialize(expected_json)
-      @expected = expected_json.deep_stringify_keys
+      @expected = expected_json.try(:deep_stringify_keys)
     end
 
     def matches?(actual_json)
-      @actual = actual_json.deep_stringify_keys
+      @actual = actual_json.try(:deep_stringify_keys)
+      # Can't use #all? because it stops on the first false
       all_passed = true
-      expected_matchers.each do |key, attr_matcher|
-        result = attr_matcher.matches?(actual)
+      expected_matchers.each do |_key, matcher|
+        result = matcher.matches?(actual)
         all_passed &&= result
       end
       all_passed
@@ -37,49 +41,34 @@ module RSpec::ResemblesJsonMatchers
       AttributeDiffer.new(self).to_s
     end
 
-    def to_json
+    def to_json(*_args)
       failure_message
     end
 
     def expected_matchers
       @expected_matchers ||= {}.tap do |hsh|
-        expected.each do |k,v|
-          hsh[k.to_s] = AttributeMatcher.new(k, matcherize(v))
+        (expected.keys + actual.keys).uniq.each do |key|
+          expected_value = matcherize(expected[key])
+          hsh[key.to_s] =
+            if !expected.key?(key) then ExtraAttributeMatcher.new(key, expected_value)
+            elsif !actual.key?(key) then MissingAttributeMatcher.new(key, expected_value)
+            else
+              AttributeMatcher.new(key, expected_value)
+            end
         end
       end
     end
 
     def expected_formatted
-      out = "{\n"
-      out << expected_matchers.map do |k,v|
+      out = +"{\n"
+      out << expected_matchers.map do |k, v|
         %{"#{k}": #{RSpec::Support::ObjectFormatter.format(v.expected_value)}}.indent(2)
       end.join(",\n")
       out << "\n}"
     end
 
-    def color_lines(text)
-      text.split("\n").map do |line|
-        case line.chr[0]
-          when "-" then red line
-          when "+" then green line
-        end
-      end.compact
-    end
-
-    def color(text, color_code)
-      "\e[#{color_code}m#{text}\e[0m"
-    end
-
-    def red(text)
-      color(text, 31)
-    end
-
-    def green(text)
-      color(text, 32)
-    end
-
-    def normal(text)
-      color(text, 0)
+    def actual
+      @actual ||= {}
     end
   end
 end