pundit_assertions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d5de5bdd6a032e18432811b7061fa42b20cb76b5e7a348177c825319ad4f672
+  data.tar.gz: d766c710ac4bd35985bab3cc57b069fda3dc981e19e090cfb87b9e2bcb3f39cb
+SHA512:
+  metadata.gz: 96afe86a57e8fcab2a1ca56aebce5398b6d76f25cba3a11479786b4a562a1eb87be85ff59b465320f7218a4b2461588a926b2a0ef5ab70e9cc2c00634b9163b1
+  data.tar.gz: 68238d5f429a88c664d1695e042596c6a4c30a33f726b0abe7473cd394880a30f4566cae42ec848c99b24a0a28a787d7496570aa29e1cbb48e43eeef5444d048

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-26
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Tree company 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# PunditAssertions
+
+A simple gem to make testing [Pundit](https://github.com/varvet/pundit) policies easier. This provides a set of assertions
+
+We deduce the relevant based on the name of the test class: We assume that `CommentPolicy` gets tested in `CommentPolicyTest`, `Admin::CommentPolicy` in `Admin::CommentPolicyTest`, ...
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+You can include the test helpers in all tests, or include this in a specific file:
+```ruby
+require 'pundit_assertions'
+
+module ActiveSupport
+  class TestCase
+    include PunditAssertions::TestHelpers
+  end
+end
+```
+
+```ruby
+require 'pundit_assertions'
+
+class CommentPolicyTest < ActiveSupport::TestCase
+  include PunditAssertions::TestHelpers
+end
+```
+
+## Usage
+We provide a bunch of custom assertions to help you validate your policies:
+```ruby
+class CommentPolicyTest < ActiveSupport::TestCase
+  setup do
+    @user = User.new
+    @comment = Comment.new
+  end
+
+  test 'should only allow index for user' do
+    assert_permitted @user, @comment, :index
+    assert_not_permitted nil, @comment, :index
+  end
+
+  test 'should allow permitted attributes for user' do
+    assert_permitted_attributes @user, @comment
+    assert_no_permitted_attributes nil, @comment
+  end
+
+  test 'should only allow private attribute on create' do
+    assert_attribute_permitted @user, @comment, :private, :create
+    assert_not_attribute_permitted @user, @comment, :private, :update
+  end
+
+  test 'should scope comments that belong to user' do
+    users_comment = Comment.create!(user: @user)
+    other_comment = Comment.create!(user: User.new)
+
+    assert_scope_includes @user, users_comment
+    assert_scope_not_includes @user, other_comment
+    assert_scope_empty @user, Comment
+  end 
+end
+```
+
+For every `assert_not_`, there is also a `refute_` variant.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tree-company/pundit_assertions.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/pundit_assertions/test_helpers.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module PunditAssertions
+  ##
+  # A set of assertions to use in minitest
+  #
+  # This module should be included in your test class to use these assertions
+  module TestHelpers
+    ##
+    # Assert whether a user is permitted to perform an action
+    def assert_permitted(user, record, action)
+      msg = "User #{user.inspect} should be permitted to #{action} #{record}, but isn't permitted"
+
+      assert permitted?(user, record, action), msg
+    end
+
+    ##
+    # Assert whether a user is not permitted to perform an action
+    def assert_not_permitted(user, record, action)
+      msg = "User #{user.inspect} should NOT be permitted to #{action} #{record}, but is permitted"
+
+      refute permitted?(user, record, action), msg
+    end
+
+    alias refute_permitted assert_not_permitted
+
+    ##
+    # Return whether a user is permitted to perform an action
+    def permitted?(user, record, action)
+      policy_class.new(user, record).public_send(:"#{action}?")
+    end
+
+    ##
+    # Assert whether a user will have any attributes permitted
+    def assert_permitted_attributes(user, record, action = nil)
+      refute_empty permitted_attributes(user, record, action)
+    end
+
+    ##
+    # Assert whether a user will have no attributes permitted
+    def assert_no_permitted_attributes(user, record, action = nil)
+      assert_nil permitted_attributes(user, record, action)
+    end
+
+    ##
+    # Assert whether a user will have all of the specified attributes permitted
+    # You can specify a specific action
+    def assert_attributes_permitted(user, record, attributes, action = nil)
+      attributes = [attributes] unless attributes.is_a?(Array)
+      permitted = permitted_attributes(user, record, action)
+      permitted = [] if permitted.nil?
+
+      assert_empty attributes - permitted
+    end
+
+    ##
+    # Assert whether a user will not have any the specified attributes permitted
+    def assert_not_attributes_permitted(user, record, attributes, action = nil)
+      attributes = [attributes] unless attributes.is_a?(Array)
+      permitted = permitted_attributes(user, record, action)
+      permitted = [] if permitted.nil?
+
+      assert_equal attributes.length, (attributes - permitted).length
+    end
+
+    ##
+    # Return the permitted attributes
+    def permitted_attributes(user, record, action = nil)
+      policy = policy_class.new(user, record)
+      method = :permitted_attributes
+      if !action.nil? && policy.respond_to?(:"permitted_attributes_for_#{action}")
+        method = :"permitted_attributes_for_#{action}"
+      end
+
+      policy.send(method)
+    end
+
+    ##
+    # Return the scoped records for a user and a klass
+    def scope(user, klass)
+      result = scope_class.new(user, klass).resolve
+
+      refute_nil result
+      result
+    end
+
+    ##
+    # Assert whether a user will have the specified records in scope
+    def assert_scope_includes(user, *records)
+      records.flatten.each do |record|
+        assert_includes scope(user, record.class), record
+      end
+    end
+
+    ##
+    # Assert whether a user will not have the specified records in scope
+    def assert_scope_not_includes(user, *records)
+      records.flatten.each do |record|
+        result = scope(user, record.class)
+
+        assert result.nil? || !result.include?(record)
+      end
+    end
+
+    alias refute_scope_includes assert_scope_not_includes
+
+    ##
+    # Assert whether the scope for a user is empty
+    def assert_scope_empty(user, klass)
+      assert_empty scope(user, klass)
+    end
+
+    # This assumes this test is happening inside ModelPolicyTest
+    def policy_class
+      Object.const_get(self.class.to_s.gsub('Test', ''))
+    end
+
+    # This assumes this test is happening inside ModelPolicyTest or ModelPolicyTest::Scope
+    def scope_class
+      klass = self.class.to_s.gsub('Test', '')
+      klass << '::Scope' unless klass.match?(/::Scope$/)
+      Object.const_get(klass)
+    end
+  end
+end

data/lib/pundit_assertions/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PunditAssertions
+  VERSION = '0.1.0'
+end

data/lib/pundit_assertions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'pundit_assertions/version'
+require_relative 'pundit_assertions/test_helpers'
+
+##
+# Set of assertions to test pundit policies
+module PunditAssertions
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: pundit_assertions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robbe Van Petegem
+bindir: bin
+cert_chain: []
+date: 2025-11-26 00:00:00.000000000 Z
+dependencies: []
+email:
+- git@robbevp.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pundit_assertions.rb
+- lib/pundit_assertions/test_helpers.rb
+- lib/pundit_assertions/version.rb
+homepage: https://github.com/tree-company/pundit_assertions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tree-company/pundit_assertions
+  source_code_uri: https://github.com/tree-company/pundit_assertions
+  changelog_uri: https://github.com/tree-company/pundit_assertions/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A simple set of minitest assertion to help test pundit policies.
+test_files: []