wor-simple_crud 0.3.0 → 0.4.0

data/lib/spec/shared_examples/simple_crud_for_destroy_with_finder.rb

@@ -1,22 +1,33 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for destroy with finder' do
+RSpec.shared_examples 'simple crud for destroy with finder' do
   describe 'DELETE #destroy with a custom finder' do
-    include_context 'with authenticated user'
+    include_context 'with authenticated user' if check_authenticate(:destroy)
 
     context 'when the model exists' do
       before do
         model
-        delete :destroy, params: with_route_params(finder_key => model.public_send(finder_key))
-      end
-
-      it 'responds with ok status' do
-        expect(response).to have_http_status(:ok)
+        delete :destroy, params: with_route_params(finder_key => model.public_send(finder_key)),
+                         format: request_format(:destroy)
       end
 
       it 'destroys the model' do
         expect(model_class_object.exists?(model.id)).to be false
       end
+
+      if check_block(:destroy)
+        it 'passes the destroyed record to the block' do
+          expect(rendered_record.id).to eq(model.id)
+        end
+      elsif check_html(:destroy)
+        it 'redirects to the collection' do
+          expect(response).to have_http_status(:found)
+        end
+      else
+        it 'responds with ok status' do
+          expect(response).to have_http_status(:ok)
+        end
+      end
     end
 
     include_examples 'simple crud not found with finder', :delete, :destroy

data/lib/spec/shared_examples/simple_crud_for_edit.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'simple crud for edit' do
+  describe 'GET #edit' do
+    subject(:edit_request) { get :edit, params: with_route_params(edit_params), format: request_format(:edit) }
+
+    before do
+      model
+    end
+
+    context 'without authenticated user' do
+      subject!(:req) do
+        get :edit, params: with_route_params(record_param(:edit, model)), format: request_format(:edit)
+      end
+
+      include_examples 'unauthorized when not logged in' if check_authenticate(:edit)
+    end
+
+    if check_authorize(:edit)
+      context 'when the user is not authorized' do
+        include_context 'with authenticated user' if check_authenticate(:edit)
+
+        let(:edit_params) { record_param(:edit, model) }
+
+        before do
+          model
+          make_policies_fail(:edit)
+          edit_request
+        end
+
+        it 'responds with forbidden status' do
+          expect(response).to have_http_status(:forbidden)
+        end
+      end
+    end
+
+    context 'when the model exists' do
+      include_context 'with authenticated user' if check_authenticate(:edit)
+
+      let(:edit_params) { record_param(:edit, model) }
+
+      before do
+        model
+        make_policies_succeed(:edit) if check_authorize(:edit)
+        edit_request
+      end
+
+      it 'responds with ok status' do
+        expect(response).to have_http_status(:ok)
+      end
+
+      if check_block(:edit)
+        it 'renders the asked model through the block' do
+          expect(response).to be_successful
+        end
+      elsif check_html(:edit)
+        include_examples 'simple crud renders template', :edit
+      else
+        it 'returns the asked model' do
+          expect(response_body['id']).to eq(model.id)
+        end
+      end
+    end
+
+    context 'when the model does not exist' do
+      include_context 'with authenticated user'
+
+      let(:edit_params) { record_param(:edit, nil, not_found: true) }
+
+      before do
+        edit_request
+      end
+
+      it 'responds with not found status' do
+        expect(response).to have_http_status(:not_found)
+      end
+    end
+  end
+end

data/lib/spec/shared_examples/simple_crud_for_index.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for index' do
+RSpec.shared_examples 'simple crud for index' do
   describe 'GET #index' do
     let(:created_models) { create_records(model_class, 10, model_attributes) }
 
@@ -13,7 +13,7 @@ shared_examples 'simple crud for index' do
       include_context 'with authenticated user' if check_authenticate(:index)
 
       before do
-        make_policies_succeed(:index)
+        make_policies_succeed(:index) if check_authorize(:index)
         get :index, params: with_route_params({}), format: request_format(:index)
       end
 

