pundit_assertions 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d5de5bdd6a032e18432811b7061fa42b20cb76b5e7a348177c825319ad4f672
-  data.tar.gz: d766c710ac4bd35985bab3cc57b069fda3dc981e19e090cfb87b9e2bcb3f39cb
+  metadata.gz: ecbd42aea5a12ef1a0110fca059d8dd42cbe219c9e0dfb734b8adbf433c85c2b
+  data.tar.gz: 71387d99a57d37b1404ec0e966640567a942df7fa9d75f982e5d337fdf42ef58
 SHA512:
-  metadata.gz: 96afe86a57e8fcab2a1ca56aebce5398b6d76f25cba3a11479786b4a562a1eb87be85ff59b465320f7218a4b2461588a926b2a0ef5ab70e9cc2c00634b9163b1
-  data.tar.gz: 68238d5f429a88c664d1695e042596c6a4c30a33f726b0abe7473cd394880a30f4566cae42ec848c99b24a0a28a787d7496570aa29e1cbb48e43eeef5444d048
+  metadata.gz: 15a5aee469a6048e4f169d0242e3ff6efb99ab0178861517bd20209b500b2606238ee02aa38f0a4365b9377cb31c0f7895c964ea611f2fc450a928fc64e3d1d5
+  data.tar.gz: c4eed4e2c6cd92cf809ba24f1dc55033d59872a5945f0d1f1d40daa396adc1ce93e6474c1d1d0c758b10e42e09a16f4b93d9f9b2ef4c1a6e41722eed58a2e5bb

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-09-07
+### Breaking changes
+* `assert_permitted_attributes` has been renamed to `assert_has_permitted_attributes` for clarity. The old method name is deprecated and will be removed in a next MINOR release.
+
+### Improvements
+* The messages of the validations have been customized. Before this, we often returned the message of the underlying assertion (ie. `assert_equal`, `assert_includes`, ...). We now have our own messages that should make it easier to understand the test failure.
+
 ## [0.1.0] - 2025-11-26
 
 - Initial release

data/README.md

