jsonapi-rspec 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c6811a07f15a3e68d69b7ba45fc6df97c649d21e3b2a8df38fb493c6a20b615
-  data.tar.gz: da564714ee866647007b624ec7c871c2834949ec6a5d7987622f39df15e72458
+  metadata.gz: fa870b24a1c1b3fcd2f6fb783dce03bd6249ddfc4cf3de068213e63aa4ed966e
+  data.tar.gz: eba5c9887ceec4b26b538a4f20337976d4196b28e126052623f9572d1234a65d
 SHA512:
-  metadata.gz: 25715dae1b5adfcfc2e2e327d7042ee035efbd7123dd3bb36be939ff1e412a16bda3765f304ecc6304f446eab52a3584954cc0f0334fff4501143f06f450f81d
-  data.tar.gz: f95632ad22f0b9b74fd5315e39f2ea800c7c1062b53845357d7312f3d1d7831faae4e476c2981d59acef81c2bc510200ecbd33bbced0bdf21a9ccba18f1da8a7
+  metadata.gz: 7d8ce2a95ddd8b843c24ef98856b771ff33c71f351bbc4f848b19eb425924a3814df254e8b8a288c64089caeb175fe54ce7acac263b42e45b5aae8b0919145f0
+  data.tar.gz: 3abf2abeb28e42e6294c36ce3fbd6e5a050ed79d990932614e44166b7f89d71e10bdf59e0b2eec415c3f57e66ebf500e3c75f49e40158660a727bedfc9b0d1fa

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:
@@ -30,6 +25,7 @@ RSpec.configure do |config|
   # Support for documents with mixed string/symbol keys. Disabled by default.
   config.jsonapi_indifferent_hash = true
 end
+```
 
 ## Usage and documentation
 
@@ -41,13 +37,42 @@ 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')`
 * `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')`
+* `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

@@ -1,5 +1,6 @@
 require 'json'
 require 'rspec/matchers'
+require 'rspec/core'
 require 'jsonapi/rspec/id'
 require 'jsonapi/rspec/type'
 require 'jsonapi/rspec/attributes'
@@ -7,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 @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_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/meta.rb

@@ -4,9 +4,17 @@ module JSONAPI
       ::RSpec::Matchers.define :have_meta do |val|
         match do |actual|
           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
 
-          actual.key?('meta') && (!val || actual['meta'] == val)
+        chain :exactly do
+          @exactly = true
         end
       end
     end

data/lib/jsonapi/rspec/relationships.rb

@@ -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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.10
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-10-15 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
@@ -90,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