controller_policies 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db99c9c096c0c752d9d035f928f7c92e9f6efff716975d2e4672b3c18443b16a
+  data.tar.gz: 01a131a24ad0f546ada81e5d10c1d27564591147c09004a97e6691150d18be71
+SHA512:
+  metadata.gz: 05ebbc1bad897b0b6fecf8280f625a5f4d73013255c0dee1e7ab5a6e564fc9aedd21772b9b0bd27d159cf698e09377b3b829dcf5ee60584c95a250841536a336
+  data.tar.gz: 5e23aa2064c53ea42acea98b1bffaa89767558e4fe2a7a7938b2331b258f0dc0c661f1b8542d866cacf44ec453a222e34019b0c8b7e1b77e1091be89281b84bd

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 TODO: Write your email address. 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,142 @@
+# Controller Policies
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'controller_policies', '~> 0.1'
+```
+
+## Usage
+
+## Generating Definitions
+
+This gem takes advantage of placing all your policy definitions for controllers in one folder (`app/policies`). To generate a policy, run:
+
+```sh
+rails g policy_definition my/namespace
+```
+
+This will generate a file: `app/policies/my/namespace/definitions.rb`
+
+The developer should edit this file and add the policies for the app.
+
+### `actions` key
+
+The `actions` key is an array of strings that contain a list of supported controller actions for automation of policy checking.
+
+For example, you have this definition:
+
+```ruby
+module Base
+  DEFINITIONS = {
+    code: 'policy_code',
+    name: 'Policy Name',
+    description: 'I am a policy.',
+    actions: ['feature_app/users', 'data_app/products#index', 'subscriptions']
+  }
+end
+```
+
+The above definition will have enforced policies on `Base::FeatureApp::UsersController` (all actions), `Base::DataApp::ProductsController` (`index` action) and `Base::SubscriptionController`.
+
+**Do note that the `actions` array implement *Regular Expression Matching*. That means that if you have multiple controllers with the same name on their parent namespace, the parent will be matched first.** To avoid this problem, simply add the namespace to match the intended child instead.
+
+```ruby
+module Base
+  DEFINITIONS = {
+    code: 'policy_code',
+    name: 'Policy Name',
+    description: 'I am a policy.',
+    actions: ['feature_app/users', 'another_base/data_app/products#index', 'base/subscriptions']
+  }
+end
+```
+
+## Adding Policy Enforcement in Controllers
+
+Simply add the line `has_enforced_policies`, and pass a block with one argument (`ability_code`), or override the `ability?(ability_code)` method.
+
+```ruby
+class MyController < ApplicationController
+  has_enforced_policies do |ability_code|
+    current_user.abilities.include? ability_code
+  end
+
+  # ...
+end
+```
+
+```ruby
+class MyController < ApplicationController
+  has_enforced_policies
+
+  def ability?(ability_code)
+    current_user.abilities.include? ability_code
+  end
+  # ...
+end
+```
+
+Since storing abilities are very flexible and there are truly infinite ways of doing it, *this gem did not support that feature.* Instead, the developer must define their own ability checking.
+
+## Ability
+
+The Ability class is a model for abilities that come from the definition files.
+
+### Class Methods
+
+#### #all
+
+Get all abilities from all definitions.
+
+#### #all_codes
+
+Get all ability codes from all definitions.
+
+#### #where(query)
+
+Filter abilities based on namespace. `query` can be a String, Module or Class.
+
+#### #find(query)
+
+Find an ability within a namespace. `query` can be a String, Module or Class.
+
+#### #match(expression)
+
+Match abilities based on a matching string or regex. The matcher is based on the namespace. `expression` can be a Regexp or String.
+
+#### #mill(expression)
+
+Find an ability based on a matching string or regex. The matcher is based on the namespace. `expression` can be a Regexp or String.
+
+### Instance Methods
+
+#### #code
+
+The code of the ability.
+
+#### #name
+
+The name of the ability.
+
+#### #description
+
+The description of the ability.
+
+#### #actions
+
+Controller actions that the ability can check against.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tieeeeen1994/controller_policies. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tieeeeen1994/controller_policies/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ControllerPolicies project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tieeeeen1994/controller_policies/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop]

data/controller_policies.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/controller_policies/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'controller_policies'
+  spec.version = ControllerPolicies::VERSION
+  spec.authors = ['Tien']
+  spec.email = ['tieeeeen1994@gmail.com']
+
+  spec.summary = 'Allows the developer to define policies for controllers.'
+  spec.homepage = 'https://github.com/tieeeeen1994/rails-controller-policies'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[spec/ .git .github Gemfile .vscode]) ||
+        f.end_with?(*%w[.gem .yml .rspec .gitignore])
+    end
+  end
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'rails', '~> 7'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/ability.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Ability struct that should house the ability definitions.
+class Ability
+  attr_reader :code, :name, :description, :actions, :namespace
+
+  # Constructor for Ability object
+  # code - The code of the ability (see definitions.rb)
+  # name - The name of the ability (see definitions.rb)
+  # namespace - The namespace of the ability. You don't need to worry about this.
+  # description - The description of the ability (see definitions.rb)
+  # actions - Controller actions that the ability can check against (see definitions.rb)
+  def initialize(code:, name:, namespace: nil, description: '', actions: [])
+    @code = code
+    @name = name
+    @description = description
+    @actions = actions
+    @namespace = namespace
+  end
+
+  class << self
+    alias instantiate new
+
+    # Get all abilities from all definitions.
+    def all
+      definitions.map { |ability| instantiate(**ability) }
+    end
+
+    # Get all ability codes from all definitions.
+    # Unused args. Need to allow filtering through namespace.
+    def all_codes(_query_string = nil)
+      definitions.pluck(:code)
+    end
+
+    # Filter abilities based on namespace.
+    def where(query)
+      case query.class.to_s
+      when 'String'
+        all.select { |ability| ability.namespace.to_s == trim(query).camelize }
+      when 'Module', 'Class'
+        all.select { |ability| ability.namespace == query }
+      end
+    end
+
+    # Find an ability within a namespace.
+    def find(query_string)
+      where(query_string).first
+    end
+
+    # Match abilities based on a matching string or regex. The matcher is based on the namespace.
+    def match(expression)
+      case expression.class.to_s
+      when 'String' then all.select { |ability| ability.namespace.to_s.match?(/#{trim(expression).camelize}/) }
+      when 'Regexp' then regex_matcher(expression)
+      end
+    end
+
+    # Find an ability based on a matching string or regex. The matcher is based on the namespace.
+    def mill(expression)
+      match(expression).first
+    end
+
+    # Path to the policy folder.
+    def policy_path
+      @policy_path ||= Rails.root.join('app/policies')
+    end
+
+    private
+
+    def definitions
+      @definitions ||= begin
+        data = []
+        Dir["#{policy_path}/**/definitions.rb"].each do |file_path|
+          data += definition_files_post_processing(file_path)
+        end
+        data
+      end
+    end
+
+    def definition_files_post_processing(file_path)
+      module_constant = convert_namespace(file_path)
+      policy_definitions = module_constant::DEFINITIONS
+      policy_definitions.map do |policy_definition|
+        policy_definition[:namespace] = module_constant
+        policy_definition
+      end
+    end
+
+    def regex_matcher(expression)
+      all.select do |ability|
+        ability.namespace.to_s.match?(expression) || ability.namespace.to_s.underscore.match?(expression)
+      end
+    end
+
+    def trim(namespace)
+      namespace.delete_prefix('/').delete_suffix('/')
+    end
+
+    def convert_namespace(file_path)
+      trim(file_path[policy_path.to_s.length..-4].split('/')[0...-1].join('/')).camelize.constantize
+    end
+  end
+end

data/lib/controller_policies/action_controller_patch.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ControllerPolicies
+  # Module containing action controller patches.
+  module ActionControllerPatch
+    def has_enforced_policies(&block) # rubocop:disable Naming/PredicateName
+      include ControllerPolicies::Enforcement
+
+      return unless block_given?
+
+      define_method(:ability?, &block)
+    end
+  end
+end

data/lib/controller_policies/enforcement.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ControllerPolicies
+  # Concern that includes the enforcement of abilities.
+  module Enforcement
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :check_abilities_by_definition
+
+      # Main driver for checking abilities.
+      # It is still possible to manually check abilities by calling this method in a controller.
+      # Developers need to override this method to implement the own ability checking logic.
+      # It needs to accept an ability code and return a boolean.
+      def ability?(ability_code) # rubocop:disable Lint/UnusedMethodArgument
+        raise AbilityMethodUnimplementedError
+      end
+
+      private
+
+      # Automatically check abilities based on definition provided in policies.
+      # It has the power to match based on controller, actions and wildcards.
+      def check_abilities_by_definition
+        applicable_abilities.each do |ability|
+          break unless ability?(ability.code)
+        end
+      end
+
+      # Simply gets the controller namespace.
+      def controller_namespace
+        @controller_namespace ||= controller_path.split('/')[0...-1].join('/')
+      end
+
+      # Method that attempts to go through policy definitions and check if it matches the current controller.
+      # If it finds a match, it will be an applicable definition to check abilities for.
+      def applicable_abilities
+        @applicable_abilities ||= Ability.where(controller_namespace).select do |ability|
+          matching_actions = ability.actions.select { |action| /#{action}/.match?("#{controller_path}##{action_name}") }
+          matching_actions.present?
+        end
+      end
+    end
+  end
+end

data/lib/controller_policies/railtie.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'action_controller_patch'
+require_relative 'enforcement'
+
+module ControllerPolicies
+  # Railtie for Breadcrumb Helper for Rails integration.
+  class Railtie < Rails::Railtie
+    generators do
+      require_relative '../generators/policy_definition_generator'
+    end
+
+    initializer 'controller_policies.action_controller' do |app|
+      app.reloader.to_prepare do
+        ::ActionController::Base.singleton_class.prepend ActionControllerPatch
+        ::ActionController::API.singleton_class.prepend ActionControllerPatch
+      end
+    end
+
+    initializer 'controller_policies.autoloaders' do
+      Rails.autoloaders.each do |autoloader|
+        autoloader.ignore(Rails.root.join('app/policies'))
+      end
+
+      Dir[Rails.root.join('app/policies/**/*.rb')].each { |definition| require definition }
+    end
+  end
+end

data/lib/controller_policies/version.rb

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

data/lib/controller_policies.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'controller_policies/version'
+
+raise LoadError, 'The project is not a Rails project!' unless defined?(Rails)
+
+require_relative 'ability'
+
+# Base namespace for the gem.
+module ControllerPolicies
+  # Exception raised for unimplemented ability? method for those including ControllerPolicies::Enforcement.
+  class AbilityMethodUnimplementedError < RuntimeError
+    def initialize(_msg)
+      super('`ability?(ability_code)` method is not implemented')
+    end
+  end
+end
+
+require_relative 'controller_policies/railtie'

data/lib/generators/policy_definition_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Generates a definition file for a namespace.
+class PolicyDefinitionGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  desc 'Generates a policy definition file based on given namespace.'
+  argument :name, type: :string, required: true, desc: 'The namespace for the definition file.'
+
+  def create_policy_definition_file
+    return if processed_name.blank?
+
+    template 'definitions.rb', "app/policies/#{processed_name}/definitions.rb"
+  end
+
+  private
+
+  def processed_name
+    @processed_name ||= name.strip.delete_prefix('/').delete_suffix('/')
+  end
+end

data/lib/generators/templates/definitions.rb.tt

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module <%= name.camelize %>
+  DEFINITIONS = [
+    {
+      # Used as identifier for the policy.
+      code: 'Policy-Code',
+      # Readable name for the policy.
+      name: 'Readable Policy Name',
+      # Readable description for the policy.
+      description: 'Short description of what this policy allows',
+      # Controller actions the policy applies to. It works as matchers based on routes.
+      # It can be empty for manual policy checking.
+      actions: ['feature_app/users', 'data_app/products#index', 'subscriptions']
+    },
+    {
+      code: 'Another-Policy-Code',
+      name: 'Another Policy',
+      description: 'Long description.',
+    }
+  ].freeze
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: controller_policies
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tien
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+description:
+email:
+- tieeeeen1994@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- controller_policies.gemspec
+- lib/ability.rb
+- lib/controller_policies.rb
+- lib/controller_policies/action_controller_patch.rb
+- lib/controller_policies/enforcement.rb
+- lib/controller_policies/railtie.rb
+- lib/controller_policies/version.rb
+- lib/generators/policy_definition_generator.rb
+- lib/generators/templates/definitions.rb.tt
+homepage: https://github.com/tieeeeen1994/rails-controller-policies
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tieeeeen1994/rails-controller-policies
+  rubygems_mfa_required: 'true'
+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.3
+signing_key:
+specification_version: 4
+summary: Allows the developer to define policies for controllers.
+test_files: []