active_element 0.0.2 → 0.0.4

data/lib/active_element/controller_interface.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  # Provides the `active_element` object available on all controller instance/class methods.
+  # Encapsulates core functionality such as `authenticate_with`, `permit_action`, and `component`
+  # without polluting application controller namespace.
+  class ControllerInterface
+    attr_reader :missing_template_store, :current_user
+
+    @state = {}
+
+    class << self
+      attr_reader :state
+    end
+
+    def initialize(controller_class, controller_instance = nil)
+      @controller_class = controller_class
+      @controller_instance = controller_instance
+      initialize_state
+      @missing_template_store = {}
+      @authorize = false
+    end
+
+    def authorize?
+      @authorize
+    end
+
+    def application_name
+      RailsComponent.new(::Rails).application_name
+    end
+
+    def authenticate_with(&block)
+      state[:authenticator] = block
+    end
+
+    def authorize_with(&block)
+      @authorize = true
+      @current_user = block.call
+    end
+
+    def authenticate
+      authenticator&.call
+    end
+
+    def permit_action(action, with: nil, always: false)
+      raise ArgumentError, "Must specify `with: '<permission>'` or `always: true`" unless with.present? || always
+      raise ArgumentError, 'Cannot specify both `with` and `always: true`' if with.present? && always
+
+      state[:permissions] << { with: with, always: always, action: action }
+    end
+
+    def authenticator
+      state[:authenticator]
+    end
+
+    def permissions
+      state.fetch(:permissions)
+    end
+
+    def component
+      return (@component ||= ActiveElement::Component.new(controller_instance)) unless controller_instance.nil?
+
+      raise ArgumentError, 'Attempted to use ActiveElement component from a controller class method.'
+    end
+
+    private
+
+    attr_reader :controller_class, :controller_instance
+
+    def initialize_state
+      self.class.state[controller_class] ||= { permissions: [], authenticator: nil }
+    end
+
+    def state
+      self.class.state[controller_class]
+    end
+  end
+end

data/lib/active_element/permissions_check.rb

@@ -3,6 +3,8 @@
 module ActiveElement
   # Verifies provided permissions against required permissions.
   class PermissionsCheck
+    include Paintbrush
+
     def initialize(required:, actual:, controller_path:, action_name:, rails_component:)
       @required = required.presence || []
       @actual = normalized(actual)
@@ -18,41 +20,58 @@ module ActiveElement
 
     def message
       return development_environment_message if rails_component.environment == 'development'
-      return "User access granted for permission(s): #{applicable.join(', ')}" if permitted?
+      return permitted_message if permitted?
 
-      "User access forbidden. Missing user permission(s): #{missing.join(', ')}"
+      forbidden_message
     end
 
     def missing
       @missing ||= applicable.reject do |permission|
-        actual.include?(permission.to_s)
-      end.map(&:to_s)
+        next true if permission.fetch(:always, false)
+
+        actual.include?(permission.fetch(:with).to_s)
+      end
     end
 
     def applicable
       @applicable ||= default_permissions + required_permissions
     end
 
+    def applicable_permissions
+      applicable.map { |permission| permission.fetch(:with) }
+    end
+
+    def missing_permissions
+      missing.map { |permission| permission.fetch(:with) }
+    end
+
     private
 
     attr_reader :required, :actual, :controller_name, :action_name, :rails_component
 
     def development_environment_message
-      "Bypassed permission(s) in development environment: #{applicable.join(', ')}"
+      "Bypassed permission(s) in development environment: #{applicable_permissions.join(', ')}"
+    end
+
+    def permitted_message
+      paintbrush { green "User access granted for permission(s): #{cyan applicable_permissions.join(', ')}" }
+    end
+
+    def forbidden_message
+      paintbrush { red "User access forbidden. Missing user permission(s): #{cyan missing_permissions.join(', ')}" }
     end
 
     def default_permissions
       return [] if normalized_action.nil?
 
-      ["can_#{normalized_action}_#{rails_component.application_name}_#{controller_name}"]
+      [{
+        action: normalized_action,
+        with: "can_#{normalized_action}_#{rails_component.application_name}_#{controller_name}"
+      }]
     end
 
     def required_permissions
-      @required_permissions ||= required.map do |permission, options|
-        next nil unless applicable?(options)
-
-        permission
-      end.compact
+      @required_permissions ||= required.select { |options| applicable?(options) }
     end
 
     def normalized_action
@@ -74,28 +93,13 @@ module ActiveElement
     end
 
     def applicable?(options)
-      return true if !options.key?(:only) && !options.key?(:except)
-      return true if only_applicable?(options)
-      return false if except_applicable?(options)
-
-      false
-    end
-
-    def only_applicable?(options)
-      return false unless options.key?(:only)
-
-      normalized(options.fetch(:only)).include?(action_name)
-    end
-
-    def except_applicable?(options)
-      return false unless options.key?(:except)
-
-      normalized(options.fetch(:except)).include?(action_name)
+      options.fetch(:action).to_s == action_name
     end
 
     def raise_unprotected_route_error
       raise UnprotectedRouteError,
