plutonium 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c06e317739b1f680a765c14d8cec25681b2a4ee8a2f28eb862d64acaab7c131
-  data.tar.gz: 685ce9c385e2a344d2b67b05c548b9ecbbc9d34f528c610963cacf0f2b6b95cc
+  metadata.gz: 6d56979564e5b0903e39197ae70e304de7848c38c02edcc039a74f9e76093931
+  data.tar.gz: 19a28e7518edcce1ee883b65bb13d5f4ad97b3eb4820dd00a5ebdb4eeeb1ebf6
 SHA512:
-  metadata.gz: 6bb7965e89acbbe4d79e9f2d75b9dddc2d5c8ea7ef55eb4a1d82a9df56f6bef23cba50f696366c651739f9f12afb7da909a904d06c2e4235e2947b680b066ce2
-  data.tar.gz: 55e6762fd915065bd5f37ecb370196f44f774b19331b9ac42f526c599ed4fb6b1dd75e0a49d6d2330d945ef0058e38de48632990f2a221c02b339ef387d36633
+  metadata.gz: b4177cf2f8f722f19d843961f155286bee3f0bdbf5536233f1850aa8917cb8fd18aae685584747779101024bc761bc3fdfb14a396f537fcee2ec080fcf02acff
+  data.tar.gz: 6ae52cb87299fb2050416fbcb6dce8fe56412b16ca8c570b77a856bfd08fd8eda1ce5c1b4517fbb56583b4d2312f86adbe3c7837fcca77cc1a29765407dd1ff5

data/README.md

@@ -56,6 +56,8 @@ TODO: Write usage instructions here
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+To build assets, run `npm dev`
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/app/assets/javascripts/turbo/index.js

@@ -1,4 +1,4 @@
-// import * as Turbo from "@hotwired/turbo"
+import * as Turbo from "@hotwired/turbo"
 
 import "./turbo_debug"
 // import "./turbo_actions"

data/app/views/application/_resource_header.html.erb

@@ -35,13 +35,15 @@
             </svg>
             <span class="sr-only">Toggle sidebar</span>
           </button>
-          <a href="https://flowbite.com" class="flex items-center justify-between mr-4">
+          <a href="<%= root_path %>" class="flex items-center justify-between mr-4">
             <img
-              src="https://flowbite.s3.amazonaws.com/logo.svg"
-              class="mr-3 h-8"
-              alt="Flowbite Logo"
+              src="<%= Plutonium.logo_link %>"
+              class="mr-3 h-10"
+              alt="<%= application_name %> Logo"
             />
-            <span class="self-center text-2xl font-semibold whitespace-nowrap dark:text-white hidden xs:block">Plutonium</span>
+            <span class="self-center text-2xl font-semibold whitespace-nowrap dark:text-white hidden xs:block">
+              <%= application_name %>
+            </span>
           </a>
           <%# <form action="#" method="GET" class="hidden md:block md:pl-2">
             <label for="topbar-search" class="sr-only">Search</label>
@@ -704,18 +706,16 @@
                   </a>
                 </li>
               </ul>
+
+              <% if respond_to? :logout_url -%>
               <ul
                 class="py-1 text-gray-700 dark:text-gray-300"
-                aria-labelledby="dropdown"
-              >
+                aria-labelledby="dropdown">
                 <li>
-                  <a
-                    href="#"
-                    class="block py-2 px-4 text-sm hover:bg-gray-100 dark:hover:bg-gray-600 dark:hover:text-white"
-                    >Sign out</a
-                  >
+                  <%= link_to "Sign out", logout_url, class: "block py-2 px-4 text-sm hover:bg-gray-100 dark:hover:bg-gray-600 dark:hover:text-white", data: { turbo: false } %>
                 </li>
               </ul>
+              <% end -%>
             </div>
           </div>
         </div>

data/app/views/layouts/resource.html.erb

@@ -7,6 +7,7 @@
     <meta name="turbo-cache-control" content="no-cache">
     <meta name="turbo-refresh-method" content="morph">
     <meta name="turbo-refresh-scroll" content="preserve">
+    <link rel="icon" type="image/x-icon" href="<%= Plutonium.favicon_link %>">
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>
     <%= yield(:meta) %>

data/app/views/layouts/rodauth.html.erb

@@ -17,10 +17,10 @@
   </head>
   <body class="antialiased bg-gray-50 dark:bg-gray-900">
     <main div class="flex flex-col items-center justify-center px-6 py-8 mx-auto md:h-screen lg:py-0">
