pundit 2.3.2 → 2.5.0

data/spec/policy_finder_spec.rb

@@ -2,13 +2,17 @@
 
 require "spec_helper"
 
-class Foo; end
 RSpec.describe Pundit::PolicyFinder do
   let(:user) { double }
   let(:post) { Post.new(user) }
   let(:comment) { CommentFourFiveSix.new }
   let(:article) { Article.new }
 
+  describe "SUFFIX" do
+    specify { expect(described_class::SUFFIX).to eq "Policy" }
+    specify { expect(Pundit::SUFFIX).to eq(described_class::SUFFIX) }
+  end
+
   describe "#scope" do
     subject { described_class.new(post) }
 

data/spec/pundit/helper_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Pundit::Helper do
+  let(:user) { double }
+  let(:controller) { Controller.new(user, "update", double) }
+  let(:view) { Controller::View.new(controller) }
+
+  describe "#policy_scope" do
+    it "doesn't flip pundit_policy_scoped?" do
+      scoped = view.policy_scope(Post)
+
+      expect(scoped).to be(Post.published)
+      expect(controller).not_to be_pundit_policy_scoped
+    end
+  end
+end

data/spec/pundit_spec.rb

@@ -43,25 +43,16 @@ RSpec.describe Pundit do
       expect(Pundit.authorize(user, Post, :show?)).to eq(Post)
     end
 
-    it "can be given a different policy class" do
-      expect(Pundit.authorize(user, post, :create?, policy_class: PublicationPolicy)).to be_truthy
-    end
-
-    it "can be given a different policy class using namespaces" do
-      expect(PublicationPolicy).to receive(:new).with(user, comment).and_call_original
-      expect(Pundit.authorize(user, [:project, comment], :create?, policy_class: PublicationPolicy)).to be_truthy
-    end
-
     it "works with anonymous class policies" do
       expect(Pundit.authorize(user, article_tag, :show?)).to be_truthy
       expect { Pundit.authorize(user, article_tag, :destroy?) }.to raise_error(Pundit::NotAuthorizedError)
     end
 
-    it "raises an error with a query and action" do
+    it "raises an error with the policy, query and record" do
       # rubocop:disable Style/MultilineBlockChain
       expect do
         Pundit.authorize(user, post, :destroy?)
