Fix matcher args consitency based on JSON:API spec. Closes #19

Author: stas

.rubocop.yml

@@ -15,6 +15,6 @@ Style/IfUnlessModifier:
   Enabled: false
 
 Metrics/BlockLength:
-  Max: 35
+  Max: 30
   Exclude:
     - 'spec/*/*_spec.rb'

README.md

@@ -47,6 +47,32 @@ Available matchers:
 * `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:

lib/jsonapi/rspec/attributes.rb

@@ -1,51 +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)
-          @attributes_node = actual['attributes']
+      ::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
+          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]
+          @existing_attributes = attributes_node.keys
+          @has_attribute = attributes_node.key?(attr_name.to_s)
+          @actual = attributes_node[attr_name.to_s]
 
-            # Work nicely with diffable
-            @actual = @actual_value
-            @expected = @expected_value
+          return @actual == @expected if @has_attribute && @should_match_value
 
-            return @actual == @expected
-          end
           @has_attribute
         end
 
         chain :with_value do |expected_value|
           @should_match_value = true
-          @expected_value = expected_value
+          @expected = expected_value
         end
 
         description do
-          result = "have attribute #{attr.inspect}"
-          if @should_match_value
-            result << " with value #{@expected_value.inspect}"
-          end
+          result = "have attribute #{attr_name.inspect}"
+          result << " with value #{@expected.inspect}" if @should_match_value
           result
         end
 
-        failure_message do |_actual|
-          if @has_attribute
-            "expected `#{attr}` attribute " \
+        failure_message do |_doc|
+          if @actual
+            "expected `#{attr_name}` attribute " \
               "to have value `#{@expected}` but was `#{@actual}`"
           else
-            "expected attributes to include `#{attr}`. " \
-              "Actual attributes were #{@attributes_node.keys}"
+            "expected attributes to include `#{attr_name}`. " \
+              "Actual attributes were #{@existing_attributes}"
           end
         end
 
         diffable
-        attr_reader :actual, :expected
       end
 
       ::RSpec::Matchers.define :have_jsonapi_attributes do |*attrs|

lib/jsonapi/rspec/id.rb

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

lib/jsonapi/rspec/type.rb

@@ -3,7 +3,7 @@ module RSpec
     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