rspec-composable_json_matchers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac347d740dd20583329e5908285b186dd61aa27a
+  data.tar.gz: a9a956bdd23674f1c7af6ccede8717485709aeda
+SHA512:
+  metadata.gz: 256ba8db6ac26b919e719a429044cc2099766f48206a90868dd14f2de56c36aa4cd226b01c3a6daceb993eca4f69d6bf64981fabb704189561fa83266e8394c1
+  data.tar.gz: b7a583703a4004e7b92a1ea93c9bf85c2dbc501769875586a8d96f012c18b11d5db7e30d11e4e70bd2eaac528fbe45bc8b86386af3d0559ea8dcfd41fd510a93

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 100
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.7
+  - 2.2.4
+  - 2.3.0
+  - jruby-19mode
+  - jruby-9.0.0.0
+before_install: gem update bundler
+script: bundle exec rake ci
+sudo: false
+cache: bundler

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--hide-void-return

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'coderay', '~> 1.1'
+  gem 'rake', '~> 10.0'
+  gem 'rubocop', '~> 0.37'
+  gem 'simplecov', '~> 0.11'
+  gem 'yard', '~> 0.8'
+end
+
+group :test do
+  gem 'coveralls', '~> 0.8'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yuji Nakayama
+
+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,217 @@
+[![Gem Version](http://img.shields.io/gem/v/rspec-composable_json_matchers.svg?style=flat)](http://badge.fury.io/rb/rspec-composable_json_matchers)
+[![Dependency Status](http://img.shields.io/gemnasium/yujinakayama/rspec-composable_json_matchers.svg?style=flat)](https://gemnasium.com/yujinakayama/rspec-composable_json_matchers)
+[![Build Status](https://travis-ci.org/yujinakayama/rspec-composable_json_matchers.svg?branch=master&style=flat)](https://travis-ci.org/yujinakayama/rspec-composable_json_matchers)
+[![Coverage Status](http://img.shields.io/coveralls/yujinakayama/rspec-composable_json_matchers/master.svg?style=flat)](https://coveralls.io/r/yujinakayama/rspec-composable_json_matchers)
+[![Code Climate](https://img.shields.io/codeclimate/github/yujinakayama/rspec-composable_json_matchers.svg?style=flat)](https://codeclimate.com/github/yujinakayama/rspec-composable_json_matchers)
+
+# RSpec::ComposableJSONMatchers
+
+**RSpec::ComposableJSONMatchers** provides `be_json` matcher,
+which lets you express expected structures on JSON strings
+with the power of RSpec's
+[built-in matchers](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers)
+and
+[composable matchers](https://relishapp.com/rspec/rspec-expectations/docs/composing-matchers).
+
+```ruby
+json = '{ "foo": 1, "bar": 2 }'
+expect(json).to be_json a_kind_of(Hash)
+expect(json).to be_json matching(foo: 1, bar: a_kind_of(Integer))
+expect(json).to be_json including(foo: 1)
+```
+
+## Installation
+
+### Adding `rspec-composable_json_matchers` dependency
+
+Add this line to your `Gemfile`:
+
+```ruby
+gem 'rspec-composable_json_matchers'
+```
+
+And then run:
+
+```bash
+$ bundle install
+```
+
+### Enabling `be_json` matcher
+
+To make the `be_json` matcher available in every example,
+add the following line to your `spec/spec_helper.rb`:
+
+```ruby
+# spec/spec_helper.rb
+require 'rspec/composable_json_matchers/setup'
+```
+
+Or if you prefer more explicit way, add the following snippet:
+
+```ruby
+# spec/spec_helper.rb
+require 'rspec/composable_json_matchers'
+
+RSpec.configure do |config|
+  include RSpec::ComposableJSONMatchers
+end
+```
+
+If you want to enable the `be_json` matcher only specific examples rather than every example,
+include the `RSpec::ComposableJSONMatchers` in the example groups:
+
+```ruby
+# spec/something_spec.rb
+require 'rspec/composable_json_matchers'
+
+describe 'something' do
+  include RSpec::ComposableJSONMatchers
+end
+```
+
+## Usage
+
+The `be_json` matcher takes another matcher, a hash, or an array.
+
+When a matcher is given,
+it passes if actual string can be decoded as JSON and the decoded structure passes the given matcher:
+
+```ruby
+expect('{ "foo": 1, "bar": 2 }').to be_json a_kind_of(Hash)
+expect('{ "foo": 1, "bar": 2 }').to be_json matching(foo: 1, bar: 2)
+expect('{ "foo": 1, "bar": 2 }').to be_json including(foo: 1)
+
+expect('["foo", "bar"]').to be_json a_kind_of(Array)
+expect('["foo", "bar"]').to be_json matching(['foo', 'bar'])
+expect('["foo", "bar"]').to be_json including('foo')
+```
+
+When a hash or an array is given,
+it's handled as `be_json matching(hash_or_array)` (`matching` is an alias of the `match` matcher):
+
+```ruby
+# Equivalents
+expect('{ "foo": 1, "bar": 2 }').to be_json(foo: 1, bar: 2)
+expect('{ "foo": 1, "bar": 2 }').to be_json matching(foo: 1, bar: 2)
+```
+
+You can compose matchers via given matchers:
+
+```ruby
+expect('{ "foo": 1, "bar": 2 }').to be_json matching(
+  foo: a_kind_of(Integer),
+  bar: a_kind_of(Integer)
+)
+
+expect('{ "foo": 1, "bar": 2 }').to be_json including(foo: a_kind_of(Integer))
+```
+
+For more practical example, see
+[`spec/example_spec.rb`](https://github.com/yujinakayama/rspec-composable_json_matchers/blob/master/spec/example_spec.rb)
+for the [GitHub Meta API](https://developer.github.com/v3/meta/).
+
+## Combinations with built-in matchers
+
+Since decoded JSON is always a hash or an array, you may want to use any of the following built-in matchers.
+
+Note that you can always use the `matching` matcher (internally uses `#===`)
+instead of the `eq_to` matcher (internally uses `#==`),
+because there's no objects that are parsed from JSON and behave differently between `#==` and `#===`.
+
+Of course, any other custom matchers supporting a hash or an array can also be used.
+
+### `matching`
+
+* Alias of [`match`](https://relishapp.com/rspec/rspec-expectations/docs/composing-matchers#composing-matchers-with-`match`:) matcher
+* Supported structure: Hash and Array
+* Accepts matchers as arguments: Yes
+
+```ruby
+expect('{ "foo": 1, "bar": 2 }').to be_json matching(foo: 1, bar: a_kind_of(Integer))
+expect('["foo", "bar"]').to be_json matching(['foo', a_string_starting_with('b')])
+```
+
+### `including`
+
+* Alias of [`include`](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/include-matcher#hash-usage) matcher
+* Supported structure: Hash and Array
+* Accepts matchers as arguments: Yes
+
+```ruby
+expect('{ "foo": 1, "bar": 2 }').to be_json including(foo: 1)
+expect('["foo", "bar"]').to be_json including('foo')
+```
+
+### `all`
+
+* [`all`](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/all-matcher) matcher
+* Supported structure: Array
+* Accepts matchers as arguments: Yes
+
+```ruby
+expect('["foo", "bar"]').to be_json all be_a(String)
+```
+
+### `containing_exactly`
+
+* Alias of [`contain_exactly`](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/contain-exactly-matcher) matcher
+* Supported structure: Array
+* Accepts matchers as arguments: Yes
+
+```ruby
+expect('["foo", "bar"]').to be_json containing_exactly('bar', 'foo')
+```
+
+### `starting_with`
+
+* Alias of [`start_with`](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/start-with-matcher) matcher
+* Supported structure: Array
+* Accepts matchers as arguments: Yes
+
+```ruby
+expect('["foo", "bar"]').to be_json starting_with('foo')
+```
+
+### `ending_with`
+
+* Alias of [`end_with`](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/end-with-matcher) matcher
+* Supported structure: Array
+* Accepts matchers as arguments: Yes
+
+```ruby
+expect('["foo", "bar"]').to be_json ending_with('bar')
+```
+
+### `a_kind_of`
+
+* Alias of [`be_a_kind_of`](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/type-matchers#be-(a-)kind-of-matcher) matcher
+* Supported structure: Hash and Array
+* Accepts matchers as arguments: No
+
+```ruby
+expect('{}').to be_json a_kind_of(Hash)
+expect('[]').to be_json a_kind_of(Array)
+```
+
+## Configuration
+
+The `be_json` matcher internally uses
+[`JSON.parse`](http://ruby-doc.org/stdlib-2.3.0/libdoc/json/rdoc/JSON.html#method-i-parse)
+to decode JSON strings.
+The default parser options used in the `be_json` matcher is `{ symbolize_names: true }`,
+so you need to pass _a hash with symbol keys_ as an expected structure.
+
+If you prefer string keys, add the following snippet to your `spec/spec_helper.rb`:
+
+```ruby
+# spec/spec_helper.rb
+RSpec::ComposableJSONMatchers.configure do |config|
+  config.parser_options = { symbolize_names: false }
+end
+```
+
+## License
+
+Copyright (c) 2016 Yuji Nakayama
+
+See the [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new do |task|
+  task.verbose = false
+end
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]
+task ci: [:spec, :rubocop]

data/lib/rspec/composable_json_matchers.rb

@@ -0,0 +1,95 @@
+require 'rspec/composable_json_matchers/be_json'
+require 'rspec/composable_json_matchers/configuration'
+require 'rspec/composable_json_matchers/version'
+
+module RSpec
+  # Mix-in module for the `be_json` matcher.
+  #
+  # @example Make `be_json` matcher available everywhere
+  #   # spec/spec_helper.rb
+  #   require 'rspec/composable_json_matchers'
+  #   RSpec.configure do |config|
+  #     include RSpec::ComposableJSONMatchers
+  #   end
+  #
+  # @example Make `be_json` matcher available only in specific example groups
+  #   require 'rspec/composable_json_matchers'
+  #   describe 'something' do
+  #     include RSpec::ComposableJSONMatchers
+  #   end
+  module ComposableJSONMatchers
+    class << self
+      # @api public
+      #
+      # Returns the current configuration.
+      #
+      # @return [RSpec::ComposableJSONMatchers::Configuration] the current configuration
+      #
+      # @see .configure
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      # @api public
+      #
+      # Provides a block for configuring RSpec::ComposableJSONMatchers.
+      #
+      # @yieldparam config [RSpec::ComposableJSONMatchers::Configuration] the current configuration
+      #
+      # @return [void]
+      #
+      # @example
+      #   # spec/spec_helper.rb
+      #   RSpec::ComposableJSONMatchers.configure do |config|
+      #     config.parser_options = { symbolize_names: false }
+      #   end
+      #
+      # @see .configuration
+      def configure
+        yield configuration
+      end
+
+      # @api private
+      def reset!
+        @configuration = nil
+      end
+
+      # @api private
+      def matcher?(object)
+        begin
+          return false if object.respond_to?(:i_respond_to_everything_so_im_not_really_a_matcher)
+        rescue NoMethodError
+          return false
+        end
+
+        object.respond_to?(:matches?)
+      end
+    end
+
+    # @api public
+    #
+    # Passes if actual string can be decoded as JSON and the decoded structure passes the given
+    # matcher. When a hash is given, it's handled as `be_json matching(hash)` (`matching` is an
+    # alias of the [`match`](http://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/match-matcher)
+    # matcher).
+    #
+    # @param matcher_or_structure [#matches?, Hash, Array] a matcher object, a hash, or an array
+    #
+    # @example
+    #   expect('{ "foo": 1, "bar": 2 }').to be_json(foo: 1, bar: 2)
+    #   expect('{ "foo": 1, "bar": 2 }').to be_json(foo: 1, bar: a_kind_of(Integer))
+    #   expect('{ "foo": 1, "bar": 2 }').to be_json matching(foo: 1, bar: 2)
+    #   expect('{ "foo": 1, "bar": 2 }').to be_json including(foo: 1)
+    #   expect('{ "foo": 1, "bar": 2 }').to be_json a_kind_of(Hash)
+    def be_json(matcher_or_structure)
+      if Hash === matcher_or_structure || Array === matcher_or_structure
+        matcher = matching(matcher_or_structure)
+        BeJSON.new(matcher, ComposableJSONMatchers.configuration)
+      elsif ComposableJSONMatchers.matcher?(matcher_or_structure)
+        BeJSON.new(matcher_or_structure, ComposableJSONMatchers.configuration)
+      else
+        raise ArgumentError, 'You must pass a matcher, a hash, or an array to `be_json` matcher.'
+      end
+    end
+  end
+end

data/lib/rspec/composable_json_matchers/be_json.rb

@@ -0,0 +1,65 @@
+module RSpec
+  module ComposableJSONMatchers
+    # @api private
+    class BeJSON
+      include RSpec::Matchers::Composable
+
+      attr_reader :matcher, :configuration, :original_actual, :decoded_actual, :parser_error
+
+      def initialize(matcher, configuration)
+        @matcher = matcher
+        @configuration = configuration
+      end
+
+      def matches?(actual)
+        @original_actual = actual
+        @decoded_actual = parse(original_actual)
+        matcher.matches?(decoded_actual)
+      rescue JSON::ParserError => error
+        @parser_error = error
+        false
+      end
+
+      def does_not_match?(actual)
+        matched = matches?(actual)
+        parser_error ? false : !matched
+      end
+
+      def description
+        "be JSON #{matcher.description}"
+      end
+
+      def failure_message
+        return parser_failure_message if parser_failure_message
+        "expected #{original_actual} to be JSON #{matcher.description}"
+      end
+
+      def failure_message_when_negated
+        return parser_failure_message if parser_failure_message
+        "expected #{original_actual} not to be JSON #{matcher.description}"
+      end
+
+      def diffable?
+        parser_error.nil? && matcher.diffable?
+      end
+
+      def expected
+        matcher.expected
+      end
+
+      alias actual decoded_actual
+
+      private
+
+      def parse(json)
+        require 'json'
+        JSON.parse(json, configuration.parser_options)
+      end
+
+      def parser_failure_message
+        return nil unless parser_error
+        "cannot parse #{original_actual.inspect} as JSON: #{parser_error.message}"
+      end
+    end
+  end
+end

data/lib/rspec/composable_json_matchers/configuration.rb

@@ -0,0 +1,39 @@
+module RSpec
+  module ComposableJSONMatchers
+    class Configuration
+      # @api public
+      #
+      # The default value of .parser_options.
+      #
+      # @see #parser_options
+      DEFAULT_PARSER_OPTIONS = { symbolize_names: true }.freeze
+
+      # @api public
+      #
+      # Returns the current options for JSON.parse used in the `be_json` matcher.
+      #
+      # @return [Hash] the current options for JSON.parse.
+      #
+      # @see #parser_options=
+      # @see http://ruby-doc.org/stdlib-2.3.0/libdoc/json/rdoc/JSON.html#method-i-parse
+      def parser_options
+        @parser_options ||= DEFAULT_PARSER_OPTIONS
+      end
+
+      # @api public
+      #
+      # Set the given hash as the option for JSON.parse used in the `be_json` matcher.
+      #
+      # @param hash [Hash] an option for JSON.parse
+      #
+      # @return [void]
+      #
+      # @see #parser_options
+      # @see http://ruby-doc.org/stdlib-2.3.0/libdoc/json/rdoc/JSON.html#method-i-parse
+      def parser_options=(hash)
+        raise ArgumentError, 'You must pass a hash to `parser_options=`.' unless hash.is_a?(Hash)
+        @parser_options = hash
+      end
+    end
+  end
+end

data/lib/rspec/composable_json_matchers/setup.rb

@@ -0,0 +1,2 @@
+require 'rspec/composable_json_matchers'
+RSpec.configuration.include(RSpec::ComposableJSONMatchers)

data/lib/rspec/composable_json_matchers/version.rb

@@ -0,0 +1,14 @@
+module RSpec
+  module ComposableJSONMatchers
+    # @api public
+    module Version
+      MAJOR = 1
+      MINOR = 0
+      PATCH = 0
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+end

data/rspec-composable_json_matchers.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/composable_json_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-composable_json_matchers'
+  spec.version       = RSpec::ComposableJSONMatchers::Version.to_s
+  spec.authors       = ['Yuji Nakayama']
+  spec.email         = ['nkymyj@gmail.com']
+
+  spec.summary       = 'RSpec matchers for JSON strings with the power of ' \
+                       'built-in matchers and composable matchers'
+  spec.homepage      = 'https://github.com/yujinakayama/rspec-composable_json_matchers'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'rspec', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rspec-composable_json_matchers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuji Nakayama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+description: 
+email:
+- nkymyj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/composable_json_matchers.rb
+- lib/rspec/composable_json_matchers/be_json.rb
+- lib/rspec/composable_json_matchers/configuration.rb
+- lib/rspec/composable_json_matchers/setup.rb
+- lib/rspec/composable_json_matchers/version.rb
+- rspec-composable_json_matchers.gemspec
+homepage: https://github.com/yujinakayama/rspec-composable_json_matchers
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for JSON strings with the power of built-in matchers and composable
+  matchers
+test_files: []
+has_rdoc: