rspec-json_matcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aea2e2c2395eca489ac7a672f7cbdfdc22db91f6
+  data.tar.gz: d5bc11c37a503f0ff4b8db0c1e456c162825bb02
+SHA512:
+  metadata.gz: 4ebf3089fd90e425dedfd883287ad02ffc94615312ec8fca156128a575a9d7a151f4f0416ff933082667fa2f0a595c5a4e91f6084f4ee35dac6b0b66f58e975f
+  data.tar.gz: 57b8cd3c74f36fb6f936e5244bd9bab12b8c179c01f49ae8d997661fabdfdc9e1d8c9647646fbd6802854af18d1f62ce9e2ce8eda57c6bf47be756418a1a5c29

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-json_matcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# RSpec::JsonMatcher
+This library provides RSpec matcher for testing JSON string.
+
+## Usage
+```ruby
+# spec/spec_helper.rb
+RSpec.configuration.include RSpec::JsonMatcher
+```
+
+### Features
+* parsing a given value as JSON string
+* handy pattern matching with `#===` method like case-when statement
+* supporting nested pattern matching
+
+### Example
+```ruby
+[
+  {
+    "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([
+  {
+    "url"          => /^invalid pattern$/,
+    "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/,
+  }
+])
+```
+
+### Failure message
+![](http://dl.dropbox.com/u/5978869/image/20130426_005849.png)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec/json_matcher.rb

@@ -0,0 +1,125 @@
+require "rspec/json_matcher/version"
+require "json"
+require "awesome_print"
+
+module RSpec
+  module JsonMatcher
+    def be_json(expected = nil)
+      Matcher.new(expected)
+    end
+
+    class Matcher
+      attr_reader :expected
+
+      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, "", "actual:", @parsed.ai].join("\n")
+      end
+    end
+
+    class Comparer
+      attr_reader :actual, :expected
+
+      def self.compare(*args)
+        new(*args).compare
+      end
+
+      def initialize(actual, expected)
+        @actual   = actual
+        @expected = expected
+      end
+
+      def compare
+        has_same_value?
+      end
+
+      private
+
+      def has_same_class?
+        actual.class == expected.class
+      end
+
+      def has_same_size?
+        actual.size == expected.size
+      end
+
+      def has_same_value?
+        has_equal_value? || has_same_collection?
+      end
+
+      def has_equal_value?
+        if expected.respond_to?(:call)
+          expected.call(actual)
+        else
+          expected === actual
+        end
+      end
+
+      def has_same_collection?
+        collection? && has_same_class? && has_same_size? && has_same_key_values?
+      end
+
+      def has_same_key_values?
+        keys.all? {|key| self.class.compare(actual[key], expected[key]) }
+      end
+
+      def collection?
+        actual.is_a?(Array) || actual.is_a?(Hash)
+      end
+
+      def keys
+        case actual
+        when Array
+          actual.each_index
+        when Hash
+          actual.keys
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_matcher/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module JsonMatcher
+    VERSION = "0.0.1"
+  end
+end

data/rspec-json_matcher.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/json_matcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-json_matcher"
+  spec.version       = RSpec::JsonMatcher::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.description   = "This library provides RSpec matcher for testing JSON string."
+  spec.summary       = "RSpec matcher for testing JSON string"
+  spec.homepage      = "https://github.com/r7kamura/rspec-json_matcher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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"
+end

data/spec/rspec/json_matcher_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe RSpec::JsonMatcher do
+  context "with invalid JSON" do
+    it "does match" do
+      "".should_not be_json
+    end
+  end
+
+  context "with valid JSON" do
+    it "matches with handy patterns" 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([
+        {
+          "url"          => /^invalid pattern$/,
+          "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

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require File.expand_path("../../lib/rspec/json_matcher", __FILE__)
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.include RSpec::JsonMatcher
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rspec-json_matcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-25 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
+  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.
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/json_matcher.rb
+- lib/rspec/json_matcher/version.rb
+- rspec-json_matcher.gemspec
+- spec/rspec/json_matcher_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/rspec-json_matcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0
+signing_key: 
+specification_version: 4
+summary: RSpec matcher for testing JSON string
+test_files:
+- spec/rspec/json_matcher_spec.rb
+- spec/spec_helper.rb
+has_rdoc: