consent 1.0.1 → 2.1.0

data/gemfiles/rails_7_1.gemfile.lock

@@ -0,0 +1,337 @@
+PATH
+  remote: ../../rubocop-powerhome
+  specs:
+    rubocop-powerhome (0.5.3)
+      rubocop (= 1.66.1)
+      rubocop-performance
+      rubocop-rails
+      rubocop-rake
+      rubocop-rspec
+
+PATH
+  remote: ..
+  specs:
+    consent (2.1.0)
+      cancancan (= 3.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      marcel (~> 1.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    byebug (11.1.3)
+    cancancan (3.2.1)
+    coderay (1.1.3)
+    combustion (1.5.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crass (1.0.6)
+    csv (3.3.2)
+    date (3.4.1)
+    diff-lcs (1.6.0)
+    drb (2.2.1)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    license_finder (7.2.1)
+      bundler
+      csv (~> 3.2)
+      rubyzip (>= 1, < 3)
+      thor (~> 1.2)
+      tomlrb (>= 1.3, < 2.1)
+      with_env (= 1.1.0)
+      xml-simple (~> 1.1.9)
+    logger (1.6.6)
+    loofah (2.24.0)
+      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)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.4)
+    mutex_m (0.3.0)
+    net-imap (0.4.19)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.17.2-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.17.2-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.17.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.17.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.17.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.10)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (7.1.3.2)
+      actioncable (= 7.1.3.2)
+      actionmailbox (= 7.1.3.2)
+      actionmailer (= 7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actiontext (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3.2)
+    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 (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      irb
+      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.12.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      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-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    rubocop (1.66.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.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.29.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.4.0)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.4.1)
+    sqlite3 (1.7.3-aarch64-linux)
+    sqlite3 (1.7.3-arm-linux)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
+    stringio (3.1.3)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tomlrb (2.0.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    with_env (1.1.0)
+    xml-simple (1.1.9)
+      rexml
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  aarch64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  activerecord (>= 5)
+  appraisal (~> 2.5.0)
+  base64
+  bigdecimal
+  bundler (~> 2.1)
+  combustion (~> 1.3)
+  consent!
+  license_finder (>= 7.0)
+  logger
+  mutex_m
+  net-imap (< 0.5.0)
+  nokogiri (< 1.18)
+  pry (>= 0.14.2)
+  pry-byebug (= 3.10.1)
+  rails (= 7.1.3.2)
+  rake (~> 13)
+  rspec (~> 3.0)
+  rspec-rails (~> 6.1.5)
+  rubocop-powerhome!
+  sqlite3 (~> 1.7.3)
+  zeitwerk (< 2.7.0)
+
+BUNDLED WITH
+   2.5.23

data/lib/consent/ability.rb

@@ -1,15 +1,64 @@
 # frozen_string_literal: true
 
 module Consent
-  # Defines a CanCan(Can)::Ability class based on a permissions hash
+  #
+  # Defines a CanCan(Can)::Ability class based on Consent::Permissions
+  #
   class Ability
     include CanCan::Ability
 
-    def initialize(*args, apply_defaults: true)
-      @context = *args
+    #
+    # Initialize a Consent::Ability consenting all the given permissions.
+    #
+    # When super_user is set to true, it grants `:manage :all`, which is understood by
+    # CanCan as a keyword to allow everything with no restrictions.
+    #
+    # If apply_defaults is set to true, Consent::Ability will grant the default views
+    # defined in the permissions.
+    #
+    # I.e.:
+    #
+    #   Consent.define Project, 'Projects' do
+    #     view :department, "User's department only" do |user|
+    #       { department_id: user.id }
+    #     end
+    #     view :self, "User's own projects" do |user|
+    #       { user_id: user.id }
+    #     end
+    #
+    #     action :close, views: %i[department self], default_view: :self
+    #   end
+    #
+    #   Consent::Ability.new(user, permissions: user&.permissions,
+    #                              super_user: user&.super_user?,
+    #                              apply_defaults: user.present?)
+    #
+    # @param [*] *context the view context, usually the user and some additional information
+    # @param [Array<Consent::Permission>] permissions the list of permissions to grant
+    # @param [Boolean] super_user whether Consent should grant :manage :all
+    # @param [Boolean] apply_defaults whether Consent should grant default views
+    #
+    def initialize(*context, permissions: nil, super_user: false, apply_defaults: true)
+      @context = *context
+
       apply_defaults! if apply_defaults
+      can :manage, :all if super_user
+
+      permissions&.each do |permission|
+        consent(**permission.slice(:subject, :action, :view).symbolize_keys)
+      end
     end
 
+    # Consents a subject/action/view to the ability
+    #
+    # `consent!` will add a `can` permission to the ability based on the
+    # view rules defined in the Consent definitions.
+    #
+    # @param [Class,Symbol] subject the target subject of the action
+    # @param [Symbol] action the action being granted on the subject
+    # @param [Symbol,nil] view the conditions/rules on which the action is granted
+    # @raises Consent::ViewNotFound when the view key doesn't exist in the context
+    #
     def consent!(subject: nil, action: nil, view: nil)
       view = case view
              when Consent::View
@@ -24,13 +73,55 @@ module Consent
       )
     end
 
+    # Consents a subject/action/view to the ability
+    #
+    # @see ::Consent::Ability#consent
+    #
     def consent(**kwargs)
       consent!(**kwargs)
     rescue Consent::ViewNotFound
       nil
     end
 
-    private
+    # Returns a hash where the keys are the given permissions, and the values
+    # are either true or false, representing their ability to perform the given
+    # permision
+    #
+    # @param [Array<String>,String,nil] permissions an array of the requested permissions
+    # @return [Hash<String,Boolean>] the hash with the results
+    def to_h(permissions = nil)
+      Array(permissions).reduce({}) do |result, permission|
+        result.merge permission => can?(permission)
+      end
+    end
+
+    # Check if the user has permission to perform a given action on an object.
+    #
+    #   can? :destroy, @project
+    #
+    # You can also pass the class instead of an instance (if you don't have one handy).
+    #
+    #   can? :create, Project
+    #
+    # You can also check with string form of the permission:
+    #
+    #   can? "project/create"
+    #
+    # For more info, check the documentation of [CanCan::Ability]
+    def can?(action_or_pair, subject = nil, *args)
+      action, subject = extract_action_subject(action_or_pair, subject)
+      super(action, subject, *args)
+    end
+
+    # @private
+    def relation_model_adapter(model_class, action_or_pair, subject, relation)
+      action, subject = extract_action_subject(action_or_pair, subject)
+      ::CanCan::ModelAdapters::AbstractAdapter
+        .adapter_class(model_class)
+        .new(model_class, relation_rules(model_class, action, subject, relation))
+    end
+
+  private
 
     def apply_defaults!
       Consent.subjects.each do |subject|
@@ -45,5 +136,23 @@ module Consent
         end
       end
     end
+
+    def relation_rules(model_class, action, subject, relation)
+      relevant_rules(action, subject).map do |rule|
+        unless rule.conditions.is_a?(Hash)
+          raise ::CanCan::Error, "accessible_through is only available with hash conditions"
+        end
+
+        conditions = rule.conditions.dig(*Array(relation))
+        ::CanCan::Rule.new(rule.base_behavior, action, model_class, conditions, rule.block)
+      end
+    end
+
+    def extract_action_subject(action_or_string_pair, subject)
+      return action_or_string_pair, subject if subject
+
+      subject_key, _, action_key = action_or_string_pair.rpartition("/")
+      [action_key.to_sym, Consent::SubjectCoder.load(subject_key)]
+    end
   end
 end

data/lib/consent/dsl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Consent
+  # @private
   class DSL # :nodoc:
     attr_reader :subject
 
@@ -13,14 +14,6 @@ module Consent
       DSL.build(@subject, @defaults.merge(new_defaults), &block)
     end
 
-    # rubocop:disable Lint/UnusedBlockArgument, Security/Eval
-    def eval_view(key, label, collection_conditions)
-      view key, label do |user|
-        eval(collection_conditions)
-      end
-    end
-    # rubocop:enable Lint/UnusedBlockArgument, Security/Eval
-
     def view(key, label, instance = nil, collection = nil, &block)
       collection ||= block
       @subject.views[key] = View.new(key, label, instance, collection)

data/lib/consent/{railtie.rb → engine.rb}

@@ -1,26 +1,29 @@
 # frozen_string_literal: true
 
-require 'consent/reloader'
+require "consent"
 
 module Consent
   # Plugs consent permission load to the Rails class loading cycle
-  class Railtie < Rails::Railtie
+  class Engine < Rails::Engine
     config.before_configuration do |app|
-      default_path = app.root.join('app', 'permissions')
-      config.consent = Consent::Reloader.new(
-        default_path,
-        ActiveSupport::Dependencies.mechanism
-      )
+      default_path = app.root.join("app", "permissions")
+      config.consent = Consent::Reloader.new(default_path)
     end
 
     config.after_initialize do |app|
       app.config.consent.execute
     end
 
-    initializer 'initialize consent permissions reloading' do |app|
+    initializer "consent.reloader" do |app|
       app.reloaders << config.consent
       ActiveSupport::Dependencies.autoload_paths -= config.consent.paths
       config.to_prepare { app.config.consent.execute }
     end
+
+    initializer "consent.accessible_through" do
+      ActiveSupport.on_load(:active_record) do
+        include Consent::ModelAdditions
+      end
+    end
   end
 end

data/lib/consent/model_additions.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Consent
+  #
+  # Accessible Through logic
+  #
+  # This module adds the accessible_through class method to a model.
+  # It is included in the activerecord base classes by Consent::Engine.
+  #
+  # @see Consent::ModelAdditions::ClassMethods#accessible_through
+  #
+  module ModelAdditions
+    module ClassMethods
+      # Provides a scope within the model to find instances of the model that are accessible
+      # by the given ability through a given relation in the main subject
+      #
+      # I.E.:
+      #
+      #      Given the following scenario
+      #
+      #      class User
+      #        belongs_to :territory
+      #      end
+      #
+      #      Consent.define User, "User permissions" do
+      #        view :territory do |user|
+      #          { territory: { id: user.territory_id } }
+      #        end
+      #        view :visible_territories do |user|
+      #          { territory: { id: user.visible_territory_ids } }
+      #        end
+      #
+      #        action :contact, views: %i[all no_access territory visible_territories]
+      #      end
+      #
+      #    This would give you a list of territories that the given ability can
+      #    contact their users:
+      #
+      #      > user = User.new(territory_id: 13, visible_territory_ids: [2, 3, 4])
+      #      > ability = Consent::Ability.new(user.to_session_user)
+      #      > ability.consent view: :territory, action: :contact, subject: User
+      #      > Territory.accessible_through(ability, :contact, User).to_sql
+      #      => SELECT * FROM territories WHERE id = 13
+      #      > ability.consent view: :visible_territories, action: :contact, subject: User
+      #      > Territory.accessible_through(ability, :contact, User).to_sql
+      #      => SELECT * FROM territories WHERE ((id = 13) OR (id IN (2, 3, 4)))
+      #
+      # @param ability [Consent::Ability] ability performing the query
+      # @param action_or_pair [Symbol,String] the name of the action or a subject/action pair
+      # @param subject [Class,Symbol,nil] the subject in which the action is, when action_or_pair is just the action
+      # @param relation [Symbol,Array<Symbol>] the relation or path to the relation
+      #
+      def accessible_through(ability, action_or_pair, subject = nil, relation: nil)
+        relation ||= model_name.element.to_sym
+        ability.relation_model_adapter(self, action_or_pair, subject, relation)
+               .database_records
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end