rspec-json_api_matchers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80f25d71ac3d429010809356ae1420279e37656b
+  data.tar.gz: 5b1b1d1fc5530fbf695339b4702ad2558d0cb865
+SHA512:
+  metadata.gz: ae8da9b3966cc8979db0a36d31943ee5f70018d3cee2bd5255f28ec33b6e144ecf6b9f669c023cc5997f1881e5110aebbda8f389db78c402a190a0e60cd5e82f
+  data.tar.gz: a2c311a5c42937970e60935c0505cc44be039d5981cb4f4fb1f45abcfc66d1fd280da2b56a2bbf375a3762258ba2c523bd35dca58bb18a75267ed069b24c8e46

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,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,165 @@
+# RSpec::JsonApiMatchers
+
+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 matchers, `have_attribute` and `match_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::JsonApiMatchers
+
+  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)>'
+```
+
+## `#match_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.
+
+### Example Usage
+
+```ruby
+RSpec.describe "my json response document" do
+  include RSpec::JsonApiMatchers
+
+  subject(:response_document) do
+    {
+      author: "Paul",
+      gems_published: 42,
+      created_at: "2016-01-01T00:00:00Z"
+    }
+  end
+
+  it { should match_json(
+    {
+      author: "Paul",
+      gems_published: be > 40,
+      created_at: iso8601_timestamp
+    }
+  )}
+
+end
+
+```
+
+Again, it provides good descriptions and useful failure messages:
+
+```
+my json response document
+  should have json that looks like
+      {
+        "author": "Paul",
+        "gems_published": be > 40,
+        "created_at": match /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/
+      }
+```
+
+```
+  1) my json response document should have json that looks like
+      {
+        "author": "Someone else",
+        "gems_published": be > 40,
+        "created_at": match /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/,
+        "does_not_exist": be present
+      }
+     Failure/Error:
+       it { should match_json(
+         {
+           author: "Paul",
+           gems_published: be > 40,
+           created_at: iso8601_timestamp,
+           does_not_exist: be_present,
+           author: "Someone else"
+         }
+       )}
+
+       Expected:
+         {
+           "author": "Paul",
+           "gems_published": 42,
+           "created_at": "2016-01-01T00:00:00Z"
+         }
+       To match:
+         {
+           "author": "Someone else",
+           "gems_published": be > 40,
+           "created_at": match /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/,
+           "does_not_exist": be present
+         }
+       Failures:
+         {
+           "author": Expected value of attribute "author" to eq "Someone else" but it was "Paul",
+           "does_not_exist": Expected value of attribute "does_not_exist" to be present but it was nil
+         }
+```
+
+
+# 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/lib/rspec/json_api_matchers.rb

@@ -0,0 +1,22 @@
+require "rspec/json_api_matchers/version"
+
+module RSpec
+  module JsonApiMatchers
+    autoload :AttributeMatcher, "rspec/json_api_matchers/attribute_matcher"
+    autoload :JsonMatcher,      "rspec/json_api_matchers/json_matcher"
+    autoload :Helpers,          "rspec/json_api_matchers/helpers"
+
+    def iso8601_timestamp
+      match(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z/)
+    end
+
+    def match_json(*a)
+      JsonMatcher.new(*a)
+    end
+
+    def have_attribute(*a)
+      AttributeMatcher.new(*a)
+    end
+
+  end
+end

data/lib/rspec/json_api_matchers/attribute_matcher.rb

@@ -0,0 +1,85 @@
+require "active_support/core_ext/hash/indifferent_access"
+
+module RSpec::JsonApiMatchers
+
+  class AttributeMatcher
+    include RSpec::JsonApiMatchers::Helpers
+
+    attr_reader :attribute_name, :expected, :document
+
+    def initialize(attribute_name, expected = NullMatcher)
+      @attribute_name, @expected = attribute_name, expected
+    end
+
+    def description
+      sentencize "have attribute #{attribute_name.inspect} #{expected.description}"
+    end
+
+    def matches?(document)
+      @document = document.with_indifferent_access
+
+      @document.key?(attribute_name) &&
+        expected.matches?(@document.fetch(attribute_name, nil))
+    end
+
+    def failure_message
+      if expected === NullMatcher
+        msgs = ["Expected attribute",
+                attribute_name.inspect,
+                "to be present"]
+      else
+        msgs = ["Expected value of attribute",
+                attribute_name.inspect,
+                "to",
+                expected.description,
+                "but it was",
+                document[attribute_name].inspect]
+      end
+      sentencize(*msgs)
+    end
+
+    def failure_message_when_negated
+      sentencize "Expected attribute #{attribute_name.inspect}",
+                 expected.description,
+                 "to be absent"
+    end
+
+    NullMatcher = Class.new do
+      def matches?(*_args)
+        true
+      end
+
+      def failure_message
+        ""
+      end
+      alias_method :failure_message_for_should, :failure_message
+
+      def description
+        "be present"
+      end
+
+      def ===(_other)
+        true
+      end
+    end.new
+
+    def matcherize(expected)
+      if matcher? expected
+        expected
+
+      elsif expected.respond_to? :===
+        RSpec::Matchers::Builtin::Match.new(expected)
+
+      else
+        RSpec::Matchers::Builtin::Eq.new(expected)
+      end
+    end
+
+    def matcher?(obj)
+      obj.respond_to(:matches?) && (obj.respond_to?(:failure_message) ||
+                                     obj.respond_to?(:failure_message_for_should))
+    end
+
+  end
+
+end

