rspec-composable_json_matchers 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 08d899242d84fd31e688747290d9540e8251bced
-  data.tar.gz: 06de1d9e179efdd21cc1e11188517aed77d533ce
+SHA256:
+  metadata.gz: 60aedac8bfa4be5a25ee02f5690bc668fa0877ac5694d25dcfd49e51b1f5959d
+  data.tar.gz: b75aa47517e390d769bf6bb85774fe16700572b3f481cf9f2f0b0d28477a08ba
 SHA512:
-  metadata.gz: a34fa9de5b8b11ef7d585a2e033dcea41663949321a2d892f0853dea773bd5bd98bd6336e5d26284f60bcb55a931d5142f7d8d9e6e011e743a2f07998ea6b998
-  data.tar.gz: a07c467c87f20fcf5c3e219d1a65e5c593cc24ef6a5fd8b34336b8725c1839fef31083387db714b9e5a6b6d343dd5b0a5b79f9605284d7d32d69e04bf69d7667
+  metadata.gz: 50c03bfe28eb3e07fc14340429a4d6d69d080373b857043d36df06ee548ce671e3ecb228e5c70e992491d417a4bbcc541078f76b4ae680478c2f5c0f5e286f3d
+  data.tar.gz: 567b30332befa7757725ca1940edfbc0cb4198b995204d27f8a080e22d7e4743aafa5dce19f760fdcc9ffdaa9cd14412ecaf42da41262d596514ba1672308fb2

data/.rubocop.yml

@@ -2,6 +2,10 @@ Lint/HandleExceptions:
   Exclude:
     - 'spec/**/*'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/LineLength:
   Max: 100
 

data/.travis.yml

@@ -1,12 +1,10 @@
 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
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 sudo: false
 cache: bundler
+before_install: gem update --system
+script: bundle exec rake ci

data/Gemfile

@@ -4,10 +4,12 @@ gemspec
 
 group :development, :test do
   gem 'coderay', '~> 1.1'
-  gem 'rake', '~> 10.0'
-  gem 'rubocop', '~> 0.37'
+  gem 'rake', '~> 12.0'
+  gem 'rubocop', '~> 0.51'
   gem 'simplecov', '~> 0.11'
-  gem 'yard', '~> 0.8'
+  gem 'vcr', '~> 4.0'
+  gem 'webmock', '~> 3.0'
+  gem 'yard', '>= 0.9.11', '< 1.0'
 end
 
 group :test do

data/README.md

