Refactor tests.

Author: beauby

jsonapi-rails.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'rake',        '~> 11.3'
   spec.add_development_dependency 'rspec-rails', '~> 3.5'
+  spec.add_development_dependency 'dry-validation', '~> 0.10.3'
 end

spec/dummy/app/controllers/tweets_controller.rb

@@ -4,7 +4,12 @@ class TweetsController < ActionController::Base
   def index
     tweets = Tweet.all
 
-    render jsonapi: tweets
+    render jsonapi: tweets,
+           jsonapi_object: { version: '1.0' },
+           meta: { foo: 'bar' },
+           links: {
+             self: 'http://foo.bar'
+           }
   end
 
   def show

spec/rails_helper.rb

@@ -6,6 +6,7 @@
 require 'spec_helper'
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
+require 'dry-validation'
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
@@ -55,3 +56,40 @@
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
 end
+
+# Custom RSpec matchers
+module JSONAPI
+  module RSpec
+    class BeValidJsonapiMatcher
+      def matches?(body)
+        JSONAPI.parse_response!(JSON.parse(body))
+        true
+      end
+    end
+
+    def be_valid_jsonapi
+      BeValidJsonapiMatcher.new
+    end
+
+    class MatchSchemaMatcher
+      def matches?(body, &block)
+        schema = Dry::Validation.Schema(&block)
+        @body = JSON.parse(body) unless body.is_a?(Hash)
+        @result = schema.call(@body.with_indifferent_access)
+        @result.success?
+      end
+
+      def failure_message
+        "#{@body} #{@result.errors}"
+      end
+    end
+
+    def match_schema(&block)
+      MatchSchemaMatcher.new(&block)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include JSONAPI::RSpec
+end

spec/requests/crud_spec.rb

@@ -10,15 +10,19 @@ def body
   end
 
   it 'works' do
+    # Get empty tweets list
     get '/tweets', headers: headers
     expect(response).to be_success
     expect(response).to have_http_status(200)
-    expected = {
-      'data' => []
-    }
-    expect { JSONAPI.parse_response!(body) }.not_to raise_error
-    expect(body).to eq(expected)
+    expect(response.body).to be_valid_jsonapi
+    expect(response.body).to match_schema do
+      required(:data).value(eql?: [])
+      required(:meta).value(eql?: { 'foo' => 'bar' })
+      required(:jsonapi).value(eql?: { 'version' => '1.0' })
+      required(:links).value(eql?: { 'self' => 'http://foo.bar' })
+    end
 
+    # Post first tweet
     params = {
       data: {
         type: 'tweets',
@@ -41,9 +45,21 @@ def body
          headers: headers.merge('CONTENT_TYPE' => 'application/vnd.api+json')
     expect(response).to be_success
     expect(response).to have_http_status(201)
-    expect { JSONAPI.parse_response!(body) }.not_to raise_error
+    expect(response.body).to be_valid_jsonapi
+    expect(response.body).to match_schema do
+      required(:data).schema do
+        required(:type).value(eql?: 'tweets')
+        required(:attributes).schema do
+          required(:content).value(eql?: 'foo')
+        end
+        required(:relationships).schema do
+          required(:author)
+        end
+      end
+    end
     first_tweet = body
 
+    # Post second tweet
     params = {
       data: {
         type: 'tweets',
@@ -61,20 +77,23 @@ def body
     expect { JSONAPI.parse_response!(body) }.not_to raise_error
     second_tweet = body
 
+    # Get first tweet
     get "/tweets/#{first_tweet['data']['id']}", headers: headers
     expect(response).to be_success
     expect(response).to have_http_status(200)
-    expect { JSONAPI.parse_response!(body) }.not_to raise_error
+    expect(response.body).to be_valid_jsonapi
     expect(body).to eq(first_tweet)
 
+    # Delete first tweet
     delete "/tweets/#{first_tweet['data']['id']}"
     expect(response).to be_success
     expect(response).to have_http_status(204)
 
+    # List remaining tweets
     get '/tweets'
     expect(response).to be_success
     expect(response).to have_http_status(200)
-    expect { JSONAPI.parse_response!(body) }.not_to raise_error
+    expect(response.body).to be_valid_jsonapi
     expect(body['data'].first).to eq(second_tweet['data'])
   end
 end