rspec-json_matcher 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7293cf1f1d54933dbfd6880e11c02e1d0a5abafa
-  data.tar.gz: 9754ed84ab5d8ee38a3c6fbd6f8d91859fd56551
+SHA256:
+  metadata.gz: 7791271c77095a624211ecf2b3f6bb5a9142f4d31ed43c287c2108ba84b9854d
+  data.tar.gz: 25fd3df8548e53ff229d18ed58c15a6d6a8837005e78910e0ec52a0252862ece
 SHA512:
-  metadata.gz: d8546c81ea7609d908b0f752904533197d67eaa7d418e6470e1b2f6ae97790428cc4e86ad8e2eac0316ced9029d8cf3bbf8f9dc9ea8b28625277117fb784d54a
-  data.tar.gz: 85819e21cafddb65dad53bb0652ebb57d94a5a0f3f671256458057fd02b5a4d5d1f5d72179711fed0695fda59e0aa31d76bd4a07aa96c4af93e962f102e07d99
+  metadata.gz: cf3fb8482b30cc606f67a40113303a2487d8043fabb7fbf5ec5f2810f5697ed89fffdfba4f045192d6dd54f6f5e123744a2be321d3e341b8703a93e857541a3b
+  data.tar.gz: 4237facf43539c1e51efa83fca24c336cd5b8bc5729da61df8263dfb06c06ff4733935c5fbc120ddf2b44866e37ab59f5935d2f8d0e0894b25c90c7a51ed40a2

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.7.2
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,29 +1,59 @@
-## 0.1.2
-* Fix method name for negative case
+## v0.2.0
 
-## 0.1.2
-* Convert keys in expectation from Symbol to String
+- Prefer amazing_print to awesome_print.
 
-## 0.1.1
-* Suppress deprecation warnings for RSpec 3
+## v0.1.6
 
-## 0.1.0
-* Change interface to be_json_including & be_json_as matchers
+- Support composable matchers and matching arguments usecase
 
-## 0.0.6
-* Fix a bug in comparison with Hash keys
+## v0.1.5
 
-## 0.0.5
-* More strict comparison to detect different Hash keys
+- Show reasons in failure case
 
-## 0.0.4
-* Change indent style on failure message
+## v0.1.4
 
-## 0.0.3
-* Bundler friendliness
+- Support RSpec 3 style negative failure message
 
-## 0.0.2
-* Tiny refactoring
+## v0.1.3
 
-## 0.0.1
-* The first release on 2013-4-25
+- Fix method name for negative case
+
+## v0.1.2
+
+- Convert keys in expectation from Symbol to String
+
+## v0.1.2
+
+- Convert keys in expectation from Symbol to String
+
+## v0.1.1
+
+- Suppress deprecation warnings for RSpec 3
+
+## v0.1.0
+
+- Change interface to be_json_including & be_json_as matchers
+
+## v0.0.6
+
+- Fix a bug in comparison with Hash keys
+
+## v0.0.5
+
+- More strict comparison to detect different Hash keys
+
+## v0.0.4
+
+- Change indent style on failure message
+
+## v0.0.3
+
+- Bundler friendliness
+
+## v0.0.2
+
+- Tiny refactoring
+
+## v0.0.1
+
+- The first release on 2013-4-25

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-json_matcher.gemspec
 gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    rspec-json_matcher (0.2.0)
+      amazing_print
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amazing_print (1.4.0)
+    diff-lcs (1.5.0)
+    json (2.6.1)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  rake
+  rspec
+  rspec-json_matcher!
+
+BUNDLED WITH
+   2.3.6

data/README.md

@@ -1,4 +1,7 @@
 # RSpec::JsonMatcher
