Support default Pundint policy class.

Sebastian Nowak · timoschilling · commit c93f6f49c6d4 · 2014-11-03T21:51:34.000+01:00
basic form @seban on #3323, with changes from @timoschilling
diff --git a/lib/active_admin/pundit_adapter.rb b/lib/active_admin/pundit_adapter.rb
@@ -2,6 +2,9 @@
 
 require 'pundit'
 
+# Add a setting to the application to configure the pundit default policy
+ActiveAdmin::Application.inheritable_setting :pundit_default_policy, nil
+
 module ActiveAdmin
 
   class PunditAdapter < AuthorizationAdapter
@@ -17,6 +20,12 @@ def scope_collection(collection, action = Auth::READ)
       # scoping is appliable only to read/index action
       # which means there is no way how to scope other actions
       Pundit.policy_scope!(user, collection)
+    rescue Pundit::NotDefinedError => e
+      if default_policy_class && default_policy_class.const_defined?(:Scope)
+        default_policy_class::Scope.new(user, collection).resolve
+      else
+        raise e
+      end
     end
 
     def retrieve_policy(subject)
@@ -25,6 +34,12 @@ def retrieve_policy(subject)
       when Class then Pundit.policy!(user, subject.new)
       else Pundit.policy!(user, subject)
       end
+    rescue Pundit::NotDefinedError => e
+      if default_policy_class
+        default_policy(user, subject)
+      else
+        raise e
+      end
     end
 
     def format_action(action, subject)
@@ -38,6 +53,16 @@ def format_action(action, subject)
       end
     end
 
+    private
+
+    def default_policy_class
+      ActiveAdmin.application.pundit_default_policy && ActiveAdmin.application.pundit_default_policy.constantize
+    end
+
+    def default_policy(user, subject)
+      default_policy_class.new(user, subject)
+    end
+
   end
 
 end
diff --git a/lib/generators/active_admin/install/templates/active_admin.rb.erb b/lib/generators/active_admin/install/templates/active_admin.rb.erb
@@ -65,6 +65,11 @@ ActiveAdmin.setup do |config|
   # CanCanAdapter or make your own. Please refer to documentation.
   # config.authorization_adapter = ActiveAdmin::CanCanAdapter
 
+  # In case you prefer Pundit over other solutions you can here pass
+  # the name of default policy class. This policy will be used in every
+  # case when Pundit is unable to find suitable policy.
+  # config.pundit_default_policy = "MyDefaultPunditPolicy"
+
   # You can customize your CanCan Ability class name here.
   # config.cancan_ability_class = "Ability"
 
diff --git a/spec/unit/pundit_adapter_spec.rb b/spec/unit/pundit_adapter_spec.rb
@@ -1,5 +1,21 @@
 require 'rails_helper'
 
+class DefaultPolicy < ApplicationPolicy
+  class Scope
+
+    attr_reader :user, :scope
+
+    def initialize(user, scope)
+      @user = user
+      @scope = scope
+    end
+
+    def resolve
+      scope
+    end
+  end
+end
+
 describe ActiveAdmin::PunditAdapter do
 
   describe "full integration" do
@@ -8,6 +24,8 @@
     let(:namespace) { ActiveAdmin::Namespace.new(application, "Admin") }
     let(:resource) { namespace.register(Post) }
     let(:auth) { namespace.authorization_adapter.new(resource, double) }
+    let(:default_policy_klass) { DefaultPolicy }
+    let(:default_policy_klass_name) { "DefaultPolicy" }
 
     before do
       namespace.authorization_adapter = ActiveAdmin::PunditAdapter
@@ -31,6 +49,31 @@ def resolve
       auth.scope_collection(collection, :read)
       expect(collection).to eq collection
     end
+
+    context 'when Pundit is unable to find policy scope' do
+      let(:collection) { double("collection", to_sym: :collection) }
+      subject(:scope) { auth.scope_collection(collection, :read) }
+
+      before do
+        allow(ActiveAdmin.application).to receive(:pundit_default_policy).and_return default_policy_klass_name
+        allow(Pundit).to receive(:policy_scope!) { raise Pundit::NotDefinedError.new }
+      end
+
+      it("should return default policy's scope if defined") { is_expected.to eq(collection) }
+    end
+
+    context "when Pundit is unable to find policy" do
+      let(:record) { double }
+
+      subject(:policy) { auth.retrieve_policy(record) }
+
+      before do
+        allow(ActiveAdmin.application).to receive(:pundit_default_policy).and_return default_policy_klass_name
+        allow(Pundit).to receive(:policy!) { raise Pundit::NotDefinedError.new }
+      end
+
+      it("should return default policy instance") { is_expected.to be_instance_of(default_policy_klass) }
+    end
   end
 
 end
