jsonapi-rspec 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2be5ed3e2b2ccdb4cee1028850cfc2c881ce15f6
-  data.tar.gz: 96c0c548a215f89d66b65ad1335cec161743afe9
+SHA256:
+  metadata.gz: 5cb345693bd692513446e88fa4d1713b7927afa9b3a3033270ac26daefe3c07f
+  data.tar.gz: 8bc079f20dc7cd85e29b2a51f2d44e511d09153809507dbc4f361b55d79caf8e
 SHA512:
-  metadata.gz: 2f9da5bfd20dc32a38d928744640f3490bcf443cbfd1e0ed1e987884caf3a31ad5db75e3a8bddd1716002655cbbe05bd91a0ae30e0be7f22b61addce281a6857
-  data.tar.gz: 1f3146f7d30fcd120722539a0e6fd778577bd9574fccf06d60fc8b5cfcb014a6161b33002576fddba31a6a761198e97f4c37c4c7b28c4a567bb34e4f51b4e1f9
+  metadata.gz: 15c13b39490b4a72ef66e1aeed229665aacf8b98a0b3f2dfc8063d4b9dfa18190edb2c9a783cf921f23c0f5553d408065626669f4c39b7fa4cbdfb991e2e559e
+  data.tar.gz: e82b0d326630160bf704058b38068de72521670715280fbdf1539d17b725cb1e721167ff5e2ed830f73baa45bf100ed1f999589ef7392a0b19254bbb500b87f3

data/README.md