-      <a href="#" class="flex items-center mb-6 text-2xl font-semibold text-gray-900 dark:text-white">
-        <img class="w-8 h-8 mr-2" src="https://flowbite.s3.amazonaws.com/blocks/marketing-ui/logo.svg" alt="logo">
-        Flowbite
-      </a>
+      <p class="flex items-center mb-6 text-2xl font-semibold text-gray-900 dark:text-white">
+        <img class="w-16 h-16 mr-2" src="<%= Plutonium.logo_link %>" alt="logo">
+        <%= application_name %>
+      </p>
       <div class="w-full bg-white rounded-lg shadow dark:border md:mt-0 sm:max-w-md xl:p-0 dark:bg-gray-800 dark:border-gray-700">
         <div class="p-6 space-y-4 md:space-y-6 sm:p-8">
           <%= yield %>

data/app/views/resource/_nav_user.html.erb

@@ -1,4 +1,4 @@
 <%= display_name_of current_user %>
 <% if respond_to? :logout_url -%>
-  <%= link_to "Sign out", "/", class: "btn btn-outline-primary", data: { turbo: false } %>
+  <%= link_to "Sign out", logout_url, class: "btn btn-outline-primary", data: { turbo: false } %>
 <% end -%>

data/app/views/resource/index.rabl

@@ -1,3 +1,3 @@
 collection @resource_records, root: resource_class.to_s.demodulize.underscore.pluralize.to_sym, object_root: false
 
-extends "_resource"
+extends "_resource_details"

data/brakeman.ignore

@@ -6,7 +6,7 @@
       "fingerprint": "1cb8570b8c91f38317cdf909e01e7016359846174f427e86011633c344d30fc3",
       "check_name": "ForgerySetting",
       "message": "`protect_from_forgery` should be called in `Plutonium::Resource::Controller`",
-      "file": "lib/plutonium/reactor/resource_controller.rb",
+      "file": "lib/plutonium/resource/controller.rb",
       "line": 10,
       "link": "https://brakemanscanner.org/docs/warning_types/cross-site_request_forgery/",
       "code": null,

data/config/initializers/rabl.rb

@@ -58,3 +58,5 @@ module Rabl
     end
   end
 end
+
+Rabl.register!

data/css.manifest

@@ -1,3 +1,3 @@
 {
-  "plutonium.css": "plutonium.50232e35b5495f5ad90d.css"
+  "plutonium.css": "plutonium.2d4f0c333cd000051d3b.css"
 }

data/js.manifest

@@ -1,4 +1,4 @@
 {
-  "plutonium-app.js.map": "plutonium-app-36KN5FVJ.js.map",
-  "plutonium-app.js": "plutonium-app-36KN5FVJ.js"
+  "plutonium-app.js.map": "plutonium-app-6WILQCTT.js.map",
+  "plutonium-app.js": "plutonium-app-6WILQCTT.js"
 }

data/lib/generators/pu/core/install/templates/config/initializers/plutonium.rb

@@ -1,4 +1 @@
 # Configure plutonium
-
-# Spin up the reactor!
-Plutonium::Reactor::Core.achieve_criticality!

data/lib/generators/pu/gen/pug/pug_generator.rb

@@ -38,6 +38,12 @@ module Pu
       def pug_class
         "#{pug_name.demodulize}Generator"
       end
+
+      def lib_path
+        depth = name.split(":").count
+        base = ([".."] * depth).join "/"
+        "#{base}/lib/plutonium_generators"
+      end
     end
   end
 end

data/lib/generators/pu/gen/pug/templates/pug.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../../../plutonium_generators', __dir__)
+require_relative "<%= lib_path %>"
 
 module Pu
   module <%= pug_module %>

data/lib/generators/pu/pkg/app/templates/config/routes.rb.tt

@@ -1,7 +1,7 @@
-<%= package_name %>::Engine.routes.draw do
-  root to: "dashboard#index"
+<%= package_name %>::Engine.draw_custom_routes do
+  # draw custom routes here
 
-  # add custom app routes here
+  root to: "dashboard#index"
 end
 
 # draw routes for registered resources

data/lib/plutonium/config.rb

@@ -1,18 +1,8 @@
 require "active_support"
+require "active_model"
 
 module Plutonium
   module Config
-    # @return [Boolean] Are we developing plutonium? This is separate from Rails development.
-    mattr_accessor :development
-    @@development = defined?(Rails.env) && Rails.env.development?
-
-    # @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}\" />"

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
+          Rails.application.class.module_parent.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/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/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,10 @@ module Plutonium
     initializer "plutonium.view_components_capture_compat" do
       config.view_component.capture_compatibility_patch_enabled = true
     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,14 @@ 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?
       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 +60,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 +87,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 +125,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)