rspec-json_matcher 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b01935d9caff916affc9015bb7210a04314b351
-  data.tar.gz: f781b67128b9852ca4d5adbd4a603c07cc324568
+  metadata.gz: 8fdf55842f130209991f93fbcd8a241467e1a002
+  data.tar.gz: daf74c7fa6e9feb16f33efdc480b88138cc6d8f8
 SHA512:
-  metadata.gz: 4981405b7a1833d0255d79b67aebea2cb05051f682f13492546905c766424528b35b5cd7a7770fcfa67e189f32587f5060cb276cb6215ae860e8892bdaa328df
-  data.tar.gz: 3b073a2a714d677a3f787de3d77fefcd946511503f2b68ed8f359dfb3088ad440a5bad6e7e2496ba7875b88a6f524c33986a356cb9371a1f55b435c5d3ddd8f7
+  metadata.gz: 83705b7ed68482bbbd4d411c6dff881db6bdbf9922f53fe3dae3375323d9ab1fdd9c1617f06b35d119d07bb3d3e6601cf8fe2fe4781b5e2f7772034f1ba27689
+  data.tar.gz: 60942294a04c7df38dbfeaa382722f8d8f26f9e9ff58601b750feca501da15cbedb0ac8558843338c5afd66aae6e892cec6db4089674ab73e21b23dfa16399ee

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.0
+* Change interface to be_json_including & be_json_as matchers
+
 ## 0.0.6
 * Fix a bug in comparison with Hash keys
 

data/README.md

@@ -13,6 +13,17 @@ require "rspec/json_matcher"
 RSpec.configuration.include RSpec::JsonMatcher
 ```
 
+### Matchers
+* be_json
+* be_json_including
+* be_json_as
+
+```ruby
+{ "a" => "b", "c" => "d" }.to_json.should be_json
+{ "a" => "b", "c" => "d" }.to_json.should be_json_including("a" => "b")
+{ "a" => "b", "c" => "d" }.to_json.should be_json_as("a" => "b", "c" => "d")
+```
+
 ### Example
 ```ruby
 [
@@ -42,7 +53,7 @@ RSpec.configuration.include RSpec::JsonMatcher
     "git_push_url" => "git@gist.github.com:1.git",
     "created_at" => "2010-04-14T02:15:15Z"
   }
