plutonium 0.18.5 → 0.18.6

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

@@ -1,4 +1,4 @@
-<%= render_component :breadcrumbs, resource_class:, parent: current_parent, resource: resource_record %>
+<%= render_component :breadcrumbs, resource_class:, parent: current_parent, resource: resource_record! %>
 
 <%= render_component :dyna_frame_content do %>
   <%= render "interactive_action_form", interactive_action: current_interactive_action %>

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

@@ -1,4 +1,4 @@
-<%= render_component :breadcrumbs, resource_class:, parent: current_parent, resource: resource_record %>
+<%= render_component :breadcrumbs, resource_class:, parent: current_parent, resource: resource_record! %>
 
 <%= render_component :dyna_frame_content do %>
   <%= render "interactive_action_form", interactive_action: current_interactive_action %>

data/lib/generators/pu/eject/layout/layout_generator.rb

@@ -11,7 +11,6 @@ module Pu
 
       desc "Eject layout views into your own project"
 
-      class_option :dest, type: :string
       class_option :rodauth, type: :boolean
 
       def start
@@ -28,7 +27,7 @@ module Pu
       private
 
       def destination_portal
-        @destination_portal || select_portal(options[:dest], msg: "Select destination portal")
+        portal_option(:dest, prompt: "Select destination portal")
       end
 
       def copy_file(source_path, destination_path)

data/lib/generators/pu/eject/shell/shell_generator.rb

@@ -11,8 +11,6 @@ module Pu
 
       desc "Eject layout shell (i.e header, sidebar) into your own project"
 