-      end.to raise_error(Pundit::NotAuthorizedError, "not allowed to destroy? this Post") do |error|
+      end.to raise_error(Pundit::NotAuthorizedError, "not allowed to PostPolicy#destroy? this Post") do |error|
         expect(error.query).to eq :destroy?
         expect(error.record).to eq post
         expect(error.policy).to have_attributes(
@@ -73,11 +64,12 @@ RSpec.describe Pundit do
       # rubocop:enable Style/MultilineBlockChain
     end
 
-    it "raises an error with a the record, query and action when the record is namespaced" do
+    it "raises an error with the policy, query and record when the record is namespaced" do
       # rubocop:disable Style/MultilineBlockChain
       expect do
         Pundit.authorize(user, [:project, :admin, comment], :destroy?)
-      end.to raise_error(Pundit::NotAuthorizedError, "not allowed to destroy? this Comment") do |error|
+      end.to raise_error(Pundit::NotAuthorizedError,
+                         "not allowed to Project::Admin::CommentPolicy#destroy? this Comment") do |error|
         expect(error.query).to eq :destroy?
         expect(error.record).to eq comment
         expect(error.policy).to have_attributes(
@@ -89,11 +81,62 @@ RSpec.describe Pundit do
       # rubocop:enable Style/MultilineBlockChain
     end
 
+    it "raises an error with the policy, query and the class name when a Class is given" do
+      # rubocop:disable Style/MultilineBlockChain
+      expect do
+        Pundit.authorize(user, Post, :destroy?)
+      end.to raise_error(Pundit::NotAuthorizedError, "not allowed to PostPolicy#destroy? Post") do |error|
+        expect(error.query).to eq :destroy?
+        expect(error.record).to eq Post
+        expect(error.policy).to have_attributes(
+          user: user,
+          record: Post
+        )
+        expect(error.policy).to be_a(PostPolicy)
+      end
+      # rubocop:enable Style/MultilineBlockChain
+    end
+
     it "raises an error with a invalid policy constructor" do
       expect do
         Pundit.authorize(user, wiki, :update?)
       end.to raise_error(Pundit::InvalidConstructorError, "Invalid #<WikiPolicy> constructor is called")
     end
+
+    context "when passed a policy class" do
+      it "uses the passed policy class" do
+        expect(Pundit.authorize(user, post, :create?, policy_class: PublicationPolicy)).to be_truthy
+      end
+
+      # This is documenting past behaviour.
+      it "doesn't cache the policy class" do
+        cache = {}
+
+        expect do
+          Pundit.authorize(user, post, :create?, policy_class: PublicationPolicy, cache: cache)
+          Pundit.authorize(user, post, :create?, policy_class: PublicationPolicy, cache: cache)
+        end.to change { PublicationPolicy.instances }.by(2)
+      end
+    end
+
+    context "when passed a policy class while simultaenously passing a namespace" do
+      it "uses the passed policy class" do
+        expect(PublicationPolicy).to receive(:new).with(user, comment).and_call_original
+        expect(Pundit.authorize(user, [:project, comment], :create?, policy_class: PublicationPolicy)).to be_truthy
+      end
+    end
+
+    context "when passed an explicit cache" do
+      it "uses the hash assignment interface on the cache" do
+        custom_cache = CustomCache.new
+
+        Pundit.authorize(user, post, :update?, cache: custom_cache)
+
+        expect(custom_cache.to_h).to match({
+          post => kind_of(PostPolicy)
+        })
+      end
+    end
   end
 
   describe ".policy_scope" do
@@ -137,8 +180,8 @@ RSpec.describe Pundit do
 
     it "raises an original error with a policy scope that contains error" do
       expect do
-        Pundit.policy_scope(user, Thread)
-      end.to raise_error(ArgumentError)
+        Pundit.policy_scope(user, DefaultScopeContainsError)
+      end.to raise_error(RuntimeError, "This is an arbitrary error that should bubble up")
     end
   end
 

data/spec/rspec_dsl_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Pundit RSpec DSL" do
+  include Pundit::RSpec::PolicyExampleGroup
+
+  let(:fake_rspec) do
+    double = class_double(RSpec::ExampleGroups)
+    double.extend(::Pundit::RSpec::DSL)
+    double
+  end
+  let(:block) { proc { "block content" } }
+
+  let(:user) { double }
+  let(:other_user) { double }
+  let(:post) { Post.new(user) }
+  let(:policy) { PostPolicy }
+
+  it "calls describe with the correct metadata and without :focus" do
+    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
+    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
+
+  describe "#permit" do
+    context "when not appropriately wrapped in permissions" do
+      it "raises a descriptive error" do
+        expect do
+          expect(policy).to permit(user, post)
+        end.to raise_error(KeyError, <<~MSG.strip)
+          No permissions in example metadata, did you forget to wrap with `permissions :show?, ...`?
+        MSG
+      end
+    end
+
+    permissions :edit?, :update? do
+      it "succeeds when action is permitted" do
+        expect(policy).to permit(user, post)
+      end
+
+      context "when it fails" do
+        it "fails with a descriptive error message" do
+          expect do
+            expect(policy).to permit(other_user, post)
+          end.to raise_error(RSpec::Expectations::ExpectationNotMetError, <<~MSG.strip)
+            Expected PostPolicy to grant edit? and update? on Post but edit? and update? were not granted
+          MSG
+        end
+      end
+
+      context "when negated" do
+        it "succeeds when action is not permitted" do
+          expect(policy).not_to permit(other_user, post)
+        end
+
+        context "when it fails" do
+          it "fails with a descriptive error message" do
+            expect do
+              expect(policy).not_to permit(user, post)
+            end.to raise_error(RSpec::Expectations::ExpectationNotMetError, <<~MSG.strip)
+              Expected PostPolicy not to grant edit? and update? on Post but edit? and update? were granted
+            MSG
+          end
+        end
+      end
+    end
+  end
+end

data/spec/simple_cov_check_action_formatter.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "simplecov"
+require "json"
+
+class SimpleCovCheckActionFormatter
+  SourceFile = Data.define(:source_file) do
+    def covered_strength = source_file.covered_strength
+    def covered_percent = source_file.covered_percent
+
+    def to_json(*args)
+      {
+        filename: source_file.filename,
+        covered_percent: covered_percent.nan? ? 0.0 : covered_percent,
+        coverage: source_file.coverage_data,
+        covered_strength: covered_strength.nan? ? 0.0 : covered_strength,
+        covered_lines: source_file.covered_lines.count,
+        lines_of_code: source_file.lines_of_code
+      }.to_json(*args)
+    end
+  end
+
+  Result = Data.define(:result) do
+    def included?(source_file) = result.filenames.include?(source_file.filename)
+
+    def files
+      result.files.filter_map do |source_file|
+        next unless result.filenames.include? source_file.filename
+
+        SourceFile.new(source_file)
+      end
+    end
+
+    def to_json(*args) # rubocop:disable Metrics/AbcSize
+      {
+        timestamp: result.created_at.to_i,
+        command_name: result.command_name,
+        files: files,
+        metrics: {
+          covered_percent: result.covered_percent,
+          covered_strength: result.covered_strength.nan? ? 0.0 : result.covered_strength,
+          covered_lines: result.covered_lines,
+          total_lines: result.total_lines
+        }
+      }.to_json(*args)
+    end
+  end
+
+  FormatterWithOptions = Data.define(:formatter) do
+    def new = formatter
+  end
+
+  class << self
+    def with_options(...)
+      FormatterWithOptions.new(new(...))
+    end
+  end
+
+  def initialize(output_filename: "coverage.json", output_directory: SimpleCov.coverage_path)
+    @output_filename = output_filename
+    @output_directory = output_directory
+  end
+
+  attr_reader :output_filename, :output_directory
+
+  def output_filepath = File.join(output_directory, output_filename)
+
+  def format(result_data)
+    result = Result.new(result_data)
+    json = JSON.generate(result)
+    File.write(output_filepath, json)
+    puts output_message(result_data)
+    json
+  end
+
+  def output_message(result)
+    "Coverage report generated for #{result.command_name} to #{output_filepath}. #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered." # rubocop:disable Layout/LineLength
+  end
+end

data/spec/spec_helper.rb

@@ -2,351 +2,34 @@
 
 if ENV["COVERAGE"]
   require "simplecov"
+  require "simplecov_json_formatter"
+  require_relative "simple_cov_check_action_formatter"
+  SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter,
+    SimpleCovCheckActionFormatter.with_options(
+      output_filename: "simplecov-check-action.json"
+    )
+  ])
   SimpleCov.start do
     add_filter "/spec/"