data/lib/spec/shared_examples/simple_crud_for_index_with_block.rb

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for index with block' do
+RSpec.shared_examples 'simple crud for index with block' do
   describe 'GET #index with a render block' do
-    let(:created_models) { create_records(model_class, 2, {}) }
+    let(:created_models) { create_records(model_class, 2, model_attributes) }
+
+    include_context 'with authenticated user' if check_authenticate(:index)
 
     before do
       created_models
-      get :index, params: with_route_params({}), format: :html
+      get :index, params: with_route_params({}), format: request_format(:index)
     end
 
-    include_examples 'simple crud renders template', :index
+    if check_html(:index)
+      include_examples 'simple crud renders template', :index
+    else
+      it 'renders the records through the block' do
+        expect(response).to be_successful
+      end
+    end
   end
 end

data/lib/spec/shared_examples/simple_crud_for_index_with_scope.rb

@@ -1,21 +1,33 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for index with scope' do
-  let(:user) { current_user }
-  let(:other_user) { resolve(config.other_user) }
-  let(:my_models) { create_records(model_class, 2, owner_association => user) }
-  let(:other_models) { create_records(model_class, 3, owner_association => other_user) }
+RSpec.shared_examples 'simple crud for index with scope' do
   let(:request_params) { {} }
+  let(:my_models) { create_records(model_class, 2, scoped_attributes) }
+  let(:other_models) { create_records(model_class, 3, other_scoped_attributes) }
 
-  before do
-    authenticate_request
-    make_policies_succeed(:index)
-    my_models
-    other_models
-    get :index, params: with_route_params(request_params)
-  end
+  # Hooks stay inside this context so co-including the example never
+  # authenticates or stubs policies for sibling examples.
+  context 'when listing the scoped records' do
+    before do
+      authenticate_request if check_authenticate(:index)
+      make_policies_succeed(:index) if check_authorize(:index)
+      my_models
+      other_models
+      get :index, params: with_route_params(request_params), format: request_format(:index)
+    end
 
-  it 'returns only the scoped records' do
-    expect(response_body['page'].map { |m| m['id'] }).to match_array(my_models.map(&:id))
+    if check_html(:index)
+      it 'returns only the assigned scoped records' do
+        expect(rendered_records.map(&:id)).to match_array(my_models.map(&:id))
+      end
+    elsif check_paginate(:index)
+      it 'returns only the paginated scoped records' do
+        expect(response_body['page'].map { |m| m['id'] }).to match_array(my_models.map(&:id))
+      end
+    else
+      it 'returns only the unpaginated scoped records' do
+        expect(response_body.map { |m| m['id'] }).to match_array(my_models.map(&:id))
+      end
+    end
   end
 end

data/lib/spec/shared_examples/simple_crud_for_new.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for new' do
+RSpec.shared_examples 'simple crud for new' do
   describe 'GET #new' do
     include_examples 'simple crud without authenticated user', :new
     include_examples 'simple crud when not authorized', :new, :get
@@ -9,7 +9,7 @@ shared_examples 'simple crud for new' do
       include_context 'with authenticated user' if check_authenticate(:new)
 
       before do
-        make_policies_succeed(:new)
+        make_policies_succeed(:new) if check_authorize(:new)
         get :new, params: with_route_params({}), format: request_format(:new)
       end
 

data/lib/spec/shared_examples/simple_crud_for_new_with_block.rb

@@ -1,9 +1,20 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for new with block' do
+RSpec.shared_examples 'simple crud for new with block' do
   describe 'GET #new with a render block' do
-    before { get :new, params: with_route_params({}), format: :html }
+    include_context 'with authenticated user' if check_authenticate(:new)
 
-    include_examples 'simple crud renders template', :new
+    before do
+      make_policies_succeed(:new) if check_authorize(:new)
+      get :new, params: with_route_params({}), format: request_format(:new)
+    end
+
+    if check_html(:new)
+      include_examples 'simple crud renders template', :new
+    else
+      it 'renders the built record through the block' do
+        expect(response).to be_successful
+      end
+    end
   end
 end

data/lib/spec/shared_examples/simple_crud_for_new_with_build.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for new with build' do
+RSpec.shared_examples 'simple crud for new with build' do
   describe 'GET #new with a build hook' do
