plutonium 0.39.1 → 0.40.0

data/lib/generators/pu/lite/solid_errors/solid_errors_generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Lite
+    class SolidErrorsGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+      include PlutoniumGenerators::Concerns::ConfiguresSqlite
+      include PlutoniumGenerators::Concerns::MountsEngines
+
+      desc "Set up Solid Errors for error tracking with SQLite"
+
+      class_option :database, type: :string, default: "errors",
+        desc: "Database name for Solid Errors"
+      class_option :route, type: :string, default: "/manage/errors",
+        desc: "Route path for Solid Errors UI"
+
+      def start
+        @db_name = options[:database]
+
+        bundle "solid_errors"
+        add_sqlite_database(@db_name)
+        run_solid_errors_install
+        configure_application
+        prepare_database(@db_name)
+        mount_solid_errors_engine
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def run_solid_errors_install
+        Bundler.with_unbundled_env do
+          run "bin/rails generate solid_errors:install", env: {"DATABASE" => @db_name}
+        end
+        run "git checkout -- config/environments/production.rb 2>/dev/null || true"
+      end
+
+      def configure_application
+        create_file "config/initializers/solid_errors.rb", <<~RUBY
+          # frozen_string_literal: true
+
+          Rails.application.configure do
+            config.solid_errors.connects_to = {database: {writing: :#{@db_name}}}
+            config.solid_errors.send_emails = ENV["SOLID_ERRORS_SEND_EMAILS"].present?
+            config.solid_errors.email_from = ENV["SOLID_ERRORS_EMAIL_FROM"]
+            config.solid_errors.email_to = ENV["SOLID_ERRORS_EMAIL_TO"]
+            config.solid_errors.username = ENV.fetch("SOLID_ERRORS_USERNAME", nil)
+            config.solid_errors.password = ENV.fetch("SOLID_ERRORS_PASSWORD", nil)
+          end
+        RUBY
+      end
+
+      def mount_solid_errors_engine
+        mount_engine %(mount SolidErrors::Engine, at: "#{options[:route]}"), authenticated: true
+      end
+    end
+  end
+end

data/lib/generators/pu/lite/solid_queue/solid_queue_generator.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Lite
+    class SolidQueueGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+      include PlutoniumGenerators::Concerns::ConfiguresSqlite
+      include PlutoniumGenerators::Concerns::MountsEngines
+
+      desc "Set up Solid Queue for background jobs with SQLite"
+
+      class_option :database, type: :string, default: "queue",
+        desc: "Database name for Solid Queue"
+      class_option :route, type: :string, default: "/manage/jobs",
+        desc: "Route path for Mission Control Jobs UI"
+      class_option :skip_mission_control, type: :boolean, default: false,
+        desc: "Skip Mission Control Jobs UI"
+
+      def start
+        @db_name = options[:database]
+
+        bundle "solid_queue"
+        add_sqlite_database(@db_name)
+        run_solid_queue_install
+        configure_application
+        prepare_database(@db_name)
+        create_jobs_script
+        configure_procfile
+        configure_kamal
+        setup_mission_control unless options[:skip_mission_control]
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def run_solid_queue_install
+        Bundler.with_unbundled_env do
+          run "bin/rails generate solid_queue:install", env: {"DATABASE" => @db_name}
+        end
+        # Restore files modified by solid_queue:install
+        run "git checkout -- config/environments/production.rb 2>/dev/null || true"
+        run "git checkout -- config/puma.rb 2>/dev/null || true"
+      end
+
+      def configure_application
+        create_file "config/initializers/solid_queue.rb", <<~RUBY
+          # frozen_string_literal: true
+
+          Rails.application.configure do
+            config.active_job.queue_adapter = :solid_queue
+            config.solid_queue.connects_to = {database: {writing: :#{@db_name}}}
+            config.solid_queue.silence_polling = true
+          end
+        RUBY
+      end
+
+      def create_jobs_script
+        jobs_script = "bin/jobs"
+        return if File.exist?(File.expand_path(jobs_script, destination_root))
+
+        create_file jobs_script, <<~BASH
+          #!/usr/bin/env bash
+          set -e
+          exec bundle exec rake solid_queue:start
+        BASH
+        chmod jobs_script, 0o755
+      end
+
+      def configure_kamal
+        deploy_file = "config/deploy.yml"
+        return unless File.exist?(File.expand_path(deploy_file, destination_root))
+        return if file_includes?(deploy_file, "job:")
+
+        insert_into_file deploy_file, after: /^servers:.*\n/ do
+          <<~YAML
+            job:
+              hosts:
+                - <%= ENV['DEPLOY_HOST'] %>
+              cmd: bin/jobs
+          YAML
+        end
+      end
+
+      def configure_procfile
+        procfile = "Procfile.dev"
+        return unless File.exist?(File.expand_path(procfile, destination_root))
+        return if file_includes?(procfile, "jobs:")
+
+        append_to_file procfile, "jobs: bin/jobs\n"
+      end
+
+      def setup_mission_control
+        bundle "mission_control-jobs"
+        configure_mission_control
+        mount_engine %(mount MissionControl::Jobs::Engine, at: "#{options[:route]}"), authenticated: true
+      end
+
+      def configure_mission_control
+        # Disable built-in HTTP Basic Auth - using route constraints instead
+        environment "config.mission_control.jobs.http_basic_auth_enabled = false"
+      end
+    end
+  end
+end

data/lib/generators/pu/pkg/portal/USAGE

@@ -7,7 +7,8 @@ Usage:
 Options:
     --auth=NAME      Rodauth account to authenticate with (e.g., --auth=user)
     --public         Grant public access (no authentication required)
-    --byo       Bring your own authentication (configure manually)
+    --byo            Bring your own authentication (configure manually)
+    --scope=CLASS    Entity class to scope to for multi-tenancy (e.g., --scope=Organization)
 
     Without options, the generator prompts interactively for authentication choice.
 
@@ -25,6 +26,10 @@ Examples:
     # Custom authentication (implement your own)
     rails g pu:pkg:portal custom --byo
 
+    # With entity scoping (multi-tenancy)
+    rails g pu:pkg:portal admin --auth=admin --scope=Organization
+    rails g pu:pkg:portal customer --auth=customer --scope=Account
+
 Generated Structure:
     packages/[name]_portal/
     ├── app/
@@ -61,5 +66,6 @@ After Generation:
     2. Connect resources to the portal:
        rails g pu:res:conn Post --dest=admin_portal
 
-    3. Optionally configure entity scoping in engine.rb:
+    3. If you used --scope, entity scoping is already configured in engine.rb.
+       Otherwise, you can manually add it:
        scope_to_entity Organization, strategy: :path

data/lib/generators/pu/pkg/portal/portal_generator.rb

@@ -16,10 +16,12 @@ module Pu
       class_option :auth, type: :string, desc: "Rodauth account to authenticate with (e.g., --auth=user)"
       class_option :public, type: :boolean, default: false, desc: "Grant public access (no authentication)"
       class_option :byo, type: :boolean, default: false, desc: "Bring your own authentication"
+      class_option :scope, type: :string, desc: "Entity class to scope to (e.g., --scope=Organization)"
 
       def start
         validate_package_name name
         configure_authentication
+        configure_entity_scoping
 
         template "lib/engine.rb", "packages/#{package_namespace}/lib/engine.rb"
         template "config/routes.rb", "packages/#{package_namespace}/config/routes.rb"
@@ -28,6 +30,8 @@ module Pu
           "packages/#{package_namespace}/app/controllers/#{package_namespace}/concerns/controller.rb"
         template "app/controllers/plutonium_controller.rb",
           "packages/#{package_namespace}/app/controllers/#{package_namespace}/plutonium_controller.rb"
+        template "app/controllers/resource_controller.rb",
+          "packages/#{package_namespace}/app/controllers/#{package_namespace}/resource_controller.rb"
 
         template "app/controllers/dashboard_controller.rb",
           "packages/#{package_namespace}/app/controllers/#{package_namespace}/dashboard_controller.rb"
@@ -48,7 +52,7 @@ module Pu
 
       private
 
-      attr_reader :rodauth_account
+      attr_reader :rodauth_account, :scoped_entity_class
 
       def configure_authentication
         if options[:auth].present?
@@ -82,6 +86,12 @@ module Pu
       def public_access? = @public_access
 
       def bring_your_own_auth? = @bring_your_own_auth
+
+      def configure_entity_scoping
+        @scoped_entity_class = options[:scope].camelize if options[:scope].present?
+      end
+
+      def scoped_to_entity? = scoped_entity_class.present?
     end
   end
 end

data/lib/generators/pu/pkg/portal/templates/app/controllers/concerns/controller.rb.tt

@@ -1,5 +1,7 @@
 module <%= package_name %>
   module Concerns
+    # Portal-wide controller customizations go here.
+    # Included by both ResourceController and PlutoniumController.
     module Controller
       extend ActiveSupport::Concern
       include Plutonium::Portal::Controller

data/lib/generators/pu/pkg/portal/templates/app/controllers/plutonium_controller.rb.tt

@@ -1,4 +1,5 @@
 module <%= package_name %>
+  # Base controller for non-resource pages (dashboard, settings, etc.).
   class PlutoniumController < ::PlutoniumController
     include <%= package_name %>::Concerns::Controller
   end

data/lib/generators/pu/pkg/portal/templates/app/controllers/resource_controller.rb.tt

@@ -0,0 +1,7 @@
+module <%= package_name %>
+  # Base controller for portal resources when no feature package controller exists.
+  # Add customizations to Concerns::Controller, not here.
+  class ResourceController < ::ResourceController
+    include <%= package_name %>::Concerns::Controller
+  end
+end

data/lib/generators/pu/pkg/portal/templates/lib/engine.rb.tt

@@ -4,6 +4,9 @@ module <%= package_name %>
     # add concerns above.
 
     config.after_initialize do
+<%- if scoped_to_entity? -%>
+      scope_to_entity <%= scoped_entity_class %>, strategy: :path
+<%- end -%>
       # add directives above.
     end
   end

data/lib/generators/pu/res/conn/USAGE

@@ -10,6 +10,7 @@ Options:
     --src=PACKAGE        Source feature package (optional)
                          Use main_app for resources in the main application
                          Use package name for resources in a feature package
+    --singular           Register the resource as singular (e.g., profile, dashboard)
 
 Arguments:
     RESOURCES            Space-separated list of model names to connect.
@@ -26,6 +27,9 @@ Examples:
     # Connect namespaced resources (from a feature package)
     rails g pu:res:conn Blogging::Post Blogging::Comment --dest=admin_portal
 
+    # Connect a singular resource (e.g., profile, dashboard)
+    rails g pu:res:conn Profile --dest=customer_portal --singular
+
     # Interactive mode (prompts for everything)
     rails g pu:res:conn
 
@@ -56,6 +60,7 @@ Generated Code:
 
     Routes register the resource:
         register_resource ::Blogging::Post
+        register_resource ::Profile, singular: true  # With --singular
 
 Workflow:
     1. Create feature package:  rails g pu:pkg:package blogging

data/lib/generators/pu/res/conn/conn_generator.rb

@@ -12,20 +12,25 @@ module Pu
 
       desc(
         "Create a connection between a resource and a portal\n\n" \
-        "e.g. rails g pu:res:conn todo --dest=dashboard_portal"
+        "e.g. rails g pu:res:conn todo --dest=dashboard_portal\n" \
+        "     rails g pu:res:conn profile --dest=customer_portal --singular"
       )
 
-      # argument :name
+      class_option :singular, type: :boolean, default: false,
+        desc: "Register the resource as a singular resource (e.g., profile)"
 
       def start
         selected_resources = resources_selection
         @app_namespace = portal_option(:dest, prompt: "Select destination portal").camelize
 
+        validate_resources!(selected_resources)
+
         selected_resources.each do |resource|
           @resource_class = resource
+
           if app_namespace == "MainApp"
             insert_into_file "config/routes.rb",
-              indent("register_resource ::#{resource}\n", 2),
+              indent("register_resource ::#{resource}#{singular_option}\n", 2),
               after: /.*Rails\.application\.routes\.draw do.*\n/
           else
             unless expected_parent_policy
@@ -42,7 +47,7 @@ module Pu
               "packages/#{package_namespace}/app/controllers/#{package_namespace}/#{resource.pluralize.underscore}_controller.rb"
 
             insert_into_file "packages/#{package_namespace}/config/routes.rb",
-              indent("register_resource ::#{resource}\n", 2),
+              indent("register_resource ::#{resource}#{singular_option}\n", 2),
               before: /.*# register resources above.*/
           end
         end
@@ -58,6 +63,10 @@ module Pu
         app_namespace.underscore
       end
 
+      def singular_option
+        options[:singular] ? ", singular: true" : ""
+      end
+
       def resource_namespace
         app_namespace.underscore
       end
@@ -110,6 +119,23 @@ module Pu
       def policy_attributes_for_read
         default_policy_attributes
       end
+
+      def validate_resources!(resources)
+        invalid = resources.reject { |r| resource_record?(r) }
+        return if invalid.empty?
+
+        invalid.each do |resource|
+          say_status :error, "#{resource} does not include Plutonium::Resource::Record", :red
+        end
+        error "All resources must include Plutonium::Resource::Record to be connected to a portal"
+      end
+
+      def resource_record?(resource)
+        klass = resource.safe_constantize
+        return false unless klass
+
+        klass.included_modules.any? { |mod| mod.to_s.include?("Plutonium::Resource::Record") }
+      end
     end
   end
 end

data/lib/generators/pu/res/scaffold/scaffold_generator.rb

@@ -14,15 +14,18 @@ module Pu
 
       class_option :model, type: :boolean, default: true
 
-      def setup
-        return unless options[:model]
+      # Skip collision check when scaffolding for existing model
+      def check_class_collision
+        super if options[:model]
+      end
 
+      def setup
         model_class = class_name.safe_constantize
         if model_class.present?
           if attributes.empty?
             attributes_str = model_class.content_columns.map { |col| "#{col.name}:#{col.type}" }
             self.attributes = parse_attributes_internal!(attributes_str)
-          else
+          elsif options[:model]
             warn("Overwriting existing resource. You can leave out the attributes to import an existing resource.")
           end
         end

data/lib/generators/pu/res/scaffold/templates/policy.rb.tt

@@ -2,13 +2,13 @@
 class <%= class_name %>Policy < <%= [feature_package_name, "ResourcePolicy"].join "::" %>
   # Core actions
 
-  def create?
-    true
-  end
+  # def create?
+  #   true
+  # end
 
-  def read?
-    true
-  end
+  # def read?
+  #   true
+  # end
 
   # Core attributes
 

data/lib/generators/pu/rodauth/account_generator.rb

@@ -18,6 +18,9 @@ module Pu
       desc "Generate a rodauth-rails account.\n\n" \
            "Configures a basic set of features as well as migrations, a model, mailer and views."
 
+      class_option :extra_attributes, type: :array, default: [],
+        desc: "Additional attributes to add to the account model (e.g., role:integer)"
+
       def install_dependencies
         Bundler.with_unbundled_env do
           run "bundle add jwt" if jwt? || jwt_refresh?
@@ -51,20 +54,27 @@ module Pu
 
       def configure_rodauth_plugin_load_memory
         in_root do
-          plugin_config = indent(
-            "rodauth#{"(:#{table_prefix})" unless primary?}.load_memory # autologin remembered #{table}\n", 4
-          )
-          gsub_file "app/rodauth/rodauth_app.rb", /.*# rodauth\.load_memory.*\n/, ""
+          rodauth_app = File.read("app/rodauth/rodauth_app.rb")
+          load_memory_pattern = primary? ? /rodauth\.load_memory/ : /rodauth\(:#{table_prefix}\)\.load_memory/
+
+          return if rodauth_app.match?(load_memory_pattern)
+
+          plugin_config = if primary?
+            indent("rodauth.load_memory # autologin remembered #{table}\n", 4)
+          else
+            indent(<<~RUBY, 4)
+              if r.path.start_with?("/#{table_prefix}_dashboard")
+                rodauth(:#{table_prefix}).load_memory # autologin remembered #{table}
+              end
+            RUBY
+          end
 
           if remember?
             insert_into_file "app/rodauth/rodauth_app.rb", plugin_config, after: "# plugin route configuration\n"
           else
-            gsub_file "app/rodauth/rodauth_app.rb", plugin_config, ""
-            in_root do
-              unless File.read("app/rodauth/rodauth_app.rb").match?(/.*\.load_memory # autologin/)
-                insert_into_file "app/rodauth/rodauth_app.rb", indent("# rodauth.load_memory # autologin remembered users\n", 4),
-                  after: "# plugin route configuration\n"
-              end
+            unless rodauth_app.match?(/\.load_memory # autologin/)
+              insert_into_file "app/rodauth/rodauth_app.rb", indent("# rodauth.load_memory # autologin remembered users\n", 4),
+                after: "# plugin route configuration\n"
             end
           end
         end
@@ -83,13 +93,28 @@ module Pu
           migration_name: options[:migration_name],
           force: options[:force],
           skip: options[:skip]
+
+        add_extra_columns_to_migration
+      end
+
+      def add_extra_columns_to_migration
+        return if options[:extra_attributes].blank?
+
+        migration_file = Dir[File.join(destination_root, "db/migrate/*_create_rodauth_#{table_prefix}_*.rb")].first
+        return unless migration_file
+
+        attributes = options[:extra_attributes].map { |attr| PlutoniumGenerators::ModelGeneratorBase::GeneratedAttribute.parse(table, attr) }
+        columns = attributes.map { |a| "      t.#{a.type} :#{a.name}#{a.inject_options}" }.join("\n")
+
+        inject_into_file migration_file, "#{columns}\n", after: /t\.string :password_hash\n/
       end
 
       def create_account_model
         return unless base?
 
         template "app/models/account.rb", "app/models/#{account_path}.rb"
-        invoke "pu:res:scaffold", [table, "email:string", "status:integer"], dest: "main_app",
+        scaffold_attrs = ["email:string", "status:integer"] + Array(options[:extra_attributes])
+        invoke "pu:res:scaffold", [table, *scaffold_attrs], dest: "main_app",
           model: false,
           force: true,
           skip: options[:skip]

data/lib/generators/pu/rodauth/admin_generator.rb

@@ -15,6 +15,12 @@ module Pu
 
       argument :name
 
+      class_option :roles, type: :array, default: %w[super_admin admin],
+        desc: "Available roles for admin accounts"
+
+      class_option :extra_attributes, type: :array, default: [],
+        desc: "Additional attributes to add to the account model (e.g., name:string)"
+
       def start
         generate_admin_account
         configure_admin_account
@@ -28,11 +34,13 @@ module Pu
         invoke "pu:rodauth:account", [name],
           defaults: false,
           **admin_features,
+          extra_attributes: options[:extra_attributes],
           force: options[:force],
           skip: options[:skip]
       end
 
       def configure_admin_account
+        add_role_column_to_migration
         # Prevent account creation from web
         insert_into_file "app/rodauth/#{normalized_name}_rodauth_plugin.rb", indent(<<~EOT, 4), after: /# ==> Hooks\n/
 
@@ -66,6 +74,37 @@ module Pu
         template "app/views/_login_form_footer.html.erb.tt", "app/views/rodauth/#{normalized_name}/_login_form_footer.html.erb"
 
         template "lib/tasks/rodauth_admin.rake", "lib/tasks/rodauth_#{normalized_name}.rake"
+
+        add_role_enum
+        create_invite_interaction
+      end
+
+      def add_role_column_to_migration
+        migration_file = Dir[File.join(destination_root, "db/migrate/*_create_rodauth_#{normalized_name}_*.rb")].first
+        return unless migration_file
+
+        inject_into_file migration_file,
+          "      t.integer :role, null: false, default: 0\n",
+          after: /t\.string :password_hash\n/
+      end
+
+      def add_role_enum
+        inject_into_file "app/models/#{normalized_name}.rb",
+          "enum :role, #{roles_enum}\n  ",
+          before: "# add enums above.\n"
+      end
+
+      def create_invite_interaction
+        template "app/interactions/invite_admin_interaction.rb",
+          "app/interactions/#{normalized_name}/invite_interaction.rb"
+
+        inject_into_file "app/definitions/#{normalized_name}_definition.rb",
+          "  action :invite, interaction: #{name.classify}::InviteInteraction, collection: true, category: :primary\n",
+          after: /class #{name.classify}Definition < .+\n/
+
+        inject_into_file "app/policies/#{normalized_name}_policy.rb",
+          "def invite?\n    true\n  end\n\n  ",
+          before: "# Core attributes"
       end
 
       def admin_features
@@ -83,6 +122,22 @@ module Pu
       def display_name = name.humanize.downcase
 
       def normalized_name = name.underscore
+
+      def roles
+        Array(options[:roles]).flat_map { |r| r.split(",") }.map(&:strip)
+      end
+
+      def roles_enum
+        roles.each_with_index.map { |r, i| "#{r}: #{i}" }.join(", ")
+      end
+
+      def default_role
+        [1, roles.size - 1].min
+      end
+
+      def default_role_name
+        roles[default_role]
+      end
     end
   end
 end

data/lib/generators/pu/rodauth/install_generator.rb

@@ -1,7 +1,6 @@
 require "rails/generators/base"
 require "rails/generators/active_record/migration"
 require "securerandom"
-require "plutonium/auth/sequel_adapter"
 
 module Pu
   module Rodauth
@@ -54,13 +53,7 @@ module Pu
 
       private
 
-      # Delegates to the SequelAdapter module to avoid code duplication.
-      def sequel_adapter
-        Plutonium::Auth::SequelAdapter.sequel_adapter
-      end
-
-      # Delegates to the SequelAdapter module's internal ActiveRecord adapter detection.
-      # We still provide this method for use in create_install_migration.
+      # Detects the ActiveRecord adapter for migration generation.
       def activerecord_adapter
         if ActiveRecord::Base.respond_to?(:connection_db_config)
           ActiveRecord::Base.connection_db_config&.adapter

data/lib/generators/pu/rodauth/templates/app/interactions/invite_admin_interaction.rb.tt

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class <%= name.classify %>::InviteInteraction < Plutonium::Resource::Interaction
+  presents label: "Invite <%= name.titleize %>", icon: Phlex::TablerIcons::Mail
+
+  attribute :email
+  attribute :role, default: :<%= default_role_name %>
+
+  validates :email, presence: true, format: {with: URI::MailTo::EMAIL_REGEXP}
+  validates :role, presence: true, inclusion: {in: <%= name.classify %>.roles.keys}
+
+  input :role, as: :select, choices: <%= name.classify %>.roles.keys
+
+  def execute
+    account = nil
+    <%= name.classify %>.transaction do
+      RodauthApp.rodauth(:<%= normalized_name %>).create_account(login: email)
+      account = <%= name.classify %>.find_by!(email: email)
+      account.update!(role: role)
+    end
+    succeed(account).with_message("Invitation sent to #{email}")
+  rescue ::Rodauth::InternalRequestError => e
+    failed(email: e.message)
+  end
+end

data/lib/generators/pu/rodauth/templates/app/models/account.rb.tt

@@ -2,6 +2,11 @@ class <%= account_path.classify %> < ResourceRecord
   include Rodauth::Rails.model<%= "(:#{table_prefix})" unless primary? %>
   # add concerns above.
 
+  # add constants above.
+
+  enum :status, unverified: 1, verified: 2, closed: 3
+  # add enums above.
+
   <%- if account_path.include?("/") -%>
   self.table_name = :<%= table_prefix.pluralize %>
   <%- end -%>
@@ -24,8 +29,7 @@ class <%= account_path.classify %> < ResourceRecord
 
   # add delegations above.
 
-  enum :status, unverified: 1, verified: 2, closed: 3
   # add misc attribute macros above.
 
-  # add methods above.
+  # add methods above. add private methods below.
 end