@@ -2,17 +2,6 @@
 
 RSpec matchers for [JSON API](http://jsonapi.org).
 
-## Status
-
-[![Gem Version](https://badge.fury.io/rb/jsonapi-rspec.svg)](https://badge.fury.io/rb/jsonapi-rspec)
-[![Build Status](https://secure.travis-ci.org/jsonapi-rb/jsonapi-rspec.svg?branch=master)](http://travis-ci.org/jsonapi-rb/jsonapi-rspec?branch=master)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/jsonapi-rb/Lobby)
-
-## Resources
-
-* Chat: [gitter](http://gitter.im/jsonapi-rb)
-* Twitter: [@jsonapirb](http://twitter.com/jsonapirb)
-
 ## Installation
 
 Add the following to your application's Gemfile:
@@ -28,9 +17,13 @@ Add to your `spec/spec_helpers.rb`:
 
 ```ruby
 # spec/spec_helpers.rb
+require 'jsonapi/rspec'
+
 RSpec.configure do |config|
-  # ...
   config.include JSONAPI::RSpec
+
+  # Support for documents with mixed string/symbol keys. Disabled by default.
+  config.jsonapi_indifferent_hash = true
 end
 ```
 
@@ -40,14 +33,17 @@ Available matchers:
 
 * `expect(document['data']).to have_id('12')`
 * `expect(document['data']).to have_type('users')`
-* `expect(document['data']).to have_attributes(:name, :email)`
+* `expect(document['data']).to have_jsonapi_attributes(:name, :email)`
+* `expect(document['data']).to have_jsonapi_attributes(:name, :email, :country).exactly`
 * `expect(document['data']).to have_attribute(:name).with_value('Lucas')`
 * `expect(document['data']).to have_relationships(:posts, :comments)`
+* `expect(document['data']).to have_relationships(:posts, :comments, :likes).exactly`
 * `expect(document['data']).to have_relationship(:posts).with_data([{ 'id' => '1', 'type' => 'posts' }])`
 * `expect(document['data']['relationships']['posts']).to have_links(:self, :related)`
 * `expect(document['data']).to have_link(:self).with_value('http://api.example.com/users/12')`
 * `expect(document).to have_meta`
 * `expect(document).to have_meta('foo' => 'bar')`
+* `expect(document).to have_meta('foo' => 'bar', 'fum' => 'baz').exactly`
 * `expect(document).to have_jsonapi_object`
 * `expect(document).to have_jsonapi_object('version' => '1.0')`
 
@@ -59,6 +55,14 @@ Checking for an included resource:
 expect(response_body['included'])
   .to include(have_type('posts').and have_id('1'))
 ```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jsonapi-rb/jsonapi-rspec
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/jsonapi/rspec.rb

@@ -1,3 +1,6 @@
+require 'json'
+require 'rspec/matchers'
+require 'rspec/core'
 require 'jsonapi/rspec/id'
 require 'jsonapi/rspec/type'
 require 'jsonapi/rspec/attributes'
@@ -6,6 +9,10 @@ require 'jsonapi/rspec/links'
 require 'jsonapi/rspec/meta'
 require 'jsonapi/rspec/jsonapi_object'
 
+RSpec.configure do |c|
+  c.add_setting :jsonapi_indifferent_hash, default: false
+end
+
 module JSONAPI
   module RSpec
     include Id
@@ -15,5 +22,15 @@ module JSONAPI
     include Links
     include Meta
     include JsonapiObject
+
+    def self.as_indifferent_hash(doc)
+      return doc unless ::RSpec.configuration.jsonapi_indifferent_hash
+
+      if doc.respond_to?(:with_indifferent_access)
+        return doc.with_indifferent_access
+      end
+
+      JSON.parse(JSON.generate(doc))
+    end
   end
 end

data/lib/jsonapi/rspec/attributes.rb

@@ -3,21 +3,64 @@ module JSONAPI
     module Attributes
       ::RSpec::Matchers.define :have_attribute do |attr|
         match do |actual|
-          (actual['attributes'] || {}).key?(attr.to_s) &&
-            (!@val_set || actual['attributes'][attr.to_s] == @val)
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
+          @attributes_node = actual['attributes']
+
+          return false unless @attributes_node
+
+          @has_attribute = @attributes_node.key?(attr.to_s)
+          if @has_attribute && @should_match_value
+            @actual_value = @attributes_node[attr.to_s]
+
+            # Work nicely with diffable
+            @actual = @actual_value
+            @expected = @expected_value
+
+            return @actual == @expected
+          end
+          @has_attribute
+        end
+
+        chain :with_value do |expected_value|
+          @should_match_value = true
+          @expected_value = expected_value
         end
 
-        chain :with_value do |val|
-          @val_set = true
-          @val = val
+        description do
+          result = "have attribute #{attr.inspect}"
+          if @should_match_value
+            result << " with value #{@expected_value.inspect}"
+          end
+          result
         end
+
+        failure_message do |_actual|
+          if @has_attribute
+            "expected `#{attr}` attribute " \
+              "to have value `#{@expected}` but was `#{@actual}`"
+          else
+            "expected attributes to include `#{attr}`. " \
+              "Actual attributes were #{@attributes_node.keys}"
+          end
+        end
+
+        diffable
+        attr_reader :actual, :expected
       end
 
-      ::RSpec::Matchers.define :have_attributes do |*attrs|
+      ::RSpec::Matchers.define :have_jsonapi_attributes do |*attrs|
         match do |actual|
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
           return false unless actual.key?('attributes')
 
-          attrs.all? { |attr| actual['attributes'].key?(attr.to_s) }
+          counted = (attrs.size == actual['attributes'].size) if @exactly
+
+          (attrs.map(&:to_s) - actual['attributes'].keys).empty? &&
+            (counted == @exactly)
+        end
+
+        chain :exactly do
+          @exactly = true
         end
       end
     end

data/lib/jsonapi/rspec/id.rb

@@ -2,7 +2,9 @@ module JSONAPI
   module RSpec
     module Id
       ::RSpec::Matchers.define :have_id do |expected|
-        match { |actual| actual['id'] == expected }
+        match do |actual|
+          JSONAPI::RSpec.as_indifferent_hash(actual)['id'] == expected
+        end
       end
     end
   end

data/lib/jsonapi/rspec/jsonapi_object.rb

@@ -3,8 +3,10 @@ module JSONAPI
     module JsonapiObject
       ::RSpec::Matchers.define :have_jsonapi_object do |val|
         match do |actual|
-          actual.key?('jsonapi') &&
-            (!val || actual['jsonapi'] == val)
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
+          val = JSONAPI::RSpec.as_indifferent_hash(val)
+
+          actual.key?('jsonapi') && (!val || actual['jsonapi'] == val)
         end
       end
     end

data/lib/jsonapi/rspec/links.rb

@@ -3,8 +3,9 @@ module JSONAPI
     module Links
       ::RSpec::Matchers.define :have_link do |link|
         match do |actual|
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
           actual.key?('links') && actual['links'].key?(link.to_s) &&
-            (!@val_set || actual['links'] == @val)
+            (!@val_set || actual['links'][link.to_s] == @val)
         end
 
         chain :with_value do |val|
@@ -15,6 +16,7 @@ module JSONAPI
 
       ::RSpec::Matchers.define :have_links do |*links|
         match do |actual|
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
           return false unless actual.key?('links')
 
           links.all? { |link| actual['links'].key?(link.to_s) }

data/lib/jsonapi/rspec/meta.rb

@@ -3,8 +3,18 @@ module JSONAPI
     module Meta
       ::RSpec::Matchers.define :have_meta do |val|
         match do |actual|
-          actual.key?('meta') &&
-            (!val || actual['meta'] == val)
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
+          return false unless actual.key?('meta')
+          return true unless val
+
+          val = JSONAPI::RSpec.as_indifferent_hash(val)
+          return false unless val <= actual['meta']
+
+          !@exactly || (@exactly && val.size == actual['meta'].size)
+        end
+
+        chain :exactly do
+          @exactly = true
         end
       end
     end

data/lib/jsonapi/rspec/relationships.rb

@@ -3,6 +3,7 @@ module JSONAPI
     module Relationships
       ::RSpec::Matchers.define :have_relationship do |rel|
         match do |actual|
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
           return false unless (actual['relationships'] || {}).key?(rel.to_s)
 
           !@data_set || actual['relationships'][rel.to_s]['data'] == @data_val
@@ -10,23 +11,32 @@ module JSONAPI
 
         chain :with_data do |val|
           @data_set = true
-          @data_val = val
+          @data_val = JSONAPI::RSpec.as_indifferent_hash(val)
         end
 
         failure_message do |actual|
           if !(actual['relationships'] || {}).key?(rel.to_s)
             "expected #{actual} to have relationship #{rel}"
           else
-            "expected #{actual['relationships'][rel.to_s]} to have data #{@data_val}"
+            "expected #{actual['relationships'][rel.to_s]} " \
+              "to have data #{@data_val}"
           end
         end
       end
 
       ::RSpec::Matchers.define :have_relationships do |*rels|
         match do |actual|
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
           return false unless actual.key?('relationships')
 
-          rels.all? { |rel| actual['relationships'].key?(rel) }
+          counted = (rels.size == actual['relationships'].keys.size) if @exactly
+
+          rels.map(&:to_s).all? { |rel| actual['relationships'].key?(rel) } \
+            && (counted == @exactly)
+        end
+
+        chain :exactly do
+          @exactly = true
         end
       end
     end

data/lib/jsonapi/rspec/type.rb

@@ -2,7 +2,9 @@ module JSONAPI
   module RSpec
     module Type
       ::RSpec::Matchers.define :have_type do |expected|
-        match { |actual| actual['type'] == expected }
+        match do |actual|
+          JSONAPI::RSpec.as_indifferent_hash(actual)['type'] == expected
+        end
       end
     end
   end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  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: rspec-expectations
+  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: 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
@@ -25,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop-performance
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: RSpec matchers for JSON API.