pundit 2.4.0 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/main.yml +92 -57
  3. data/.rubocop.yml +18 -8
  4. data/.rubocop_ignore_git.yml +7 -0
  5. data/.yardopts +1 -1
  6. data/CHANGELOG.md +61 -42
  7. data/Gemfile +22 -2
  8. data/README.md +30 -0
  9. data/Rakefile +1 -0
  10. data/lib/generators/pundit/install/install_generator.rb +3 -1
  11. data/lib/generators/pundit/policy/policy_generator.rb +3 -1
  12. data/lib/generators/rspec/policy_generator.rb +4 -1
  13. data/lib/generators/test_unit/policy_generator.rb +4 -1
  14. data/lib/pundit/authorization.rb +152 -77
  15. data/lib/pundit/cache_store/legacy_store.rb +7 -0
  16. data/lib/pundit/cache_store/null_store.rb +9 -0
  17. data/lib/pundit/cache_store.rb +22 -0
  18. data/lib/pundit/context.rb +76 -26
  19. data/lib/pundit/policy_finder.rb +22 -1
  20. data/lib/pundit/railtie.rb +19 -0
  21. data/lib/pundit/rspec.rb +67 -6
  22. data/lib/pundit/version.rb +2 -1
  23. data/lib/pundit.rb +39 -14
  24. data/pundit.gemspec +8 -12
  25. data/spec/authorization_spec.rb +60 -3
  26. data/spec/policy_finder_spec.rb +5 -1
  27. data/spec/pundit/helper_spec.rb +18 -0
  28. data/spec/pundit_spec.rb +37 -11
  29. data/spec/rspec_dsl_spec.rb +81 -0
  30. data/spec/simple_cov_check_action_formatter.rb +79 -0
  31. data/spec/spec_helper.rb +22 -339
  32. data/spec/support/lib/controller.rb +38 -0
  33. data/spec/support/lib/custom_cache.rb +19 -0
  34. data/spec/support/lib/instance_tracking.rb +20 -0
  35. data/spec/support/models/article.rb +4 -0
  36. data/spec/support/models/article_tag.rb +7 -0
  37. data/spec/support/models/artificial_blog.rb +7 -0
  38. data/spec/support/models/blog.rb +4 -0
  39. data/spec/support/models/comment.rb +5 -0
  40. data/spec/support/models/comment_four_five_six.rb +5 -0
  41. data/spec/support/models/comment_scope.rb +13 -0
  42. data/spec/support/models/comments_relation.rb +15 -0
  43. data/spec/support/models/customer/post.rb +11 -0
  44. data/spec/support/models/default_scope_contains_error.rb +5 -0
  45. data/spec/support/models/dummy_current_user.rb +7 -0
  46. data/spec/support/models/foo.rb +4 -0
  47. data/spec/support/models/post.rb +25 -0
  48. data/spec/support/models/post_four_five_six.rb +9 -0
  49. data/spec/support/models/project_one_two_three/avatar_four_five_six.rb +7 -0
  50. data/spec/support/models/project_one_two_three/tag_four_five_six.rb +11 -0
  51. data/spec/support/models/wiki.rb +4 -0
  52. data/spec/support/policies/article_tag_other_name_policy.rb +13 -0
  53. data/spec/support/policies/base_policy.rb +23 -0
  54. data/spec/support/policies/blog_policy.rb +5 -0
  55. data/spec/support/policies/comment_policy.rb +11 -0
  56. data/spec/support/policies/criteria_policy.rb +5 -0
  57. data/spec/support/policies/default_scope_contains_error_policy.rb +10 -0
  58. data/spec/support/policies/denier_policy.rb +7 -0
  59. data/spec/support/policies/dummy_current_user_policy.rb +9 -0
  60. data/spec/support/policies/nil_class_policy.rb +17 -0
  61. data/spec/support/policies/post_policy.rb +36 -0
  62. data/spec/support/policies/project/admin/comment_policy.rb +15 -0
  63. data/spec/support/policies/project/comment_policy.rb +17 -0
  64. data/spec/support/policies/project/criteria_policy.rb +7 -0
  65. data/spec/support/policies/project/post_policy.rb +13 -0
  66. data/spec/support/policies/project_one_two_three/avatar_four_five_six_policy.rb +6 -0
  67. data/spec/support/policies/project_one_two_three/comment_four_five_six_policy.rb +6 -0
  68. data/spec/support/policies/project_one_two_three/criteria_four_five_six_policy.rb +6 -0
  69. data/spec/support/policies/project_one_two_three/post_four_five_six_policy.rb +6 -0
  70. data/spec/support/policies/project_one_two_three/tag_four_five_six_policy.rb +6 -0
  71. data/spec/support/policies/publication_policy.rb +13 -0
  72. data/spec/support/policies/wiki_policy.rb +8 -0
  73. metadata +62 -158
  74. data/spec/dsl_spec.rb +0 -30
  75. /data/lib/generators/pundit/install/templates/{application_policy.rb → application_policy.rb.tt} +0 -0
  76. /data/lib/generators/pundit/policy/templates/{policy.rb → policy.rb.tt} +0 -0
  77. /data/lib/generators/rspec/templates/{policy_spec.rb → policy_spec.rb.tt} +0 -0
  78. /data/lib/generators/test_unit/templates/{policy_test.rb → policy_test.rb.tt} +0 -0
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ class DenierPolicy < BasePolicy
4
+ def update?
5
+ false
6
+ end
7
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ class DummyCurrentUserPolicy < BasePolicy
4
+ class Scope < BasePolicy::BaseScope
5
+ def resolve
6
+ user
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ class NilClassPolicy < BasePolicy
4
+ class Scope
5
+ def initialize(*)
6
+ raise Pundit::NotDefinedError, "Cannot scope NilClass"
7
+ end
8
+ end
9
+
10
+ def show?
11
+ false
12
+ end
13
+
14
+ def destroy?
15
+ false
16
+ end
17
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ class PostPolicy < BasePolicy
4
+ class Scope < BaseScope
5
+ def resolve
6
+ scope.published
7
+ end
8
+ end
9
+
10
+ alias post record
11
+
12
+ def update?
13
+ post.user == user
14
+ end
15
+ alias edit? update?
16
+
17
+ def destroy?
18
+ false
19
+ end
20
+
21
+ def show?
22
+ true
23
+ end
24
+
25
+ def permitted_attributes
26
+ if post.user == user
27
+ %i[title votes]
28
+ else
29
+ [:votes]
30
+ end
31
+ end
32
+
33
+ def permitted_attributes_for_revise
34
+ [:body]
35
+ end
36
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Project
4
+ module Admin
5
+ class CommentPolicy < BasePolicy
6
+ def update?
7
+ true
8
+ end
9
+
10
+ def destroy?
11
+ false
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Project
4
+ class CommentPolicy < BasePolicy
5
+ class Scope < BaseScope
6
+ def resolve
7
+ scope
8
+ end
9
+ end
10
+
11
+ def update?
12
+ true
13
+ end
14
+
15
+ alias comment record
16
+ end
17
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Project
4
+ class CriteriaPolicy < BasePolicy
5
+ alias criteria record
6
+ end
7
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Project
4
+ class PostPolicy < BasePolicy
5
+ class Scope < BaseScope
6
+ def resolve
7
+ scope.read
8
+ end
9
+ end
10
+
11
+ alias post record
12
+ end
13
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ProjectOneTwoThree
4
+ class AvatarFourFiveSixPolicy < BasePolicy
5
+ end
6
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ProjectOneTwoThree
4
+ class CommentFourFiveSixPolicy < BasePolicy
5
+ end
6
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ProjectOneTwoThree
4
+ class CriteriaFourFiveSixPolicy < BasePolicy
5
+ end
6
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ProjectOneTwoThree
4
+ class PostFourFiveSixPolicy < BasePolicy
5
+ end
6
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ProjectOneTwoThree
4
+ class TagFourFiveSixPolicy < BasePolicy
5
+ end
6
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ class PublicationPolicy < BasePolicy
4
+ class Scope < BaseScope
5
+ def resolve
6
+ scope.published
7
+ end
8
+ end
9
+
10
+ def create?
11
+ true
12
+ end
13
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ class WikiPolicy
4
+ class Scope
5
+ # deliberate typo method
6
+ def initalize; end
7
+ end
8
+ end
metadata CHANGED
@@ -1,15 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pundit
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.4.0
4
+ version: 2.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonas Nicklas
8
8
  - Varvet AB