-            "#{controller_name.titleize.tr(' ', '')}##{action_name} must be protected with `permit_user`"
+            "#{controller_name.titleize.tr(' ', '')}##{action_name} must be protected with " \
+            '`active_element.permit_action`'
     end
   end
 end

data/lib/active_element/permissions_report.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  # Generates a report of all permissions used by a given application. Used by `rake active_element:permissions`
+  # to provide a convenient interface to listing all required permissions so that they can be provisioned to
+  # users as needed.
+  class PermissionsReport
+    include Paintbrush
+
+    COLOR_MAP = { list: :cyan, view: :blue, create: :green, delete: :red, edit: :yellow, text: :white }.freeze
+
+    def initialize
+      ActiveElement.eager_load_controllers
+      ActiveElement.eager_load_models
+      @buffer = []
+    end
+
+    def report
+      generate
+      buffer.join("\n")
+    end
+
+    private
+
+    attr_reader :buffer
+
+    def generate
+      buffer << paintbrush { blue "\nThe following user permissions are used by this application:\n" }
+      permissions.each do |permission|
+        buffer << paintbrush { white "    * #{public_send(color(permission), permission)}" }
+      end
+      buffer << "\n"
+    end
+
+    def color(permission)
+      COLOR_MAP.find do |action, _|
+        permission.include?("_#{action}_")
+      end&.last || :purple
+    end
+
+    def permissions
+      routes.map(&:permissions).flatten.sort.uniq + text_search_permissions
+    end
+
+    def text_search_permissions
+      ActiveElement::Components::TextSearch.authorized_text_searches.map do |model, with, providing|
+        (Array(with) + Array(providing)).map do |field|
+          ActiveElement::Components::TextSearch::Authorization.permission_for(model: model, field: field)
+        end
+      end.flatten.uniq
+    end
+
+    def routes
+      ActiveElement::Routes.new(rails_component: ActiveElement::RailsComponent.new(Rails))
+    end
+  end
+end

data/lib/active_element/route.rb

@@ -49,7 +49,7 @@ module ActiveElement
     end
 
     def permissions
-      permissions_check.applicable.map(&:to_s)
+      permissions_check.applicable.map { |permission| permission.fetch(:with).to_s }
     end
 
     def rails_route?

data/lib/active_element/routes.rb

@@ -41,7 +41,7 @@ module ActiveElement
 
     def descendants_with_permissions
       @descendants_with_permissions ||= descendants.map do |controller_class|
-        [controller_class.new, controller_class.active_element_permissions]
+        [controller_class.new, controller_class.active_element.permissions]
       end.compact
     end
 

data/lib/active_element/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveElement
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end

data/lib/active_element.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-require 'faraday'
 require 'rouge'
 require 'kaminari'
 require 'sassc'
 require 'bootstrap'
 require 'active_record'
-# require 'rspec/documentation' # FIXME: Load dynamically when running rspec documentation command.
+require 'paintbrush'
 
 require_relative 'active_element/version'
-require_relative 'active_element/active_record_text_search_authorization'
-require_relative 'active_element/colorized_string'
 require_relative 'active_element/active_menu_link'
 require_relative 'active_element/permissions_check'
+require_relative 'active_element/permissions_report'
+require_relative 'active_element/controller_interface'
 require_relative 'active_element/controller_action'
 require_relative 'active_element/rails_component'
 require_relative 'active_element/route'
@@ -30,6 +29,8 @@ module ActiveElement
   class << self
     attr_writer :application_name, :navbar_items
 
+    include Paintbrush
+
     def application_title
       @application_name || RailsComponent.new(Rails).application_name.titleize
     end
@@ -38,6 +39,14 @@ module ActiveElement
       @navbar_items || inferred_navbar_items(user)
     end
 