-    include_context 'with authenticated user'
+    include_context 'with authenticated user' if check_authenticate(:new)
 
-    before { get :new, params: with_route_params({}) }
+    before do
+      get :new, params: with_route_params({}), format: request_format(:new)
+    end
 
-    it 'builds the record owned by the current user' do
-      expect(response_body[owner_foreign_key.to_s]).to eq(current_user.id)
+    it 'builds the record owned by the current user', :aggregate_failures do
+      if check_html(:new) || check_block(:new)
+        expect(rendered_record.public_send(owner_foreign_key)).to eq(current_user.id)
+      else
+        expect(response_body[owner_foreign_key.to_s]).to eq(current_user.id)
+      end
     end
   end
 end

data/lib/spec/shared_examples/simple_crud_for_show.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for show' do
+RSpec.shared_examples 'simple crud for show' do
   describe 'GET #show' do
     subject(:show_request) { get :show, params: with_route_params(show_params), format: request_format(:show) }
 

data/lib/spec/shared_examples/simple_crud_for_show_with_block.rb

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for show with block' do
+RSpec.shared_examples 'simple crud for show with block' do
   describe 'GET #show with a render block' do
+    include_context 'with authenticated user' if check_authenticate(:show)
+
     let!(:record) { model }
 
-    before { get :show, params: with_route_params({ id: record.id }), format: :html }
+    before do
+      make_policies_succeed(:show) if check_authorize(:show)
+      get :show, params: with_route_params(record_param(:show, record)), format: request_format(:show)
+    end
 
-    include_examples 'simple crud renders template', :show
+    if check_html(:show)
+      include_examples 'simple crud renders template', :show
+    else
+      it 'renders the record through the block' do
+        expect(response).to be_successful
+      end
+    end
   end
 end

data/lib/spec/shared_examples/simple_crud_for_show_with_finder.rb

@@ -1,21 +1,30 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for show with finder' do
+RSpec.shared_examples 'simple crud for show with finder' do
   describe 'GET #show with a custom finder' do
-    include_context 'with authenticated user'
+    include_context 'with authenticated user' if check_authenticate(:show)
 
     context 'when the model exists' do
       before do
         model
-        get :show, params: with_route_params(finder_key => model.public_send(finder_key))
+        get :show, params: with_route_params(finder_key => model.public_send(finder_key)),
+                   format: request_format(:show)
       end
 
-      it 'responds with ok status' do
-        expect(response).to have_http_status(:ok)
-      end
+      if check_block(:show)
+        it 'finds the asked model' do
+          expect(rendered_record.id).to eq(model.id)
+        end
+      elsif check_html(:show)
+        include_examples 'simple crud renders template', :show
+      else
+        it 'responds with ok status' do
+          expect(response).to have_http_status(:ok)
+        end
 
-      it 'returns the asked model' do
-        expect(response_body['id']).to eq(model.id)
+        it 'returns the asked model' do
+          expect(response_body['id']).to eq(model.id)
+        end
       end
     end
 

data/lib/spec/shared_examples/simple_crud_for_update.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for update' do
+RSpec.shared_examples 'simple crud for update' do
   describe 'PUT #update' do
     context 'without authenticated user' do
       subject!(:req) do
@@ -54,6 +54,11 @@ shared_examples 'simple crud for update' do
           expect(model_class_object.last).to have_attributes(update_attributes)
         end
       end
+
+      it 'updates a record passing created_record_check', :aggregate_failures do
+        expect(model_class_object.last).to be_present
+        instance_exec(model_class_object.last, &created_record_check) if created_record_check
+      end
     end
 
     context 'when updating a model that doesn\'t exist' do
@@ -84,15 +89,17 @@ shared_examples 'simple crud for update' do
                        format: request_format(:update)
         end
 