-].to_json.should be_json([
+].to_json.should be_json_as([
   {
     "url"          => /^https:/,
     "id"           => /^\d+$/,

data/lib/rspec/json_matcher.rb

@@ -1,120 +1,25 @@
 require "rspec/json_matcher/version"
+require "rspec/json_matcher/abstract_comparer"
+require "rspec/json_matcher/exact_comparer"
+require "rspec/json_matcher/fuzzy_comparer"
+require "rspec/json_matcher/abstract_matcher"
+require "rspec/json_matcher/exact_matcher"
+require "rspec/json_matcher/fuzzy_matcher"
 require "json"
 require "awesome_print"
 
 module RSpec
   module JsonMatcher
     def be_json(expected = nil)
-      Matcher.new(expected)
+      ExactMatcher.new(expected)
     end
 
-    class Matcher
-      attr_reader :expected, :parsed
-
-      def initialize(expected = nil)
-        @expected = expected
-      end
-
-      def matches?(json)
-        @parsed = JSON.parse(json)
-        if has_expectation?
-          Comparer.compare(parsed, expected)
-        else
-          true
-        end
-      rescue JSON::ParserError
-        @parser_error = true
-        false
-      end
-
-      def description
-        "be JSON"
-      end
-
-      def failure_message_for_should
-        if has_parser_error?
-          "expected value to be parsed as JSON, but failed"
-        else
-          inspection
-        end
-      end
-
-      def failure_message_for_should_not
-        if has_parser_error?
-          "expected value not to be parsed as JSON, but succeeded"
-        else
-          inspection("not ")
-        end
-      end
-
-      private
-
-      def has_parser_error?
-        !!@parser_error
-      end
-
-      def has_expectation?
-        !!expected
-      end
-
-      def inspection(prefix = nil)
-        ["expected #{prefix}to match:", expected.ai(indent: -2), "", "actual:", parsed.ai(indent: -2)].join("\n")
-      end
+    def be_json_as(expected)
+      ExactMatcher.new(expected)
     end
 
-    class Comparer
-      attr_reader :actual, :expected
-
-      def self.compare(*args)
-        new(*args).compare
-      end
-
-      def self.extract_keys(array_or_hash)
-        if array_or_hash.is_a?(Array)
-          array_or_hash.each_index.to_a
-        else
-          array_or_hash.keys
-        end
-      end
-
-      def initialize(actual, expected)
-        @actual   = actual
-        @expected = expected
-      end
-
-      def compare
-        has_same_value? || has_same_collection?
-      end
-
-      private
-
-      def has_same_class?
-        actual.class == expected.class
-      end
-
-      def has_same_keys?
-        self.class.extract_keys(actual).sort == self.class.extract_keys(expected).sort
-      end
-
-      def has_same_value?
-        if expected.respond_to?(:call)
-          expected.call(actual)
-        else
-          expected === actual
-        end
-      end
-
-      def has_same_collection?
-        collection? && has_same_class? && has_same_keys? && has_same_values?
-      end
-
-      def has_same_values?
-        self.class.extract_keys(actual).all? {|key| self.class.compare(actual[key], expected[key]) }
-      end
-
-      def collection?
-        actual.is_a?(Array) || actual.is_a?(Hash)
-      end
+    def be_json_including(expected)
+      FuzzyMatcher.new(expected)
     end
   end
 end

data/lib/rspec/json_matcher/abstract_comparer.rb

@@ -0,0 +1,66 @@
+module RSpec
+  module JsonMatcher
+    class AbstractComparer
+      attr_reader :actual, :expected
+
+      def self.compare(*args)
+        new(*args).compare
+      end
+
+      def self.extract_keys(array_or_hash)
+        if array_or_hash.is_a?(Array)
+          array_or_hash.each_index.to_a
+        else
+          array_or_hash.keys
+        end
+      end
+
+      def initialize(actual, expected)
+        @actual   = actual
+        @expected = expected
+      end
+
+      def compare
+        has_same_value? || has_same_collection?
+      end
+
+      private
+
+      def has_same_class?
+        actual.class == expected.class
+      end
+
+      def has_same_keys?
+        self.class.extract_keys(actual).sort == self.class.extract_keys(expected).sort
+      end
+
+      def has_same_value?
+        if expected.respond_to?(:call)
+          expected.call(actual)
+        else
+          expected === actual
+        end
+      end
+
+      def has_same_collection?
+        raise NotImplementedError, "You must implement #{self.class}#has_same_collection?"
+      end
+
+      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])
+          end
+        else
+          expected.keys.all? do |key|
+            actual.has_key?(key) && self.class.compare(actual[key], expected[key])
+          end
+        end
+      end
+
+      def collection?
+        actual.is_a?(Array) || actual.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/rspec/json_matcher/abstract_matcher.rb

@@ -0,0 +1,61 @@
+module RSpec
+  module JsonMatcher
+    class AbstractMatcher
+      attr_reader :expected, :parsed
+
+      def initialize(expected = nil)
+        @expected = expected
+      end
+
+      def matches?(json)
+        @parsed = JSON.parse(json)
+        if has_expectation?
+          compare
+        else
+          true
+        end
+      rescue JSON::ParserError
+        @parser_error = true
+        false
+      end
+
+      def compare
+        raise NotImplementedError, "You must implement #{self.class}#compare"
+      end
+
+      def description
+        "be JSON"
+      end
+
+      def failure_message_for_should
+        if has_parser_error?
+          "expected value to be parsed as JSON, but failed"
+        else
+          inspection
+        end
+      end
+
+      def failure_message_for_should_not
+        if has_parser_error?
+          "expected value not to be parsed as JSON, but succeeded"
+        else
+          inspection("not ")
+        end
+      end
+
+      private
+
+      def has_parser_error?
+        !!@parser_error
+      end
+
+      def has_expectation?
+        !!expected
+      end
+
+      def inspection(prefix = nil)
+        ["expected #{prefix}to match:", expected.ai(indent: -2), "", "actual:", parsed.ai(indent: -2)].join("\n")
+      end
+    end
+  end
+end

data/lib/rspec/json_matcher/exact_comparer.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module JsonMatcher
+    class ExactComparer < AbstractComparer
+      private
+
+      def has_same_collection?
+        collection? && has_same_class? && has_same_keys? && has_same_values?
+      end
+    end
+  end
+end

data/lib/rspec/json_matcher/exact_matcher.rb

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

data/lib/rspec/json_matcher/fuzzy_comparer.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module JsonMatcher
+    class FuzzyComparer < AbstractComparer
+      private
+
+      def has_same_collection?
+        collection? && has_same_class? && has_same_values?
+      end
+    end
+  end
+end

data/lib/rspec/json_matcher/fuzzy_matcher.rb

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

data/lib/rspec/json_matcher/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module JsonMatcher
-    VERSION = "0.0.6"
+    VERSION = "0.1.0"
   end
 end

data/spec/rspec/json_matcher_spec.rb

@@ -1,78 +1,279 @@
 require "spec_helper"
 
 describe RSpec::JsonMatcher do
-  context "with invalid JSON" do
-    it "does not match" do
-      "".should_not be_json
+  describe "#be_json" do
+    context "with invalid JSON" do
+      it "does not match" do
+        "".should_not be_json
+      end
     end
-  end
 
-  context "with invalid keys JSON" do
-    it "does not match" do
-      {
-        "a" => nil
-      }.to_json.should_not be_json(
-        "b" => nil
-      )
+    context "with valid JSON" do
+      it "matches" do
+        {}.to_json.should be_json
+      end
     end
   end
 
-  context "with non-existent keys in JSON" do
-    it "does not match" do
-      {
-        "a" => nil,
-      }.to_json.should_not be_json(
-        "a" => nil,
-        "b" => nil,
-      )
+  describe "#be_json_as" do
+    context "with invalid JSON" do
+      it "does not match" do
+        "".should_not be_json_as("a" => "b")
+      end
+    end
+
+    context "with few keys" do
+      it "does not match" do
+        {
+          "a" => 1,
+          "b" => 2,
+        }.to_json.should_not be_json_as(
+          "a" => 1,
+        )
+      end
+    end
+
+    context "with too many keys" do
+      it "does not match" do
+        {
+          "a" => 1,
+        }.to_json.should_not be_json_as(
+          "a" => 1,
+          "b" => 2,
+        )
+      end
+    end
+
+    context "with different values" do
+      it "does not match" do
+        {
+          "a" => 1,
+          "b" => 2,
+        }.to_json.should_not be_json_as(
+          "a" => 2,
+          "b" => 2,
+        )
+      end
+    end
+
+    context "with same keys and values" do
+      it "matches" do
+        {
+          "a" => 1,
+          "b" => 2,
+        }.to_json.should be_json_as(
+          "a" => 1,
+          "b" => 2,
+        )
+      end
+    end
+
+    context "with nil values" do
+      it "does not match" do
+        {
+          "a" => nil,
+        }.to_json.should_not be_json_as(
+          "b" => nil,
+        )
+      end
+    end
+
+    context "with subset array" do
+      it "does not match" do
+        [
+          "a",
+          "b",
+        ].to_json.should_not be_json_as(
+          [
+            "a",
+          ],
+        )
+      end
+    end
+
+    context "with superset array" do
+      it "does not match" do
+        [
+          "a",
+          "b",
+        ].to_json.should_not be_json_as(
+          [
+            "a",
+            "b",
+            "c",
+          ],
+        )
+      end
+    end
+
+    context "with superset array with nil" do
+      it "does not match" do
+        [
+          "a",
+          "b",
+        ].to_json.should_not be_json_as(
+          [
+            "a",
+            "b",
+            nil,
+          ],
+        )
+      end
+    end
+
+    context "with complex JSON" do
+      it "matches" do
+        [
+          {
+            "url" => "https://api.github.com/gists/17a07d0a27fd3f708f5f",
+            "id" => "1",
+            "description" => "description of gist",
+            "public" => true,
+            "user" => {
+              "login" => "octocat",
+              "id" => 1,
+              "avatar_url" => "https://github.com/images/error/octocat_happy.gif",
+              "gravatar_id" => "somehexcode",
+              "url" => "https://api.github.com/users/octocat"
+            },
+            "files" => {
+              "ring.erl" => {
+                "size" => 932,
+                "filename" => "ring.erl",
+                "raw_url" => "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl"
+              }
+            },
+            "comments" => 0,
+            "comments_url" => "https://api.github.com/gists/6fb6af8cb6e26dbbc327/comments/",
+            "html_url" => "https://gist.github.com/1",
+            "git_pull_url" => "git://gist.github.com/1.git",
+            "git_push_url" => "git@gist.github.com:1.git",
+            "created_at" => "2010-04-14T02:15:15Z"
+          }
+        ].to_json.should be_json_as([
+          {
+            "url"          => /^https:/,
+            "id"           => /^\d+$/,
+            "description"  => /gist/,
+            "public"       => true,
+            "user"         => Hash,
+            "files"        => Hash,
+            "comments"     => Fixnum,
+            "comments_url" => /^https:/,
+            "html_url"     => /^https:/,
+            "git_pull_url" => /^git:/,
+            "git_push_url" => /^git@/,
+            "created_at"   => /^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ/,
+          }
+        ])
+      end
     end
   end
 
-  context "with valid JSON" do
-    it "matches with handy patterns" do
-      [
+  describe "#be_json_including" do
+    context "with invalid JSON" do
+      it "does not match" do
+        "".should_not be_json_including("a" => "b")
+      end
+    end
+
+    context "with few keys" do
+      it "matches" do
         {
-          "url" => "https://api.github.com/gists/17a07d0a27fd3f708f5f",
-          "id" => "1",
-          "description" => "description of gist",
-          "public" => true,
-          "user" => {
-            "login" => "octocat",
-            "id" => 1,
-            "avatar_url" => "https://github.com/images/error/octocat_happy.gif",
-            "gravatar_id" => "somehexcode",
-            "url" => "https://api.github.com/users/octocat"
-          },
-          "files" => {
-            "ring.erl" => {
-              "size" => 932,
-              "filename" => "ring.erl",
-              "raw_url" => "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl"
-            }
-          },
-          "comments" => 0,
-          "comments_url" => "https://api.github.com/gists/6fb6af8cb6e26dbbc327/comments/",
-          "html_url" => "https://gist.github.com/1",
-          "git_pull_url" => "git://gist.github.com/1.git",
-          "git_push_url" => "git@gist.github.com:1.git",
-          "created_at" => "2010-04-14T02:15:15Z"
-        }
-      ].to_json.should be_json([
+          "a" => 1,
+          "b" => 2,
+        }.to_json.should be_json_including(
+          "a" => 1,
+        )
+      end
+    end
+
+    context "with too many keys" do
+      it "matches" do
         {
-          "url"          => /^https:/,
-          "id"           => /^\d+$/,
-          "description"  => /gist/,
-          "public"       => true,
-          "user"         => Hash,
-          "files"        => Hash,
-          "comments"     => Fixnum,
-          "comments_url" => /^https:/,
-          "html_url"     => /^https:/,
-          "git_pull_url" => /^git:/,
-          "git_push_url" => /^git@/,
-          "created_at"   => /^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ/,
-        }
-      ])
+          "a" => 1,
+        }.to_json.should_not be_json_including(
+          "a" => 1,
+          "b" => 2,
+        )
+      end
+    end
+
+    context "with different values" do
+      it "does not match" do
+        {
+          "a" => 1,
+          "b" => 2,
+        }.to_json.should_not be_json_including(
+          "a" => 2,
+          "b" => 2,
+        )
+      end
+    end
+
+    context "with same keys and values" do
+      it "matches" do
+        {
+          "a" => 1,
+          "b" => 2,
+        }.to_json.should be_json_including(
+          "a" => 1,
+          "b" => 2,
+        )
+      end
+    end
+
+    context "with nil values" do
+      it "does not match" do
+        {
+          "a" => nil,
+        }.to_json.should_not be_json_including(
+          "b" => nil,
+        )
+      end
+    end
+
+    context "with subset array" do
+      it "does not match" do
+        [
+          "a",
+          "b",
+        ].to_json.should be_json_including(
+          [
+            "a",
+          ],
+        )
+      end
+    end
+
+    context "with superset array" do
+      it "does not match" do
+        [
+          "a",
+          "b",
+        ].to_json.should_not be_json_including(
+          [
+            "a",
+            "b",
+            "c",
+          ],
+        )
+      end
+    end
+
+    context "with superset array with nil" do
+      it "does not match" do
+        [
+          "a",
+          "b",
+        ].to_json.should_not be_json_including(
+          [
+            "a",
+            "b",
+            nil,
+          ],
+        )
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-json_matcher
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -95,6 +95,12 @@ files:
 - Rakefile
 - lib/rspec-json_matcher.rb
 - lib/rspec/json_matcher.rb
+- lib/rspec/json_matcher/abstract_comparer.rb
+- lib/rspec/json_matcher/abstract_matcher.rb
+- lib/rspec/json_matcher/exact_comparer.rb
+- lib/rspec/json_matcher/exact_matcher.rb
+- lib/rspec/json_matcher/fuzzy_comparer.rb
+- lib/rspec/json_matcher/fuzzy_matcher.rb
 - lib/rspec/json_matcher/version.rb
 - rspec-json_matcher.gemspec
 - spec/rspec/json_matcher_spec.rb