pundit_role_play 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 967fbb651ade454c1781fd00745665b608714f9bd1753ba305270f16118996c2
+  data.tar.gz: 0f79a19cd94aca3fe9f38e7702c3d019c2288405caf89907cf011bfa776060e0
+SHA512:
+  metadata.gz: a463aaba01c4447057465d183d3a3f8845e747bf72851da91e33ba813d13327b3176d7f58cf59e0d01fdfeea4f583809cbf5e24bcd49a4f06ef0cefd0a50072f
+  data.tar.gz: 5ec06b0a8cfaa49500a2fbdce564463a75d52fe58150ff49f35f198d494a04acbcdc63d8ea0f6d9f7caaf075b0d4994f6e208fa0c52bf6eafc4c34a2408244f7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+# Omakase Ruby styling for Rails
+AllCops:
+  Exclude:
+    - "lib/generators/pundit_role_play/role/templates/role.rb"
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jimmypoulsen96@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pundit_role_play.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rubocop-rails-omakase", require: false

data/Gemfile.lock

@@ -0,0 +1,247 @@
+PATH
+  remote: .
+  specs:
+    pundit_role_play (0.1.0)
+      rails (>= 7.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (8.0.1)
+      actionpack (= 8.0.1)
+      activesupport (= 8.0.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.1)
+      actionpack (= 8.0.1)
+      activejob (= 8.0.1)
+      activerecord (= 8.0.1)
+      activestorage (= 8.0.1)
+      activesupport (= 8.0.1)
+      mail (>= 2.8.0)
+    actionmailer (8.0.1)
+      actionpack (= 8.0.1)
+      actionview (= 8.0.1)
+      activejob (= 8.0.1)
+      activesupport (= 8.0.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.1)
+      actionview (= 8.0.1)
+      activesupport (= 8.0.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.1)
+      actionpack (= 8.0.1)
+      activerecord (= 8.0.1)
+      activestorage (= 8.0.1)
+      activesupport (= 8.0.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.1)
+      activesupport (= 8.0.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.1)
+      activesupport (= 8.0.1)
+      globalid (>= 0.3.6)
+    activemodel (8.0.1)
+      activesupport (= 8.0.1)
+    activerecord (8.0.1)
+      activemodel (= 8.0.1)
+      activesupport (= 8.0.1)
+      timeout (>= 0.4.0)
+    activestorage (8.0.1)
+      actionpack (= 8.0.1)
+      activejob (= 8.0.1)
+      activerecord (= 8.0.1)
+      activesupport (= 8.0.1)
+      marcel (~> 1.0)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    erubi (1.13.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.14.2)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.9.0)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.3)
+    loofah (2.23.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.25.4)
+    net-imap (0.5.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.17.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.2.1)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.1)
+      actioncable (= 8.0.1)
+      actionmailbox (= 8.0.1)
+      actionmailer (= 8.0.1)
+      actionpack (= 8.0.1)
+      actiontext (= 8.0.1)
+      actionview (= 8.0.1)
+      activejob (= 8.0.1)
+      activemodel (= 8.0.1)
+      activerecord (= 8.0.1)
+      activestorage (= 8.0.1)
+      activesupport (= 8.0.1)
+      bundler (>= 1.15.0)
+      railties (= 8.0.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.1)
+      actionpack (= 8.0.1)
+      activesupport (= 8.0.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.9.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.3)
+    reline (0.5.12)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.69.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.36.2)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.36.0)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.27.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails-omakase (1.0.0)
+      rubocop
+      rubocop-minitest
+      rubocop-performance
+      rubocop-rails
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.0)
+    stringio (3.1.2)
+    thor (1.3.2)
+    timeout (0.4.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.2)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.2)
+    useragent (0.16.11)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pundit_role_play!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rails-omakase
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jimmy Poulsen
+
+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,182 @@
+# Pundit Role Play
+
+A simple and flexible role-based authorization gem built on top of [Pundit](https://github.com/varvet/pundit) for Ruby on Rails applications. Pundit Role Play allows developers to manage user roles and permissions in an intuitive way while leveraging Pundit's policy-driven architecture.
+
+## Features
+- Easy role management for users.
+- Built-in support for Pundit policies.
+- Flexible and lightweight design with minimal dependencies.
+- Supports role inheritance and custom roles.
+
+## Installation
+Add the gem to your Rails application's `Gemfile`:
+
+```ruby
+gem "pundit_role_play", github: "Synsbasen/pundit-role-play", branch: "master"
+```
+
+Run the bundle command to install it:
+
+```bash
+bundle install
+```
+
+Run the install generator to setup an application role:
+```bash
+bin/rails generate pundit_role_play:install
+```
+
+## Preconditions
+Ensure that the models you want to use roles and permissions with have a `role` attribute. This attribute should be a string and should be present in the database.
+
+```ruby
+class AddRoleToUsers < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :role, :string #, default: "MemberRole"
+  end
+end
+```
+
+Furthermore, ensure that the `has_pundit_role` method is called in the User model.
+
+```ruby
+class User < ApplicationRecord
+  has_pundit_role
+end
+```
+
+## Usage
+### Setting up Roles
+Define roles for your application by utilizing the built-in role generator:
+
+```bash
+bin/rails generate pundit_role_play:role admin
+```
+
+This will generate the following role:
+
+```ruby
+class AdminRole < ApplicationRole
+  PERMISSIONS = {
+    users: :read,
+    another_resource: :write
+  }.freeze
+end
+```
+
+Now, it's up to you to define the resources for the role. Example:
+
+```ruby
+class AdminRole < ApplicationRole
+  PERMISSIONS = {
+    areas: :write,
+    invoices: :read,
+    organizations: :write,
+    user_areas: :write,
+    users: :write,
+    user_organizations: :write
+  }.freeze
+end
+```
+
+### Using roles in Pundit policies
+Pundit Role Play integrates seamlessly with Pundit policies. Use the current user's permissions within your Pundit policy files with the `can_read?` and `can_write?` helper methods:
+
+```ruby
+class UserPolicy < ApplicationPolicy
+  class Scope < Scope
+    def resolve
+      scope.all
+    end
+  end
+
+  def edit?
+    can_write? || user == record
+  end
+
+  def index?
+    can_read?
+  end
+
+  def show?
+    can_read?
+  end
+
+  def new?
+    can_write?
+  end
+
+  def create?
+    can_write?
+  end
+
+  def update?
+    can_write? || user == record
+  end
+end
+```
+
+PunditRolePlay knows which resource from the role's permissions to target based on the name of the policy. In the example above it will target the `users` resource and evaluate if read/write is allowed.
+
+The `can_edit?` and `can_write?` methods takes an optional argument `:resource` in case you're working with a policy that depends on other resources. Example:
+
+```ruby
+class UserOrganizationPolicy < ApplicationPolicy
+  def edit?
+    can_write?(resource: :users)
+  end
+end
+```
+
+### Checking roles in controllers
+You can use the role helper methods in your controllers:
+
+```ruby
+class PostsController < ApplicationController
+  def update
+    if current_user.has_role?(:editor)
+      # Proceed with update logic
+    else
+      redirect_to root_path, alert: 'Access Denied!'
+    end
+  end
+end
+```
+
+### Role helper in views
+You can use the role helper methods in your views:
+
+```erb
+<% if current_user.has_role?(:admin) %>
+  <%= link_to 'Delete Post', post_path(@post), method: :delete %>
+<% end %>
+```
+
+## Role inheritance
+Pundit Role Play supports role inheritance out of the box. For example:
+
+- **Admin** inherits permissions from **Manager** and **Editor**.
+- **Manager** inherits permissions from **Editor**.
+
+This means an admin user will automatically have all the permissions of a manager and editor.
+
+## Contributing
+We welcome contributions! Please fork the repository, make changes, and submit a pull request.
+
+### Steps to contribute
+1. Fork the repository.
+2. Create a new branch for your feature: `git checkout -b my-new-feature`.
+3. Commit your changes: `git commit -am 'Add new feature'`.
+4. Push the branch: `git push origin my-new-feature`.
+5. Submit a pull request.
+
+## License
+This gem is released under the [MIT License](LICENSE).
+
+## Support
+If you encounter any issues, please open an issue in the GitHub repository.
+
+---
+
+**Pundit Role Play** simplifies role-based authorization for Pundit users. Get started today and make authorization in your Rails app clean, flexible, and powerful!
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/generators/pundit_role_play/install/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module PunditRolePlay
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_roles_folder
+        empty_directory "app/roles"
+      end
+
+      def create_application_role
+        template "application_role.rb", "app/roles/application_role.rb"
+      end
+
+      def display_readme
+        readme "README.md" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/pundit_role_play/install/templates/README.md

@@ -0,0 +1 @@
+PunditRolePlay was successfully installed! Generate a new role by running `rails g pundit_role_play:role <role_name>`.

data/lib/generators/pundit_role_play/install/templates/application_role.rb

@@ -0,0 +1 @@
+class ApplicationRole < PunditRolePlay::Role; end

data/lib/generators/pundit_role_play/role/role_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module PunditRolePlay
+  module Generators
+    class RoleGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      argument :role_name, type: :string, required: true, banner: "Role name"
+
+      def create_role_file
+        # Generate the role file in app/roles
+        template "role.rb", File.join("app/roles", "#{file_name}.rb")
+      end
+
+      private
+
+      # Ensure the class name ends with "Role"
+      def class_name
+        role_name.camelize.end_with?("Role") ? role_name.camelize : "#{role_name.camelize}Role"
+      end
+
+      # Convert the class name to a file name
+      def file_name
+        class_name.underscore
+      end
+    end
+  end
+end

data/lib/generators/pundit_role_play/role/templates/role.rb

@@ -0,0 +1,7 @@
+class <%= class_name %> < ApplicationRole
+  PERMISSIONS = {
+    users: :read,
+    another_resource: :write
+  }.freeze
+end
+

data/lib/pundit_role_play/adapter/active_record.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+
+module PunditRolePlay
+  module Adapter
+    module ActiveRecord
+      def has_pundit_role
+        include PunditRolePlay::Adapter::ActiveRecordMethods
+      end
+    end
+
+    module ActiveRecordMethods
+      def role
+        value = super
+
+        return nil unless value.present?
+
+        value.constantize
+
+        value
+      rescue NameError
+        # Handle the case where the string can't be converted to a constant
+        # eg. "testrole" (which should be "TestRole")
+        #
+        # Handle the case where the constant does not exist
+        raise RoleNotFoundError
+      end
+
+      def has_role?(role)
+        role.to_sym == self.role.underscore.sub(/_role$/, '').to_sym
+      end
+
+      def pretty_role_name
+        role.gsub(/Role/, "")
+      end
+
+      def permissions
+        role.constantize.permissions
+      rescue NoMethodError
+        Permissions.new(nil)
+      end
+    end
+  end
+end

data/lib/pundit_role_play/adapter/pundit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PunditRolePlay
+  module Adapter
+    module Pundit
+      def can_read?(resource: self.class.to_s.gsub("Policy", "").pluralize.underscore)
+        user.permissions.can?(:read, resource.to_sym)
+      end
+
+      def can_write?(resource: self.class.to_s.gsub("Policy", "").pluralize.underscore)
+        user.permissions.can?(:write, resource.to_sym)
+      end
+    end
+  end
+end

data/lib/pundit_role_play/permissions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PunditRolePlay
+  class Permissions
+    attr_reader :permissions
+
+    def initialize(role)
+      @permissions = role::PERMISSIONS
+    rescue TypeError => e
+      # Handle the case where the role is nil
+      raise e unless role.nil?
+
+      @permissions = {}
+    end
+
+    def can?(operation, resource)
+      # If you can write to a resource, you can also read from it
+      return true if permissions[resource.to_sym] == :write
+
+      permissions[resource.to_sym] == operation.to_sym
+    end
+
+    def [](resource)
+      permissions[resource.to_sym]
+    end
+  end
+end

data/lib/pundit_role_play/railtie.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module PunditRolePlay
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      # Add app/roles to eager_load_paths early
+      Rails.application.config.eager_load_paths << Rails.root.join("app", "roles")
+    end
+
+    initializer "pundit_role_play.eager_load_roles" do
+      Rails.application.config.to_prepare do
+        # Force Zeitwerk to load all role classes
+        Dir[Rails.root.join("app/roles/**/*.rb")].each { |file| require_dependency file }
+      end
+    end
+
+    initializer "pundit_role_play.extend_active_record" do
+      ActiveSupport.on_load(:active_record) do
+        extend PunditRolePlay::Adapter::ActiveRecord
+      end
+    end
+
+    initializer "pundit_role_play.extend_application_policy" do
+      Rails.application.config.to_prepare do
+        if defined?(ApplicationPolicy)
+          ApplicationPolicy.include(PunditRolePlay::Adapter::Pundit)
+        end
+      end
+    end
+  end
+end

data/lib/pundit_role_play/role.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "permissions"
+
+module PunditRolePlay
+  class Role
+    def self.inherited(subclass)
+      super
+
+      PunditRolePlay.register_role(subclass.name)
+    end
+
+    def self.permissions
+      Permissions.new(self)
+    end
+  end
+end

data/lib/pundit_role_play/version.rb

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

data/lib/pundit_role_play.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "pundit_role_play/adapter/active_record"
+require_relative "pundit_role_play/adapter/pundit"
+require_relative "pundit_role_play/railtie"
+require_relative "pundit_role_play/role"
+require_relative "pundit_role_play/version"
+
+module PunditRolePlay
+  class Error < StandardError; end
+  class RoleNotFoundError < Error
+    def message
+      "Role does not exist"
+    end
+  end
+
+  def self.roles
+    @roles ||= []
+  end
+
+  def self.register_role(name)
+    roles << name unless name == "ApplicationRole"
+    roles.uniq!
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: pundit_role_play
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmy Poulsen
+- Tobias Knudsen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: |-
+  This gem is a simple role based authorization gem for Pundit.
+      It allows you to define roles and permissions in a simple way and use them in your Pundit policies.
+email:
+- jimmypoulsen96@gmail.com
+- tobias.knudsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/pundit_role_play/install/install_generator.rb
+- lib/generators/pundit_role_play/install/templates/README.md
+- lib/generators/pundit_role_play/install/templates/application_role.rb
+- lib/generators/pundit_role_play/role/role_generator.rb
+- lib/generators/pundit_role_play/role/templates/role.rb
+- lib/pundit_role_play.rb
+- lib/pundit_role_play/adapter/active_record.rb
+- lib/pundit_role_play/adapter/pundit.rb
+- lib/pundit_role_play/permissions.rb
+- lib/pundit_role_play/railtie.rb
+- lib/pundit_role_play/role.rb
+- lib/pundit_role_play/version.rb
+homepage: https://github.com/synsbasen/pundit-role-play
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/synsbasen/pundit-role-play
+  source_code_uri: https://github.com/synsbasen/pundit-role-play
+  changelog_uri: https://github.com/synsbasen/pundit-role-play
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A simple role based authorization gem for Pundit
+test_files: []