pundit 2.4.0 → 2.5.1

data/spec/policy_finder_spec.rb

@@ -1,187 +0,0 @@
-# frozen_string_literal: true
-
-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 "#scope" do
-    subject { described_class.new(post) }
-
-    it "returns a policy scope" do
-      expect(subject.scope).to eq PostPolicy::Scope
-    end
-
-    context "policy is nil" do
-      it "returns nil" do
-        allow(subject).to receive(:policy).and_return nil
-        expect(subject.scope).to eq nil
-      end
-    end
-  end
-
-  describe "#policy" do
-    context "with an instance" do
-      it "returns the associated policy" do
-        object = described_class.new(post)
-
-        expect(object.policy).to eq PostPolicy
-      end
-    end
-
-    context "with an array of symbols" do
-      it "returns the associated namespaced policy" do
-        object = described_class.new(%i[project post])
-
-        expect(object.policy).to eq Project::PostPolicy
-      end
-    end
-
-    context "with an array of a symbol and an instance" do
-      it "returns the associated namespaced policy" do
-        object = described_class.new([:project, post])
-
-        expect(object.policy).to eq Project::PostPolicy
-      end
-    end
-
-    context "with an array of a symbol and a class with a specified policy class" do
-      it "returns the associated namespaced policy" do
-        object = described_class.new([:project, Customer::Post])
-
-        expect(object.policy).to eq Project::PostPolicy
-      end
-    end
-
-    context "with an array of a symbol and a class with a specified model name" do
-      it "returns the associated namespaced policy" do
-        object = described_class.new([:project, CommentsRelation])
-
-        expect(object.policy).to eq Project::CommentPolicy
-      end
-    end
-
-    context "with a class" do
-      it "returns the associated policy" do
-        object = described_class.new(Post)
-
-        expect(object.policy).to eq PostPolicy
-      end
-    end
-
-    context "with a class which has a specified policy class" do
-      it "returns the associated policy" do
-        object = described_class.new(Customer::Post)
-
-        expect(object.policy).to eq PostPolicy
-      end
-    end
-
-    context "with an instance which has a specified policy class" do
-      it "returns the associated policy" do
-        object = described_class.new(Customer::Post.new(user))
-
-        expect(object.policy).to eq PostPolicy
-      end
-    end
-
-    context "with a class which has a specified model name" do
-      it "returns the associated policy" do
-        object = described_class.new(CommentsRelation)
-
-        expect(object.policy).to eq CommentPolicy
-      end
-    end
-
-    context "with an instance which has a specified policy class" do
-      it "returns the associated policy" do
-        object = described_class.new(CommentsRelation.new)
-
-        expect(object.policy).to eq CommentPolicy
-      end
-    end
-
-    context "with nil" do
-      it "returns a NilClassPolicy" do
-        object = described_class.new(nil)
-
-        expect(object.policy).to eq NilClassPolicy
-      end
-    end
-
-    context "with a class that doesn't have an associated policy" do
-      it "returns nil" do
-        object = described_class.new(Foo)
-
-        expect(object.policy).to eq nil
-      end
-    end
-  end
-
-  describe "#scope!" do
-    context "@object is nil" do
-      subject { described_class.new(nil) }
-
-      it "returns the NilClass policy's scope class" do
-        expect(subject.scope!).to eq NilClassPolicy::Scope
-      end
-    end
-
-    context "@object is defined" do
-      subject { described_class.new(post) }
-
-      it "returns the scope" do
-        expect(subject.scope!).to eq PostPolicy::Scope
-      end
-    end
-  end
-
-  describe "#param_key" do
-    context "object responds to model_name" do
-      subject { described_class.new(comment) }
-
-      it "returns the param_key" do
-        expect(subject.object).to respond_to(:model_name)
-        expect(subject.param_key).to eq "comment_four_five_six"
-      end
-    end
-
-    context "object is a class" do
-      subject { described_class.new(Article) }
-
-      it "returns the param_key" do
-        expect(subject.object).not_to respond_to(:model_name)
-        expect(subject.object).to be_a Class
-        expect(subject.param_key).to eq "article"
-      end
-    end
-
-    context "object is an instance of a class" do
-      subject { described_class.new(article) }
-
-      it "returns the param_key" do
-        expect(subject.object).not_to respond_to(:model_name)
-        expect(subject.object).not_to be_a Class
-        expect(subject.object).to be_an_instance_of Article
-
-        expect(subject.param_key).to eq "article"
-      end
-    end
-
-    context "object is an array" do
-      subject { described_class.new([:project, article]) }
-
-      it "returns the param_key for the last element of the array" do
-        expect(subject.object).not_to respond_to(:model_name)
-        expect(subject.object).not_to be_a Class
-        expect(subject.object).to be_an_instance_of Array
-
-        expect(subject.param_key).to eq "article"
-      end
-    end
-  end
-end

