plutonium 0.15.0 → 0.15.2

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

@@ -26,7 +26,6 @@ module Plutonium
         class ActionMissingCurrentAuthorizedScope < ActionPolicy::UnauthorizedAction; end
 
         included do
-          verify_authorized
           after_action :verify_authorize_current
           after_action :verify_current_authorized_scope, except: %i[new create]
 
@@ -35,28 +34,53 @@ module Plutonium
           attr_writer :authorize_current_count
           attr_writer :current_authorized_scope_count
 
+          attr_reader :verify_authorize_current_skipped
+          attr_reader :verify_current_authorized_scope_skipped
+
           protected :authorize_current_count=, :authorize_current_count
           protected :current_authorized_scope_count=, :current_authorized_scope_count
         end
 
+        class_methods do
+          # Skips verify_authorize_current after_action callback.
+          def skip_verify_authorize_current(**options)
+            skip_after_action :verify_authorize_current, options
+          end
+
+          # Skips verify_current_authorized_scope after_action callback.
+          def skip_verify_current_authorized_scope(**options)
+            skip_after_action :verify_current_authorized_scope, options
+          end
+        end
+
         private
 
+        def skip_verify_authorize_current!
+          @verify_authorize_current_skipped = true
+        end
+
+        def skip_verify_current_authorized_scope!
+          @verify_current_authorized_scope_skipped = true
+        end
+
         # Verifies that authorize_current has been called
         #
         # @raise [ActionMissingAuthorizeCurrent] if authorize_current hasn't been called
         def verify_authorize_current
-          return if verify_authorized_skipped
+          return if verify_authorize_current_skipped
+          return if authorize_current_count > 0
 
-          raise ActionMissingAuthorizeCurrent.new(controller_path, action_name) if authorize_current_count.zero?
+          raise ActionMissingAuthorizeCurrent.new(controller_path, action_name)
         end
 
         # Verifies that current_authorized_scope has been called
         #
         # @raise [ActionMissingCurrentAuthorizedScope] if current_authorized_scope hasn't been called
         def verify_current_authorized_scope
-          return if verify_authorized_skipped
+          return if current_authorized_scope_count
+          return if current_authorized_scope_count > 0
 
-          raise ActionMissingCurrentAuthorizedScope.new(controller_path, action_name) if current_authorized_scope_count.zero?
+          raise ActionMissingCurrentAuthorizedScope.new(controller_path, action_name)
         end
 
         # @return [Integer] the number of times authorize_current has been called

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

@@ -7,169 +7,178 @@ module Plutonium
         included do
           helper_method :current_interactive_action
 
