plutonium 0.10.1 → 0.10.3

data/lib/generators/pu/service/sidekiq/templates/app/sidekiq/sidekiq_job.rb

@@ -0,0 +1,5 @@
+class SidekiqJob
+  include Sidekiq::Job
+
+  sidekiq_options failures: :exhausted
+end

data/lib/generators/pu/service/sidekiq/templates/config/initializers/sidekiq.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+redis_config = {
+  url: ENV.fetch("REDIS_QUEUE_URL", ""),
+  connect_timeout: 1,  # Defaults to 1 second
+  read_timeout: 0.2, # Defaults to 1 second
+  write_timeout: 0.2, # Defaults to 1 second
+  # https://github.com/redis/redis-rb#reconnections
+  reconnect_attempts: [ # Defaults to 1
+    0, # retry immediately
+    0.25, # retry a second time after 250ms
+    1, # retry a third time after another 1s
+    5, # retry a fourth time after another 5s
+    10 # retry a fifth and final time after another 15s
+  ]
+}
+
+Sidekiq.configure_client do |config|
+  config.redis = redis_config
+
+  # Configure sidekiq client here
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = redis_config
+  config.logger = Rails.logger = Sidekiq::Logger.new($stdout)
+  config.death_handlers << lambda { |job, exception|
+    worker = job["wrapped"].safe_constantize
+    worker&.sidekiq_retries_exhausted_block&.call(job, exception)
+  }
+
+  if defined?(Prosopite)
+    # configure prosopite
+    config.server_middleware do |chain|
+      require "prosopite/middleware/sidekiq"
+      chain.add(Prosopite::Middleware::Sidekiq)
+    end
+  end
+
+  # Configure sidekiq server here
+end
+
+# Use sidekiq
+Rails.application.config.active_job.queue_adapter = :sidekiq
+
+# nil will use the "default" queue
+# some of these options will not work with your Rails version. add/remove as necessary
+Rails.application.config.action_mailer.deliver_later_queue_name = nil if Rails.application.config.respond_to?(:action_mailbox)  # defaults to "mailers"
+Rails.application.config.action_mailbox.queues.routing = nil if Rails.application.config.respond_to?(:action_mailbox)  # defaults to "action_mailbox_routing"
+Rails.application.config.active_storage.queues.analysis = nil if Rails.application.config.respond_to?(:active_storage)  # defaults to "active_storage_analysis"
+Rails.application.config.active_storage.queues.purge = nil if Rails.application.config.respond_to?(:active_storage)  # defaults to "active_storage_purge"
+Rails.application.config.active_storage.queues.mirror = nil if Rails.application.config.respond_to?(:active_storage)  # defaults to "active_storage_mirror"
+Rails.application.config.active_storage.queues.purge = :low if Rails.application.config.respond_to?(:active_storage) # put purge jobs in the `low` queue

data/lib/generators/pu/service/sidekiq/templates/config/sidekiq.yml

@@ -0,0 +1,6 @@
+---
+:queues:
+  - [critical, 5]
+  - [high, 3]
+  - [default, 2]
+  - [low, 1]

data/lib/plutonium/config.rb

@@ -3,25 +3,19 @@ require "active_model"
 
 module Plutonium
   module Config
-    # @return [Boolean] Are we developing plutonium? This is separate from Rails development.
-    mattr_accessor :development
-    @@development = ActiveModel::Type::Boolean.new.cast(ENV["PLUTONIUM_DEV"]).present?
-
-    # @return [Boolean] Should hotreload be enabled? Enabled by default in Rails development.
-    mattr_accessor :enable_hotreload
-    @@enable_hotreload = defined?(Rails.env) && Rails.env.development?
-
-    mattr_accessor :cache_discovery
-    @@cache_discovery = defined?(Rails.env) && !Rails.env.development?
-
     mattr_accessor :stylesheet_tag
     @@stylesheet_tag = ->(view_context) {
-      "<link rel=\"stylesheet\" href=\"#{Plutonium.stylesheet_link}\" />"
+      "<link rel=\"stylesheet\" href=\"#{Plutonium.stylesheet_link}\" data-turbo-track=\"reload\" />".html_safe
     }
 
     mattr_accessor :script_tag
     @@script_tag = ->(view_context) {
-      "<script src=\"#{Plutonium.script_link}\"></script>"
+      "<script src=\"#{Plutonium.script_link}\" data-turbo-track=\"reload\"></script>".html_safe
+    }
+
+    mattr_accessor :favicon_tag
+    @@favicon_tag = ->(view_context) {
+      "<link rel=\"icon\" type=\"image/x-icon\" href=\"#{Plutonium.favicon_link}\">".html_safe
     }
   end
 end

