jsonapi-rspec 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b878b8a4ec8f73194ed8abe2b544e1495d19d0ccc5a430a5696993cf63c4f4a7
-  data.tar.gz: 94be8756e49e6a50ce5723f9acd6982791b2a00cdfd7ad2c078189ec9190175a
+  metadata.gz: 52b2400bcac651bfc0b4c8421d716c79fbaf2e18041a2eef042fe610ed07d6e9
+  data.tar.gz: 4222824ea957fe826a5d2e6fc7cf2bccfbe05abd012047809ea1e88ad75b426c
 SHA512:
-  metadata.gz: 214b267455042c80a12476e976d7c4567dc21e8aa6239b29e97e6f55b2aab9285caefe39ab7af84c42090fd9792f97b2044b0a941277dc5cbf60b7ce95c284d2
-  data.tar.gz: 6a2926acda88bb36be7455fabbfea98013c545032156b4375d2ab09b419bc23e67e26a03478c35a16cfeafa2140281e1053f1c2f3ed77bf6029a1fd40421c8f5
+  metadata.gz: 7aaf222387bac2360894059c1dea6b82e8c954518d6ed36aad4381784b40d08f93c12dea33d56c6eb07efaf7b8c2da37a40ef3ac68d37bbf0400aab2f173cc7d
+  data.tar.gz: 8322947de5e6a2832e1fa0813ce26a4a1db01f9b1fe7fc0236e9f66913f597386144454363cb184f252f178fe9001be86e6220e6ea94cef95313307aa06e2949

data/README.md

@@ -2,11 +2,6 @@
 
 RSpec matchers for [JSON API](http://jsonapi.org).
 
-## Resources
-
-* Chat: [gitter](http://gitter.im/jsonapi-rb)
-* Twitter: [@jsonapirb](http://twitter.com/jsonapirb)
-
 ## Installation
 
 Add the following to your application's Gemfile:
@@ -25,8 +20,10 @@ Add to your `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
 ```
 
@@ -36,17 +33,46 @@ 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')`
 
+### On matcher arguments...
+
+**Note**: JSON:API spec requires JSON documents, thus attribute, relationship
+and link matcher arguments will always be converted into strings for
+consistency!!!
+
+Basically, the tests bellow are absolutely equal:
+
+```ruby
+expect(document['data']).to have_id(12)
+expect(document['data']).to have_id('12')
+
+expect(document['data']).to have_type(:users)
+expect(document['data']).to have_type('users')
+
+expect(document['data']).to have_jsonapi_attributes(:name, :email)
+expect(document['data']).to have_jsonapi_attributes('name', 'email')
+```
+
+The JSON:API spec also requires the `id` and `type` to be strings, so any other
+argument passed will also be converted into a string.
+
+If the document you are trying to test has mixed string/symbol keys, just
+configure matchers to be indifferent in that regard, using the
+`jsonapi_indifferent_hash = true` configuration option.
+
 ## Advanced examples
 
 Checking for an included resource:

data/lib/jsonapi/rspec.rb

@@ -1,4 +1,6 @@
+require 'json'
 require 'rspec/matchers'
+require 'rspec/core'
 require 'jsonapi/rspec/id'
 require 'jsonapi/rspec/type'
 require 'jsonapi/rspec/attributes'
@@ -7,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
@@ -16,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

@@ -1,23 +1,59 @@
 module JSONAPI
   module RSpec
     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)
+      ::RSpec::Matchers.define :have_attribute do |attr_name|
+        match do |doc|
+          doc = JSONAPI::RSpec.as_indifferent_hash(doc)
+          attributes_node = doc['attributes']
+
+          return false unless attributes_node
+
+          @existing_attributes = attributes_node.keys
+          @has_attribute = attributes_node.key?(attr_name.to_s)
+          @actual = attributes_node[attr_name.to_s]
+
+          return @actual == @expected if @has_attribute && @should_match_value
+
+          @has_attribute
+        end
+
+        chain :with_value do |expected_value|
+          @should_match_value = true
+          @expected = expected_value
         end
 
-        chain :with_value do |val|
-          @val_set = true
-          @val = val
+        description do
+          result = "have attribute #{attr_name.inspect}"
+          result << " with value #{@expected.inspect}" if @should_match_value
+          result
         end
+
+        failure_message do |_doc|
+          if @actual
+            "expected `#{attr_name}` attribute " \
+              "to have value `#{@expected}` but was `#{@actual}`"
+          else
+            "expected attributes to include `#{attr_name}`. " \
+              "Actual attributes were #{@existing_attributes}"
+          end
+        end
+
+        diffable
       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.to_s
+        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,6 +3,7 @@ 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'][link.to_s] == @val)
         end
@@ -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.to_s
+        end
       end
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-07-30 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
@@ -24,6 +38,20 @@ dependencies:
     - - ">="
       - !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
@@ -39,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: RSpec matchers for JSON API.