-        if check_html(:update)
-          include_examples 'simple crud renders template', :edit, -> { invalid_status }
-        else
-          it 'responds with unprocessable entity' do
-            expect(response).to have_http_status(unprocessable_status)
-          end
-
-          it 'returns the validation errors' do
-            expect(response_body['errors']).to include(required_error)
+        unless check_block(:update)
+          if check_html(:update)
+            include_examples 'simple crud renders template', :edit, -> { invalid_status }
+          else
+            it 'responds with unprocessable entity' do
+              expect(response).to have_http_status(unprocessable_status)
+            end
+
+            it 'returns the validation errors' do
+              expect(response_body['errors']).to include(required_error)
+            end
           end
         end
       end

data/lib/spec/shared_examples/simple_crud_for_update_with_finder.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud for update with finder' do
+RSpec.shared_examples 'simple crud for update with finder' do
   describe 'PUT #update with a custom finder' do
-    include_context 'with authenticated user'
+    include_context 'with authenticated user' if check_authenticate(:update)
 
     context 'when successfully updating a model' do
       let(:update_params) do
@@ -12,16 +12,26 @@ shared_examples 'simple crud for update with finder' do
 
       before do
         model
-        put :update, params: update_params
-      end
-
-      it 'responds with ok status' do
-        expect(response).to have_http_status(:ok)
+        put :update, params: update_params, format: request_format(:update)
       end
 
       it 'updates the model' do
         expect(model.reload.public_send(required_attribute)).to eq('Updated')
       end
+
+      if check_block(:update)
+        it 'passes the updated model to the block' do
+          expect(rendered_record.id).to eq(model.id)
+        end
+      elsif check_html(:update)
+        it 'redirects to the updated record' do
+          expect(response).to have_http_status(:found)
+        end
+      else
+        it 'responds with ok status' do
+          expect(response).to have_http_status(:ok)
+        end
+      end
     end
 
     include_examples 'simple crud not found with finder', :put, :update

data/lib/spec/shared_examples/simple_crud_not_found_with_finder.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud not found with finder' do |http_method, action|
+RSpec.shared_examples 'simple crud not found with finder' do |http_method, action|
   context 'when the model does not exist' do
     before do
-      send(http_method, action, params: with_route_params(finder_key => "nonexistent-#{finder_key}"))
+      send(http_method, action, params: with_route_params(finder_key => "nonexistent-#{finder_key}"),
+                                format: request_format(action))
     end
 
     it 'responds with not found status' do

data/lib/spec/shared_examples/simple_crud_renders_template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud renders template' do |template, status = :ok|
+RSpec.shared_examples 'simple crud renders template' do |template, status = :ok|
   it "renders the #{template} template", :aggregate_failures do
     expect(response).to have_http_status(resolve(status))
     expect(response).to render_template(template) if assert_html_template

data/lib/spec/shared_examples/simple_crud_when_not_authorized.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud when not authorized' do |action, verb, request_params = {}|
+RSpec.shared_examples 'simple crud when not authorized' do |action, verb, request_params = {}|
   if check_authorize(action)
     context 'when not authorized' do
       include_context 'with authenticated user' if check_authenticate(action)

data/lib/spec/shared_examples/simple_crud_without_authenticated_user.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'simple crud without authenticated user' do |action|
+RSpec.shared_examples 'simple crud without authenticated user' do |action|
   context 'without authenticated user' do
     subject!(:req) { get action, params: with_route_params({}) }
 

data/lib/spec/shared_examples/unauthorized_when_not_logged_in.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_examples 'unauthorized when not logged in' do
+RSpec.shared_examples 'unauthorized when not logged in' do
   context 'when the user is not logged in' do
     it 'returns the unauthenticated status' do
       req

data/spec/block_finder/dummy_models_controller_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BlockFinder::DummyModelsController, type: :controller do
+  include_examples 'simple crud for edit'
+  include_examples 'simple crud for show with finder'
+  include_examples 'simple crud for update with finder'
+  include_examples 'simple crud for destroy with finder'
+end

data/spec/block_json/dummy_models_controller_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BlockJson::DummyModelsController, type: :controller do
+  include_examples 'simple crud for index with block'
+  include_examples 'simple crud for show with block'
+  include_examples 'simple crud for new with block'
+end