data/lib/plutonium/core/autodiscovery/input_discoverer.rb

@@ -14,7 +14,7 @@ module Plutonium
         # If cache_discovery is enabled, use the class level cache that persists
         # between requests, otherwise use the instance one.
         def autodiscovery_input_cache
-          if Plutonium::Config.cache_discovery
+          if Rails.application.config.plutonium.cache_discovery
             self.class.autodiscovery_input_cache
           else
             @autodiscovery_input_cache ||= {}

data/lib/plutonium/core/autodiscovery/renderer_discoverer.rb

@@ -14,7 +14,7 @@ module Plutonium
         # If cache_discovery is enabled, use the class level cache that persists
         # between requests, otherwise use the instance one.
         def autodiscovery_renderer_cache
-          if Plutonium::Config.cache_discovery
+          if Rails.application.config.plutonium.cache_discovery
             self.class.autodiscovery_renderer_cache
           else
             @autodiscovery_renderer_cache ||= {}

data/lib/plutonium/core/controllers/base.rb

@@ -18,7 +18,7 @@ module Plutonium
           end
 
           helper Plutonium::Helpers
-          helper_method :page_title, :resource_url_for, :resource_url_args_for
+          helper_method :page_title, :resource_url_for, :resource_url_args_for, :root_path, :application_name
 
           append_view_path File.expand_path("app/views", Plutonium.root)
           layout -> { turbo_frame_request? ? false : "resource" }
@@ -27,11 +27,15 @@ module Plutonium
         private
 
         def set_page_title
-          @page_title = "Pluton8"
+          @page_title = nil
         end
 
         def page_title(title)
-          [title.presence, Rails.application.class.module_parent.name].compact.join(" | ")
+          [title.presence, application_name].compact.join(" | ")
+        end
+
+        def application_name
+          Plutonium.application_name
         end
 
         #
@@ -80,6 +84,12 @@ module Plutonium
         def resource_url_for(...)
           send(current_package.name.underscore.to_sym).url_for(resource_url_args_for(...))
         end
+
+        def root_path(*)
+          return send(:"#{scoped_entity_param_key}_root_path", *) if scoped_to_entity? && scoped_entity_strategy == :path
+
+          super(*)
+        end
       end
     end
   end

data/lib/plutonium/core/controllers/entity_scoping.rb

@@ -43,15 +43,15 @@ module Plutonium
           return unless current_user.present?
 
           @current_scoped_entity ||= case scoped_entity_strategy
-          when :current_user
-            current_user
           when :path
             scoped_entity_class
               .associated_with(current_user)
               .from_path_param(request.path_parameters[scoped_entity_param_key])
               .first! # Raise NotFound if user does not have access to the entity or it does not exist
+          when Symbol
+            send scoped_entity_strategy
           else
-            raise NotImplementedError, "unknown scoped entity strategy: #{scoped_entity_strategy}"
+            raise NotImplementedError, "unknown scoped entity strategy: #{scoped_entity_strategy.inspect}"
           end
         end
 

data/lib/plutonium/core/controllers/queryable.rb

@@ -1,3 +1,5 @@
+using Plutonium::Refinements::ParameterRefinements
+
 module Plutonium
   module Core
     module Controllers
@@ -18,7 +20,7 @@ module Plutonium
         end
 
         def resource_query_params
-          (params[:q]&.to_unsafe_h || {}).with_indifferent_access
+          (params[:q]&.nilify&.to_unsafe_h || {}).with_indifferent_access
         end
       end
     end

data/lib/plutonium/icons.rb