@@ -5,19 +5,10 @@ A simple gem to make testing [Pundit](https://github.com/varvet/pundit) policies
 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
+bundle add pundit_assertions
 ```
 
 You can include the test helpers in all tests, or include this in a specific file:
@@ -54,13 +45,13 @@ class CommentPolicyTest < ActiveSupport::TestCase
   end
 
   test 'should allow permitted attributes for user' do
-    assert_permitted_attributes @user, @comment
+    assert_has_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
+    assert_attributes_permitted @user, @comment, :private, :create
+    assert_not_attributes_permitted @user, @comment, :private, :update
   end
 
   test 'should scope comments that belong to user' do

data/lib/pundit_assertions/deprecation.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PunditAssertions
+  module Deprecation # :nodoc:
+    ##
+    # Mark a method as deprecated and replace with a new method
+    def deprecate_method(old_name, new_name)
+      define_method(old_name) do |*args, **kwargs|
+        message = "#{old_name} is deprecated and will be removed in a future release. Use #{new_name} instead.\n"
+
+        # If we are in rails, we deprecate using rails' builtins, otherwise we use ruby's Warning
+        if defined?(ActiveSupport::Deprecation)
+          ActiveSupport::Deprecation.warn(message)
+        else
+          Warning.warn message, category: :deprecated
+        end
+        send(new_name, *args, **kwargs)
+      end
+    end
+  end
+end

data/lib/pundit_assertions/test_helpers.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
+require_relative 'deprecation'
+
 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
+    extend PunditAssertions::Deprecation
+
     ##
     # 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"
+      msg = "Expected #{inspect_user(user)} to be permitted to #{action} #{record}"
 
       assert permitted?(user, record, action), msg
     end
@@ -17,7 +21,7 @@ module PunditAssertions
     ##
     # 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"
+      msg = "Expected #{inspect_user(user)} to not be permitted to #{action} #{record}"
 
       refute permitted?(user, record, action), msg
     end
@@ -32,25 +36,41 @@ module PunditAssertions
 
     ##
     # Assert whether a user will have any attributes permitted
-    def assert_permitted_attributes(user, record, action = nil)
-      refute_empty permitted_attributes(user, record, action)
+    def assert_has_permitted_attributes(user, record, action = nil)
+      permitted = permitted_attributes(user, record, action)
+      for_action = action.nil? ? '' : " for #{action}"
+      message = "Expected #{inspect_user(user)} to have permitted attributes#{for_action}\n"
+
+      refute_nil permitted, message
+      refute_empty permitted, message
     end
 
+    deprecate_method :assert_permitted_attributes, :assert_has_permitted_attributes
+
     ##
     # 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)
+      permitted = permitted_attributes(user, record, action)
+      for_action = action.nil? ? '' : " for #{action}"
+      permitted_message = "Attributes #{permitted.inspect} were permitted\n"
+      message = "Expected #{inspect_user(user)} to not have permitted attributes#{for_action}\n#{permitted_message}"
+
+      assert_nil permitted, message
     end
 
+    alias refute_permitted_attributes assert_no_permitted_attributes
+
     ##
-    # Assert whether a user will have all of the specified attributes permitted
+    # Assert whether a user will have at least 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?
+      for_action = action.nil? ? '' : " for #{action}"
 
-      assert_empty attributes - permitted
+      assert_empty attributes - permitted,
+                   "Expected #{inspect_user(user)} to have #{attributes} in permitted attributes#{for_action}"
     end
 
     ##
@@ -59,10 +79,14 @@ module PunditAssertions
       attributes = [attributes] unless attributes.is_a?(Array)
       permitted = permitted_attributes(user, record, action)
       permitted = [] if permitted.nil?
+      union = (attributes & permitted)
+      for_action = action.nil? ? '' : " for #{action}"
 
-      assert_equal attributes.length, (attributes - permitted).length
+      assert_empty union, "Expected #{inspect_user(user)} to not have #{union} in permitted attributes#{for_action}"
     end
 
+    alias refute_attributes_permitted assert_not_attributes_permitted
+
     ##
     # Return the permitted attributes
     def permitted_attributes(user, record, action = nil)
@@ -75,51 +99,63 @@ module PunditAssertions
       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
+        assert_includes scope(user, record.class), record,
+                        "Expected #{record} to be included in the scope for #{inspect_user(user)}"
       end
     end
 
     ##
     # Assert whether a user will not have the specified records in scope
-    def assert_scope_not_includes(user, *records)
+    def assert_not_scope_includes(user, *records)
       records.flatten.each do |record|
-        result = scope(user, record.class)
-
-        assert result.nil? || !result.include?(record)
+        refute_includes scope(user, record.class), record,
+                        "Expected #{record} to not be included in the scope for #{inspect_user(user)}"
       end
     end
 
-    alias refute_scope_includes assert_scope_not_includes
+    alias refute_scope_includes assert_not_scope_includes
 
     ##
     # Assert whether the scope for a user is empty
     def assert_scope_empty(user, klass)
-      assert_empty scope(user, klass)
+      assert_empty scope(user, klass), "Expected scope for #{inspect_user(user)} to be empty"
     end
 
-    # This assumes this test is happening inside ModelPolicyTest
+    ##
+    # 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
+
+    ##
+    # Get the policy class based on the current test class
+    # This assumes this method is called inside `ModelPolicyTest` to get `ModelPolicy`
     def policy_class
       Object.const_get(self.class.to_s.gsub('Test', ''))
     end
 
-    # This assumes this test is happening inside ModelPolicyTest or ModelPolicyTest::Scope
+    ##
+    # Get the policy scope class based on the current test class
+    # This assumes this method is called inside `ModelPolicyTest` or `ModelPolicyTest::Scope` to get `ModelPolicy::Scope`
     def scope_class
       klass = self.class.to_s.gsub('Test', '')
       klass << '::Scope' unless klass.match?(/::Scope$/)
       Object.const_get(klass)
     end
+
+    private
+
+    def inspect_user(user)
+      return 'nil' if user.nil?
+
+      user.class.name
+    end
   end
 end

data/lib/pundit_assertions/version.rb

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

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: pundit_assertions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robbe Van Petegem
 bindir: bin
 cert_chain: []
-date: 2025-11-26 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - git@robbevp.be
 executables: []
@@ -21,6 +35,7 @@ files:
 - README.md
 - Rakefile
 - lib/pundit_assertions.rb
+- lib/pundit_assertions/deprecation.rb
 - lib/pundit_assertions/test_helpers.rb
 - lib/pundit_assertions/version.rb
 homepage: https://github.com/tree-company/pundit_assertions
@@ -45,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A simple set of minitest assertion to help test pundit policies.
 test_files: []