data/spec/block_redirect/dummy_models_controller_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BlockRedirect::DummyModelsController, type: :controller do
+  include_examples 'simple crud for destroy'
+end

data/spec/dummy/app/controllers/block/dummy_models_controller.rb

@@ -5,12 +5,7 @@ module Block
     include Wor::Paginate
     extend SimpleCrudController
 
-    before_action :set_params
-    def set_params
-      SimpleCrudController.params = params
-    end
-
-    simple_crud_for :index, paginate: false, authenticate: false, authorize: false do |records|
+    simple_crud_for :index, html: true, paginate: false, authenticate: false, authorize: false do |records|
       render :index, locals: { models: records }
     end
   end

data/spec/dummy/app/controllers/block_finder/dummy_models_controller.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlockFinder
+  class DummyModelsController < HtmlModes::BaseController
+    simple_crud_for :show, html: false, authenticate: false, authorize: false,
+                           finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) } do |record|
+      render json: { found_id: record.id }
+    end
+
+    simple_crud_for :update, html: false, authenticate: false, authorize: false,
+                             finder: :find_by_slug do |_record, saved|
+      render json: { updated: saved }
+    end
+
+    simple_crud_for :destroy, html: false, authenticate: false, authorize: false,
+                              finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) } do |_record, destroyed|
+      render json: { destroyed: destroyed }
+    end
+
+    simple_crud_for :edit, html: false, authenticate: false, authorize: false,
+                           finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) } do |record|
+      render json: { edit_id: record.id }
+    end
+  end
+end

data/spec/dummy/app/controllers/block_json/dummy_models_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BlockJson
+  class DummyModelsController < HtmlModes::BaseController
+    simple_crud_for :index, html: false, authenticate: false, authorize: false, paginate: false do |records|
+      render json: { ids: records.map(&:id) }
+    end
+
+    simple_crud_for :show, html: false, authenticate: false, authorize: false do |record|
+      render json: { id: record.id }
+    end
+
+    simple_crud_for :new, html: false, authenticate: false, authorize: false do |record|
+      render json: { id: record.id }
+    end
+  end
+end

data/spec/dummy/app/controllers/block_new/dummy_models_controller.rb

@@ -2,7 +2,7 @@
 
 module BlockNew
   class DummyModelsController < BlockModes::BaseController
-    simple_crud_for :new, authenticate: false, authorize: false do |record|
+    simple_crud_for :new, html: true, authenticate: false, authorize: false do |record|
       render_model(record, :new)
     end
   end

data/spec/dummy/app/controllers/block_redirect/dummy_models_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BlockRedirect
+  class DummyModelsController < HtmlModes::BaseController
+    simple_crud_for :destroy, html: true, authenticate: false, authorize: false do |_record, destroyed|
+      if destroyed
+        redirect_to action: :show, notice: 'removed'
+      else
+        redirect_to action: :show, alert: 'could not remove'
+      end
+    end
+  end
+end

data/spec/dummy/app/controllers/block_show/dummy_models_controller.rb

@@ -2,7 +2,7 @@
 
 module BlockShow
   class DummyModelsController < BlockModes::BaseController
-    simple_crud_for :show, authenticate: false, authorize: false do |record|
+    simple_crud_for :show, html: true, authenticate: false, authorize: false do |record|
       render_model(record, :show)
     end
   end

data/spec/dummy/app/controllers/built/dummy_models_controller.rb

@@ -6,11 +6,6 @@ module Built
     include Pundit::Authorization
     extend SimpleCrudController
 
-    before_action :set_params
-    def set_params
-      SimpleCrudController.params = params
-    end
-
     def dummy_model_params
       params.permit(:name, :something, :user_id, :slug)
     end

data/spec/dummy/app/controllers/dummy_models_controller.rb

@@ -6,11 +6,6 @@ class DummyModelsController < ApplicationController
   include Pundit::Authorization
   extend SimpleCrudController
 
-  before_action :set_params
-  def set_params
-    SimpleCrudController.params = params
-  end
-
   def dummy_model_params
     params.permit(:name, :something, :user_id, :slug)
   end