@@ -1,8 +1,7 @@
-[![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)
+[![Gem Version](https://badge.fury.io/rb/rspec-composable_json_matchers.svg)](http://badge.fury.io/rb/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)
+[![Coverage Status](https://coveralls.io/repos/yujinakayama/rspec-composable_json_matchers/badge.svg?branch=master&service=github)](https://coveralls.io/github/yujinakayama/rspec-composable_json_matchers?branch=master)
+[![Code Climate](https://codeclimate.com/github/yujinakayama/rspec-composable_json_matchers/badges/gpa.svg)](https://codeclimate.com/github/yujinakayama/rspec-composable_json_matchers)
 
 # RSpec::ComposableJSONMatchers
 
@@ -53,7 +52,7 @@ Or if you prefer more explicit way, add the following snippet:
 require 'rspec/composable_json_matchers'
 
 RSpec.configure do |config|
-  include RSpec::ComposableJSONMatchers
+  config.include RSpec::ComposableJSONMatchers
 end
 ```
 
@@ -71,10 +70,11 @@ end
 
 ## Usage
 
-The `be_json` matcher takes another matcher, a hash, or an array.
+The `be_json` matcher takes another matcher
+or a JSON value (hash, array, numeric, string, true, false, or nil).
 
 When a matcher is given,
-it passes if actual string can be decoded as JSON and the decoded structure passes the given matcher:
+it passes if actual string can be decoded as JSON and the decoded value passes the given matcher:
 
 ```ruby
 expect('{ "foo": 1, "bar": 2 }').to be_json a_kind_of(Hash)
@@ -84,10 +84,12 @@ 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')
+
+expect('null').to be_json(nil)
 ```
 
-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):
+When a JSON value is given,
+it's handled as `be_json matching(value)` (`matching` is an alias of the `match` matcher):
 
 ```ruby
 # Equivalents
@@ -112,13 +114,14 @@ 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.
+Since decoded JSON is a hash or an array in most cases,
+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 `#===`.
+Note that you can always use the `match` matcher (internally uses `#===`)
+instead of the `eq` matcher (internally uses `#==`),
+because there's no object that is parsed from JSON and behaves differently between `#==` and `#===`.
 
-Of course, any other custom matchers supporting a hash or an array can also be used.
+Of course, any other custom matchers can also be used.
 
 ### `matching`
 
@@ -182,6 +185,17 @@ expect('["foo", "bar"]').to be_json starting_with('foo')
 expect('["foo", "bar"]').to be_json ending_with('bar')
 ```
 
+### `having_attributes`
+
+* Alias of [`have_attributes`](https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/have-attributes-matcher) matcher
+* Supported structure: Hash and Array
+* Accepts matchers as arguments: Yes
+
+```ruby
+expect('{ "foo": 1, "bar": 2 }').to be_json having_attributes(keys: [:foo, :bar])
+expect('["foo", "bar"]').to be_json having_attributes(size: 2)
+```
+
 ### `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

data/Rakefile

@@ -8,5 +8,5 @@ end
 
 RuboCop::RakeTask.new
 
-task default: [:spec, :rubocop]
-task ci: [:spec, :rubocop]
+task default: %i[spec rubocop]
+task ci: %i[spec rubocop]

data/lib/rspec/composable_json_matchers.rb

@@ -64,16 +64,31 @@ module RSpec
 
         object.respond_to?(:matches?)
       end
+
+      # @api private
+      def json_value?(object)
+        # value = false / null / true / object / array / number / string
+        # https://www.rfc-editor.org/rfc/rfc8259.txt
+        case object
+        when Hash, Array, Numeric, String, TrueClass, FalseClass, NilClass
+          true
+        else
+          false
+        end
+      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)
+    # Passes if actual string can be decoded as JSON and the decoded value passes the given
+    # matcher. When a JSON value is given, it's handled as `be_json matching(value)`
+    # (`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
+    # @param
+    #   matcher_or_json_value
+    #   [#matches?, Hash, Array, Numeric, String, TrueClass, FalseClass, NilClass]
+    #   a matcher object or a JSON value
     #
     # @example
     #   expect('{ "foo": 1, "bar": 2 }').to be_json(foo: 1, bar: 2)
@@ -81,14 +96,16 @@ module RSpec
     #   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)
+    def be_json(matcher_or_json_value)
+      if ComposableJSONMatchers.matcher?(matcher_or_json_value)
+        BeJSON.new(matcher_or_json_value, ComposableJSONMatchers.configuration)
+      elsif ComposableJSONMatchers.json_value?(matcher_or_json_value)
+        matcher = matching(matcher_or_json_value)
         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.'
+        raise ArgumentError, 'You must pass a matcher or a JSON value ' \
+                             '(hash, array, numeric, string, true, false, or nil) ' \
+                             'to `be_json` matcher.'
       end
     end
   end

data/lib/rspec/composable_json_matchers/version.rb

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

data/rspec-composable_json_matchers.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rspec/composable_json_matchers/version'
 

metadata

@@ -1,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: rspec-composable_json_matchers
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Yuji Nakayama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2018-05-15 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
+  name: rspec
   prerelease: false
+  type: :runtime
   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
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
-description: 
+description:
 email:
 - nkymyj@gmail.com
 executables: []
@@ -64,7 +64,7 @@ homepage: https://github.com/yujinakayama/rspec-composable_json_matchers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,11 +79,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.13
+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: