pundit-plus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e24b7b92951d89eacea12daeb0883a4210e1f900d3dd472fd069119f197a978
+  data.tar.gz: 2de203579d764e39b71c72c3bc3dc0c13138ae7d97d87f0b0676ee0925156fd7
+SHA512:
+  metadata.gz: f6fa345e74e3a2dd1a3756782226fab68a0d1e005f9f993b0273132c18648fe8616c938a2fce78df2ed3d26b3744fe42e08a7ff80876ad3ca0e755f3e9ab3a80
+  data.tar.gz: 29c5545f4294059194b327dbbc7f3b8ff81463e97dcfcc767a30d053ed29e782d7c53bdfe9a67f69e9ed92a4790ec59ebe432510eaff2d62a5b34aafdee7a13e

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [2024-04-10]
+
+### Added
+- Initial project setup with basic Pundit integration.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SOFware LLC
+
+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,56 @@
+# Pundit::Plus
+
+Add some extra features to Pundit.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add pundit-plus
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install pundit-plus
+
+## Usage
+
+This includes [Pundit](https://github.com/varvet/pundit) and [Pundit Matchers](https://github.com/pundit-community/pundit-matchers).
+
+Follow the instructions for using Pundit and Pundit Matchers.
+
+Include the `Pundit::Plus` module in your policy classes to add extra features to Pundit. For example:
+
+```ruby
+class ApplicationPolicy
+  include Pundit::Plus
+  # this module defines the default exception_from behavior
+end
+
+class MyPolicy < ApplicationPolicy
+  # Then you can use your own exception classes
+  class CustomException < Pundit::NotAuthorizedError
+    def initialize(options = {})
+      options[:message] ||= "You are not authorized to perform this action."
+      super(options)
+    end
+  end
+
+  def exeception_from(query:)
+    if query == :show?
+      CustomException
+    else
+      super
+    end
+  end
+end
+```
+
+## 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/SOFware/pundit-plus.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pundit/plus/custom_exception.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "pundit"
+
+module Pundit
+  module Plus
+    # This module is prepended to Pundit to allow for custom exceptions to be
+    # raised by policies.
+    module CustomException
+      # This method is called by Pundit when a policy raises an exception.
+      #
+      # The default implementation raises the exception that was passed to
+      # `authorize`, but you can override this method in your policy classes to
+      # handle the exception differently.
+      #
+      # To make use of this method define the `exception_from` method in your
+      # policy class.
+      def raise(klass, query:, record:, policy:)
+        super(policy.exception_from(query:), query: query, record: record, policy: policy)
+      end
+    end
+  end
+end
+Pundit.singleton_class.prepend(Pundit::Plus::CustomException)

data/lib/pundit/plus/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pundit
+  module Plus
+    VERSION = "0.1.0"
+  end
+end

data/lib/pundit/plus.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "plus/version"
+require_relative "plus/custom_exception"
+
+module Pundit
+  module Plus
+    def exception_from(query:)
+      Pundit::NotAuthorizedError
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: pundit-plus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Gay
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pundit
+  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'
+- !ruby/object:Gem::Dependency
+  name: pundit-matchers
+  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'
+description: Add Pundit to your application with additional features.
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/pundit/plus.rb
+- lib/pundit/plus/custom_exception.rb
+- lib/pundit/plus/version.rb
+homepage: https://github.com/SOFware/pundit-plus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SOFware/pundit-plus
+  source_code_uri: https://github.com/SOFware/pundit-plus
+  changelog_uri: https://github.com/SOFware/pundit-plus/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: Pundit with additional features.
+test_files: []