plutonium 0.43.2 → 0.44.0

data/gemfiles/rails_8.1.gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: ..
   specs:
-    plutonium (0.43.1)
+    plutonium (0.43.2)
       action_policy (~> 0.7.0)
       listen (~> 3.8)
-      pagy (~> 9.0)
+      pagy (~> 43.0)
       phlex (~> 2.0)
       phlex-rails
       phlex-slotable (>= 1.0.0)
@@ -187,7 +187,10 @@ GEM
     nio4r (2.7.5)
     nokogiri (1.19.1-arm64-darwin)
       racc (~> 1.4)
-    pagy (9.4.0)
+    pagy (43.3.3)
+      json
+      uri
+      yaml
     parallel (1.27.0)
     parser (3.3.10.2)
       ast (~> 2.4.1)
@@ -391,6 +394,7 @@ GEM
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     wisper (2.0.1)
+    yaml (0.4.0)
     zeitwerk (2.7.5)
 
 PLATFORMS

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

@@ -9,6 +9,7 @@ module Pu
     class InstallGenerator < ::Rails::Generators::Base
       include ::ActiveRecord::Generators::Migration
       include PlutoniumGenerators::Generator
+      include PlutoniumGenerators::Concerns::RodauthRedirects
 
       source_root File.expand_path("templates", __dir__)
 
@@ -21,7 +22,7 @@ module Pu
         desc: "The user model name"
 
       class_option :membership_model, type: :string,
-        desc: "The membership model name (defaults to <Entity>User)"
+        desc: "The membership model name (defaults to <Entity><User>)"
 
       class_option :rodauth, type: :string, default: "user",
         desc: "Rodauth configuration name for signup integration"
@@ -153,7 +154,7 @@ module Pu
 
       def add_entity_policy
         inject_into_file entity_policy_path,
-          "def invite_user?\n    false # TODO: e.g., current_membership&.admin? or user.is_a?(Admin)\n  end\n\n  ",
+          "def invite_user?\n    current_membership&.owner?\n  end\n\n  ",
           before: "# Core attributes"
       end
 
@@ -170,7 +171,7 @@ module Pu
 
       def add_user_policy
         inject_into_file user_policy_path,
-          "def invite_user?\n    false # TODO: e.g., current_membership&.admin? or user.is_a?(Admin)\n  end\n\n  ",
+          "def invite_user?\n    current_membership&.owner?\n  end\n\n  ",
           before: "# Core attributes"
       end
 
@@ -201,11 +202,18 @@ module Pu
       end
 
       def add_routes
+        routes_content = File.read(Rails.root.join("config/routes.rb"))
+        if routes_content.include?("# User invitation routes")
+          say_status :skip, "Invitation routes already present", :yellow
+          return
+        end
+
         route_code = <<-RUBY
 
-  # User invitation routes (public, unauthenticated)
+  # User invitation routes
   scope module: :invites do
-    get "welcome", to: "welcome#index", as: :invites_welcome
+    get "invitations/welcome", to: "welcome#index", as: :invites_welcome_check
+    delete "invitations/welcome", to: "welcome#skip", as: :invites_welcome_skip
     get "invitations/:token", to: "user_invitations#show", as: :invitation
     post "invitations/:token/accept", to: "user_invitations#accept", as: :accept_invitation
     get "invitations/:token/signup", to: "user_invitations#signup", as: :invitation_signup
@@ -216,6 +224,20 @@ module Pu
         inject_into_file "config/routes.rb",
           route_code,
           before: /^end\s*\z/
+
+        # If no main WelcomeController exists, add /welcome route pointing to
+        # Invites::WelcomeController so Rodauth's login_redirect "/welcome" works.
+        unless File.exist?(Rails.root.join("app/controllers/welcome_controller.rb"))
+          welcome_route = <<-RUBY
+
+  # Welcome route (handled by invites package — replace with pu:saas:welcome for full onboarding)
+  get "welcome", to: "invites/welcome#index"
+          RUBY
+
+          inject_into_file "config/routes.rb",
+            welcome_route,
+            before: /^\s*# User invitation routes/
+        end
       end
 
       def configure_rodauth