9
- autorequire:
9
+ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2024-08-26 00:00:00.000000000 Z
12
+ date: 2025-03-03 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: activesupport
@@ -25,146 +25,6 @@ dependencies:
25
25
  - - ">="
26
26
  - !ruby/object:Gem::Version
27
27
  version: 3.0.0
28
- - !ruby/object:Gem::Dependency
29
- name: actionpack
30
- requirement: !ruby/object:Gem::Requirement
31
- requirements:
32
- - - ">="
33
- - !ruby/object:Gem::Version
34
- version: 3.0.0
35
- type: :development
36
- prerelease: false
37
- version_requirements: !ruby/object:Gem::Requirement
38
- requirements:
39
- - - ">="
40
- - !ruby/object:Gem::Version
41
- version: 3.0.0
42
- - !ruby/object:Gem::Dependency
43
- name: activemodel
44
- requirement: !ruby/object:Gem::Requirement
45
- requirements:
46
- - - ">="
47
- - !ruby/object:Gem::Version
48
- version: 3.0.0
49
- type: :development
50
- prerelease: false
51
- version_requirements: !ruby/object:Gem::Requirement
52
- requirements:
53
- - - ">="
54
- - !ruby/object:Gem::Version
55
- version: 3.0.0
56
- - !ruby/object:Gem::Dependency
57
- name: bundler
58
- requirement: !ruby/object:Gem::Requirement
59
- requirements:
60
- - - ">="
61
- - !ruby/object:Gem::Version
62
- version: '0'
63
- type: :development
64
- prerelease: false
65
- version_requirements: !ruby/object:Gem::Requirement
66
- requirements:
67
- - - ">="
68
- - !ruby/object:Gem::Version
69
- version: '0'
70
- - !ruby/object:Gem::Dependency
71
- name: pry
72
- requirement: !ruby/object:Gem::Requirement
73
- requirements:
74
- - - ">="
75
- - !ruby/object:Gem::Version
76
- version: '0'
77
- type: :development
78
- prerelease: false
79
- version_requirements: !ruby/object:Gem::Requirement
80
- requirements:
81
- - - ">="
82
- - !ruby/object:Gem::Version
83
- version: '0'
84
- - !ruby/object:Gem::Dependency
85
- name: railties
86
- requirement: !ruby/object:Gem::Requirement
87
- requirements:
88
- - - ">="
89
- - !ruby/object:Gem::Version
90
- version: 3.0.0
91
- type: :development
92
- prerelease: false
93
- version_requirements: !ruby/object:Gem::Requirement
94
- requirements:
95
- - - ">="
96
- - !ruby/object:Gem::Version
97
- version: 3.0.0
98
- - !ruby/object:Gem::Dependency
99
- name: rake
100
- requirement: !ruby/object:Gem::Requirement
101
- requirements:
102
- - - ">="
103
- - !ruby/object:Gem::Version
104
- version: '0'
105
- type: :development
106
- prerelease: false
107
- version_requirements: !ruby/object:Gem::Requirement
108
- requirements:
109
- - - ">="
110
- - !ruby/object:Gem::Version
111
- version: '0'
112
- - !ruby/object:Gem::Dependency
113
- name: rspec
114
- requirement: !ruby/object:Gem::Requirement
115
- requirements:
116
- - - ">="
117
- - !ruby/object:Gem::Version
118
- version: 3.0.0
119
- type: :development
120
- prerelease: false
121
- version_requirements: !ruby/object:Gem::Requirement
122
- requirements:
123
- - - ">="
124
- - !ruby/object:Gem::Version
125
- version: 3.0.0
126
- - !ruby/object:Gem::Dependency
127
- name: rubocop
128
- requirement: !ruby/object:Gem::Requirement
129
- requirements:
130
- - - ">="
131
- - !ruby/object:Gem::Version
132
- version: '0'
133
- type: :development
134
- prerelease: false
135
- version_requirements: !ruby/object:Gem::Requirement
136
- requirements:
137
- - - ">="
138
- - !ruby/object:Gem::Version
139
- version: '0'
140
- - !ruby/object:Gem::Dependency
141
- name: simplecov
142
- requirement: !ruby/object:Gem::Requirement
143
- requirements:
144
- - - ">="
145
- - !ruby/object:Gem::Version
146
- version: 0.17.0
147
- type: :development
148
- prerelease: false
149
- version_requirements: !ruby/object:Gem::Requirement
150
- requirements:
151
- - - ">="
152
- - !ruby/object:Gem::Version
153
- version: 0.17.0
154
- - !ruby/object:Gem::Dependency
155
- name: yard
156
- requirement: !ruby/object:Gem::Requirement
157
- requirements:
158
- - - ">="
159
- - !ruby/object:Gem::Version
160
- version: '0'
161
- type: :development
162
- prerelease: false
163
- version_requirements: !ruby/object:Gem::Requirement
164
- requirements:
165
- - - ">="
166
- - !ruby/object:Gem::Version
167
- version: '0'
168
28
  description: Object oriented authorization for Rails applications