+    def warning(message)
+      warn "#{log_tag} #{paintbrush { yellow(message) }}"
+    end
+
+    def log_tag
+      paintbrush { cyan "[#{blue 'ActiveElement'}]" }
+    end
+
     def active_path_class(user:, current_navbar_item:, current_path:, controller_path:, action_name:)
       if ActiveMenuLink.new(
         rails_component: RailsComponent.new(Rails),
@@ -71,12 +80,17 @@ module ActiveElement
       false
     end
 
+    def eager_load_models
+      eager_load(:models)
+    end
+
     def eager_load_controllers
-      Pathname.new(__dir__)
-              .join('../app/controllers/active_element')
-              .glob('**/*_controller.rb')
-              .each { |path| require path }
-      Rails.root.join('app/controllers/admin/').glob('**/*_controller.rb').each { |path| require path }
+      eager_load(:controllers)
+    end
+
+    def eager_load(resource)
+      suffix = resource == :controllers ? '_controller' : nil
+      Rails.root.join("app/#{resource}").glob("**/*#{suffix}.rb").each { |path| require path }
     end
 
     private
@@ -90,7 +104,7 @@ module ActiveElement
 
     def user_routes(user)
       ActiveElement::Routes.new(
-        permissions: user.permissions,
+        permissions: user&.permissions,
         rails_component: ActiveElement::RailsComponent.new(Rails)
       )
     end

data/lib/tasks/active_element.rake

@@ -3,21 +3,6 @@
 namespace :active_element do
   desc 'Displays all permissions used by this application'
   task permissions: :environment do
-    ActiveElement.eager_load_controllers
-    routes = ActiveElement::Routes.new(rails_component: ActiveElement::RailsComponent.new(Rails))
-    permissions = routes.map(&:permissions).flatten.sort.uniq
-    $stdout.puts ActiveElement::ColorizedString.new(
-      "\nThe following user permissions are used by this application:\n",
-      color: :light_blue
-    ).value
-    permissions.each do |permission|
-      color = { list: :cyan, view: :blue, create: :green, delete: :red, edit: :yellow }.find do |action, _|
-        permission.include?("_#{action}_")
-      end&.last || :purple
-      $stdout.puts('    ' \
-                   "#{ActiveElement::ColorizedString.new('*', color: :white).value} " \
-                   "#{ActiveElement::ColorizedString.new(permission, color: color).value}")
-    end
-    $stdout.puts
+    $stdout.puts ActiveElement::PermissionsReport.new.report
   end
 end

data/rspec-documentation/pages/Components/Tables.md

@@ -15,7 +15,7 @@ collection = [
   User.new(name: 'Jane', email: 'jane@example.org')
 ]
 
-html = active_element_component.table collection: collection, fields: [:name, :email]
+html = active_element.component.table collection: collection, fields: [:name, :email]
 
 it_documents html do
   expect(html).to include 'John'
@@ -32,7 +32,7 @@ end
 
 item = User.new(name: 'John', email: 'john@example.com', overview: 'Writes Ruby code for a living.')
 
-html = active_element_component.table item: item, fields: [:name, :email, :password, :secret]
+html = active_element.component.table item: item, fields: [:name, :email, :password, :secret]
 
 it_documents html do
   expect(html).to include 'John'

data/rspec-documentation/spec_helper.rb

@@ -30,6 +30,6 @@ RSpec::Documentation.configure do |config|
       end
     end
 
-    context.active_element_component = ActiveElement::Component.new(StubbedController.new)
+    context.active_element.component = ActiveElement::Component.new(StubbedController.new)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_element
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.3.0alpha3
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: paintbrush
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -118,14 +118,15 @@ files:
 - app/assets/javascripts/active_element/form.js
 - app/assets/javascripts/active_element/json_field.js
 - app/assets/javascripts/active_element/pagination.js
-- app/assets/javascripts/active_element/search_field.js
+- app/assets/javascripts/active_element/popover.js
 - app/assets/javascripts/active_element/secret.js
 - app/assets/javascripts/active_element/setup.js
+- app/assets/javascripts/active_element/text_search_field.js
 - app/assets/javascripts/active_element/theme.js
+- app/assets/javascripts/active_element/toast.js
 - app/assets/stylesheets/active_element/_variables.scss
 - app/assets/stylesheets/active_element/application.scss
 - app/controllers/active_element/application_controller.rb
-- app/controllers/active_element/text_searches_controller.rb
 - app/views/active_element/components/_horizontal_tabs.html.erb
 - app/views/active_element/components/_vertical_tabs.html.erb
 - app/views/active_element/components/button.html.erb
@@ -175,8 +176,6 @@ files:
 - config/routes.rb
 - lib/active_element.rb
 - lib/active_element/active_menu_link.rb
-- lib/active_element/active_record_text_search_authorization.rb
-- lib/active_element/colorized_string.rb
 - lib/active_element/component.rb
 - lib/active_element/components.rb
 - lib/active_element/components/button.rb
@@ -189,6 +188,11 @@ files:
 - lib/active_element/components/secret_fields.rb
 - lib/active_element/components/tab.rb
 - lib/active_element/components/tabs.rb
+- lib/active_element/components/text_search.rb
+- lib/active_element/components/text_search/active_record_authorization.rb
+- lib/active_element/components/text_search/authorization.rb
+- lib/active_element/components/text_search/component.rb
+- lib/active_element/components/text_search/sql.rb
 - lib/active_element/components/translations.rb
 - lib/active_element/components/util.rb
 - lib/active_element/components/util/association_mapping.rb
@@ -199,9 +203,12 @@ files:
 - lib/active_element/components/util/form_value_mapping.rb
 - lib/active_element/components/util/i18n.rb
 - lib/active_element/components/util/record_mapping.rb
+- lib/active_element/components/util/record_path.rb
 - lib/active_element/controller_action.rb
+- lib/active_element/controller_interface.rb
 - lib/active_element/engine.rb
 - lib/active_element/permissions_check.rb
+- lib/active_element/permissions_report.rb
 - lib/active_element/rails_component.rb
 - lib/active_element/route.rb
 - lib/active_element/routes.rb