jsonapi_spec_helpers 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 319b2470e387e56133c175300436a521422afd02
-  data.tar.gz: 3afed12ece44c28fb3133fc238bd26a9ef9f0992
+  metadata.gz: 2a6f8ea375381fb21a7d8db9415ade8e1d7a8da6
+  data.tar.gz: 202e35d79f5d3798410d0b25fa35830ff6c58dd1
 SHA512:
-  metadata.gz: 3f318974fe29ca4339a596c116b12cda815ba84044ca336555002190c094c67e504d4f55e15b5185ce17c0fff67dc45970c7f9adbb9fca96baa07f45ce93f7f8
-  data.tar.gz: 52d3b95df9f5b7ebe4f52c7322ecd92ab5e8776dd3ce85676457944697194e199f01cc5611c9eebd00f3a438eb957ce390d3988b9872abca110573757a9a4bdd
+  metadata.gz: 8ad84e0cc89b526ccfa0bb1f9375e7c96ae371cf103a66ed4198a832f0cd1465d3a79e437c214f1a847a134681d830cb9e91fdef7e24d2f5457028e352ef14ae
+  data.tar.gz: 556a4ec9df1bfaa1b36b4286704965a9e62b76d078fa95cfaa65ddb90d6727863b72d6c95a5bc180858cfc8a88306a85056661789f018b920e47fd9daa627863

data/lib/jsonapi_spec_helpers.rb

@@ -1,122 +1,22 @@
 require 'json'
 require 'jsonapi_spec_helpers/version'
+require 'jsonapi_spec_helpers/matchers'
+require 'jsonapi_spec_helpers/helpers'
 require 'jsonapi_spec_helpers/payload'
 
-RSpec::Matchers.define :match_payload do |attribute, expected|
-  match do |actual|
-    # cast as_json for things like Time
-    # use as_json instead of to_json for things like hashes
-    if expected.respond_to?(:as_json)
-      actual.as_json == expected.as_json
-    else
-      actual.to_json == expected.to_json
-    end
-  end
-
-  failure_message do |actual|
-    "Expected JSON payload to have key '#{attribute}' == #{expected.inspect} but was #{actual.inspect}"
-  end
-end
-
-RSpec::Matchers.define :have_payload_key do |expected, allow_nil|
-  match do |json|
-    @has_key = json.has_key?(expected.to_s)
-    @has_value = !json[expected.to_s].nil?
-
-    if allow_nil
-      @has_key
-    else
-      @has_key && @has_value
-    end
-  end
-
-  failure_message do |actual|
-    msg = !allow_nil && @has_key ? "nil. Use 'key(:foo, allow_nil: true)' to allow nils" : "not present"
-    "Expected JSON payload to have key '#{expected}' but was #{msg}"
-  end
-
-  failure_message_when_negated do |actual|
-    "Expected JSON payload to NOT have key '#{expected}' but was present"
-  end
-end
-
-RSpec::Matchers.define :be_not_in_payload do |expected|
-  match do |json|
-    false
-  end
-
-  failure_message do |actual|
-    "JSON payload contained unexpected key '#{actual}'"
-  end
-end
-
 module JsonapiSpecHelpers
   def self.included(klass)
+    klass.send(:include, Helpers)
     if defined?(Rails)
       Dir[Rails.root.join('spec/payloads/**/*.rb')].each { |f| require f }
     end
   end
 
-  def json
-    JSON.parse(response.body)
-  end
-
-  def json_item(from: nil)
-    from = json if from.nil?
-    data = from.has_key?('data') ? from['data'] : from
-
-    {}.tap do |item|
-      item['id'] = data['id']
-      item['jsonapi_type'] = data['type']
-      item.merge!(data['attributes']) if data.has_key?('attributes')
-    end
-  end
-
-  def json_items(*indices)
-    items   = []
-    json['data'].each_with_index do |datum, index|
-      included = indices.empty? || indices.include?(index)
-      items << json_item(from: datum) if included
-    end
-    indices.length == 1 ? items[0] : items
-  end
-
-  def json_related_link(payload, assn_name)
-    link = payload['relationships'][assn_name]['links']['related']['href']
-    fail "link for #{assn_name} not found" unless link
-    URI.decode(link)
-  end
-
-  def json_included_types
-    (json['included'] || []).map { |i| i['type'] }.uniq
-  end
-
-  def json_includes(type, *indices)
-    included = (json['included'] || []).select { |data| data['type'] == type }
-    indices  = (0...included.length).to_a if indices.empty?
-    includes = []
-    indices.each do |index|
-      includes << json_item(from: included.at(index))
-    end
-    includes
-  end
-
-  def json_include(type, index = 0)
-    json_includes(type, index)[0]
-  end
-
-  def json_ids(integers = false)
-    ids = json['data'].map { |d| d['id'] }
-    ids.map!(&:to_i) if integers
-    ids
-  end
-
   def assert_payload(name, record, json, &blk)
     unless payload = JsonapiSpecHelpers::Payload.registry[name]
       raise "No payloads registered for '#{name}'"
     end
 