-      class_option :dest, type: :string
-
       def start
         destination_dir = (destination_portal == "main_app") ? "app/views/" : "packages/#{destination_portal}/app/views"
         [
@@ -28,7 +26,7 @@ module Pu
       private
 
       def destination_portal
-        @destination_portal || select_portal(options[:dest], msg: "Select destination portal")
+        portal_option(:dest, prompt: "Select destination portal")
       end
 
       def copy_file(source_path, destination_path)

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

@@ -11,6 +11,10 @@ module PlutoniumGenerators
         say format_log(msg, :info), :blue
       end
 
+      def warn(msg)
+        say format_log(msg, :warn), :yellow
+      end
+
       def success(msg)
         say format_log(msg, :success), :green
       end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module PlutoniumGenerators
+  module Concerns
+    module PackageSelector
+      def self.included(base)
+        base.send :class_option, :src, type: :string, desc: "The source package if applicable"
+        base.send :class_option, :dest, type: :string, desc: "The destination package if applicable"
+      end
+
+      private
+
+      def reserved_packages
+        %w[core reactor app main plutonium pluton8 plutonate]
+      end
+
+      def validate_package_name(package_name)
+        package_name = package_name.underscore
+        error("Package name is reserved\n\n#{reserved_packages.join "\n"}") if reserved_packages.include?(package_name)
+        error("Package name cannot end in `_app` or `_portal`") if /(_app|_portal)$/i.match?(package_name)
+      end
+
+      def available_packages
+        @available_packages ||= begin
+          packages = Dir["packages/*"].map { |dir| dir.gsub "packages/", "" }
+          packages - reserved_packages
+        end
+      end
+
+      def available_portals
+        @available_portals ||= ["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
+      end
+
+      def select_package(selected_package = nil, msg: "Select package", pkgs: nil)
+        pkgs ||= available_packages
+        if pkgs.include?(selected_package)
+          selected_package
+        else
+          prompt.select(msg, pkgs)
+        end
+      end
+
+      def select_feature(selected_package = nil, msg: "Select feature")
+        select_package(selected_package, msg: msg, pkgs: available_features)
+      end
+
+      def feature_option(name, prompt: nil, option_key: nil)
+        # Get stored value or command line option
+        ivar = :"@#{name}_feature_option"
+        return instance_variable_get(ivar) if instance_variable_defined?(ivar)
+
+        # Validate option or prompt user
+        option_key ||= name
+        value = select_feature(options[option_key], msg: prompt || "Select #{name} feature")
+        instance_variable_set(ivar, value)
+        value
+      end
+
+      def select_portal(selected_package = nil, msg: "Select portal")
+        select_package(selected_package, msg: msg, pkgs: available_portals)
+      end
+
+      def portal_option(name, prompt: nil, option_key: nil)
+        # Get stored value or command line option
+        ivar = :"@#{name}_portal_option"
+        return instance_variable_get(ivar) if instance_variable_defined?(ivar)
+
+        # Validate option or prompt user
+        option_key ||= name
+        value = select_portal(options[option_key], msg: prompt || "Select #{name} portal")
+        instance_variable_set(ivar, value)
+        value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PlutoniumGenerators
+  module Concerns
+    module ResourceSelector
+      def self.included(base)
+        # base.send :class_option, :resources, type: :array, desc: "List of resource model names if applicable"
+        base.send :argument, :resources, type: :array, optional: true, default: [],
+          desc: "List of model names if applicable"
+      end
+
+      private
+
+      def available_resources(source_module)
+        Plutonium.eager_load_rails!
+
+        source_module.constantize.descendants.reject do |resource_klass|
+          next true if resource_klass.abstract_class?
+          next true if source_module == "ApplicationRecord" &&
+            resource_klass.ancestors.any? { |ancestor| ancestor.to_s.end_with?("::ResourceRecord") }
+        end.map(&:to_s).sort
+      end
+
+      def select_resources(source_module, prompt: "Select resources")
+        resources = available_resources(source_module)
+        error "No resources found" if resources.blank?
+
+        self.prompt.multi_select(prompt, resources)
+      end
+
+      def resources_selection(prompt: nil)
+        ivar = :@resources_selection
+        return instance_variable_get(ivar) if instance_variable_defined?(ivar)
+
+        # Convert comma-separated string to array if from command line
+        value = resources.map(&:classify)
+        if value.empty?
+          source_feature = feature_option :src, prompt: "Select source feature"
+          source_module = (source_feature == "main_app") ? "ApplicationRecord" : "#{source_feature.camelize}::ResourceRecord"
+          value = select_resources(source_module, prompt: prompt || "Select #{source_module} resources")
+        end
+
+        instance_variable_set(ivar, value)
+        value
+      end
+    end
+  end
+end

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

@@ -14,51 +14,11 @@ module PlutoniumGenerators
       base.send :class_option, :interactive, type: :boolean, desc: "Show prompts. Default: true"
       base.send :class_option, :bundle, type: :boolean, desc: "Run bundle after setup. Default: true"
       base.send :class_option, :lint, type: :boolean, desc: "Run linter after generation. Default: false"
-    end
-
-    protected
-
-    def reserved_packages
-      %w[core reactor app main plutonium pluton8 plutonate]
-    end
-
-    def validate_package_name(package_name)
-      package_name = package_name.underscore
-      error("Package name is reserved\n\n#{reserved_packages.join "\n"}") if reserved_packages.include?(package_name)
-      error("Package name cannot end in `_app` or `_portal`") if /(_app|_portal)$/i.match?(package_name)
-    end
-
-    def available_packages
-      @available_packages ||= begin
-        packages = Dir["packages/*"].map { |dir| dir.gsub "packages/", "" }
-        packages - reserved_packages
-      end
-    end
 
-    def available_apps
-      @available_apps ||= ["main_app"] + available_packages.select { |pkg| pkg.ends_with?("_app") || pkg.ends_with?("_portal") }.sort
+      base.include Concerns::PackageSelector
     end
 
-    def available_features
-      @available_features ||= ["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)
-      pkgs ||= available_packages
-      if pkgs.include?(selected_package)
-        selected_package
-      else
-        prompt.select(msg, pkgs)
-      end
-    end
-
-    def select_portal(selected_package = nil, msg: "Select portal")
-      select_package(selected_package, msg: msg, pkgs: available_apps)
-    end
-
-    def select_feature(selected_package = nil, msg: "Select feature")
-      select_package(selected_package, msg: msg, pkgs: available_features)
-    end
+    protected
 
     # ####################
 

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

@@ -13,8 +13,6 @@ module PlutoniumGenerators
     remove_task :create_module_file
     # remove_task :check_class_collision
 
-    class_option :dest, type: :string
-
     # def check_class_collision # :doc:
     #   class_collisions "#{options[:prefix]}#{name}#{options[:suffix]}"
     # end
@@ -41,7 +39,6 @@ module PlutoniumGenerators
     def name
       @pu_name ||= begin
         @original_name = @name
-        @selected_destination_feature = select_feature selected_destination_feature, msg: "Select destination feature"
         @name = [main_app? ? nil : selected_destination_feature.underscore, super.singularize.underscore].compact.join "/"
         set_destination_root!
         @name
@@ -57,7 +54,7 @@ module PlutoniumGenerators
     end
 
     def selected_destination_feature
-      @selected_destination_feature || options[:dest]
+      feature_option :dest, prompt: "Select destination feature"
     end
 
     def set_destination_root!

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

@@ -6,26 +6,20 @@ module Pu
   module Res
     class ConnGenerator < Rails::Generators::Base
       include PlutoniumGenerators::Generator
+      include PlutoniumGenerators::Concerns::ResourceSelector
 
       source_root File.expand_path("templates", __dir__)
 
-      desc "Create a connection between a resource and an app"
+      desc(
+        "Create a connection between a resource and a portal\n\n" \
+        "e.g. rails g pu:res:conn todo --dest=dashboard_portal"
+      )
 
       # argument :name
 
       def start
-        source_feature = select_feature msg: "Select source feature"
-        source_module = (source_feature == "main_app") ? "ApplicationRecord" : "#{source_feature.camelize}::ResourceRecord"
-
-        Plutonium.eager_load_rails!
-        available_resources = source_module.constantize.descendants.reject do |model|
-          next true if model.abstract_class?
-          next true if source_module == "ApplicationRecord" && model.ancestors.any? { |ancestor| ancestor.to_s.end_with?("::ResourceRecord") }
-        end.map(&:to_s).sort
-        error "No resources found" if available_resources.blank?
-        selected_resources = prompt.multi_select("Select resources", available_resources)
-
-        @app_namespace = select_portal.camelize
+        selected_resources = resources_selection
+        @app_namespace = portal_option(:dest, prompt: "Select destination portal").camelize
 
         selected_resources.each do |resource|
           @resource_class = resource
@@ -97,13 +91,7 @@ module Pu
 
       def attributes
         resource_klass = resource_class.constantize
-        unwanted_attrs = [
-          resource_klass.primary_key.to_sym, # primary_key
-          :created_at, :updated_at # timestamps
-        ]
         resource_klass.content_columns.filter_map { |col|
-          next if unwanted_attrs.include? col.name.to_sym
-
           PlutoniumGenerators::ModelGeneratorBase::GeneratedAttribute.parse resource_class, "#{col.name}:#{col.type}"
         }
       rescue ActiveRecord::StatementInvalid
@@ -116,11 +104,11 @@ module Pu
       end
 
       def policy_attributes_for_create
-        default_policy_attributes
+        default_policy_attributes - [:created_at, :updated_at]
       end
 
       def policy_attributes_for_read
-        default_policy_attributes + [:created_at, :updated_at]
+        default_policy_attributes
       end
     end
   end

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

@@ -4,6 +4,7 @@ require_relative "../../lib/plutonium_generators"
 
 module Pu
   module Res
+    # run `rails g pu:res:scaffold existing_resource` without any arguments to import an existing resource
     class ScaffoldGenerator < PlutoniumGenerators::ModelGeneratorBase
       include PlutoniumGenerators::Generator
 
@@ -17,9 +18,13 @@ module Pu
         return unless options[:model]
 
         model_class = class_name.safe_constantize
-        if model_class.present? && attributes.empty? && prompt.yes?("Existing model class found. Do you want to import its attributes?")
-          attributes_str = model_class.content_columns.map { |col| "#{col.name}:#{col.type}" }
-          self.attributes = parse_attributes_internal!(attributes_str)
+        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
+            warn("Overwriting existing resource. You can leave out the attributes to import an existing resource.")
+          end
         end
       end
 
@@ -56,11 +61,11 @@ module Pu
       end
 
       def policy_attributes_for_create
-        default_policy_attributes
+        default_policy_attributes - [:created_at, :updated_at]
       end
 
       def policy_attributes_for_read
-        default_policy_attributes + [:created_at, :updated_at]
+        default_policy_attributes
       end
     end
   end

data/lib/plutonium/resource/controller.rb

@@ -19,7 +19,7 @@ module Plutonium
         # https://github.com/ddnexus/pagy/blob/master/docs/extras/headers.md#headers
         after_action { pagy_headers_merge(@pagy) if @pagy }
 
-        helper_method :current_parent, :resource_record, :resource_param_key, :resource_class
+        helper_method :current_parent, :resource_record!, :resource_record?, :resource_param_key, :resource_class
       end
 
       class_methods do
@@ -62,7 +62,7 @@ module Plutonium
         end
       end
 
-      def resource_record
+      def resource_record!
         @resource_record ||= resource_record_relation.first!
       end
 
@@ -117,7 +117,7 @@ module Plutonium
       # Applies submitted resource params if they have been passed
       def maybe_apply_submitted_resource_params!
         ensure_get_request
-        resource_record.attributes = submitted_resource_params if params[resource_param_key]
+        resource_record!.attributes = submitted_resource_params if params[resource_param_key]
       end
 
       # Returns the current parent based on path parameters

data/lib/plutonium/resource/controllers/authorizable.rb

@@ -12,7 +12,7 @@ module Plutonium
       #     include Plutonium::Resource::Controllers::Authorizable
       #   end
       #
-      # @note This module assumes the existence of methods like `resource_record`,
+      # @note This module assumes the existence of methods like `resource_record!`,
       #   `resource_class`, `current_parent`, and `entity_scope_for_authorize`.
       #
       # @see ActionPolicy

data/lib/plutonium/resource/controllers/crud_actions.rb

@@ -21,8 +21,8 @@ module Plutonium
 
         # GET /resources/1(.{format})
         def show
-          authorize_current! resource_record
-          set_page_title resource_record.to_label.titleize
+          authorize_current! resource_record!
+          set_page_title resource_record!.to_label.titleize
 
           render :show
         end
@@ -46,7 +46,7 @@ module Plutonium
           @resource_record = resource_class.new resource_params
 
           respond_to do |format|
-            if resource_record.save
+            if resource_record!.save
               format.html do
                 redirect_to redirect_url_after_submit,
                   notice: "#{resource_class.model_name.human} was successfully created."
@@ -57,7 +57,7 @@ module Plutonium
                 render :new, status: :unprocessable_entity
               end
               format.any do
-                @errors = resource_record.errors
+                @errors = resource_record!.errors
                 render "errors", status: :unprocessable_entity
               end
             end
@@ -66,8 +66,8 @@ module Plutonium
 
         # GET /resources/1/edit
         def edit
-          authorize_current! resource_record
-          set_page_title "Update #{resource_record.to_label.titleize}"
+          authorize_current! resource_record!
+          set_page_title "Update #{resource_record!.to_label.titleize}"
 
           maybe_apply_submitted_resource_params!
 
@@ -76,11 +76,11 @@ module Plutonium
 
         # PATCH/PUT /resources/1(.{format})
         def update
-          authorize_current! resource_record
-          set_page_title "Update #{resource_record.to_label.titleize}"
+          authorize_current! resource_record!
+          set_page_title "Update #{resource_record!.to_label.titleize}"
 
           respond_to do |format|
-            if resource_record.update(resource_params)
+            if resource_record!.update(resource_params)
               format.html do
                 redirect_to redirect_url_after_submit, notice: "#{resource_class.model_name.human} was successfully updated.",
                   status: :see_other
@@ -91,7 +91,7 @@ module Plutonium
                 render :edit, status: :unprocessable_entity
               end
               format.any do
-                @errors = resource_record.errors
+                @errors = resource_record!.errors
                 render "errors", status: :unprocessable_entity
               end
             end
@@ -100,10 +100,10 @@ module Plutonium
 
         # DELETE /resources/1(.{format})
         def destroy
-          authorize_current! resource_record
+          authorize_current! resource_record!
 
           respond_to do |format|
-            resource_record.destroy
+            resource_record!.destroy
 
             format.html do
               redirect_to redirect_url_after_destroy,
@@ -112,11 +112,11 @@ module Plutonium
             format.json { head :no_content }
           rescue ActiveRecord::InvalidForeignKey
             format.html do
-              redirect_to resource_url_for(resource_record),
+              redirect_to resource_url_for(resource_record!),
                 alert: "#{resource_class.model_name.human} is referenced by other records."
             end
             format.any do
-              @errors = ActiveModel::Errors.new resource_record
+              @errors = ActiveModel::Errors.new resource_record!
               @errors.add :base, :existing_references, message: "is referenced by other records"
 
               render "errors", status: :unprocessable_entity
@@ -133,9 +133,9 @@ module Plutonium
 
           url = case preferred_action_after_submit
           when "show"
-            resource_url_for(resource_record) if current_policy.allowed_to? :show?
+            resource_url_for(resource_record!) if current_policy.allowed_to? :show?
           when "edit"
-            resource_url_for(resource_record, action: :edit) if current_policy.allowed_to? :edit?
+            resource_url_for(resource_record!, action: :edit) if current_policy.allowed_to? :edit?
           when "new"
             resource_url_for(resource_class, action: :new) if current_policy.allowed_to? :new?
           when "index"
@@ -144,7 +144,7 @@ module Plutonium
             # ensure we have a valid value
             session[:action_after_submit_preference] = "show"
           end
-          url || resource_url_for(resource_record)
+          url || resource_url_for(resource_record!)
         end
 
         def redirect_url_after_destroy

data/lib/plutonium/resource/controllers/interactive_actions.rb

@@ -42,7 +42,7 @@ module Plutonium
           if outcome.success?
             outcome.to_response.process(self) do |value|
               respond_to do |format|
-                return_url = redirect_url_after_action_on(resource_record)
+                return_url = redirect_url_after_action_on(resource_record!)
                 format.any { redirect_to return_url, status: :see_other }
                 if helpers.current_turbo_frame == "modal"
                   format.turbo_stream do
@@ -202,7 +202,7 @@ module Plutonium
 
         def authorize_interactive_record_action!
           interactive_resource_action = params[:interactive_action]&.to_sym
-          authorize_current! resource_record, to: :"#{interactive_resource_action}?"
+          authorize_current! resource_record!, to: :"#{interactive_resource_action}?"
         end
 
         def authorize_interactive_resource_action!
@@ -216,7 +216,7 @@ module Plutonium
 
         def build_interactive_record_action_interaction
           @interaction = current_interactive_action.interaction.new(view_context:)
-          @interaction.attributes = interaction_params.merge(resource: resource_record)
+          @interaction.attributes = interaction_params.merge(resource: resource_record!)
           @interaction
         end
 

data/lib/plutonium/resource/controllers/presentable.rb

@@ -36,10 +36,10 @@ module Plutonium
         end
 
         def build_detail
-          current_definition.detail_class.new(resource_record, resource_fields: presentable_attributes, resource_associations: permitted_associations, resource_definition: current_definition)
+          current_definition.detail_class.new(resource_record!, resource_fields: presentable_attributes, resource_associations: permitted_associations, resource_definition: current_definition)
         end
 
-        def build_form(record = resource_record)
+        def build_form(record = resource_record!)
           current_definition.form_class.new(record, resource_fields: submittable_attributes, resource_definition: current_definition)
         end
       end

data/lib/plutonium/resource/record/associated_with.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# lib/plutonium/resource/associations.rb
+module Plutonium
+  module Resource
+    module Record
+      module AssociatedWith
+        extend ActiveSupport::Concern
+
+        included do
+          scope :associated_with, ->(record) do
+            named_scope = :"associated_with_#{record.model_name.singular}"
+            return send(named_scope, record) if respond_to?(named_scope)
+
+            own_association = klass.find_association_from_self_to_record(record)
+            if own_association
+              return klass.query_based_on_association(own_association, record)
+            end
+
+            record_association = klass.find_association_to_self_from_record(record)
+            if record_association
+              Plutonium.logger.warn do
+                [
+                  "Using indirect association from #{record.class} to #{klass.name}",
+                  "via '#{record_association.name}'.",
+                  "This may result in poor query performance for large datasets",
+                  "as it requires loading records to perform the association.",
+                  "",
+                  "Consider defining a direct association or implementing",
+                  "a custom scope '#{named_scope}' for better performance."
+                ].join("\n")
+              end
+              return where(id: record.public_send(record_association.name))
+            end
+
+            klass.raise_unresolvable_association_error(record, named_scope)
+          end
+        end
+
+        class_methods do
+          def find_association_from_self_to_record(record)
+            reflect_on_all_associations.find do |assoc|
+              assoc.klass.name == record.class.name unless assoc.polymorphic?
+            rescue
+              assoc.check_validity!
+              raise
+            end
+          end
+
+          def find_association_to_self_from_record(record)
+            record.class.reflect_on_all_associations.find do |assoc|
+              assoc.klass.name == name
+            rescue
+              assoc.check_validity!
+              raise
+            end
+          end
+
+          def query_based_on_association(assoc, record)
+            case assoc.macro
+            when :has_one
+              joins(assoc.name).where(assoc.name => {record.class.primary_key => record.id})
+            when :belongs_to
+              where(assoc.name => record)
+            when :has_many
+              joins(assoc.name).where(assoc.klass.table_name => record)
+            else
+              raise NotImplementedError, "associated_with->##{assoc.macro}"
+            end
+          end
+
+          def raise_unresolvable_association_error(record, named_scope)
+            raise "Could not resolve the association between '#{name}' and '#{record.class.name}'\n\n" \
+                  "Define\n" \
+                  " 1. the associations between the models\n" \
+                  " 2. a named scope on #{name} e.g.\n\n" \
+                  "scope :#{named_scope}, ->(#{record.model_name.singular}) { do_something_here }"
+          end
+        end
+      end
+    end
+  end
+end