-          before_action :validate_interactive_resource_action!, only: %i[
-            begin_interactive_resource_record_action commit_interactive_resource_record_action
-            begin_interactive_resource_collection_action commit_interactive_resource_collection_action
-            begin_interactive_resource_recordless_action commit_interactive_resource_recordless_action
+          before_action :validate_interactive_action!, only: %i[
+            interactive_record_action commit_interactive_record_action
+            interactive_bulk_action commit_interactive_bulk_action
+            interactive_resource_action commit_interactive_resource_action
           ]
 
-          before_action :authorize_interactive_resource_record_action!, only: %i[
-            begin_interactive_resource_record_action commit_interactive_resource_record_action
+          before_action :authorize_interactive_record_action!, only: %i[
+            interactive_record_action commit_interactive_record_action
           ]
 
           before_action :authorize_interactive_resource_action!, only: %i[
-            begin_interactive_resource_collection_action commit_interactive_resource_collection_action
-            begin_interactive_resource_recordless_action commit_interactive_resource_recordless_action
+            interactive_bulk_action commit_interactive_bulk_action
+            interactive_resource_action commit_interactive_resource_action
           ]
         end
 
-        # GET /resources/1/actions/:interactive_action
-        def begin_interactive_resource_record_action
-          @interaction = current_interactive_action.interaction.new interaction_params
+        # GET /resources/1/record_actions/:interactive_action
+        def interactive_record_action
+          build_interactive_record_action_interaction
 
           if helpers.current_turbo_frame == "modal"
             render layout: false
           else
-            render :interactive_resource_record_action
+            render :interactive_record_action
           end
         end
 
-        # POST /resources/1/actions/:interactive_action
-        def commit_interactive_resource_record_action
-          respond_to do |format|
-            inputs = interaction_params.merge(resource: resource_record)
-            @interaction = current_interactive_action.interaction.run(inputs)
-
-            if @interaction.valid?
-              flash[:notice] = "TODO:#{current_interactive_action} was successfully updated."
-
-              format.html { redirect_to resource_url_for(@interaction.result), status: :see_other }
-              format.any { render :show, status: :ok, location: resource_url_for(@interaction.result) }
-
-              if helpers.current_turbo_frame == "modal"
-                format.turbo_stream do
-                  render turbo_stream: [
-                    turbo_stream.redirect(resource_url_for(@interaction.result))
-                  ]
+        # POST /resources/1/record_actions/:interactive_action
+        def commit_interactive_record_action
+          build_interactive_record_action_interaction
+
+          outcome = @interaction.call
+          if outcome.success?
+            outcome.to_response.process(self) do |value|
+              respond_to do |format|
+                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
+                    render turbo_stream: [
+                      turbo_stream.redirect(return_url)
+                    ]
+                  end
                 end
               end
-            else
-              format.html do
-                render :interactive_resource_record_action, status: :unprocessable_entity
-              end
-              format.any do
-                @errors = @interaction.errors
-                render "errors", status: :unprocessable_entity
-              end
-
-              if helpers.current_turbo_frame == "modal"
-                format.turbo_stream do
-                  render turbo_stream: turbo_stream.replace(:modal, partial: "interactive_resource_record_action_form")
+            end
+          else
+            outcome.to_response.process(self) do
+              respond_to do |format|
+                format.html do
+                  render :interactive_record_action, status: :unprocessable_entity
+                end
+                format.any do
+                  @errors = @interaction.errors
+                  render "errors", status: :unprocessable_entity
+                end
+                if helpers.current_turbo_frame == "modal"
+                  format.turbo_stream do
+                    render turbo_stream: [
+                      turbo_stream.replace(:modal, partial: "interactive_action_form")
+                    ]
+                  end
                 end
               end
             end
           end
         end
 
-        # GET /resources/actions/:interactive_action?ids[]=1&ids[]=2
-        def begin_interactive_resource_collection_action
-          # TODO: ensure that the selected list matches the returned value
-          interactive_resource_collection
-          @interaction = current_interactive_action.interaction.new((params[:interaction] || {}).except(:resources))
+        # GET /resources/resource_actions/:interactive_action
+        def interactive_resource_action
+          skip_verify_current_authorized_scope!
+          build_interactive_resource_action_interaction
 
           if helpers.current_turbo_frame == "modal"
             render layout: false
           else
-            render :interactive_resource_collection_action
+            render :interactive_resource_action
           end
         end
 
-        # POST /resources/actions/:interactive_action?ids[]=1&ids[]=2
-        def commit_interactive_resource_collection_action
-          respond_to do |format|
-            inputs = interaction_params.merge(resources: interactive_resource_collection)
-            @interaction = current_interactive_action.interaction.run(inputs)
-
-            if @interaction.valid?
-              collection_count = interactive_resource_collection.size
-
-              flash[:notice] = "TODO:#{current_interactive_action} #{collection_count} #{resource_class.model_name.human.pluralize(collection_count)} successfully updated."
-
-              format.html { redirect_to resource_url_for(resource_class) }
-              if helpers.current_turbo_frame == "modal"
-                format.turbo_stream do
-                  render turbo_stream: [
-                    turbo_stream.redirect(resource_url_for(resource_class))
-                  ]
+        # POST /resources/resource_actions/:interactive_action
+        def commit_interactive_resource_action
+          skip_verify_current_authorized_scope!
+          build_interactive_resource_action_interaction
+
+          outcome = @interaction.call
+          if outcome.success?
+            outcome.to_response.process(self) do |value|
+              respond_to do |format|
+                return_url = redirect_url_after_action_on(resource_class)
+                format.any { redirect_to return_url, status: :see_other }
+                if helpers.current_turbo_frame == "modal"
+                  format.turbo_stream do
+                    render turbo_stream: [
+                      turbo_stream.redirect(return_url)
+                    ]
+                  end
                 end
               end
-            else
-              format.html do
-                render :interactive_resource_collection_action, status: :unprocessable_entity
-              end
-              format.any do
-                @errors = @interaction.errors
-                render "errors", status: :unprocessable_entity
-              end
-
-              if helpers.current_turbo_frame == "modal"
-                format.turbo_stream do
-                  render turbo_stream: turbo_stream.replace(:modal, partial: "interactive_resource_collection_action_form")
+            end
+          else
+            outcome.to_response.process(self) do
+              respond_to do |format|
+                format.html do
+                  render :interactive_record_action, status: :unprocessable_entity
+                end
+                format.any do
+                  @errors = @interaction.errors
+                  render "errors", status: :unprocessable_entity
+                end
+                if helpers.current_turbo_frame == "modal"
+                  format.turbo_stream do
+                    render turbo_stream: [
+                      turbo_stream.replace(:modal, partial: "interactive_action_form")
+                    ]
+                  end
                 end
               end
             end
           end
         end
 
-        # GET /resources/actions/:interactive_action
-        def begin_interactive_resource_recordless_action
-          # skip_policy_scope
-
-          @interaction = current_interactive_action.interaction.new interaction_params
-
-          if helpers.current_turbo_frame == "modal"
-            render layout: false
-          else
-            render :interactive_resource_recordless_action
-          end
+        # GET /resources/bulk_actions/:interactive_action?ids[]=1&ids[]=2
+        def interactive_bulk_action
+          raise NotImplementedError
+          # # TODO: ensure that the selected list matches the returned value
+          # interactive_bulk
+          # @interaction = current_interactive_action.interaction.new((params[:interaction] || {}).except(:resources))
+
+          # if helpers.current_turbo_frame == "modal"
+          #   render layout: false
+          # else
+          #   render :interactive_bulk_action
+          # end
         end
 
-        # POST /resources/actions/:interactive_action
-        def commit_interactive_resource_recordless_action
-          # skip_policy_scope
-
-          respond_to do |format|
-            inputs = interaction_params
-            @interaction = current_interactive_action.interaction.run(inputs)
-
-            if @interaction.valid?
-              flash[:notice] = "TODO:#{current_interactive_action} was successfully updated."
-
-              format.html { redirect_to resource_url_for(resource_class) }
-
-              if helpers.current_turbo_frame == "modal"
-                format.turbo_stream do
-                  render turbo_stream: [
-                    turbo_stream.redirect(resource_url_for(resource_class))
-                  ]
-                end
-              end
-            else
-              format.html do
-                render :interactive_resource_recordless_action, status: :unprocessable_entity
-              end
-              format.any do
-                @errors = @interaction.errors
-                render "errors", status: :unprocessable_entity
-              end
-
-              if helpers.current_turbo_frame == "modal"
-                format.turbo_stream do
-                  render turbo_stream: turbo_stream.replace(:modal, partial: "interactive_resource_recordless_action_form")
-                end
-              end
-            end
-          end
+        # POST /resources/bulk_actions/:interactive_action?ids[]=1&ids[]=2
+        def commit_interactive_bulk_action
+          raise NotImplementedError
+          # respond_to do |format|
+          #   inputs = interaction_params.merge(resources: interactive_bulk)
+          #   @interaction = current_interactive_action.interaction.run(inputs)
+
+          #   if @interaction.valid?
+          #     collection_count = interactive_bulk.size
+
+          #     flash[:notice] = "TODO:#{current_interactive_action} #{collection_count} #{resource_class.model_name.human.pluralize(collection_count)} successfully updated."
+
+          #     format.html { redirect_to resource_url_for(resource_class) }
+          #     if helpers.current_turbo_frame == "modal"
+          #       format.turbo_stream do
+          #         render turbo_stream: [
+          #           turbo_stream.redirect(resource_url_for(resource_class))
+          #         ]
+          #       end
+          #     end
+          #   else
+          #     format.html do
+          #       render :interactive_bulk_action, status: :unprocessable_entity
+          #     end
+          #     format.any do
+          #       @errors = @interaction.errors
+          #       render "errors", status: :unprocessable_entity
+          #     end
+
+          #     if helpers.current_turbo_frame == "modal"
+          #       format.turbo_stream do
+          #         render turbo_stream: turbo_stream.replace(:modal, partial: "interactive_bulk_action_form")
+          #       end
+          #     end
+          #   end
+          # end
         end
 
         private
@@ -179,17 +188,19 @@ module Plutonium
         end
 
         def interactive_resource_actions
-          @interactive_resource_actions ||= current_presenter.actions.except :new, :show, :edit, :destroy
+          @interactive_resource_actions ||= current_definition
+            .defined_actions
+            .select { |k, v| v.is_a?(Plutonium::Action::Interactive) }
         end
 
-        def validate_interactive_resource_action!
+        def validate_interactive_action!
           interactive_resource_action = params[:interactive_action]&.to_sym
           unless interactive_resource_actions.key?(interactive_resource_action)
             raise ::AbstractController::ActionNotFound, "Unknown action '#{interactive_resource_action}'"
           end
         end
 
-        def authorize_interactive_resource_record_action!
+        def authorize_interactive_record_action!
           interactive_resource_action = params[:interactive_action]&.to_sym
           authorize_current! resource_record, to: :"#{interactive_resource_action}?"
         end
@@ -199,13 +210,43 @@ module Plutonium
           authorize_current! resource_class, to: :"#{interactive_resource_action}?"
         end
 
-        def interactive_resource_collection
-          @interactive_resource_collection ||= current_authorized_scope.from_path_param(params.require(:ids))
+        def interactive_bulk
+          @interactive_bulk ||= current_authorized_scope.from_path_param(params.require(:ids))
+        end
+
+        def build_interactive_record_action_interaction
+          @interaction = current_interactive_action.interaction.new
+          @interaction.attributes = interaction_params.merge(resource: resource_record)
+          @interaction
+        end
+
+        def build_interactive_resource_action_interaction
+          @interaction = current_interactive_action.interaction.new
+          @interaction.attributes = interaction_params
+          @interaction
+        end
+
+        # Returns the submitted resource parameters
+        # @return [Hash] The submitted resource parameters
+        def submitted_interaction_params
+          @submitted_interaction_params ||= current_interactive_action
+            .interaction
+            .build_form(nil)
+            .extract_input(params)[:interaction]
+        end
+
+        def redirect_url_after_action_on(resource_record_or_resource_class)
+          if (return_to = url_from(params[:return_to]))
+            return return_to
+          end
+
+          resource_url_for(resource_record_or_resource_class)
         end
 
+        # Returns the resource parameters, including scoped and parent parameters
+        # @return [Hash] The resource parameters
         def interaction_params
-          # active interaction handles filtering so no need for strong params
-          (params[:interaction] || {}).except(:resource, :resources)
+          @interaction_params ||= submitted_interaction_params.except(:resource, :resources)
         end
       end
     end

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

@@ -24,11 +24,11 @@ module Plutonium
             end
 
             current_definition.defined_scopes.each do |key, value|
-              query_object.define_scope key, value[:block]
+              query_object.define_scope key, value[:block], **value[:options]
             end
 
             current_definition.defined_sorts.each do |key, value|
-              query_object.define_sorter key, value[:block]
+              query_object.define_sorter key, value[:block], **value[:options]
             end
 
             query_object

data/lib/plutonium/resource/interaction.rb

@@ -1,8 +1,6 @@
-require "active_interaction"
-
 module Plutonium
   module Resource
-    class Interaction < ActiveInteraction::Base
+    class Interaction < Plutonium::Interaction::Base
     end
   end
 end

data/lib/plutonium/resource/query_object.rb

@@ -138,9 +138,9 @@ module Plutonium
       #
       # @param name [Symbol] The name of the sort.
       # @param body [Proc, nil] The body of the sort.
-      def define_sorter(name, body = nil)
+      def define_sorter(name, body = nil, using: nil)
         if body.nil?
-          sort_field = determine_sort_field(name)
+          sort_field = using || determine_sort_field(name)
           body = ->(scope, direction:) { scope.order(sort_field => direction) }
         end
 

data/lib/plutonium/routing/mapper_extensions.rb

@@ -90,9 +90,9 @@ module Plutonium
       # @return [void]
       def define_member_interactive_actions
         member do
-          get "record_actions/:interactive_action", action: :begin_interactive_resource_record_action,
-            as: :interactive_resource_record_action
-          post "record_actions/:interactive_action", action: :commit_interactive_resource_record_action
+          get "record_actions/:interactive_action", action: :interactive_record_action,
+            as: :record_action
+          post "record_actions/:interactive_action", action: :commit_interactive_record_action
         end
       end
 
@@ -101,13 +101,13 @@ module Plutonium
       # @return [void]
       def define_collection_interactive_actions
         collection do
-          get "collection_actions/:interactive_action", action: :begin_interactive_resource_collection_action,
-            as: :interactive_resource_collection_action
-          post "collection_actions/:interactive_action", action: :commit_interactive_resource_collection_action
+          get "bulk_actions/:interactive_action", action: :interactive_bulk_action,
+            as: :bulk_action
+          post "bulk_actions/:interactive_action", action: :commit_interactive_bulk_action
 
-          get "recordless_actions/:interactive_action", action: :begin_interactive_resource_recordless_action,
-            as: :interactive_resource_recordless_action
-          post "recordless_actions/:interactive_action", action: :commit_interactive_resource_recordless_action
+          get "resource_actions/:interactive_action", action: :interactive_resource_action,
+            as: :resource_action
+          post "resource_actions/:interactive_action", action: :commit_interactive_resource_action
         end
       end
 

data/lib/plutonium/ui/action_button.rb

@@ -40,6 +40,7 @@ module Plutonium
           class: "inline-block",
           form: {
             data: {
+              turbo: @action.turbo,
               turbo_confirm: @action.confirmation,
               turbo_frame: @action.turbo_frame
             }
@@ -55,7 +56,7 @@ module Plutonium
         if @action.icon
           render @action.icon.new(class: icon_classes)
         end
-        span { @action.label } unless @variant == :table
+        span { @action.label }
       end
 
       def button_classes
@@ -69,7 +70,7 @@ module Plutonium
 
       def base_classes
         if @variant == :table
-          "inline-flex items-center justify-center p-1 rounded-lg focus:outline-none focus:ring-2"
+          "inline-flex items-center justify-center py-1 px-2 rounded-lg focus:outline-none focus:ring-2"
         else
           "flex items-center justify-center px-4 py-2 text-sm font-medium rounded-lg focus:outline-none focus:ring-4"
         end
@@ -77,7 +78,7 @@ module Plutonium
 
       def icon_classes
         if @variant == :table
-          "h-4 w-4"
+          "h-4 w-4 mr-1"
         else
           "h-3.5 w-3.5 mr-2 -ml-1"
         end

data/lib/plutonium/ui/component/methods.rb

@@ -44,6 +44,7 @@ module Plutonium
           :resource_query_params,
           :current_policy,
           :current_turbo_frame,
+          :current_interactive_action,
           :policy_for,
           :allowed_to?,
           :registered_resources,

data/lib/plutonium/ui/display/theme.rb

@@ -7,17 +7,18 @@ module Plutonium
         def self.theme
           super.merge({
             base: "relative bg-white dark:bg-gray-800 shadow-md sm:rounded-lg my-3",
+            value_wrapper: "max-h-[300px] overflow-y-auto",
             fields_wrapper: "p-6 grid grid-cols-1 md:grid-cols-2 2xl:grid-cols-4 gap-6 gap-y-10 grid-flow-row-dense",
             label: "text-base font-bold text-gray-500 dark:text-gray-400 mb-1",
             description: "text-sm text-gray-400 dark:text-gray-500",
             placeholder: "text-md text-gray-500 dark:text-gray-300 mb-1 italic",
-            string: "max-h-[300px] overflow-y-auto text-md text-gray-900 dark:text-white mb-1 whitespace-pre-line",
-            text: "max-h-[300px] overflow-y-auto text-md text-gray-900 dark:text-white mb-1 whitespace-pre-line",
+            string: "text-md text-gray-900 dark:text-white mb-1 whitespace-pre-line",
+            text: "text-md text-gray-900 dark:text-white mb-1 whitespace-pre-line",
             link: "text-primary-600 dark:text-primary-500 whitespace-pre-line",
             color: "flex items-center text-md text-gray-900 dark:text-white mb-1 whitespace-pre-line",
             color_indicator: "w-10 h-10 rounded-full mr-2", # max-h-fit
             email: "flex items-center text-md text-primary-600 dark:text-primary-500 mb-1 whitespace-pre-line",
-            json: "max-h-[300px] overflow-y-auto text-sm text-gray-900 dark:text-white mb-1 whitespace-pre font-mono shadow-inner p-4",
+            json: "text-sm text-gray-900 dark:text-white mb-1 whitespace-pre font-mono shadow-inner p-4",
             prefixed_icon: "w-8 h-8 mr-2"
           })
         end

data/lib/plutonium/ui/form/interaction.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Form
+      class Interaction < Resource
+        def initialize(interaction, *, **options, &)
+          options[:key] = :interaction
+          options[:resource_fields] = interaction.attribute_names.map(&:to_sym) - %i[resource resources]
+          options[:resource_definition] = interaction
+
+          super
+        end
+
+        private
+
+        def form_action
+          # interactive action forms post to the same page
+          nil
+        end
+
+        def initialize_attributes
+          super
+          attributes.fetch(:data_turbo) { attributes[:data_turbo] = object.turbo.to_s }
+        end
+
+        def submit_button(*, **)
+          super(*, **) do
+            object.label
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/ui/form/resource.rb

@@ -65,7 +65,7 @@ module Plutonium
         end
 
         def when_permitted(name, &)
-          return unless @resource_fields.include? name
+          return unless resource_fields.include? name
 
           yield
         end

data/lib/plutonium/ui/page/interactive_action.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Page
+      class InteractiveAction < Base
+        private
+
+        def page_title
+          current_interactive_action.label || super
+        end
+
+        def page_description
+          current_interactive_action.description || super
+        end
+
+        def render_default_content
+          render "interactive_action_form"
+        end
+      end
+    end
+  end
+end