169
29
  email:
170
30
  - jonas.nicklas@gmail.com
@@ -181,6 +41,7 @@ files:
181
41
  - ".github/workflows/push_gem.yml"
182
42
  - ".gitignore"
183
43
  - ".rubocop.yml"
44
+ - ".rubocop_ignore_git.yml"
184
45
  - ".yardopts"
185
46
  - CHANGELOG.md
186
47
  - CODE_OF_CONDUCT.md
@@ -193,36 +54,86 @@ files:
193
54
  - config/rubocop-rspec.yml
194
55
  - lib/generators/pundit/install/USAGE
195
56
  - lib/generators/pundit/install/install_generator.rb
196
- - lib/generators/pundit/install/templates/application_policy.rb
57
+ - lib/generators/pundit/install/templates/application_policy.rb.tt
197
58
  - lib/generators/pundit/policy/USAGE
198
59
  - lib/generators/pundit/policy/policy_generator.rb
199
- - lib/generators/pundit/policy/templates/policy.rb
60
+ - lib/generators/pundit/policy/templates/policy.rb.tt
200
61
  - lib/generators/rspec/policy_generator.rb
201
- - lib/generators/rspec/templates/policy_spec.rb
62
+ - lib/generators/rspec/templates/policy_spec.rb.tt
202
63
  - lib/generators/test_unit/policy_generator.rb