+    enable_coverage :branch
+    primary_coverage :branch
   end
 end
 
+# @see https://github.com/rails/rails/issues/54260
+require "logger" if RUBY_ENGINE == "jruby" && RUBY_ENGINE_VERSION.start_with?("9.3")
+
 require "pundit"
 require "pundit/rspec"
-
-require "rack"
-require "rack/test"
-require "pry"
-require "active_support"
-require "active_support/core_ext"
 require "active_model/naming"
-require "action_controller/metal/strong_parameters"
-
-module InstanceTracking
-  module ClassMethods
-    def instances
-      @instances || 0
-    end
-
-    attr_writer :instances
-  end
-
-  def self.prepended(other)
-    other.extend(ClassMethods)
-  end
-
-  def initialize(*args, **kwargs, &block)
-    self.class.instances += 1
-    super(*args, **kwargs, &block)
-  end
-end
-
-class BasePolicy
-  prepend InstanceTracking
-
-  class BaseScope
-    prepend InstanceTracking
-
-    def initialize(user, scope)
-      @user = user
-      @scope = scope
-    end
-
-    attr_reader :user, :scope
-  end
-
-  def initialize(user, record)
-    @user = user
-    @record = record
-  end
-
-  attr_reader :user, :record
-end
-
-class PostPolicy < BasePolicy
-  class Scope < BaseScope
-    def resolve
-      scope.published
-    end
-  end
-
-  alias post record
-
-  def update?
-    post.user == user
-  end
-
-  def destroy?
-    false
-  end
-
-  def show?
-    true
-  end
-
-  def permitted_attributes
-    if post.user == user
-      %i[title votes]
-    else
-      [:votes]
-    end
-  end
-
-  def permitted_attributes_for_revise
-    [:body]
-  end
-end
-
-class Post
-  def initialize(user = nil)
-    @user = user
-  end
-
-  attr_reader :user
-
-  def self.published
-    :published
-  end
-
-  def self.read
-    :read
-  end
-
-  def to_s
-    "Post"
-  end
-
-  def inspect
-    "#<Post>"
-  end
-end
-
-module Customer
-  class Post < ::Post
-    def model_name
-      OpenStruct.new(param_key: "customer_post")
-    end
-
-    def self.policy_class
-      PostPolicy
-    end
-  end
-end
-
-class CommentScope
-  attr_reader :original_object
-
-  def initialize(original_object)
-    @original_object = original_object
-  end
-
-  def ==(other)
-    original_object == other.original_object
-  end
-end
-
-class CommentPolicy < BasePolicy
-  class Scope < BaseScope
-    def resolve
-      CommentScope.new(scope)
-    end
-  end
-
-  alias comment record
-end
-
-class PublicationPolicy < BasePolicy
-  class Scope < BaseScope
-    def resolve
-      scope.published
-    end
-  end
-
-  def create?
-    true
-  end
-end
-
-class Comment
-  extend ActiveModel::Naming
-end
-
-class CommentsRelation
-  def initialize(empty: false)
-    @empty = empty
-  end
-
-  def blank?
-    @empty
-  end
-
-  def self.model_name
-    Comment.model_name
-  end
-end
-
-class Article; end
-
-class BlogPolicy < BasePolicy
-  alias blog record
-end
-
-class Blog; end
-
-class ArtificialBlog < Blog
-  def self.policy_class
-    BlogPolicy
-  end
-end
-
-class ArticleTagOtherNamePolicy < BasePolicy
-  def show?
-    true
-  end
-
-  def destroy?
-    false
-  end
-
-  alias tag record
-end
-
-class ArticleTag
-  def self.policy_class
-    ArticleTagOtherNamePolicy
-  end
-end
-
-class CriteriaPolicy < BasePolicy
-  alias criteria record
-end
-
-module Project
-  class CommentPolicy < BasePolicy
-    class Scope < BaseScope
-      def resolve
-        scope
-      end
-    end
-
-    def update?
-      true
-    end
-
-    alias comment record
-  end
-
-  class CriteriaPolicy < BasePolicy
-    alias criteria record
-  end
-
-  class PostPolicy < BasePolicy
-    class Scope < BaseScope
-      def resolve
-        scope.read
-      end
-    end
-
-    alias post record
-  end
-
-  module Admin
-    class CommentPolicy < BasePolicy
-      def update?
-        true
-      end
-
-      def destroy?
-        false
-      end
-    end
-  end
-end
-
-class DenierPolicy < BasePolicy
-  def update?
-    false
-  end
-end
 
