rspec-resembles_json_matchers 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b968c8c6cd58c9a8d19b1c104ca37bf6e1960d387a239faf58cfbcd62a1255
-  data.tar.gz: 288b9ecbf70b2dd717db213ff6b5a66993e83adbd030d76dc53aae9c8c709316
+  metadata.gz: 8c9a61de4b2be0f18eada606356321688910baf9dc9a8c662648bea89e068422
+  data.tar.gz: '068d9310ca39fb2bdf735b3bdf0bf1ce94b64c649f43ab19f86361b1ec3213d2'
 SHA512:
-  metadata.gz: 637c49cab05c7f2d4c36e324369b25a9ff20debfc929e4d35c10462d3d09c6948161aa3760b952b4d242ecd3f013d90a7de61c09deec811ad3f9b0010501af9f
-  data.tar.gz: b5e1181998db3821b26727e1756719d611bac69d4346112d48e3f6ef5b50ea3887fbb01ad93638d47a2bac0d4b837c9079adc98a04f3f50c78dabde373fd0dd7
+  metadata.gz: 100c49f936bc8177ee0ab361d920cf2ade74b4c5cf07d17adbff6372aabe9b6ba7cee3f8c6120233bfb276913fac56c9901cc700762bfac356273d63d47d0c4f
+  data.tar.gz: 844f1bf3f602a8a33f0fde5154c99cfa2f8ad92704070356ab5d56fb59eb9563a4d79fc3f633a96e3ee3950d577179ffbddd1568e0b310fe283f2ade5b4bb666

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,96 @@
+Rails:
+  Enabled: true
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRailsVersion: 5.1
+  TargetRubyVersion: 2.5
+
+  Include:
+    - "**/Rakefile"
+    - "**/config.ru"
+  Exclude:
+    - "vendor/**/*"
+    - "spec/fixtures/**/*"
+    - "bin/**/*"
+    - "script/**/*"
+    - "node_modules/**/*"
+
+inherit_from:
+  - http://relaxed.ruby.style/rubocop.yml
+# Rules subject to debate
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - context
+    - it
+    - specify
+  Exclude:
+    - "lib/tasks/**/*"
+    - "config/routes.rb"
+Rails/Date:
+  Enabled: false
+Rails/TimeZone:
+  Enabled: false
+Rails/RelativeDateConstant:
+  Enabled: false
+Style/AndOr:
+  EnforcedStyle: conditionals
+Layout/CaseIndentation:
+  IndentOneStep: true
+Style/Documentation:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Layout/ExtraSpacing:
+  Exclude:
+    - "config/routes.rb"
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/HashSyntax:
+  Exclude:
+    - "lib/tasks/**/*"
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Style/NumericLiterals:
+  Enabled: true
+  Exclude:
+    - "spec/**/*"
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_special
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_special
+Style/SingleLineBlockParams:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - "spec/**/*.rb"
+Style/FormatString:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/SymbolArray:
+  MinSize: 4
+Style/WordArray:
+  MinSize: 4
+Lint/UnusedBlockArgument:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Enabled: false
+Performance/Casecmp:
+  Enabled: false
+Performance/RedundantMerge:
+  MaxKeyValuePairs: 1
+Style/ClassCheck:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+

data/.travis.yml

@@ -1,12 +1,10 @@
 language: ruby
 rvm:
-  - 2.4.2
-  - 2.5.0
-before_install: gem install bundler
+  - "2.4"
+  - "2.5"
+before_install: gem update --system && gem install bundler
 gemfile:
-  - gemfiles/rails_32.gemfile
   - gemfiles/rails_42.gemfile
-  - gemfiles/rails_42_rspec_33.gemfile
   - gemfiles/rails_5.gemfile
 matrix:
   fast_finish: true

data/Changelog.md

@@ -1,3 +1,7 @@
+# 0.8.0
+
+ - ResemblesJson now fails if there are unexpected keys in the actual hash
+
 # 0.7.3
 
  - Add a few more missing render methods

data/Guardfile

@@ -27,7 +27,7 @@
 guard :rspec,
       # cmd: "bin/rspec --no-profile --fail-fast",
       cmd: "bin/rspec --no-profile",
-      failed_mode: :keep,
+      failed_mode: :focus,
       run_all: { cmd: "bin/rspec --no-profile --tag ~type:feature" }, # skip feature specs on "all"
       notification: true,
       all_on_start: false,

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_42.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~> 4.2"
 gem "rspec", "~> 3.4"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_42.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rspec-resembles_json_matchers (0.7.0)
+    rspec-resembles_json_matchers (0.7.4)
       activesupport (>= 3.0)
       rspec (>= 2.0, < 4.0.0.a)
       rspec-expectations (>= 2.0, < 4.0.0.a)

data/gemfiles/rails_5.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~> 5.1.0"
 gem "rspec", "~> 3.6.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rspec-resembles_json_matchers (0.7.0)
+    rspec-resembles_json_matchers (0.7.4)
       activesupport (>= 3.0)
       rspec (>= 2.0, < 4.0.0.a)
       rspec-expectations (>= 2.0, < 4.0.0.a)

data/lib/rspec/resembles_json_matchers.rb

@@ -3,18 +3,18 @@ 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/)

data/lib/rspec/resembles_json_matchers/attribute_differ.rb

@@ -51,20 +51,11 @@ module RSpec::ResemblesJsonMatchers
         @buffer.puts
       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 NORMAL_COLOR
+          @buffer.print prefix + "  " + "#{matcher.attribute_name.to_json}: "
+          render(matcher.value_matcher, prefix: prefix + "  ")
+          @buffer.print(",") unless last
+          @buffer.puts
         else
           @buffer.print REMOVED_COLOR
           @buffer.print prefix
@@ -78,18 +69,34 @@ module RSpec::ResemblesJsonMatchers
           @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 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
       end
     end
 
+    def render_MissingAttributeMatcher(matcher, prefix: "", last: false)
+      prefix = 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 = 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)
       @buffer.puts "["
       if matcher.actual.nil? || matcher.actual.empty?

data/lib/rspec/resembles_json_matchers/attribute_matcher.rb

@@ -1,13 +1,15 @@
 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
 
@@ -18,15 +20,11 @@ module RSpec::ResemblesJsonMatchers
     def matches?(document)
       @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 +43,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 +60,40 @@ 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/json_matcher.rb

@@ -1,6 +1,7 @@
 require "active_support/core_ext/hash/keys" # stringify_keys
 require "json"
 
+require "rspec/matchers"
 require "rspec/resembles_json_matchers/attribute_differ"
 
 module RSpec::ResemblesJsonMatchers
@@ -20,9 +21,10 @@ module RSpec::ResemblesJsonMatchers
 
     def matches?(actual_json)
       @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
@@ -43,8 +45,14 @@ module RSpec::ResemblesJsonMatchers
 
     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
@@ -57,29 +65,9 @@ module RSpec::ResemblesJsonMatchers
       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)
+    def actual
+      @actual ||= {}
     end
 
-    def normal(text)
-      color(text, 0)
-    end
   end
 end

data/lib/rspec/resembles_json_matchers/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module ResemblesJsonMatchers
-    VERSION = "0.7.4"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-resembles_json_matchers
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Paul Sadauskas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,6 +219,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
 - Changelog.md
@@ -228,6 +229,7 @@ files:
 - Rakefile
 - bin/rspec
 - examples/example_spec.rb
+- gemfiles/.bundle/config
 - gemfiles/rails_42.gemfile
 - gemfiles/rails_42.gemfile.lock
 - gemfiles/rails_5.gemfile
@@ -271,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Helpful matchers for comparing JSON documents.