203
- - lib/generators/test_unit/templates/policy_test.rb
64
+ - lib/generators/test_unit/templates/policy_test.rb.tt
204
65
  - lib/pundit.rb
205
66
  - lib/pundit/authorization.rb
67
+ - lib/pundit/cache_store.rb
206
68
  - lib/pundit/cache_store/legacy_store.rb
207
69
  - lib/pundit/cache_store/null_store.rb
208
70
  - lib/pundit/context.rb
209
71
  - lib/pundit/policy_finder.rb
72
+ - lib/pundit/railtie.rb
210
73
  - lib/pundit/rspec.rb
211
74
  - lib/pundit/version.rb
212
75
  - pundit.gemspec
213
76
  - spec/authorization_spec.rb
214
- - spec/dsl_spec.rb
215
77
  - spec/generators_spec.rb
216
78
  - spec/policies/post_policy_spec.rb
217
79
  - spec/policy_finder_spec.rb
80
+ - spec/pundit/helper_spec.rb
218
81
  - spec/pundit_spec.rb
82
+ - spec/rspec_dsl_spec.rb
83
+ - spec/simple_cov_check_action_formatter.rb
219
84
  - spec/spec_helper.rb
85
+ - spec/support/lib/controller.rb
86
+ - spec/support/lib/custom_cache.rb
87
+ - spec/support/lib/instance_tracking.rb
88
+ - spec/support/models/article.rb
89
+ - spec/support/models/article_tag.rb
90
+ - spec/support/models/artificial_blog.rb
91
+ - spec/support/models/blog.rb
92
+ - spec/support/models/comment.rb
93
+ - spec/support/models/comment_four_five_six.rb
94
+ - spec/support/models/comment_scope.rb
95
+ - spec/support/models/comments_relation.rb
96
+ - spec/support/models/customer/post.rb
97
+ - spec/support/models/default_scope_contains_error.rb
98
+ - spec/support/models/dummy_current_user.rb
99
+ - spec/support/models/foo.rb
100
+ - spec/support/models/post.rb
101
+ - spec/support/models/post_four_five_six.rb
102
+ - spec/support/models/project_one_two_three/avatar_four_five_six.rb
103
+ - spec/support/models/project_one_two_three/tag_four_five_six.rb
104
+ - spec/support/models/wiki.rb
105
+ - spec/support/policies/article_tag_other_name_policy.rb
106
+ - spec/support/policies/base_policy.rb
107
+ - spec/support/policies/blog_policy.rb
108
+ - spec/support/policies/comment_policy.rb
109
+ - spec/support/policies/criteria_policy.rb
110
+ - spec/support/policies/default_scope_contains_error_policy.rb
111
+ - spec/support/policies/denier_policy.rb
112
+ - spec/support/policies/dummy_current_user_policy.rb
113
+ - spec/support/policies/nil_class_policy.rb
114
+ - spec/support/policies/post_policy.rb
115
+ - spec/support/policies/project/admin/comment_policy.rb
116
+ - spec/support/policies/project/comment_policy.rb
117
+ - spec/support/policies/project/criteria_policy.rb
118
+ - spec/support/policies/project/post_policy.rb
119
+ - spec/support/policies/project_one_two_three/avatar_four_five_six_policy.rb
120
+ - spec/support/policies/project_one_two_three/comment_four_five_six_policy.rb
121
+ - spec/support/policies/project_one_two_three/criteria_four_five_six_policy.rb
122
+ - spec/support/policies/project_one_two_three/post_four_five_six_policy.rb
123
+ - spec/support/policies/project_one_two_three/tag_four_five_six_policy.rb
124
+ - spec/support/policies/publication_policy.rb
125
+ - spec/support/policies/wiki_policy.rb
220
126
  homepage: https://github.com/varvet/pundit