@@ -17,7 +17,7 @@ module Plutonium
           path = Plutonium.root.join "app/assets/icons/#{name}.svg"
           raise "Invalid icon: #{name}" unless File.exist?(path)
 
-          File.read(path).sub("<svg ", "<svg class=\"#{ICON_SIZES[size]}\" ")
+          File.read(path).sub("<svg ", "<svg class=\"#{ICON_SIZES[size]}\" ").html_safe
         end
       end
     end

data/lib/plutonium/pkg/app.rb

@@ -44,7 +44,12 @@ module Plutonium
           }.to_h
         end
 
+        def draw_custom_routes(&block)
+          @custom_routes_block = block
+        end
+
         def draw_resource_routes
+          custom_routes_block = @custom_routes_block
           registered_resources = resource_register
           scoped_entity_param_key = self.scoped_entity_param_key if scoped_entity_strategy == :path
           routes.draw do
@@ -111,6 +116,7 @@ module Plutonium
             scope_options = scoped_entity_param_key.present? ? {as: scoped_entity_param_key} : {}
 
             scope scope_name, scope_options do
+              instance_exec(&custom_routes_block) if custom_routes_block.present?
               # we have to reverse sort our resource routes in order to prevent routing conflicts
               # e.g. /blogs/1 and blogs/comments cause an issue if Blog is registered before Blogs::Comment
               # attempting to load blogs/comments routes to blogs/:id which fails with a 404 since BlogsController

data/lib/plutonium/railtie.rb

@@ -3,6 +3,8 @@ require "view_component"
 module Plutonium
   class Railtie < Rails::Railtie
     config.plutonium = ActiveSupport::OrderedOptions.new
+    config.plutonium.cache_discovery = defined?(Rails.env) && !Rails.env.development?
+    config.plutonium.enable_hotreload = defined?(Rails.env) && Rails.env.development?
 
     initializer "plutonium.append_assets_path" do |app|
       config.to_prepare do
@@ -10,6 +12,14 @@ module Plutonium
       end
     end
 
