Improve generators; add 404 support (#66)

Author: richmolj

lib/generators/jsonapi/templates/controller.rb.erb

@@ -39,7 +39,9 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
   <%- end -%>
   def show
     scope = jsonapi_scope(<%= model_klass %>.where(id: params[:id]))
-    render_jsonapi(scope.resolve.first, scope: false)
+    instance = scope.resolve.first
+    raise JsonapiCompliable::Errors::RecordNotFound unless instance
+    render_jsonapi(instance, scope: false)
   end
 
   <%- end -%>
@@ -86,7 +88,7 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
     <%= file_name %>, success = jsonapi_destroy.to_a
 
     if success
-      render_jsonapi(<%= file_name %>, scope: false)
+      render json: { meta: {} }
     else
       render_errors_for(<%= file_name %>)
     end

lib/generators/jsonapi/templates/create_request_spec.rb.erb

@@ -1,7 +1,11 @@
 require 'rails_helper'
 
 RSpec.describe "<%= type %>#create", type: :request do
-  context 'basic create' do
+  subject(:make_request) do
+    jsonapi_post "/<%= api_namespace %>/v1/<%= type %>", payload
+  end
+
+  describe 'basic create' do
     let(:payload) do
       {
         data: {
@@ -15,7 +19,7 @@ RSpec.describe "<%= type %>#create", type: :request do
 
     it 'creates the resource' do
       expect {
-        jsonapi_post "/<%= api_namespace %>/v1/<%= type %>", payload
+        make_request
       }.to change { <%= model_klass %>.count }.by(1)
       <%= file_name %> = <%= model_klass %>.last
 

lib/generators/jsonapi/templates/destroy_request_spec.rb.erb

@@ -1,15 +1,20 @@
 require 'rails_helper'
 
 RSpec.describe "<%= type %>#destroy", type: :request do
-  context 'basic destroy' do
+  subject(:make_request) do
+    jsonapi_delete "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}"
+  end
+
+  describe 'basic destroy' do
     let!(:<%= file_name %>) { create(:<%= file_name %>) }
 
     it 'updates the resource' do
       expect {
-        delete "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}"
+        make_request
       }.to change { <%= model_klass %>.count }.by(-1)
 
-      expect(response.status).to eq(204)
+      expect(response.status).to eq(200)
+      expect(json).to eq('meta' => {})
     end
   end
 end

lib/generators/jsonapi/templates/index_request_spec.rb.erb

@@ -1,13 +1,19 @@
 require 'rails_helper'
 
 RSpec.describe "<%= file_name.pluralize %>#index", type: :request do
-  context 'basic fetch' do
+  let(:params) { {} }
+
+  subject(:make_request) do
+    jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>",
+      params: params
+  end
+
+  describe 'basic fetch' do
     let!(:<%= file_name %>1) { create(:<%= file_name %>) }
     let!(:<%= file_name %>2) { create(:<%= file_name %>) }
 
     it 'serializes the list correctly' do
-      jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>"
-
+      make_request
       expect(json_ids(true)).to match_array([<%= file_name %>1.id, <%= file_name %>2.id])
       assert_payload(:<%= file_name %>, <%= file_name %>1, json_items[0])
       assert_payload(:<%= file_name %>, <%= file_name %>2, json_items[1])

lib/generators/jsonapi/templates/show_request_spec.rb.erb

@@ -1,12 +1,18 @@
 require 'rails_helper'
 
 RSpec.describe "<%= file_name.pluralize %>#show", type: :request do
-  context 'basic fetch' do
+  let(:params) { {} }
+
+  subject(:make_request) do
+    jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>/#{<%= file_name %>.id}",
+      params: params
+  end
+
+  describe 'basic fetch' do
     let!(:<%= file_name %>) { create(:<%= file_name %>) }
 
     it 'serializes the resource correctly' do
-      jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>/#{<%= file_name %>.id}"
-
+      make_request
       assert_payload(:<%= file_name %>, <%= file_name %>, json_item)
     end
   end

lib/generators/jsonapi/templates/update_request_spec.rb.erb

@@ -1,7 +1,11 @@
 require 'rails_helper'
 
 RSpec.describe "<%= type %>#update", type: :request do
-  context 'basic update' do
+  subject(:make_request) do
+    jsonapi_put "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}", payload
+  end
+
+  describe 'basic update' do
     let!(:<%= file_name %>) { create(:<%= file_name %>) }
 
     let(:payload) do
@@ -19,7 +23,7 @@ RSpec.describe "<%= type %>#update", type: :request do
     # Replace 'xit' with 'it' after adding attributes
     xit 'updates the resource' do
       expect {
-        jsonapi_put "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}", payload
+        make_request
       }.to change { <%= file_name %>.reload.attributes }
       assert_payload(:<%= file_name %>, <%= file_name %>, json_item)
 

lib/jsonapi_compliable/errors.rb

@@ -44,5 +44,8 @@ def pretty(input)
         end
       end
     end
+
+    class RecordNotFound < StandardError
+    end
   end
 end