@@ -297,10 +319,46 @@ module Pu
             after: /login_redirect.*\n/
         end
 
-        # Update login_redirect to /welcome
-        gsub_file rodauth_file,
-          /login_redirect\s+["']\/["']/,
-          'login_redirect "/welcome"'
+        # Update login_redirect and create_account_redirect to /welcome
+        update_rodauth_redirects(rodauth_file)
+      end
+
+      def integrate_with_welcome_controller
+        welcome_controller_path = Rails.root.join("app/controllers/welcome_controller.rb")
+        return unless File.exist?(welcome_controller_path)
+
+        file_content = File.read(welcome_controller_path)
+        return if file_content.include?("PendingInviteCheck")
+
+        relative_path = "app/controllers/welcome_controller.rb"
+
+        # Add PendingInviteCheck concern
+        inject_into_file relative_path,
+          "  include Plutonium::Invites::PendingInviteCheck\n",
+          after: /class WelcomeController.*\n/
+
+        # Add invite check as first step in index
+        inject_into_file relative_path,
+          "    return redirect_to(invites_welcome_check_path) if pending_invite\n\n",
+          after: /def index\n/
+
+        # Add invite_class method if not present
+        unless file_content.include?("def invite_class")
+          inject_into_file relative_path,
+            "\n  def invite_class\n    ::Invites::UserInvite\n  end\n",
+            before: /^end\s*\z/
+        end
+
+        # Update Invites::WelcomeController to redirect to /welcome (the main hub)
+        # instead of / (the app root)
+        invites_welcome_path = "packages/invites/app/controllers/invites/welcome_controller.rb"
+        if File.exist?(Rails.root.join(invites_welcome_path))
+          gsub_file invites_welcome_path,
+            /def default_redirect_path\n\s*"\/"\n\s*end/,
+            "def default_redirect_path\n      \"/welcome\"\n    end"
+        end
+
+        say_status :info, "Integrated invite check into WelcomeController", :green
       end
 
       def show_instructions
@@ -373,13 +431,13 @@ module Pu
       end
 
       def membership_model
-        options[:membership_model] || "#{entity_model}User"
+        options[:membership_model] || "#{entity_model}#{user_model}"
       end
 
       def membership_model_file
         model_path = "#{membership_model.underscore}.rb"
         if entity_in_package?
-          Rails.root.join("packages", options[:dest], "app/models", model_path)
+          Rails.root.join("packages", entity_package, "app/models", model_path)
         else
           Rails.root.join("app/models", model_path)
         end

data/lib/generators/pu/invites/templates/INSTRUCTIONS

@@ -12,7 +12,10 @@ Next steps:
    # packages/<portal>/config/routes.rb
    register_resource ::Invites::UserInvite
 
-3. (Optional) Connect invitable models that trigger invites:
+3. (Optional) Set up the welcome/onboarding flow if you haven't already:
+   rails g pu:saas:welcome --user-model=User --entity-model=Organization --portal=CustomerPortal
+
+4. (Optional) Connect invitable models that trigger invites:
    rails g pu:invites:invitable Tenant
    rails g pu:invites:invitable TeamMember --role=member
 

data/lib/generators/pu/invites/templates/app/interactions/invite_user_interaction.rb.tt

@@ -6,7 +6,7 @@ class <%= entity_model %>::InviteUserInteraction < Plutonium::Resource::Interact
   presents label: "Invite <%= user_model.underscore.humanize.titleize %>", icon: Phlex::TablerIcons::Mail
 
   attribute :role
-  input :role, as: :select, choices: Invites::UserInvite.roles.keys
+  input :role, as: :select, choices: Invites::UserInvite.roles.keys.excluding("owner")
 <% if membership_model != "EntityUser" || user_model != "User" -%>
 
   private

data/lib/generators/pu/invites/templates/app/interactions/user_invite_user_interaction.rb.tt

@@ -6,7 +6,7 @@ class <%= user_model %>::InviteUserInteraction < Plutonium::Resource::Interactio
   presents label: "Invite <%= user_model.underscore.humanize.titleize %>", icon: Phlex::TablerIcons::Mail
 
   attribute :role
-  input :role, as: :select, choices: Invites::UserInvite.roles.keys
+  input :role, as: :select, choices: Invites::UserInvite.roles.keys.excluding("owner")
 
   private
 

data/lib/generators/pu/invites/templates/packages/invites/app/controllers/invites/user_invitations_controller.rb.tt

@@ -14,7 +14,7 @@ module Invites
     private
 
     def invite_class
-      Invites::UserInvite
+      ::Invites::UserInvite
     end
 
     def user_class
@@ -22,7 +22,11 @@ module Invites
     end
 
     def after_accept_path
+<% if rodauth? -%>
+      rodauth.login_redirect
+<% else -%>
       "/"
+<% end -%>
     end
 
     def login_path

data/lib/generators/pu/invites/templates/packages/invites/app/controllers/invites/welcome_controller.rb.tt

@@ -4,16 +4,17 @@ module Invites
   class WelcomeController < ApplicationController
 <% if rodauth? -%>
     include Plutonium::Auth::Rodauth(:<%= rodauth_config %>)
+
+    before_action { rodauth.require_authentication }
+<% else -%>
+    before_action :require_authentication
+
 <% end -%>
     include Plutonium::Invites::PendingInviteCheck
 
     prepend_view_path Invites::Engine.root.join("app/views")
     layout "invites/invitation"
 
-<% if rodauth? -%>
-    before_action :require_authentication
-<% end -%>
-
     def index
       @invite = pending_invite
 
@@ -24,10 +25,15 @@ module Invites
       end
     end
 
+    def skip
+      cookies.delete(:pending_invitation)
+      redirect_to after_welcome_path, allow_other_host: false
+    end
+
     private
 
     def invite_class
-      Invites::UserInvite
+      ::Invites::UserInvite
     end
 
     # Returns the path to redirect to after the welcome flow completes.
@@ -40,30 +46,14 @@ module Invites
     def default_redirect_path
       "/"
     end
+<% unless rodauth? -%>
 
-<% if rodauth? -%>
-    def require_authentication
-      redirect_to login_path unless current_user
-    end
-
-    # Override: the default current_user raises when not logged in,
-    # but this controller needs a nil return for the authentication check.
-    def current_user
-      rodauth.rails_account if rodauth.logged_in?
-    end
-
-    def login_path
-      rodauth.login_path
-    end
-<% else -%>
     def require_authentication
-      # TODO: Implement based on your authentication system
-      redirect_to "/login" unless current_user
+      raise NotImplementedError, "#{self.class}#require_authentication must be implemented for your authentication system"
     end
 
     def current_user
-      # TODO: Implement based on your authentication system
-      nil
+      raise NotImplementedError, "#{self.class}#current_user must be implemented for your authentication system"
     end
 <% end -%>
   end

data/lib/generators/pu/invites/templates/packages/invites/app/mailers/invites/user_invite_mailer.rb.tt

@@ -2,6 +2,8 @@
 
 module Invites
   class UserInviteMailer < ApplicationMailer
+    prepend_view_path Invites::Engine.root.join("app/views")
+
     def invitation(user_invite)
       @user_invite = user_invite
       @invitation_url = invitation_url(token: user_invite.token)

data/lib/generators/pu/invites/templates/packages/invites/app/views/invites/user_invitations/show.html.erb.tt

@@ -32,8 +32,9 @@
     <div class="space-y-3 pt-4">
       <%%= form.submit "Accept Invitation",
           class: "w-full pu-btn pu-btn-md pu-btn-primary cursor-pointer" %>
-      <%%= link_to "Cancel", "/",
-          class: "w-full block pu-btn pu-btn-md pu-btn-outline text-center" %>
+      <%%= button_to "Skip for Now", invites_welcome_skip_path,
+          method: :delete,
+          class: "w-full pu-btn pu-btn-md pu-btn-outline text-center" %>
     </div>
   <%% end %>
 </div>

data/lib/generators/pu/invites/templates/packages/invites/app/views/invites/welcome/pending_invitation.html.erb.tt

@@ -18,6 +18,7 @@
   <%%= link_to "View Invitation", invitation_path(token: @invite.token),
       class: "w-full block pu-btn pu-btn-md pu-btn-primary text-center" %>
 
-  <%%= link_to "Skip for Now", "/",
-      class: "w-full block pu-btn pu-btn-md pu-btn-outline text-center" %>
+  <%%= button_to "Skip for Now", invites_welcome_skip_path,
+      method: :delete,
+      class: "w-full pu-btn pu-btn-md pu-btn-outline text-center" %>
 </div>

data/lib/generators/pu/lib/plutonium_generators/concerns/logger.rb

@@ -25,6 +25,8 @@ module PlutoniumGenerators
       end
 
       def exception(msg, err)
+        raise err if Rails.env.test?
+
         error "#{msg}\n\n#{err.class}: #{err}\n#{err.backtrace.join("\n")}"
       end
 

data/lib/generators/pu/lib/plutonium_generators/concerns/package_selector.rb

@@ -21,18 +21,16 @@ module PlutoniumGenerators
       end
 
       def available_packages
-        @available_packages ||= begin
-          packages = Dir[Rails.root.join("packages", "*")].map { |dir| File.basename(dir) }
-          packages - reserved_packages
-        end
+        packages = Dir[Rails.root.join("packages", "*")].map { |dir| File.basename(dir) }
+        packages - reserved_packages
       end
 
       def available_portals
-        @available_portals ||= ["main_app"] + available_packages.select { |pkg| pkg.ends_with?("_app") || pkg.ends_with?("_portal") }.sort
+        ["main_app"] + available_packages.select { |pkg| pkg.ends_with?("_app") || pkg.ends_with?("_portal") }.sort
       end
 
       def available_features
-        @available_features ||= ["main_app"] + available_packages.select { |pkg| !(pkg.ends_with?("_app") || pkg.ends_with?("_portal")) }.sort
+        ["main_app"] + available_packages.select { |pkg| !(pkg.ends_with?("_app") || pkg.ends_with?("_portal")) }.sort
       end
 
       def select_package(selected_package = nil, msg: "Select package", pkgs: nil)

data/lib/generators/pu/lib/plutonium_generators/concerns/rodauth_redirects.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module PlutoniumGenerators
+  module Concerns
+    # Shared logic for updating Rodauth redirect configuration.
+    # Used by generators that need to point login/create_account redirects to /welcome.
+    module RodauthRedirects
+      # Updates login_redirect and create_account_redirect in a Rodauth plugin file
+      # to point to the given path (typically "/welcome").
+      #
+      # @param rodauth_file [String] relative path to the rodauth plugin file
+      # @param redirect_path [String] the path to redirect to (default: "/welcome")
+      def update_rodauth_redirects(rodauth_file, redirect_path: "/welcome")
+        unless File.exist?(Rails.root.join(rodauth_file))
+          say_status :skip, "Rodauth plugin not found: #{rodauth_file}", :yellow
+          return
+        end
+
+        file_content = File.read(Rails.root.join(rodauth_file))
+
+        # Update login_redirect
+        if file_content.match?(/login_redirect\s+["']\/["']/)
+          gsub_file rodauth_file,
+            /login_redirect\s+["']\/["']/,
+            "login_redirect \"#{redirect_path}\""
+        end
+
+        # Update or add create_account_redirect
+        if file_content.include?("create_account_redirect")
+          gsub_file rodauth_file,
+            /create_account_redirect\s+["']\/["']/,
+            "create_account_redirect \"#{redirect_path}\""
+        elsif file_content.include?("login_redirect")
+          inject_into_file rodauth_file,
+            "\n    create_account_redirect \"#{redirect_path}\"\n",
+            after: /login_redirect.*\n/
+        end
+      end
+    end
+  end
+end

data/lib/generators/pu/lib/plutonium_generators/generator.rb

@@ -52,7 +52,11 @@ module PlutoniumGenerators
     # ####################
 
     def prompt
-      @prompt ||= TTY::Prompt.new
+      @prompt ||= if options[:interactive] == false || Rails.env.test?
+        NonInteractivePrompt.new
+      else
+        TTY::Prompt.new
+      end
     end
 
     # def appname

data/lib/generators/pu/lib/plutonium_generators/non_interactive_prompt.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PlutoniumGenerators
+  # A drop-in replacement for TTY::Prompt that raises on any interactive method.
+  # Used when --no-interactive is passed or when there's no TTY (e.g., tests, CI).
+  class NonInteractivePrompt
+    def select(question, choices = nil, **)
+      raise Thor::Error, "Interactive prompt not available: #{question}. Provide the required option explicitly."
+    end
+
+    def ask(question, **)
+      raise Thor::Error, "Interactive prompt not available: #{question}. Provide the required option explicitly."
+    end
+
+    def yes?(question, **)
+      raise Thor::Error, "Interactive prompt not available: #{question}. Provide the required option explicitly."
+    end
+
+    def no?(question, **)
+      raise Thor::Error, "Interactive prompt not available: #{question}. Provide the required option explicitly."
+    end
+
+    def multi_select(question, **)
+      raise Thor::Error, "Interactive prompt not available: #{question}. Provide the required option explicitly."
+    end
+  end
+end

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

@@ -31,5 +31,9 @@ class <%= account_path.classify %> < ResourceRecord
 
   # add misc attribute macros above.
 
+  def to_label
+    <%= login_column %>
+  end
+
   # add methods above. add private methods below.
 end

data/lib/generators/pu/saas/entity_generator.rb

@@ -16,6 +16,7 @@ module Pu
       def start
         generate_entity_resource
         add_unique_index_to_migration
+        add_dynamic_path_parameter
       rescue => e
         exception "#{self.class} failed:", e
       end
@@ -43,6 +44,21 @@ module Pu
           before: /^  end\s*$/
       end
 
+      def add_dynamic_path_parameter
+        dest = selected_destination_feature
+        model_path = if dest == "main_app"
+          "app/models/#{normalized_name}.rb"
+        else
+          "packages/#{dest}/app/models/#{normalized_name}.rb"
+        end
+
+        return unless File.exist?(Rails.root.join(model_path))
+
+        inject_into_file model_path,
+          "  dynamic_path_parameter :name\n",
+          before: /^\s*# add model configurations above\./
+      end
+
       def entity_attributes
         ["name:string", *Array(options[:extra_attributes])]
       end

data/lib/generators/pu/saas/membership_generator.rb

@@ -16,8 +16,8 @@ module Pu
       class_option :entity, type: :string, required: true,
         desc: "The entity model name (e.g., Organization)"
 
-      class_option :roles, type: :array, default: %w[member owner],
-        desc: "Available roles for memberships"
+      class_option :roles, type: :array, default: %w[admin member],
+        desc: "Additional roles for memberships (owner is always included as the first role)"
 
       class_option :extra_attributes, type: :array, default: [],
         desc: "Additional attributes for the membership model"
@@ -211,7 +211,8 @@ module Pu
       end
 
       def roles
-        Array(options[:roles]).flat_map { |r| r.split(",") }.map(&:strip)
+        additional = Array(options[:roles]).flat_map { |r| r.split(",") }.map(&:strip)
+        ["owner", *additional.excluding("owner")]
       end
 
       def roles_enum

data/lib/generators/pu/saas/portal/USAGE

@@ -0,0 +1,15 @@
+Description:
+  Generates a SaaS portal with entity scoping, entity self-management,
+  and navigation helpers.
+
+  Wraps pu:pkg:portal and adds:
+  - Entity registered as a singular resource
+  - Portal-scoped EntityPolicy (update=owner, no destroy)
+  - entity_url and user_entities helpers in portal concerns
+  - Entity controller for the portal
+
+Example:
+  rails g pu:saas:portal --entity-model=Organization --portal-name=Dashboard
+
+  This generates a DashboardPortal scoped to Organization, with
+  entity management and navigation helpers built in.

data/lib/generators/pu/saas/portal_generator.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require_relative "../lib/plutonium_generators"
+
+module Pu
+  module Saas
+    class PortalGenerator < ::Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      desc "Generate a SaaS portal with entity scoping, entity management, and navigation helpers"
+
+      class_option :entity_model, type: :string, required: true,
+        desc: "The entity model name (e.g., Organization)"
+
+      class_option :user_model, type: :string, default: "User",
+        desc: "The user model name"
+
+      class_option :portal_name, type: :string, default: "Dashboard",
+        desc: "Portal name (e.g., Dashboard generates DashboardPortal)"
+
+      class_option :rodauth, type: :string, default: "user",
+        desc: "Rodauth configuration name"
+
+      def start
+        create_portal
+        connect_entity_to_portal
+        customize_entity_policy
+        add_entity_url_helper
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def create_portal
+        generate "pu:pkg:portal", "#{options[:portal_name]} --auth=#{rodauth_config} --scope=#{entity_model}"
+      end
+
+      def connect_entity_to_portal
+        # Shell out so the subprocess can load the newly created entity model
+        generate "pu:res:conn", "#{entity_model} --dest=#{portal_package} --singular --policy"
+      end
+
+      def customize_entity_policy
+        content = <<-RUBY
+
+  def update?
+    current_membership&.owner?
+  end
+
+  def destroy?
+    false
+  end
+
+  def permitted_attributes_for_read
+    [:name]
+  end
+
+  def permitted_attributes_for_update
+    [:name]
+  end
+
+  def permitted_associations
+    []
+  end
+        RUBY
+        inject_into_file entity_policy_path, content, after: /include #{portal_engine}::ResourcePolicy\n/
+      end
+
+      def add_entity_url_helper
+        content = <<-RUBY
+
+      included do
+        helper_method :entity_url, :user_entities
+      end
+
+      private
+
+      # Returns the URL to the current entity's show page.
+      def entity_url
+        resource_url_for(current_scoped_entity)
+      end
+
+      # Returns all entities the current user belongs to (for the entity switcher).
+      def user_entities
+        @user_entities ||= current_user.#{entity_table.pluralize}
+      end
+        RUBY
+        inject_into_file concerns_controller_path, content, after: /# add concerns above\.\n/
+      end
+
+      def entity_model
+        options[:entity_model].camelize
+      end
+
+      def entity_table
+        options[:entity_model].underscore
+      end
+
+      def rodauth_config
+        options[:rodauth]
+      end
+
+      def portal_engine
+        "#{options[:portal_name].camelize}Portal"
+      end
+
+      def portal_package
+        portal_engine.underscore
+      end
+
+      def concerns_controller_path
+        "packages/#{portal_package}/app/controllers/#{portal_package}/concerns/controller.rb"
+      end
+
+      def entity_policy_path
+        "packages/#{portal_package}/app/policies/#{portal_package}/#{entity_table}_policy.rb"
+      end
+    end
+  end
+end