Support filter_run_when_matching :focus with permissions helper

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Improve the `NotAuthorizedError` message to include the policy class.
 Furthermore, in the case where the record passed is a class instead of an instance, the class name is given. (#812)
+- Add support for filter_run_when_matching :focus with permissions helper. (#820)
 
 ## 2.3.2 (2024-05-08)
 

README.md

@@ -824,6 +824,14 @@ which may be desirable when distributing policy specs as documentation.
 An alternative approach to Pundit policy specs is scoping them to a user context as outlined in this
 [excellent post](http://thunderboltlabs.com/blog/2013/03/27/testing-pundit-policies-with-rspec/) and implemented in the third party [pundit-matchers](https://github.com/punditcommunity/pundit-matchers) gem.
 
+### Focus Support
+
+If your RSpec config has `filter_run_when_matching :focus`, you may tag the `permissions` helper like so:
+
+```
+permissions :show?, :focus do
+```
+
 ### Scope Specs
 
 Pundit does not provide a DSL for testing scopes. Test them like you would a regular Ruby class!

lib/pundit/rspec.rb

@@ -69,7 +69,15 @@ def permissions
 
  module DSL
  def permissions(*list, &block)
- describe(list.to_sentence, permissions: list, caller: caller) { instance_eval(&block) }
+ metadata = { permissions: list, caller: caller }
+
+ if list.last == :focus
+ list.pop
+ metadata[:focus] = true
+ end
+
+ description = list.to_sentence
+ describe(description, metadata) { instance_eval(&block) }
  end
  end
 

spec/dsl_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+RSpec.describe "Pundit RSpec DSL" do
+ let(:fake_rspec) do
+ double = class_double(RSpec::ExampleGroups)
+ double.extend(::Pundit::RSpec::DSL)
+ allow(double).to receive(:describe).and_yield
+ double
+ end
+ let(:block) { proc { "block content" } }
+
+ it "calls describe with the correct metadata and without :focus" do
+ expect { |block| fake_rspec.permissions(:item1, :item2, &block) }.to yield_control
+
+ expected_metadata = { permissions: %i[item1 item2], caller: instance_of(Array) }
+ expect(fake_rspec).to receive(:describe).with("item1 and item2", match(expected_metadata)) do |&block|
+ expect(block.call).to eq("block content")
+ end
+
+ fake_rspec.permissions(:item1, :item2, &block)
+ end
+
+ it "calls describe with the correct metadata and with :focus" do
+ expect { |block| fake_rspec.permissions(&block) }.to yield_control
+
+ expected_metadata = { permissions: %i[item1 item2], caller: instance_of(Array), focus: true }
+ expect(fake_rspec).to receive(:describe).with("item1 and item2", match(expected_metadata)) do |&block|
+ expect(block.call).to eq("block content")
+ end
+
+ fake_rspec.permissions(:item1, :item2, :focus, &block)
+ end
+end