wor-simple_crud 0.3.0 → 0.3.1

data/lib/spec/shared_examples/simple_crud_for_new.rb

@@ -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

@@ -2,8 +2,19 @@
 
 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

@@ -2,12 +2,18 @@
 
 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_with_block.rb

@@ -2,10 +2,21 @@
 
 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

@@ -2,20 +2,29 @@
 
 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

@@ -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

@@ -2,7 +2,7 @@
 
 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

@@ -3,7 +3,8 @@
 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/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_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_redirect/dummy_models_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BlockRedirect
+  class DummyModelsController < HtmlModes::BaseController
+    simple_crud_for :destroy, 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/finder/dummy_models_controller.rb

@@ -18,5 +18,6 @@ module Finder
     simple_crud_for :show, finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) }
     simple_crud_for :update, finder: :find_by_slug
     simple_crud_for :destroy, finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) }
+    simple_crud_for :edit, finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) }
   end
 end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module HtmlFinder
+  class DummyModelsController < HtmlModes::BaseController
+    include Pundit::Authorization
+
+    simple_crud_for :show, html: true, authenticate: false, authorize: false,
+                           finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) }
+    simple_crud_for :update, html: true, authenticate: false, authorize: false,
+                             finder: :find_by_slug
+    simple_crud_for :destroy, html: true, authenticate: false, authorize: false,
+                              finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) }
+    simple_crud_for :new, html: true, build: -> { current_user.dummy_models.build }
+    simple_crud_for :edit, html: true, authenticate: false, authorize: false,
+                           finder: ->(params) { DummyModel.find_by!(slug: params[:slug]) }
+  end
+end

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

@@ -3,6 +3,6 @@
 module HtmlScoped
   class DummyModelsController < HtmlModes::BaseController
     simple_crud_for :index, html: true, scope: ->(user) { DummyModel.where(user: user) },
-                            authenticate: false, authorize: false
+                            authorize: false
   end
 end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module UnpaginatedScoped
+  class DummyModelsController < ApplicationController
+    include Wor::Paginate
+    include Pundit::Authorization
+    extend SimpleCrudController
+
+    before_action :set_params
+    def set_params
+      SimpleCrudController.params = params
+    end
+
+    simple_crud_for :index, paginate: false, scope: ->(user) { DummyModel.where(user: user) }
+  end
+end

data/spec/dummy/app/models/dummy_model_policy.rb

@@ -20,6 +20,10 @@ class DummyModelPolicy
     check_user
   end
 
+  def edit?
+    update?
+  end
+
   def create?
     check_user
   end
@@ -33,6 +37,6 @@ class DummyModelPolicy
   end
 
   def index?
-    check_user
+    user.present?
   end
 end

data/spec/dummy/app/views/html_finder/dummy_models/edit.html.erb

@@ -0,0 +1 @@
+<h1>Edit dummy model</h1>

data/spec/dummy/app/views/html_finder/dummy_models/new.html.erb

@@ -0,0 +1 @@
+<h1>New dummy model</h1>

data/spec/dummy/app/views/html_finder/dummy_models/show.html.erb

@@ -0,0 +1 @@
+<span class="record"><%= @record.name %></span>

data/spec/dummy/config/routes.rb

@@ -17,13 +17,25 @@ Rails.application.routes.draw do
   end
 
   namespace :finder do
-    resources :dummy_models, only: %i[show update destroy], param: :slug
+    resources :dummy_models, only: %i[show edit update destroy], param: :slug
+  end
+
+  namespace :html_finder do
+    resources :dummy_models, only: %i[new show edit update destroy], param: :slug
+  end
+
+  namespace :block_finder do
+    resources :dummy_models, only: %i[show edit update destroy], param: :slug
   end
 
   namespace :scoped do
     resources :dummy_models, only: :index
   end
 
+  namespace :unpaginated_scoped do
+    resources :dummy_models, only: :index
+  end
+
   namespace :scoped_params do
     resources :dummy_models, only: :index
   end
@@ -72,6 +84,14 @@ Rails.application.routes.draw do
     resources :dummy_models, only: :destroy
   end
 
+  namespace :block_redirect do
+    resources :dummy_models, only: %i[show destroy]
+  end
+
+  namespace :block_json do
+    resources :dummy_models, only: %i[index show new]
+  end
+
   namespace :built do
     resources :dummy_models, only: %i[new create]
   end

