rspec-resembles_json_matchers 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85c0060d722ce75ef9a360088d85b78f095cb7c0
+  data.tar.gz: f51a19065d79d805b34f6745f494691379527538
+SHA512:
+  metadata.gz: a2a0c803b0fa775e02f5077b76df085adbc1b065ffea9b11902a927c3600b2e891b44d6d256d2b6866fdcf067921f9c284ada4a2f158863d81fda0773e0c395b
+  data.tar.gz: 7a402c3ca3573eeff8861b557ee7587affaf5cdf2049be860cc0af04eb2c81a57ff9a8a3156ffb46f4a958eea2de47ef2b48cfb421ebed699b125cdb0e77a816

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.0
+  - ruby-head
+before_install: gem install bundler -v 1.11.2
+gemfile:
+  - gemfiles/rails_42.gemfile
+  - gemfiles/rails_42_rspec_33.gemfile
+  - gemfiles/rails_5.gemfile
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+notifications:
+  email: false

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "rails-42" do
+  gem "rails", "~> 4.2.0"
+  gem "rspec", "~> 3.4.0"
+end
+
+appraise "rails-42-rspec-33" do
+  gem "rails", "~> 4.2.0"
+  gem "rspec", "~> 3.3.0"
+end
+
+appraise "rails-5" do
+  gem "rails", "~> 5.0.0.beta2"
+  gem "rspec", "~> 3.5.0.beta1"
+end

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,47 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  watch(%r{^lib/rspec/resembles_json_matchers/(.+_matcher)\.rb$}) do |m|
+    "spec/matchers/#{m[1]}_spec.rb"
+  end
+
+end

data/README.md

