fix: make rspec dsl show source test code snippets

Author: palkan

lib/action_policy/rspec/dsl.rb

@@ -5,38 +5,27 @@ module RSpec # :nodoc: all
     module DSL
       %w[describe fdescribe xdescribe].each do |meth|
         class_eval <<~CODE, __FILE__, __LINE__ + 1
-          def #{meth}_rule(policy_rule, *args, **kwargs)
-            #{meth}("#\#{policy_rule}", *args, **kwargs) do
-              let(:rule) { policy_rule }
-
-              subject do
-                policy.apply(rule)
-                policy.result
-              end
-
-              instance_eval(&Proc.new) if block_given?
-            end
+          def #{meth}_rule(rule, *args, &block)
+            find_and_eval_shared("context", "action_policy:policy_rule_context", caller.first, rule, *args, method: :#{meth}, block: block)
           end
         CODE
       end
 
       ["", "f", "x"].each do |prefix|
         class_eval <<~CODE, __FILE__, __LINE__ + 1
-          def #{prefix}succeed(*args, **kwargs)
-            context(*args) do
+          def #{prefix}succeed(msg = "succeeds", *args, **kwargs)
+            the_caller = caller
+            #{prefix}context(msg, *args, **kwargs) do
               instance_eval(&Proc.new) if block_given?
-              #{prefix}it "succeeds", kwargs do
-                is_expected.to be_success, "Expected succeed but failed:\n\#{formatted_policy(policy)}"
-              end
+              find_and_eval_shared("examples", "action_policy:policy_rule_example", the_caller.first, true, the_caller)
             end
           end
 
-          def #{prefix}failed(*args, **kwargs)
-            context(*args) do
+          def #{prefix}failed(msg = "fails", *args, **kwargs)
+            the_caller = caller
+            #{prefix}context(msg, *args, **kwargs) do
               instance_eval(&Proc.new) if block_given?
-              #{prefix}it "fails", kwargs do
-                is_expected.to be_fail, "Expected to fail but succeed:\n\#{formatted_policy(policy)}"
-              end
+              find_and_eval_shared("examples", "action_policy:policy_rule_example", the_caller.first, false, the_caller)
             end
           end
         CODE
@@ -47,8 +36,6 @@ module PolicyExampleGroup
       def self.included(base)
         base.metadata[:type] = :policy
         base.extend ActionPolicy::RSpec::DSL
-        base.let(:record) { nil }
-        base.let(:policy) { described_class.new(record, context) }
         super
       end
 
@@ -60,11 +47,57 @@ def formatted_policy(policy)
 end
 
 if defined?(::RSpec)
-  RSpec.configure do |config|
+  ::RSpec.shared_context "action_policy:policy_context" do
+    let(:record) { nil }
+    let(:context) { {} }
+    let(:policy) { described_class.new(record, context) }
+  end
+
+  ::RSpec.shared_context "action_policy:policy_rule_context" do |policy_rule, *args, method: "describe", block: nil|
+    public_send(method, policy_rule.to_s, *args) do
+      let(:rule) { policy_rule }
+
+      let(:subject) do
+        policy.apply(rule)
+        policy.result
+      end
+
+      instance_eval(&block) if block
+    end
+  end
+
+  ::RSpec.shared_examples_for "action_policy:policy_rule_example" do |success, the_caller|
+    if success
+      specify do
+        next if subject.success?
+        raise(
+          RSpec::Expectations::ExpectationNotMetError,
+          "Expected to succeed but failed:\n#{formatted_policy(policy)}",
+          the_caller
+        )
+      end
+    else
+      specify do
+        next if subject.fail?
+        raise(
+          RSpec::Expectations::ExpectationNotMetError,
+          "Expected to fail but succeed:\n#{formatted_policy(policy)}",
+          the_caller
+        )
+      end
+    end
+  end
+
+  ::RSpec.configure do |config|
     config.include(
       ActionPolicy::RSpec::PolicyExampleGroup,
       type: :policy,
       file_path: %r{spec/policies}
     )
+    config.include_context(
+      "action_policy:policy_context",
+      type: :policy,
+      file_path: %r{spec/policies}
+    )
   end
 end

lib/action_policy/utils/pretty_print.rb

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
+old_verbose = $VERBOSE
+
 begin
   require "method_source"
+  # Ignore parse warnings when patch
+  # Ruby version mismatches
+  $VERBOSE = nil
   require "parser/current"
   require "unparser"
 rescue LoadError
   # do nothing
+ensure
+  $VERBOSE = old_verbose
 end
 
 module ActionPolicy

spec/action_policy/dsl_spec.rb

@@ -35,6 +35,11 @@ def manage?
   let(:admin) { User.new("admin") }
   let(:context) { {user: user} }
 
+  # test skip rule
+  xdescribe_rule :manage? do
+    succeed
+  end
+
   describe_rule :manage? do
     let(:record) { User.new("guest") }
 
@@ -62,5 +67,11 @@ def manage?
         let(:user) { admin }
       end
     end
+
+    context "test skip" do
+      xfailed do
+        let(:user) { admin }
+      end
+    end
   end
 end