pundit-before 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 120b45a26b35d09c85f44f3eceac5557759770e94da78d8d8ac1538121a61c52
+  data.tar.gz: e52a3f89c3e7a07b613f64cb3b4dfd3c6825c106a804de6520508077ac44a777
+SHA512:
+  metadata.gz: 10123635560be0123e65d2799b707727b2b88d60634e15e58c84570008454bf5c7a28503bd5fbf91871adb1e9bf3de6aa0de50e9815ac788399a925138c3ab74
+  data.tar.gz: 1c1afcd63dc07af3b76359e27f4af777fe86d5deb109e24901d263e47d8920a0df0e0e57a8ec4252590bb565fb1668079901cf28e2d7c1e97460f5880007ef91

data/.editorconfig

@@ -0,0 +1,12 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.pryrc

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Pry.config.prompt_name = "[pundit-before]"

data/.rubocop.yml

@@ -0,0 +1,57 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+    - Prefixes
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - "**/bin/**/*"
+    - "**/gemfiles/**/*"
+    - "**/Appraisals"
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/ModuleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Naming/FileName:
+  Exclude:
+    - "**/lib/pundit-before.rb"
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.0

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "pundit-2.0" do
+  gem "pundit", "2.0"
+end
+
+appraise "pundit-2.1" do
+  gem "pundit", "2.1"
+end
+
+appraise "pundit-2.2" do
+  gem "pundit", "2.2"
+end
+
+appraise "pundit-2.3" do
+  gem "pundit", "2.3"
+end

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.0.1] - 2023-01-15
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.19"
+gem "rubocop-rake", "~> 0.6"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+GIT
+  remote: https://github.com/excid3/appraisal.git
+  revision: 14855fc54ce88b42def871ce8bfd4259fbf06043
+  branch: fix-bundle-env
+  specs:
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+
+PATH
+  remote: .
+  specs:
+    pundit-before (0.0.1)
+      pundit (>= 2.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pundit (2.3.0)
+      activesupport (>= 3.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.19.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  appraisal!
+  minitest (~> 5.0)
+  pry (~> 0.14)
+  pundit-before!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-minitest (~> 0.19)
+  rubocop-rake (~> 0.6)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Javier Aranda
+
+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,204 @@
+# Pundit::Before
+
+![CI](https://github.com/javierav/pundit-before/workflows/CI/badge.svg)
+
+Adds `before` hook to pundit policy classes to resolve things like varvet/pundit#474. Inspired by action_policy
+[pre-checks](https://actionpolicy.evilmartians.io/#/pre_checks).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pundit-before"
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+## Usage
+
+Use `allow!` inside callback method or block to return `true` without evaluating `edit?` method defined in policy.
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  include Pundit::Before
+
+  before :check_admin
+
+  def edit?
+    false
+  end
+
+  private
+
+  def check_admin
+    allow! if user.admin?
+  end
+end
+
+UserPolicy.new(User.new(admin: true), record).edit?  # => true
+UserPolicy.new(User.new(admin: false), record).edit? # => false
+```
+
+Use `deny!` inside callback method or block to return `false` without evaluating `edit?` method defined in policy.
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  include Pundit::Before
+
+  before :check_admin
+
+  def edit?
+    true
+  end
+
+  private
+
+  def check_admin
+    deny! unless user.admin?
+  end
+end
+
+UserPolicy.new(User.new(admin: true), record).edit?  # => true
+UserPolicy.new(User.new(admin: false), record).edit? # => false
+```
+
+Internally `before` hook is implemented as `ActiveSupport::Callbacks`, so the callback chain will halt if do any call to
+`allow!` or `deny!` method. It's similar as Rails controller action filters works.
+
+### block form
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  include Pundit::Before
+
+  before do
+    allow! if user.admin?
+  end
+
+  def edit?
+    false
+  end
+end
+```
+
+### skip before hook
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  include Pundit::Before
+
+  before :check_admin
+
+  def edit?
+    false
+  end
+
+  private
+
+  def check_admin
+    allow! if user.admin?
+  end
+end
+
+class OperatorPolicy < UserPolicy
+  skip_before :check_admin
+end
+
+UserPolicy.new(User.new(admin: true), record).edit?     # => true
+OperatorPolicy.new(User.new(admin: true), record).edit? # => false
+```
+
+### using `only` modifier
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  include Pundit::Before
+
+  before :check_admin, only: :update?
+
+  def edit?
+    false
+  end
+
+  private
+
+  def check_admin
+    allow! if user.admin?
+  end
+end
+
+UserPolicy.new(User.new(admin: true), record).edit? # => false
+```
+
+### using `except` modifier
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  include Pundit::Before
+
+  before :check_admin, except: :edit?
+
+  def edit?
+    false
+  end
+
+  def destroy?
+    false
+  end
+
+  private
+
+  def check_admin
+    allow! if user.admin?
+  end
+end
+
+UserPolicy.new(User.new(admin: true), record).edit?    # => false
+UserPolicy.new(User.new(admin: true), record).destroy? # => true
+```
+
+### calling multiple methods
+
+```ruby
+class UserPolicy < BasePolicy
+  before :check_presence, :check_admin
+
+  def edit?
+    false
+  end
+
+  private
+
+  def check_presence
+    deny! unless user.present?
+  end
+
+  def check_admin
+    allow! if user.admin?
+  end
+end
+
+UserPolicy.new(nil, record).edit?                    # => false
+UserPolicy.new(User.new(admin: false), record).edit? # => false
+UserPolicy.new(User.new(admin: true), record).edit?  # => true
+```
+
+## 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 `bin/rake install`.
+
+To release a new version, update the version number in `version.rb`, and then run `bin/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).
+
+## License
+
+Copyright © 2023 Javier Aranda. Released under the terms of the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/gemfiles/pundit_2.0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.19"
+gem "rubocop-rake", "~> 0.6"
+gem "pundit", "2.0"
+
+gemspec path: "../"

data/gemfiles/pundit_2.1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.19"
+gem "rubocop-rake", "~> 0.6"
+gem "pundit", "2.1"
+
+gemspec path: "../"

data/gemfiles/pundit_2.2.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.19"
+gem "rubocop-rake", "~> 0.6"
+gem "pundit", "2.2"
+
+gemspec path: "../"

data/gemfiles/pundit_2.3.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.19"
+gem "rubocop-rake", "~> 0.6"
+gem "pundit", "2.3"
+
+gemspec path: "../"

data/lib/pundit/before/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pundit
+  module Before
+    module VERSION
+      MAJOR = 0
+      MINOR = 0
+      TINY  = 1
+      PRE   = nil
+
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+    end
+
+    def self.version
+      VERSION::STRING
+    end
+
+    def self.gem_version
+      Gem::Version.new VERSION::STRING
+    end
+  end
+end

data/lib/pundit/before.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "active_support/callbacks"
+require "active_support/core_ext/array/wrap"
+require "active_support/core_ext/module/redefine_method"
+require "active_support/core_ext/object/blank"
+
+require_relative "before/version"
+
+module Pundit
+  module Before
+    # rubocop:disable Metrics/MethodLength
+    def self.included(base)
+      base.extend ClassMethods
+      base.include ActiveSupport::Callbacks
+
+      base.class_eval do
+        define_callbacks :_pundit_before, skip_after_callbacks_if_terminated: true
+
+        def self.method_added(method_name)
+          super
+
+          return unless method_name.to_s =~ /.*\?$/ && public_method_defined?(method_name)
+          return if @_pundit_before_running
+
+          @_pundit_before_running = true
+
+          old_method = instance_method(method_name)
+
+          redefine_method(method_name) do
+            @_pundit_before_result = nil
+            @_pundit_before_method = method_name
+
+            run_callbacks :_pundit_before
+
+            @_pundit_before_result.nil? ? old_method.bind(self).call : @_pundit_before_result
+          end
+
+          @_pundit_before_running = false
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    class CallbackFilter
+      def initialize(methods)
+        @methods = Array(methods).map(&:to_sym)
+      end
+
+      def match?(object)
+        @methods.include?(object.instance_variable_get(:@_pundit_before_method).to_sym)
+      end
+
+      alias after  match?
+      alias before match?
+      alias around match?
+    end
+
+    module ClassMethods
+      def before(*method_names, **options, &block)
+        _normalize_callback_options(options)
+
+        if block_given?
+          set_callback :_pundit_before, :before, **options, &block
+        else
+          set_callback :_pundit_before, :before, *method_names, **options
+        end
+      end
+
+      def skip_before(*method_names, **options)
+        _normalize_callback_options(options)
+        skip_callback :_pundit_before, :before, *method_names, **options
+      end
+
+      def _normalize_callback_options(options)
+        _normalize_callback_option(options, :only, :if)
+        _normalize_callback_option(options, :except, :unless)
+      end
+
+      def _normalize_callback_option(options, from, to)
+        return unless (from = options.delete(from))
+
+        from = CallbackFilter.new(from)
+        options[to] = Array(options[to]).unshift(from)
+      end
+    end
+
+    def allow!
+      @_pundit_before_result = true
+      throw :abort
+    end
+
+    def deny!
+      @_pundit_before_result = false
+      throw :abort
+    end
+  end
+end

data/lib/pundit-before.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "pundit/before"

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: pundit-before
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Javier Aranda
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- javier.aranda.varo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".editorconfig"
+- ".envrc"
+- ".pryrc"
+- ".rubocop.yml"
+- ".tool-versions"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- gemfiles/pundit_2.0.gemfile
+- gemfiles/pundit_2.1.gemfile
+- gemfiles/pundit_2.2.gemfile
+- gemfiles/pundit_2.3.gemfile
+- lib/pundit-before.rb
+- lib/pundit/before.rb
+- lib/pundit/before/version.rb
+homepage: https://github.com/javierav/pundit-before
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/javierav/pundit-before
+  source_code_uri: https://github.com/javierav/pundit-before/tree/v0.0.1
+  changelog_uri: https://github.com/javierav/pundit-before/blob/v0.0.1/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Adds before hook to pundit policy classes
+test_files: []