+
+[![test](https://github.com/r7kamura/rspec-json_matcher/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/rspec-json_matcher/actions/workflows/test.yml)
+
 This library provides RSpec matcher for testing JSON string.
 
 * parsing a given value as JSON string

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/lib/rspec/json_matcher/abstract_comparer.rb

@@ -1,10 +1,10 @@
 module RSpec
   module JsonMatcher
     class AbstractComparer
-      attr_reader :actual, :expected
+      attr_reader :actual, :expected, :reason
 
-      def self.compare(*args)
-        new(*args).compare
+      def self.compare(*args, &reason)
+        new(*args, &reason).compare
       end
 
       def self.extract_keys(array_or_hash)
@@ -15,9 +15,10 @@ module RSpec
         end
       end
 
-      def initialize(actual, expected)
+      def initialize(actual, expected, &reason)
         @actual   = actual
         @expected = expected
+        @reason   = reason
       end
 
       def compare
@@ -31,7 +32,14 @@ module RSpec
       end
 
       def has_same_keys?
-        self.class.extract_keys(actual).sort == self.class.extract_keys(expected).sort
+        actual_keys = self.class.extract_keys(actual).sort
+        expected_keys = self.class.extract_keys(expected).sort
+        (actual_keys == expected_keys).tap do |success|
+          unless success
+            diff_keys = (actual_keys - expected_keys) + (expected_keys - actual_keys)
+            reason[diff_keys.ai]
+          end
+        end
       end
 
       def has_same_value?
@@ -49,11 +57,15 @@ module RSpec
       def has_same_values?
         if expected.is_a?(Array)
           expected.each_index.all? do |index|
-            index < actual.size && self.class.compare(actual[index], expected[index])
+            (index < actual.size && self.class.compare(actual[index], expected[index], &reason)).tap do |success|
+              reason["[#{index}]"] unless success
+            end
           end
         else
           expected.keys.all? do |key|
-            actual.has_key?(key.to_s) && self.class.compare(actual[key.to_s], expected[key])
+            (actual.has_key?(key.to_s) && self.class.compare(actual[key.to_s], expected[key], &reason)).tap do |success|
+              reason[key.to_s] unless success
+            end
           end
         end
       end

data/lib/rspec/json_matcher/abstract_matcher.rb

@@ -1,16 +1,19 @@
 module RSpec
   module JsonMatcher
     class AbstractMatcher
-      attr_reader :expected, :parsed
+      attr_reader :expected, :parsed, :reasons
 
       def initialize(expected = nil)
         @expected = expected
+        @reasons = []
       end
 
       def matches?(json)
         @parsed = JSON.parse(json)
         if has_expectation?
-          compare
+          compare do |reason|
+            @reasons << reason
+          end
         else
           true
         end
@@ -19,7 +22,9 @@ module RSpec
         false
       end
 
-      def compare
+      alias_method :===, :matches?
+
+      def compare(&reason)
         raise NotImplementedError, "You must implement #{self.class}#compare"
       end
 
@@ -42,6 +47,7 @@ module RSpec
           inspection("not ")
         end
       end
+      alias :failure_message_when_negated :negative_failure_message
 
       private
 
@@ -54,7 +60,9 @@ module RSpec
       end
 
       def inspection(prefix = nil)
-        ["expected #{prefix}to match:", expected.ai(indent: -2), "", "actual:", parsed.ai(indent: -2)].join("\n")
+        messages = ["expected #{prefix}to match:", expected.ai(indent: -2), "", "actual:", parsed.ai(indent: -2), ""]
+        messages.push "reason: #{reasons.reverse.join(".")}" unless reasons.empty?
+        messages.join("\n")
       end
     end
   end

data/lib/rspec/json_matcher/exact_matcher.rb

@@ -1,8 +1,8 @@
 module RSpec
   module JsonMatcher
     class ExactMatcher < AbstractMatcher
-      def compare
-        ExactComparer.compare(parsed, expected)
+      def compare(&reason)
+        ExactComparer.compare(parsed, expected, &reason)
       end
     end
   end

data/lib/rspec/json_matcher/fuzzy_matcher.rb

@@ -1,8 +1,8 @@
 module RSpec
   module JsonMatcher
     class FuzzyMatcher < AbstractMatcher
-      def compare
-        FuzzyComparer.compare(parsed, expected)
+      def compare(&reason)
+        FuzzyComparer.compare(parsed, expected, &reason)
       end
     end
   end

data/lib/rspec/json_matcher/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module JsonMatcher
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

data/lib/rspec/json_matcher.rb

@@ -6,7 +6,7 @@ require "rspec/json_matcher/abstract_matcher"
 require "rspec/json_matcher/exact_matcher"
 require "rspec/json_matcher/fuzzy_matcher"
 require "json"
-require "awesome_print"
+require "amazing_print"
 
 module RSpec
   module JsonMatcher

data/rspec-json_matcher.gemspec

@@ -19,8 +19,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "json"
-  spec.add_dependency "awesome_print"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_dependency "amazing_print"
 end

data/spec/rspec/json_matcher_spec.rb

@@ -13,6 +13,14 @@ describe RSpec::JsonMatcher do
         {}.to_json.should be_json
       end
     end
+
+    context 'when used with a composable matcher' do
+      it 'matches' do
+        {
+          "a" => {"b" => 1}.to_json
+        }.should match("a" => be_json)
+      end
+    end
   end
 
   describe "#be_json_as" do
@@ -174,6 +182,14 @@ describe RSpec::JsonMatcher do
         { "foo" => "bar" }.to_json.should be_json_as(foo: "bar")
       end
     end
+
+    context 'when used with a composable matcher' do
+      it 'matches' do
+        {
+          "a" => {"b" => 1}.to_json
+        }.should match("a" => be_json_as("b" => 1))
+      end
+    end
   end
 
   describe "#be_json_including" do
@@ -293,5 +309,13 @@ describe RSpec::JsonMatcher do
         )
       end
     end
+
+    context 'when used with a composable matcher' do
+      it 'matches' do
+        {
+          "a" => {"b" => 1, "c" => 2}.to_json
+        }.should match("a" => be_json_including("b" => 1))
+      end
+    end
   end
 end

metadata

@@ -1,83 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: rspec-json_matcher
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: This library provides RSpec matcher for testing JSON string.
@@ -87,9 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/test.yml"
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -115,17 +75,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: RSpec matcher for testing JSON string