-    # todo dup payload
     if blk
       payload = payload.fork
       payload.instance_eval(&blk)
@@ -128,6 +28,10 @@ module JsonapiSpecHelpers
         if (expect(json).to have_payload_key(attribute, options[:allow_nil])) == true
           unless options[:allow_nil]
             expect(json[attribute.to_s]).to match_payload(attribute, prc.call(record))
+
+            if options[:type]
+              expect(json[attribute.to_s]).to match_type(attribute, options[:type])
+            end
           end
         end
       end

data/lib/jsonapi_spec_helpers/helpers.rb

@@ -0,0 +1,58 @@
+module JsonapiSpecHelpers
+  module Helpers
+    def json
+      JSON.parse(response.body)
+    end
+
+    def json_item(from: nil)
+      from = json if from.nil?
+      data = from.has_key?('data') ? from['data'] : from
+
+      {}.tap do |item|
+        item['id'] = data['id']
+        item['jsonapi_type'] = data['type']
+        item.merge!(data['attributes']) if data.has_key?('attributes')
+      end
+    end
+
+    def json_items(*indices)
+      items   = []
+      json['data'].each_with_index do |datum, index|
+        included = indices.empty? || indices.include?(index)
+        items << json_item(from: datum) if included
+      end
+      indices.length == 1 ? items[0] : items
+    end
+
+    def json_related_link(payload, assn_name)
+      link = payload['relationships'][assn_name]['links']['related']['href']
+      fail "link for #{assn_name} not found" unless link
+      URI.decode(link)
+    end
+
+    def json_included_types
+      (json['included'] || []).map { |i| i['type'] }.uniq
+    end
+
+    def json_includes(type, *indices)
+      included = (json['included'] || []).select { |data| data['type'] == type }
+      indices  = (0...included.length).to_a if indices.empty?
+      includes = []
+      indices.each do |index|
+        includes << json_item(from: included.at(index))
+      end
+      includes
+    end
+
+    def json_include(type, index = 0)
+      json_includes(type, index)[0]
+    end
+
+    def json_ids(integers = false)
+      ids = json['data'].map { |d| d['id'] }
+      ids.map!(&:to_i) if integers
+      ids
+    end
+
+  end
+end

data/lib/jsonapi_spec_helpers/matchers.rb

@@ -0,0 +1,51 @@
+RSpec::Matchers.define :match_payload do |attribute, expected|
+  match do |actual|
+    actual == expected
+  end
+
+  failure_message do |actual|
+    "Expected JSON payload to have key '#{attribute}' == #{expected.inspect} but was #{actual.inspect}"
+  end
+end
+
+RSpec::Matchers.define :match_type do |attribute, type|
+  match do |actual|
+    actual.is_a?(type)
+  end
+
+  failure_message do |actual|
+    "Expected JSON payload key '#{attribute}' to have type #{type} but was #{actual.class}"
+  end
+end
+
+RSpec::Matchers.define :have_payload_key do |expected, allow_nil|
+  match do |json|
+    @has_key = json.has_key?(expected.to_s)
+    @has_value = !json[expected.to_s].nil?
+
+    if allow_nil
+      @has_key
+    else
+      @has_key && @has_value
+    end
+  end
+
+  failure_message do |actual|
+    msg = !allow_nil && @has_key ? "nil. Use 'key(:foo, allow_nil: true)' to allow nils" : "not present"
+    "Expected JSON payload to have key '#{expected}' but was #{msg}"
+  end
+
+  failure_message_when_negated do |actual|
+    "Expected JSON payload to NOT have key '#{expected}' but was present"
+  end
+end
+
+RSpec::Matchers.define :be_not_in_payload do |expected|
+  match do |json|
+    false
+  end
+
+  failure_message do |actual|
+    "JSON payload contained unexpected key '#{actual}'"
+  end
+end

data/lib/jsonapi_spec_helpers/payload.rb

@@ -30,7 +30,9 @@ module JsonapiSpecHelpers
       @no_keys << name
     end
 
-    def key(name, options = {}, &blk)
+    def key(name, *args, &blk)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:type] = args.first
       options[:allow_nil] ||= false
       @no_keys.reject! { |k| k == name }
       prc = blk

data/lib/jsonapi_spec_helpers/version.rb

@@ -1,3 +1,3 @@
 module JsonapiSpecHelpers
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_spec_helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2017-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -113,6 +113,8 @@ files:
 - bin/setup
 - jsonapi_spec_helpers.gemspec
 - lib/jsonapi_spec_helpers.rb
+- lib/jsonapi_spec_helpers/helpers.rb
+- lib/jsonapi_spec_helpers/matchers.rb
 - lib/jsonapi_spec_helpers/payload.rb
 - lib/jsonapi_spec_helpers/version.rb
 homepage: 
@@ -135,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Spec helpers for jsonapi