jsonapi-rspec 0.0.6 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa7320e501ff0cc08655a6e935589d300bedef20bc70add21f64d91d2e053a36
-  data.tar.gz: 1d31cafea53bb133cc8c62c274403bad9aaaa7dfcf4834679bd4cf2dbd246a8c
+  metadata.gz: 1cb9e74645ca848dc856552923c6092f1a50507b46e8a5d3d04c3f74ea8f3853
+  data.tar.gz: 99be94b04361649547d569632dfba13d6b4aff18f28125b0f5c2aef592e2a7f4
 SHA512:
-  metadata.gz: 727c5d55cfa976e4961dfe9798d1767bde29b364d7e4ff33dd52541a12c719c45f67bc021fd179432bd37ae60d26bc8477dce288eadb4b6365d0575570d3c6f0
-  data.tar.gz: bc74dd39b5b8186f7f6d945277f4fd8a091a20f9c33febf4ed52a788ac54778c6d176e20861261d5e7ef60a061cefdaf1fbefb4eaf63ff5163e661ee378ffde0
+  metadata.gz: 37d6572ad5001c856154da99ca102d801457674da382f931b339a501e05ff2e483b4f7bbadb43ae640ca7ff9d3a92e261915db96be9a50d9e3cb40706fc72070
+  data.tar.gz: 5284418148ab647f9b6bed37fc276f8ce97fba88499b564003b7f129238bf3fed2d1f8ec4fa34b491a790c7a0b86b52b343b8001abd149772dbf43a613bd0a9b

data/README.md

@@ -37,6 +37,7 @@ Available matchers:
 * `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')`
@@ -45,6 +46,33 @@ Available matchers:
 * `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')`
+* `expect(document).to have_error('status' => '422')`
+
+### 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
 

data/lib/jsonapi/rspec.rb

@@ -8,6 +8,7 @@ require 'jsonapi/rspec/relationships'
 require 'jsonapi/rspec/links'
 require 'jsonapi/rspec/meta'
 require 'jsonapi/rspec/jsonapi_object'
+require 'jsonapi/rspec/errors'
 
 RSpec.configure do |c|
   c.add_setting :jsonapi_indifferent_hash, default: false

data/lib/jsonapi/rspec/attributes.rb

@@ -1,17 +1,44 @@
 module JSONAPI
   module RSpec
     module Attributes
-      ::RSpec::Matchers.define :have_attribute do |attr|
-        match do |actual|
-          actual = JSONAPI::RSpec.as_indifferent_hash(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 |val|
-          @val_set = true
-          @val = val
+        chain :with_value do |expected_value|
+          @should_match_value = true
+          @expected = expected_value
         end
+
+        description do
+          result = "have attribute #{attr_name.inspect}"
+          result << " with value #{@expected.inspect}" if @should_match_value
+          result
+        end
+
+        failure_message do |_doc|
+          if @has_attribute
+            "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_jsonapi_attributes do |*attrs|

data/lib/jsonapi/rspec/errors.rb

@@ -0,0 +1,19 @@
+module JSONAPI
+  module RSpec
+    module Meta
+      ::RSpec::Matchers.define :have_error do |error|
+        match do |actual|
+          actual = JSONAPI::RSpec.as_indifferent_hash(actual)
+          return false unless actual.key?('errors')
+          return false unless actual['errors'].is_a?(Array)
+
+          return true if actual['errors'].any? && error.nil?
+
+          error = JSONAPI::RSpec.as_indifferent_hash(error)
+
+          actual['errors'].any? { |actual_error| error <= actual_error }
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/rspec/relationships.rb

@@ -15,11 +15,11 @@ module JSONAPI
         end
 
         failure_message do |actual|
-          if !(actual['relationships'] || {}).key?(rel.to_s)
-            "expected #{actual} to have relationship #{rel}"
-          else
+          if (actual['relationships'] || {}).key?(rel.to_s)
             "expected #{actual['relationships'][rel.to_s]} " \
               "to have data #{@data_val}"
+          else
+            "expected #{actual} to have relationship #{rel}"
           end
         end
       end
@@ -29,7 +29,14 @@ module JSONAPI
           actual = JSONAPI::RSpec.as_indifferent_hash(actual)
           return false unless actual.key?('relationships')
 
-          rels.map(&:to_s).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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.11
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -104,6 +104,7 @@ files:
 - README.md
 - lib/jsonapi/rspec.rb
 - lib/jsonapi/rspec/attributes.rb
+- lib/jsonapi/rspec/errors.rb
 - lib/jsonapi/rspec/id.rb
 - lib/jsonapi/rspec/jsonapi_object.rb
 - lib/jsonapi/rspec/links.rb
@@ -129,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: RSpec matchers for JSON API.