@@ -0,0 +1,225 @@
+# RSpec::ResemblesJsonMatchers
+
+[![Gem Version](https://badge.fury.io/rb/rspec-json_api_matchers.svg)](https://badge.fury.io/rb/rspec-json_api_matchers)[![Build Status](https://travis-ci.org/paul/rspec-json_api_matchers.svg?branch=master)](https://travis-ci.org/paul/rspec-json_api_matchers)
+
+This gem provides a set of matchers that make testing JSON documents (actually
+the hashes parsed from them) simpler and more elegant.
+
+It provides two primary matchers, `have_attribute` and `resembles`/`resembles_json`.
+
+## `#have_attribute`
+
+Use this matcher when you want to examine a single attribute, and optionally
+match against its value.
+
+### Example Usage
+
+```ruby
+RSpec.describe "my hash" do
+  include RSpec::ResemblesJsonMatchers
+
+  subject(:response_document) do
+    {
+      author: "Paul",
+      gems_published: 42,
+      created_at: "2016-01-01T00:00:00Z"
+    }
+  end
+
+  # Test that the key is present, regardless of value (even nil)
+  it { should have_attribute :author }
+
+  # Test the value by using another matcher
+  it { should have_attribute :author, eq("Paul") }
+  it { should have_attribute :author, match(/Paul/) }
+  it { should have_attribute :gems_published, be > 40 }
+  it { should have_attribute :created_at, iso8601_timestamp }
+end
+```
+
+It will also provide nice descriptions in the rspec doc format, and useful
+failure messages:
+
+```
+my hash
+  should have attribute :author be present
+  should have attribute :author eq "Paul"
+  should have attribute :author match /Paul/
+  should have attribute :gems_published be > 40
+  should have attribute :created_at match /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/
+```
+
+```
+Failures:
+
+  1) my hash should have attribute :full_name be present
+     Failure/Error: it { should have_attribute :full_name }
+       Expected attribute :full_name to be present
+     # ./spec/examples_spec.rb:24:in `block (2 levels) in <top (required)>'
+
+  2) my hash should have attribute :author match /paul/
+     Failure/Error: it { should have_attribute :author, match(/paul/) }
+       Expected value of attribute :author to match /paul/ but it was "Paul"
+     # ./spec/examples_spec.rb:25:in `block (2 levels) in <top (required)>'
+```
+
+## `#resembles_json`
+
+This matcher builds upon `#have_attribute` to let you test an entire JSON document in a single example, but still provide detailed errors about each attribute.
+
+Additionally, it does "fuzzy" matching on the fields (unless a matcher is explicitly given), because its primary purpose it do have a clear and concise example of the API output for documentation.
+
+See the examples folder for more.
+
+### Example Usage
+
+```ruby
+RSpec.describe "a basic json document" do
+  let(:document) do
+    {
+      "@id": "/posts/2016/test1",
+      "@type": "Post",
+      "title": "Hello World!",
+      "body": "lorem ipsum",
+      "created_at": "2016-03-01T00:03:42",
+      "published_at": "2016-03-10T15:35:00"
+    }
+  end
+
+  specify do
+    expect(document).to resemble_json(
+      {
+        "@id": "/posts/:year/:title",
+        "@type": eq("Post"),
+        "title": "Hello World!",
+        "body": "lorem ipsum",
+        "created_at": "2016-03-01T00:03:42",
+        "published_at": "2016-03-10T15:35:00"
+      }
+    )
+  end
+end
+```
+
+Again, it provides good descriptions:
+
+```
+  a basic json document
+    should resemble json
+      {
+        "@id": /posts/:year/:title,
+        "@type": "Post",
+        "title": Hello World!,
+        "body": lorem ipsum,
+        "created_at": "2016-03-01T00:03:42",
+        "published_at": "2016-03-10T15:35:00"
+      }
+```
+
+And useful failure messages:
+
+```
+Failures:
+
+  1) The resembles json matcher a basic json document with several attributes that failed to match should resemble json
+  {
+    "@id": /posts/:year/:title,
+    "@type": "PostCollection",
+    "title": 42.0,
+    "body": lorem ipsum,
+    "created_at": "2016-03-01T00:03:42",
+    "published_at": "2016-03-10T15:35:00"
+  }
+
+     Failure/Error:
+       expect(document).to resemble_json(
+         {
+           "@id": "/posts/:year/:title",
+           "@type": eq("PostCollection"),
+           "title": 42.0,
+           "body": "lorem ipsum",
+           "created_at": "2016-03-01T00:03:42",
+           "published_at": "2016-03-10T15:35:00"
+         }
+       )
+
+       failed because
+         attribute "@type":
+           expected: "PostCollection"
+                got: "Post"
+         attribute "title":
+           "Hello World!" does not resemble a number
+     # ./examples/example_spec.rb:40:in `block (4 levels) in <top (required)>'
+
+  2) The resembles json matcher a basic json document when the matcher is missing a field that is present in the document should resemble json
+  {
+    "@id": /posts/:year/:title,
+    "@type": "Post",
+    "body": lorem ipsum,
+    "created_at": "2016-03-01T00:03:42",
+    "published_at": "2016-03-10T15:35:00"
+  }
+
+     Failure/Error:
+       expect(document).to resemble_json(
+         {
+           "@id": "/posts/:year/:title",
+           "@type": eq("Post"),
+           "body": "lorem ipsum",
+           "created_at": "2016-03-01T00:03:42",
+           "published_at": "2016-03-10T15:35:00"
+         }
+       )
+
+       failed because
+         attribute "title":
+           is present, but no matcher provided to match it
+     # ./examples/example_spec.rb:55:in `block (4 levels) in <top (required)>'
+
+  3) The resembles json matcher a basic json document when the document is missing a field that is present in the matcher should resemble json
+  {
+    "@id": /posts/:year/:title,
+    "@type": "Post",
+    "body": lorem ipsum,
+    "created_at": "2016-03-01T00:03:42",
+    "published_at": "2016-03-10T15:35:00"
+  }
+
+     Failure/Error:
+       expect(document).to resemble_json(
+         {
+           "@id": "/posts/:year/:title",
+           "@type": eq("Post"),
+           "body": "lorem ipsum",
+           "created_at": "2016-03-01T00:03:42",
+           "published_at": "2016-03-10T15:35:00"
+         }
+       )
+
+       failed because
+         attribute "title":
+           is present, but no matcher provided to match it
+     # ./examples/example_spec.rb:69:in `block (4 levels) in <top (required)>'
+```
+
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-json_api_matchers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-json_api_matchers
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paul/rspec-json_api_matchers.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/example_spec.rb

@@ -0,0 +1,123 @@
+require_relative "../spec/spec_helper"
+
+RSpec.describe "The resembles json matcher" do
+  include RSpec::ResemblesJsonMatchers
+
+  before :all do
+    puts <<-WARNING.strip_heredoc
+      NOTE: some of these are expected to fail, they are meant to demonstrate
+      the output generated by failing specs
+    WARNING
+  end
+
+  describe "a basic json document" do
+    let(:document) do
+      {
+        "@id": "/posts/2016/test1",
+        "@type": "Post",
+        "title": "Hello World!",
+        "body": "lorem ipsum",
+        "created_at": "2016-03-01T00:03:42",
+        "published_at": "2016-03-10T15:35:00"
+      }
+    end
+
+    specify do
+      expect(document).to resemble_json(
+        {
+          "@id": "/posts/:year/:title",
+          "@type": eq("Post"),
+          "title": "Hello World!",
+          "body": "lorem ipsum",
+          "created_at": "2016-03-01T00:03:42",
+          "published_at": "2016-03-10T15:35:00"
+        }
+      )
+    end
+
+    context "with several attributes that failed to match" do
+      specify do
+        expect(document).to resemble_json(
+          {
+            "@id": "/posts/:year/:title",
+            "@type": eq("PostCollection"),
+            "title": 42.0,
+            "body": "lorem ipsum",
+            "created_at": "2016-03-01T00:03:42",
+            "published_at": "2016-03-10T15:35:00"
+          }
+        )
+      end
+    end
+
+    context "when the matcher is missing a field that is present in the document" do
+      specify do
+        expect(document).to resemble_json(
+          {
+            "@id": "/posts/:year/:title",
+            "@type": eq("Post"),
+            "body": "lorem ipsum",
+            "created_at": "2016-03-01T00:03:42",
+            "published_at": "2016-03-10T15:35:00"
+          }
+        )
+      end
+    end
+
+    context "when the document is missing a field that is present in the matcher" do
+      specify do
+        expect(document).to resemble_json(
+          {
+            "@id": "/posts/:year/:title",
+            "@type": eq("Post"),
+            "body": "lorem ipsum",
+            "created_at": "2016-03-01T00:03:42",
+            "published_at": "2016-03-10T15:35:00"
+          }
+        )
+      end
+    end
+  end
+
+  describe "complex nested json documents" do
+    let(:document) do
+      {
+        "@id": "/posts",
+        "@type": "PostCollection",
+        "nextPage": "/posts?page=2",
+        "members": [
+          {
+            "@id": "/posts/2016/test1",
+            "@type": "Post",
+            "title": "Hello World!",
+            "body": "lorem ipsum",
+            "created_at": "2016-03-01T00:03:42",
+            "published_at": "2016-03-10T15:35:00"
+          }
+        ]
+      }
+    end
+
+    specify do
+      expect(document).to resemble_json(
+        {
+          "@id": "/posts",
+          "@type": eq("PostCollection"),
+          "nextPage": "/posts?page=2",
+          "members": [
+            {
+              "@id": "/posts/:year/:title",
+              "@type": eq("Post"),
+              "title": "Hello World!",
+              "body": "lorem ipsum",
+              "created_at": "2016-03-01T00:03:42",
+              "published_at": "2016-03-10T15:35:00"
+            }
+          ]
+        }
+      )
+    end
+
+
+  end
+end