data/lib/rspec/json_api_matchers/helpers.rb

@@ -0,0 +1,15 @@
+module RSpec::JsonApiMatchers
+  module Helpers
+    # Returns string composed of the specified clauses with proper
+    # spacing between them. Empty and nil clauses are ignored.
+    def sentencize(*clauses)
+      clauses
+        .flatten
+        .compact
+        .reject(&:empty?)
+        .map(&:strip)
+        .join(" ")
+    end
+
+  end
+end

data/lib/rspec/json_api_matchers/json_matcher.rb

@@ -0,0 +1,85 @@
+require "active_support/core_ext/string/indent" # indent
+require "active_support/core_ext/hash/keys"     # stringify_keys
+
+require "json"
+
+module RSpec::JsonApiMatchers
+  class JsonMatcher
+    include RSpec::Matchers::Composable
+    include RSpec::JsonApiMatchers::Helpers
+
+    def initialize(expected_json)
+      @expected_json = expected_json.stringify_keys
+      @failed_matchers = {}
+    end
+
+    def matches?(actual_json)
+      @actual_json = actual_json
+      expected_matchers.each do |expected_key, value_matcher|
+        attr_matcher = RSpec::JsonApiMatchers::AttributeMatcher.new(expected_key, value_matcher)
+        match = attr_matcher.matches?(@actual_json)
+        @failed_matchers[expected_key] = attr_matcher unless match
+      end
+      @failed_matchers.size == 0
+    end
+
+    def description
+      # TODO Figure out how to discover the right indent level
+      "have json that looks like\n#{pretty_expected.indent(6)}"
+    end
+
+    def failure_message
+      msgs = [ "Expected:",
+                pretty_actual.indent(2),
+                "To match:",
+                pretty_expected.indent(2),
+                "Failures:",
+                pretty_errors.indent(2) ]
+      msgs.join("\n")
+    end
+
+    def pretty_json(obj)
+      JSON.pretty_generate(obj)
+    end
+
+    def pretty_expected
+      pretty_json(@expected_json)
+    end
+
+    def pretty_actual
+      pretty_json(@actual_json)
+    end
+
+    def expected_matchers
+      @expected_matchers ||= {}.tap do |hsh|
+        @expected_json.each do |k,v|
+          hsh[k] = v.respond_to?(:description) ? v : RSpec::Matchers::BuiltIn::Eq.new(v)
+        end
+      end
+    end
+
+    def pretty_expected
+      out = "{\n"
+      out << expected_matchers.map do |k,v|
+        case v
+        when RSpec::Matchers::BuiltIn::Eq
+          %{"#{k}": #{v.expected_formatted}}.indent(2)
+        else
+          %{"#{k}": #{v.description}}.indent(2)
+        end
+      end.join(",\n")
+      out << "\n}"
+    end
+
+    def pretty_errors
+      out = "{\n"
+      out << @failed_matchers.map do |k,v|
+        %{"#{k}": #{v.failure_message}}.indent(2)
+      end.join(",\n")
+      out << "\n}"
+    end
+
+  end
+end
+
+

data/lib/rspec/json_api_matchers/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module JsonApiMatchers
+    VERSION = "0.1.0"
+  end
+end

data/rspec-json_api_matchers.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/json_api_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-json_api_matchers"
+  spec.version       = Rspec::JsonApiMatchers::VERSION
+  spec.authors       = ["Paul Sadauskas"]
+  spec.email         = ["psadauskas@gmail.com"]
+
+  spec.summary       = %q{Helpful matchers for comparing JSON documents.}
+  spec.homepage      = "https://github.com/paul/rspec-json_api_matchers"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "rspec", ">= 2.0", "< 4.0.0.a"
+  spec.add_runtime_dependency "rspec-expectations", ">= 2.0", "< 4.0.0.a"
+  spec.add_runtime_dependency "activesupport", ">= 4.0" # For String#indent
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: rspec-json_api_matchers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.a
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- psadauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/rspec/json_api_matchers.rb
+- lib/rspec/json_api_matchers/attribute_matcher.rb
+- lib/rspec/json_api_matchers/helpers.rb
+- lib/rspec/json_api_matchers/json_matcher.rb
+- lib/rspec/json_api_matchers/version.rb
+- rspec-json_api_matchers.gemspec
+homepage: https://github.com/paul/rspec-json_api_matchers
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Helpful matchers for comparing JSON documents.
+test_files: []