+    initializer "plutonium.load_view_components" do
+      load Plutonium.root.join("app", "views", "components", "base.rb")
+    end
+
+    initializer "plutonium.load_initializers" do
+      Dir.glob(Plutonium.root.join("config", "initializers", "**", "*.rb")) { |file| load file }
+    end
+
     initializer "plutonium.asset_server" do
       # setup a middleware to serve our assets
       config.app_middleware.insert_before(
@@ -28,5 +38,14 @@ module Plutonium
     initializer "plutonium.view_components_capture_compat" do
       config.view_component.capture_compatibility_patch_enabled = true
     end
+
+    rake_tasks do
+      load "tasks/create_rodauth_admin.rake"
+    end
+
+    config.after_initialize do
+      Plutonium::Reloader.start! if Rails.application.config.plutonium.enable_hotreload
+      Plutonium::ZEITWERK_LOADER.eager_load if Rails.env.production?
+    end
   end
 end

data/lib/plutonium/reloader.rb

@@ -0,0 +1,99 @@
+# Be sure to restart your server when you modify this file.
+# This is a glorified initializer
+
+module Plutonium
+  class Reloader
+    class << self
+      def start!
+        puts "=> [plutonium] starting reloader"
+
+        @listener&.stop
+        @listener = initialize_listener
+      end
+
+      private
+
+      def initialize_listener
+        require "listen"
+
+        reload_paths = gather_reload_paths
+        return unless reload_paths.any?
+
+        listener = Listen.to(*reload_paths, only: /\.rb$/) do |modified, added, removed|
+          handle_file_changes(modified, added, removed)
+        end
+        listener.start
+        listener
+      end
+
+      def gather_reload_paths
+        reload_paths = []
+
+        if Plutonium.development?
+          reload_paths << Plutonium.lib_root.to_s
+          reload_paths << Plutonium.root.join("app", "views", "components").to_s
+          reload_paths << Plutonium.root.join("config", "initializers").to_s
+        end
+
+        packages_dir = Rails.root.join("packages/").to_s
+        reload_paths << packages_dir if File.directory?(packages_dir)
+
+        reload_paths
+      end
+
+      def handle_file_changes(modified, added, removed)
+        (modified + added).each do |file|
+          Plutonium.logger.debug "[plutonium] change detected: #{file}"
+
+          if file == __FILE__
+            reload_file(file)
+            start!
+          elsif file_starts_with_packages_dir?(file)
+            handle_package_file_changes(file, added)
+          else
+            reload_framework_and_file(file)
+          end
+        rescue => e
+          log_reload_failure(file, e)
+        end
+      end
+
+      def file_starts_with_packages_dir?(file)
+        packages_dir = Rails.root.join("packages/").to_s
+        file.starts_with?(packages_dir)
+      end
+
+      def handle_package_file_changes(file, added)
+        return if added.include?(file)
+
+        case File.basename(file)
+        when "engine.rb"
+          reload_engine_and_routes(file)
+        else
+          # Non-engine package files are reloaded by Rails automatically
+        end
+      end
+
+      def reload_engine_and_routes(file)
+        Plutonium.logger.debug "[plutonium] reloading #{file}"
+        load file
+        Rails.application.reload_routes!
+      end
+
+      def reload_framework_and_file(file)
+        Plutonium.logger.debug "[plutonium] reloading framework"
+        Plutonium::ZEITWERK_LOADER.reload
+        load Plutonium.root.join("app", "views", "components", "base.rb")
+        load file # Ensure files that do not contain constants are loaded
+      end
+
+      def reload_file(file)
+        load file
+      end
+
+      def log_reload_failure(file, error)
+        Plutonium.logger.error "\n[plutonium] reload failed #{file}\n\n#{error}\n"
+      end
+    end
+  end
+end

data/lib/plutonium/resource/controller.rb

@@ -6,6 +6,7 @@ using Plutonium::Refinements::ParameterRefinements
 
 module Plutonium
   module Resource
+    # Controller module to handle resource actions and concerns
     module Controller
       extend ActiveSupport::Concern
       include Pagy::Backend
@@ -17,7 +18,6 @@ module Plutonium
       include Plutonium::Core::Controllers::InteractiveActions
 
       included do
-        # we use class attribute since we want this value inherited
         class_attribute :resource_class, instance_writer: false, instance_predicate: false
 
         # https://github.com/ddnexus/pagy/blob/master/docs/extras/headers.md#headers
@@ -27,6 +27,8 @@ module Plutonium
       end
 
       class_methods do
+        # Sets the resource class for the controller
+        # @param [Class] resource_class The resource class
         def controller_for(resource_class)
           self.resource_class = resource_class
         end
@@ -34,6 +36,8 @@ module Plutonium
 
       private
 
+      # Creates a policy context
+      # @return [Plutonium::Resource::PolicyContext] The policy context
       def policy_context
         Plutonium::Resource::PolicyContext.new(
           user: current_user,
@@ -41,10 +45,15 @@ module Plutonium
         )
       end
 
+      # Returns the resource record based on path parameters
+      # @return [ActiveRecord::Base, nil] The resource record
       def resource_record
-        @resource_record ||= (policy_scope(resource_class).from_path_param(params[:id]).first! if params[:id].present?)
+        @resource_record ||= policy_scope(resource_class).from_path_param(params[:id]).first! if params[:id].present?
+        @resource_record
       end
 
+      # Returns the submitted resource parameters
+      # @return [Hash] The submitted resource parameters
       def submitted_resource_params
         @submitted_resource_params ||= begin
           strong_parameters = resource_class.strong_parameters_for(*permitted_attributes)
@@ -52,24 +61,25 @@ module Plutonium
         end
       end
 
+      # Returns the resource parameters, including scoped and parent parameters
+      # @return [Hash] The resource parameters
       def resource_params
         input_params = submitted_resource_params.dup
 
-        # Override any entity scoping params
-        input_params[scoped_entity_param_key] = current_scoped_entity if scoped_to_entity?
-        input_params[:"#{scoped_entity_param_key}_id"] = current_scoped_entity.id if scoped_to_entity?
-        # Override any parent params
-        input_params[parent_input_param] = current_parent if current_parent.present?
-        input_params[:"#{parent_input_param}_id"] = current_parent.id if current_parent.present?
+        override_entity_scoping_params(input_params)
+        override_parent_params(input_params)
 
-        # additionally filter our input_params through our inputs
         current_presenter.defined_inputs_for(*permitted_attributes).collect_all(input_params)
       end
 
+      # Returns the resource parameter key
+      # @return [Symbol] The resource parameter key
       def resource_param_key
         resource_class.model_name.singular_route_key
       end
 
+      # Creates a resource context
+      # @return [Plutonium::Resource::Context] The resource context
       def resource_context
         Plutonium::Resource::Context.new(
           resource_class:,
@@ -78,29 +88,32 @@ module Plutonium
         )
       end
 
+      # Creates a resource presenter
+      # @param [Class] resource_class The resource class
+      # @param [ActiveRecord::Base] resource_record The resource record
+      # @return [Object] The resource presenter
       def resource_presenter(resource_class, resource_record)
         presenter_class = "#{current_package}::#{resource_class}Presenter".constantize
         presenter_class.new resource_context, resource_record
       end
 
+      # Creates a resource query object
+      # @param [Class] resource_class The resource class
+      # @param [ActionController::Parameters] params The request parameters
+      # @return [Object] The resource query object
       def resource_query_object(resource_class, params)
         query_object_class = "#{current_package}::#{resource_class}QueryObject".constantize
         query_object_class.new resource_context, params
       end
 
-      # sets params on submitted_resource_params if they have been passed
+      # Applies submitted resource params if they have been passed
       def maybe_apply_submitted_resource_params!
-        # this is useful in dynamic forms as we can read the resource record to determine how to define our inputs
-        # we need to ensure that this is being called from get because
-        # it is potentially unsafe since we don't apply the input filter. see #resource_params
-        # would have been nice to be able to, but we can't until we have the presenter, and the presenter
-        # requires the resource_record for our dynamic forms
-        # is this perfect? no. but it works.
-        raise "🚨🚨🚨 this should be called from actions that are not persisting this data" unless request.method == "GET"
-
+        ensure_get_request
         resource_record.attributes = submitted_resource_params if params[resource_param_key].present?
       end
 
+      # Returns the current parent based on path parameters
+      # @return [ActiveRecord::Base, nil] The current parent
       def current_parent
         return unless parent_route_param.present?
 
@@ -113,22 +126,49 @@ module Plutonium
         end
       end
 
+      # Returns the parent route parameter
+      # @return [Symbol, nil] The parent route parameter
       def parent_route_param
         @parent_route_param ||= request.path_parameters.keys.reverse.find { |key| /_id$/.match? key }
       end
 
+      # Returns the parent input parameter
+      # @return [Symbol, nil] The parent input parameter
       def parent_input_param
         return unless current_parent.present?
 
         resource_class.reflect_on_all_associations(:belongs_to).find { |assoc| assoc.klass.name == current_parent.class.name }&.name&.to_sym
       end
 
-      ############
+      # Ensures the method is a GET request
+      def ensure_get_request
+        unless request.method == "GET"
+          raise "🚨🚨🚨 This should be called from actions that are not persisting this data"
+        end
+      end
+
+      # Overrides entity scoping parameters
+      # @param [Hash] input_params The input parameters
+      def override_entity_scoping_params(input_params)
+        if scoped_to_entity?
+          input_params[scoped_entity_param_key] = current_scoped_entity
+          input_params[:"#{scoped_entity_param_key}_id"] = current_scoped_entity.id
+        end
+      end
 
-      # def current_package
-      #   @current_package ||= self.class.module_parents[-2]
-      # end
+      # Overrides parent parameters
+      # @param [Hash] input_params The input parameters
+      def override_parent_params(input_params)
+        if current_parent.present?
+          input_params[parent_input_param] = current_parent
+          input_params[:"#{parent_input_param}_id"] = current_parent.id
+        end
+      end
 
+      # Constructs resource URL arguments
+      # @param [Array] args The URL arguments
+      # @param [Hash] kwargs The keyword arguments
+      # @return [Array] The URL arguments
       def resource_url_args_for(*args, **kwargs)
         kwargs[:parent] = current_parent unless kwargs.key?(:parent)
         super(*args, **kwargs)