data/spec/dummy_model_policy_spec.rb

@@ -7,15 +7,25 @@ describe DummyModelPolicy do
   let(:other_user) { create(:user) }
   let(:dummy_model) { create(:dummy_model, user: user) }
 
-  %i[destroy? index?].each do |policy_method|
-    describe "##{policy_method}" do
-      it 'allows the owning user' do
-        expect(described_class.new(user, dummy_model).public_send(policy_method)).to be true
-      end
+  describe '#destroy?' do
+    it 'allows the owning user' do
+      expect(described_class.new(user, dummy_model).destroy?).to be true
+    end
+
+    it 'denies a different user' do
+      expect(described_class.new(other_user, dummy_model).destroy?).to be false
+    end
+  end
+
+  # :index authorizes the model class, not an instance, so the policy can
+  # only reason about the user.
+  describe '#index?' do
+    it 'allows any signed-in user' do
+      expect(described_class.new(other_user, dummy_model).index?).to be true
+    end
 
-      it 'denies a different user' do
-        expect(described_class.new(other_user, dummy_model).public_send(policy_method)).to be false
-      end
+    it 'denies an anonymous user' do
+      expect(described_class.new(nil, dummy_model).index?).to be false
     end
   end
 end

data/spec/finder/dummy_models_controller_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'
 
 describe Finder::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'

data/spec/html_finder/dummy_models_controller_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe HtmlFinder::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'
+  include_examples 'simple crud for new with build'
+end

data/spec/html_scoped/dummy_models_controller_spec.rb

@@ -3,5 +3,5 @@
 require 'spec_helper'
 
 describe HtmlScoped::DummyModelsController, type: :controller do
-  include_examples 'simple crud for index'
+  include_examples 'simple crud for index with scope'
 end

data/spec/scoped_params/dummy_models_controller_spec.rb

@@ -2,10 +2,11 @@
 
 require 'spec_helper'
 
-describe ScopedParams::DummyModelsController, type: :controller do
+describe ScopedParams::DummyModelsController, simple_crud: {
+  scoped_attributes: -> { { user: current_user, something: 42 } },
+  other_scoped_attributes: -> { { user: other_user, something: 7 } }
+}, type: :controller do
   include_examples 'simple crud for index with scope' do
-    let(:my_models) { create_list(:dummy_model, 2, user: user, something: 42) }
-    let(:other_models) { create_list(:dummy_model, 1, user: user, something: 7) }
     let(:request_params) { { something: 42 } }
   end
 end

data/spec/simple_crud/rspec_config_spec.rb

@@ -39,6 +39,16 @@ describe SimpleCrud::RSpec do
       end
     end
 
+    it 'derives other_scoped_attributes from model_attributes and the other user' do
+      expect(other_scoped_attributes).to eq(user: other_user)
+    end
+
+    it 'requires a Hash model_attributes before deriving other_scoped_attributes' do
+      with_config_override(:model_attributes, -> { 'not-a-hash' }) do
+        expect { other_scoped_attributes }.to raise_error(ArgumentError, /override other_scoped_attributes instead/)
+      end
+    end
+
     it 'lets settings be overridden and restored', :aggregate_failures do
       original = config.required_attribute
 
@@ -63,5 +73,28 @@ describe SimpleCrud::RSpec do
 
       SimpleCrud::RSpec.configure { |c| c.required_attribute = original }
     end
+
+    it 'falls back to global config when no metadata overrides' do
+      expect(setting(:finder_key)).to eq(:slug)
+    end
+
+    it 'defaults model_attributes to the owner association and current user' do
+      expect(model_attributes).to eq(user: current_user)
+    end
+
+    describe 'with simple_crud metadata',
+             simple_crud: { finder_key: :token, model_attributes: -> { { overridden: true } } } do
+      it 'prefers metadata for overridden settings' do
+        expect(setting(:finder_key)).to eq(:token)
+      end
+
+      it 'still falls back to global config for the rest' do
+        expect(required_attribute).to eq(:name)
+      end
+
+      it 'resolves model_attributes from metadata in the example context' do
+        expect(model_attributes).to eq(overridden: true)
+      end
+    end
   end
 end

data/spec/unpaginated_scoped/dummy_models_controller_spec.rb

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