221
127
  licenses:
222
128
  - MIT
223
129
  metadata:
224
130
  rubygems_mfa_required: 'true'
225
- post_install_message:
131
+ bug_tracker_uri: https://github.com/varvet/pundit/issues
132
+ changelog_uri: https://github.com/varvet/pundit/blob/main/CHANGELOG.md
133
+ documentation_uri: https://github.com/varvet/pundit/blob/main/README.md
134
+ homepage_uri: https://github.com/varvet/pundit
135
+ source_code_uri: https://github.com/varvet/pundit
136
+ post_install_message:
226
137
  rdoc_options: []
227
138
  require_paths:
228
139
  - lib
@@ -238,14 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
238
149
  version: '0'
239
150
  requirements: []
240
151
  rubygems_version: 3.5.11
241
- signing_key:
152
+ signing_key:
242
153
  specification_version: 4
243
154
  summary: OO authorization for Rails
244
- test_files:
245
- - spec/authorization_spec.rb
246
- - spec/dsl_spec.rb
247
- - spec/generators_spec.rb
248
- - spec/policies/post_policy_spec.rb
249
- - spec/policy_finder_spec.rb
250
- - spec/pundit_spec.rb
251
- - spec/spec_helper.rb
155
+ test_files: []
data/spec/dsl_spec.rb DELETED
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require "spec_helper"
4
-
5
- RSpec.describe "Pundit RSpec DSL" do
6
- let(:fake_rspec) do
7
- double = class_double(RSpec::ExampleGroups)
8
- double.extend(::Pundit::RSpec::DSL)
9
- double
10
- end
11
- let(:block) { proc { "block content" } }
12
-
13
- it "calls describe with the correct metadata and without :focus" do
14
- expected_metadata = { permissions: %i[item1 item2], caller: instance_of(Array) }
15
- expect(fake_rspec).to receive(:describe).with("item1 and item2", match(expected_metadata)) do |&block|
16
- expect(block.call).to eq("block content")
17
- end
18
-
19
- fake_rspec.permissions(:item1, :item2, &block)
20
- end
21
-
22
- it "calls describe with the correct metadata and with :focus" do
23
- expected_metadata = { permissions: %i[item1 item2], caller: instance_of(Array), focus: true }
24
- expect(fake_rspec).to receive(:describe).with("item1 and item2", match(expected_metadata)) do |&block|
25
- expect(block.call).to eq("block content")
26
- end
27
-
28
- fake_rspec.permissions(:item1, :item2, :focus, &block)
29
- end
30
- end