-class Controller
-  include Pundit::Authorization
-  # Mark protected methods public so they may be called in test
-  # rubocop:disable Style/AccessModifierDeclarations
-  public(*Pundit::Authorization.protected_instance_methods)
-  # rubocop:enable Style/AccessModifierDeclarations
-
-  attr_reader :current_user, :action_name, :params
-
-  def initialize(current_user, action_name, params)
-    @current_user = current_user
-    @action_name = action_name
-    @params = params
-  end
-end
-
-class NilClassPolicy < BasePolicy
-  class Scope
-    def initialize(*)
-      raise Pundit::NotDefinedError, "Cannot scope NilClass"
-    end
-  end
-
-  def show?
-    false
-  end
-
-  def destroy?
-    false
-  end
-end
-
-class Wiki; end
-
-class WikiPolicy
-  class Scope
-    # deliberate typo method
-    def initalize; end
-  end
-end
-
-class Thread
-  def self.all; end
-end
-
-class ThreadPolicy < BasePolicy
-  class Scope < BaseScope
-    def resolve
-      # deliberate wrong useage of the method
-      scope.all(:unvalid, :parameters)
-    end
-  end
-end
-
-class PostFourFiveSix
-  def initialize(user)
-    @user = user
-  end
-
-  attr_reader(:user)
-end
-
-class CommentFourFiveSix; extend ActiveModel::Naming; end
-
-module ProjectOneTwoThree
-  class CommentFourFiveSixPolicy < BasePolicy; end
-
-  class CriteriaFourFiveSixPolicy < BasePolicy; end
-
-  class PostFourFiveSixPolicy < BasePolicy; end
-
-  class TagFourFiveSix
-    def initialize(user)
-      @user = user
-    end
-
-    attr_reader(:user)
-  end
-
-  class TagFourFiveSixPolicy < BasePolicy; end
-
-  class AvatarFourFiveSix; extend ActiveModel::Naming; end
-
-  class AvatarFourFiveSixPolicy < BasePolicy; end
-end
+# Load all supporting files: models, policies, etc.
+require "zeitwerk"
+loader = Zeitwerk::Loader.new
+loader.push_dir(File.expand_path("support/models", __dir__))
+loader.push_dir(File.expand_path("support/policies", __dir__))
+loader.push_dir(File.expand_path("support/lib", __dir__))
+loader.setup
+loader.eager_load