data/spec/pundit_spec.rb

@@ -1,448 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe Pundit do
-  let(:user) { double }
-  let(:post) { Post.new(user) }
-  let(:customer_post) { Customer::Post.new(user) }
-  let(:post_four_five_six) { PostFourFiveSix.new(user) }
-  let(:comment) { Comment.new }
-  let(:comment_four_five_six) { CommentFourFiveSix.new }
-  let(:article) { Article.new }
-  let(:artificial_blog) { ArtificialBlog.new }
-  let(:article_tag) { ArticleTag.new }
-  let(:comments_relation) { CommentsRelation.new(empty: false) }
-  let(:empty_comments_relation) { CommentsRelation.new(empty: true) }
-  let(:tag_four_five_six) { ProjectOneTwoThree::TagFourFiveSix.new(user) }
-  let(:avatar_four_five_six) { ProjectOneTwoThree::AvatarFourFiveSix.new }
-  let(:wiki) { Wiki.new }
-
-  describe ".authorize" do
-    it "infers the policy and authorizes based on it" do
-      expect(Pundit.authorize(user, post, :update?)).to be_truthy
-    end
-
-    it "returns the record on successful authorization" do
-      expect(Pundit.authorize(user, post, :update?)).to eq(post)
-    end
-
-    it "returns the record when passed record with namespace " do
-      expect(Pundit.authorize(user, [:project, comment], :update?)).to eq(comment)
-    end
-
-    it "returns the record when passed record with nested namespace " do
-      expect(Pundit.authorize(user, [:project, :admin, comment], :update?)).to eq(comment)
-    end
-
-    it "returns the policy name symbol when passed record with headless policy" do
-      expect(Pundit.authorize(user, :publication, :create?)).to eq(:publication)
-    end
-
-    it "returns the class when passed record not a particular instance" 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 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 PostPolicy#destroy? this 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 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 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(
-          user: user,
-          record: comment
-        )
-        expect(error.policy).to be_a(Project::Admin::CommentPolicy)
-      end
-      # 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
-  end
-
-  describe ".policy_scope" do
-    it "returns an instantiated policy scope given a plain model class" do
-      expect(Pundit.policy_scope(user, Post)).to eq :published
-    end
-
-    it "returns an instantiated policy scope given an active model class" do
-      expect(Pundit.policy_scope(user, Comment)).to eq CommentScope.new(Comment)
-    end
-
-    it "returns an instantiated policy scope given an active record relation" do
-      expect(Pundit.policy_scope(user, comments_relation)).to eq CommentScope.new(comments_relation)
-    end
-
-    it "returns an instantiated policy scope given an empty active record relation" do
-      expect(Pundit.policy_scope(user, empty_comments_relation)).to eq CommentScope.new(empty_comments_relation)
-    end
-
-    it "returns an instantiated policy scope given an array of a symbol and plain model class" do
-      expect(Pundit.policy_scope(user, [:project, Post])).to eq :read
-    end
-
-    it "returns an instantiated policy scope given an array of a symbol and active model class" do
-      expect(Pundit.policy_scope(user, [:project, Comment])).to eq Comment
-    end
-
-    it "returns nil if the given policy scope can't be found" do
-      expect(Pundit.policy_scope(user, Article)).to be_nil
-    end
-
-    it "raises an exception if nil object given" do
-      expect { Pundit.policy_scope(user, nil) }.to raise_error(Pundit::NotDefinedError)
-    end
-
-    it "raises an error with a invalid policy scope constructor" do
-      expect do
-        Pundit.policy_scope(user, Wiki)
-      end.to raise_error(Pundit::InvalidConstructorError, "Invalid #<WikiPolicy::Scope> constructor is called")
-    end
-
-    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)
-    end
-  end
-
-  describe ".policy_scope!" do
-    it "returns an instantiated policy scope given a plain model class" do
-      expect(Pundit.policy_scope!(user, Post)).to eq :published
-    end
-
-    it "returns an instantiated policy scope given an active model class" do
-      expect(Pundit.policy_scope!(user, Comment)).to eq CommentScope.new(Comment)
-    end
-
-    it "throws an exception if the given policy scope can't be found" do
-      expect { Pundit.policy_scope!(user, Article) }.to raise_error(Pundit::NotDefinedError)
-    end
-
-    it "throws an exception if the given policy scope can't be found" do
-      expect { Pundit.policy_scope!(user, ArticleTag) }.to raise_error(Pundit::NotDefinedError)
-    end
-
-    it "throws an exception if the given policy scope is nil" do
-      expect do
-        Pundit.policy_scope!(user, nil)
-      end.to raise_error(Pundit::NotDefinedError, "Cannot scope NilClass")
-    end
-
-    it "returns an instantiated policy scope given an array of a symbol and plain model class" do
-      expect(Pundit.policy_scope!(user, [:project, Post])).to eq :read
-    end
-
-    it "returns an instantiated policy scope given an array of a symbol and active model class" do
-      expect(Pundit.policy_scope!(user, [:project, Comment])).to eq Comment
-    end
-
-    it "raises an error with a invalid policy scope constructor" do
-      expect do
-        Pundit.policy_scope(user, Wiki)
-      end.to raise_error(Pundit::InvalidConstructorError, "Invalid #<WikiPolicy::Scope> constructor is called")
-    end
-  end
-
-  describe ".policy" do
-    it "returns an instantiated policy given a plain model instance" do
-      policy = Pundit.policy(user, post)
-      expect(policy.user).to eq user
-      expect(policy.post).to eq post
-    end
-
-    it "returns an instantiated policy given an active model instance" do
-      policy = Pundit.policy(user, comment)
-      expect(policy.user).to eq user
-      expect(policy.comment).to eq comment
-    end
-
-    it "returns an instantiated policy given a plain model class" do
-      policy = Pundit.policy(user, Post)
-      expect(policy.user).to eq user
-      expect(policy.post).to eq Post
-    end
-
-    it "returns an instantiated policy given an active model class" do
-      policy = Pundit.policy(user, Comment)
-      expect(policy.user).to eq user
-      expect(policy.comment).to eq Comment
-    end
-
-    it "returns an instantiated policy given a symbol" do
-      policy = Pundit.policy(user, :criteria)
-      expect(policy.class).to eq CriteriaPolicy
-      expect(policy.user).to eq user
-      expect(policy.criteria).to eq :criteria
-    end
-
-    it "returns an instantiated policy given an array of symbols" do
-      policy = Pundit.policy(user, %i[project criteria])
-      expect(policy.class).to eq Project::CriteriaPolicy
-      expect(policy.user).to eq user
-      expect(policy.criteria).to eq :criteria
-    end
-
-    it "returns an instantiated policy given an array of a symbol and plain model instance" do
-      policy = Pundit.policy(user, [:project, post])
-      expect(policy.class).to eq Project::PostPolicy
-      expect(policy.user).to eq user
-      expect(policy.post).to eq post
-    end
-
-    it "returns an instantiated policy given an array of a symbol and a model instance with policy_class override" do
-      policy = Pundit.policy(user, [:project, customer_post])
-      expect(policy.class).to eq Project::PostPolicy
-      expect(policy.user).to eq user
-      expect(policy.post).to eq customer_post
-    end
-
-    it "returns an instantiated policy given an array of a symbol and an active model instance" do
-      policy = Pundit.policy(user, [:project, comment])
-      expect(policy.class).to eq Project::CommentPolicy
-      expect(policy.user).to eq user
-      expect(policy.comment).to eq comment
-    end
-
-    it "returns an instantiated policy given an array of a symbol and a plain model class" do
-      policy = Pundit.policy(user, [:project, Post])
-      expect(policy.class).to eq Project::PostPolicy
-      expect(policy.user).to eq user
-      expect(policy.post).to eq Post
-    end
-
-    it "raises an error with a invalid policy constructor" do
-      expect do
-        Pundit.policy(user, Wiki)
-      end.to raise_error(Pundit::InvalidConstructorError, "Invalid #<WikiPolicy> constructor is called")
-    end
-
-    it "returns an instantiated policy given an array of a symbol and an active model class" do
-      policy = Pundit.policy(user, [:project, Comment])
-      expect(policy.class).to eq Project::CommentPolicy
-      expect(policy.user).to eq user
-      expect(policy.comment).to eq Comment
-    end
-
-    it "returns an instantiated policy given an array of a symbol and a class with policy_class override" do
-      policy = Pundit.policy(user, [:project, Customer::Post])
-      expect(policy.class).to eq Project::PostPolicy
-      expect(policy.user).to eq user
-      expect(policy.post).to eq Customer::Post
-    end
-
-    it "returns correct policy class for an array of a multi-word symbols" do
-      policy = Pundit.policy(user, %i[project_one_two_three criteria_four_five_six])
-      expect(policy.class).to eq ProjectOneTwoThree::CriteriaFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for an array of a multi-word symbol and a multi-word plain model instance" do
-      policy = Pundit.policy(user, [:project_one_two_three, post_four_five_six])
-      expect(policy.class).to eq ProjectOneTwoThree::PostFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for an array of a multi-word symbol and a multi-word active model instance" do
-      policy = Pundit.policy(user, [:project_one_two_three, comment_four_five_six])
-      expect(policy.class).to eq ProjectOneTwoThree::CommentFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for an array of a multi-word symbol and a multi-word plain model class" do
-      policy = Pundit.policy(user, [:project_one_two_three, PostFourFiveSix])
-      expect(policy.class).to eq ProjectOneTwoThree::PostFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for an array of a multi-word symbol and a multi-word active model class" do
-      policy = Pundit.policy(user, [:project_one_two_three, CommentFourFiveSix])
-      expect(policy.class).to eq ProjectOneTwoThree::CommentFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for a multi-word scoped plain model class" do
-      policy = Pundit.policy(user, ProjectOneTwoThree::TagFourFiveSix)
-      expect(policy.class).to eq ProjectOneTwoThree::TagFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for a multi-word scoped plain model instance" do
-      policy = Pundit.policy(user, tag_four_five_six)
-      expect(policy.class).to eq ProjectOneTwoThree::TagFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for a multi-word scoped active model class" do
-      policy = Pundit.policy(user, ProjectOneTwoThree::AvatarFourFiveSix)
-      expect(policy.class).to eq ProjectOneTwoThree::AvatarFourFiveSixPolicy
-    end
-
-    it "returns correct policy class for a multi-word scoped active model instance" do
-      policy = Pundit.policy(user, avatar_four_five_six)
-      expect(policy.class).to eq ProjectOneTwoThree::AvatarFourFiveSixPolicy
-    end
-
-    it "returns nil if the given policy can't be found" do
-      expect(Pundit.policy(user, article)).to be_nil
-      expect(Pundit.policy(user, Article)).to be_nil
-    end
-
-    it "returns the specified NilClassPolicy for nil" do
-      expect(Pundit.policy(user, nil)).to be_a NilClassPolicy
-    end
-
-    describe "with .policy_class set on the model" do
-      it "returns an instantiated policy given a plain model instance" do
-        policy = Pundit.policy(user, artificial_blog)
-        expect(policy.user).to eq user
-        expect(policy.blog).to eq artificial_blog
-      end
-
-      it "returns an instantiated policy given a plain model class" do
-        policy = Pundit.policy(user, ArtificialBlog)
-        expect(policy.user).to eq user
-        expect(policy.blog).to eq ArtificialBlog
-      end
-
-      it "returns an instantiated policy given a plain model instance providing an anonymous class" do
-        policy = Pundit.policy(user, article_tag)
-        expect(policy.user).to eq user
-        expect(policy.tag).to eq article_tag
-      end
-
-      it "returns an instantiated policy given a plain model class providing an anonymous class" do
-        policy = Pundit.policy(user, ArticleTag)
-        expect(policy.user).to eq user
-        expect(policy.tag).to eq ArticleTag
-      end
-    end
-  end
-
-  describe ".policy!" do
-    it "returns an instantiated policy given a plain model instance" do
-      policy = Pundit.policy!(user, post)
-      expect(policy.user).to eq user
-      expect(policy.post).to eq post
-    end
-
-    it "returns an instantiated policy given an active model instance" do
-      policy = Pundit.policy!(user, comment)
-      expect(policy.user).to eq user
-      expect(policy.comment).to eq comment
-    end
-
-    it "returns an instantiated policy given a plain model class" do
-      policy = Pundit.policy!(user, Post)
-      expect(policy.user).to eq user
-      expect(policy.post).to eq Post
-    end
-
-    it "returns an instantiated policy given an active model class" do
-      policy = Pundit.policy!(user, Comment)
-      expect(policy.user).to eq user
-      expect(policy.comment).to eq Comment
-    end
-
-    it "returns an instantiated policy given a symbol" do
-      policy = Pundit.policy!(user, :criteria)
-      expect(policy.class).to eq CriteriaPolicy
-      expect(policy.user).to eq user
-      expect(policy.criteria).to eq :criteria
-    end
-
-    it "returns an instantiated policy given an array of symbols" do
-      policy = Pundit.policy!(user, %i[project criteria])
-      expect(policy.class).to eq Project::CriteriaPolicy
-      expect(policy.user).to eq user
-      expect(policy.criteria).to eq :criteria
-    end
-
-    it "throws an exception if the given policy can't be found" do
-      expect { Pundit.policy!(user, article) }.to raise_error(Pundit::NotDefinedError)
-      expect { Pundit.policy!(user, Article) }.to raise_error(Pundit::NotDefinedError)
-    end
-
-    it "returns the specified NilClassPolicy for nil" do
-      expect(Pundit.policy!(user, nil)).to be_a NilClassPolicy
-    end
-
-    it "raises an error with a invalid policy constructor" do
-      expect do
-        Pundit.policy(user, Wiki)
-      end.to raise_error(Pundit::InvalidConstructorError, "Invalid #<WikiPolicy> constructor is called")
-    end
-  end
-
-  describe ".included" do
-    it "includes Authorization module" do
-      klass = Class.new
-
-      expect do
-        klass.include Pundit
-      end.to output.to_stderr
-
-      expect(klass).to include Pundit::Authorization
-    end
-
-    it "warns about deprecation" do
-      klass = Class.new
-      expect do
-        klass.include Pundit
-      end.to output(a_string_starting_with("'include Pundit' is deprecated")).to_stderr
-    end
-  end
-
-  describe "Pundit::NotAuthorizedError" do
-    it "can be initialized with a string as message" do
-      error = Pundit::NotAuthorizedError.new("must be logged in")
-      expect(error.message).to eq "must be logged in"
-    end
-  end
-end