plutonium 0.15.0 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a79da147b298beabc3cfbdeaca6b9fc9d933b28eeca7dc305ded679f8ad21319
-  data.tar.gz: 99b1d2b9c16aa6e097c2f50dfa5eee01768999c046d6a463b061608498c55523
+  metadata.gz: f7af9842b0dca317dc9cb8ca805d2a73373660f99e897f36862e93d6c3fa637b
+  data.tar.gz: 3daa392b9b27adc9e4d82fa760a38cf6a953c4be1394ad7cbaf2cad88012c1af
 SHA512:
-  metadata.gz: ebe1f5da07fbe90389c8dad3006084952649a82cfca662a177b51b612d84479ef52a8ad91b9c0df60a450b597933e560e12d0ddef85a63ce1ba6e7be3320e431
-  data.tar.gz: d372628ad0e5a0d79e90ec04d5bac2fccbb3ce43426494f49c0e1f64f1d002cdae414f7238718f654c11eb73b80debe298f147ae748877216b03f595513f5c25
+  metadata.gz: 020a6db84fe590b28095f4d2f2a60cc61b58a7d1cd4304bf944d464182439d0a4f3d4967c63846282ae8abbc05b5f016d1abae22516518c4ad73745308a359d8
+  data.tar.gz: 5987f4b5ee94790630c3bc1051b804223837e0fe28713fa5944c66fe719d7c727361d7d411a133c5435d7198db667e586a873314bf189891045c4e33c1aaa458

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

@@ -0,0 +1 @@
+<%= render @interaction.build_form %>

data/app/views/resource/{interactive_resource_collection_action.html.erb → interactive_bulk_action.html.erb}

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

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

@@ -0,0 +1 @@
+<%= render current_definition.interactive_action_page_class.new %>

data/app/views/resource/{interactive_resource_record_action.html.erb → interactive_resource_action.html.erb}

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

data/lib/plutonium/action/base.rb

@@ -16,13 +16,14 @@ module Plutonium
     # @attr_reader [Symbol, nil] category The category of the action.
     # @attr_reader [Integer] position The position of the action within its category.
     class Base
-      attr_reader :name, :label, :icon, :route_options, :confirmation, :turbo_frame, :color, :category, :position
+      attr_reader :name, :label, :description, :icon, :route_options, :confirmation, :turbo, :turbo_frame, :color, :category, :position
 
       # Initialize a new action.
       #
       # @param [Symbol] name The name of the action.
       # @param [Hash] options The options for the action.
       # @option options [String] :label The human-readable label for the action.
+      # @option options [String] :description The human-readable description for the action.
       # @option options [String] :icon The icon associated with the action (e.g., 'fa-edit' for Font Awesome).
       # @option options [Symbol] :color The color associated with the action (e.g., :primary, :secondary, :success, :warning, :danger).
       # @option options [String] :confirmation The confirmation message to display before executing the action.
@@ -40,11 +41,13 @@ module Plutonium
       # @option options [Integer] :position (50) The position of the action in its group. Lower numbers appear first.
       def initialize(name, **options)
         @name = name.to_sym
-        @label = options[:label] || name.to_s.humanize
-        @icon = options[:icon]
+        @label = options[:label] || @name.to_s.titleize
+        @description = options[:description]
+        @icon = options[:icon] || Phlex::TablerIcons::ChevronRight
         @color = options[:color]
         @confirmation = options[:confirmation]
         @route_options = build_route_options(options[:route_options])
+        @turbo = options[:turbo]
         @turbo_frame = options[:turbo_frame]
         @bulk_action = options[:bulk_action] || false
         @collection_record_action = options[:collection_record_action] || false

data/lib/plutonium/action/interactive.rb

@@ -15,11 +15,15 @@ module Plutonium
       # @param [Class] interaction The interaction class for this action
       # @param [Boolean] immediate Whether the action is executed immediately
       # @param [Hash] options Additional options for the action
-      def initialize(name, interaction:, immediate:, **)
+      def initialize(name, interaction:, immediate:, **options)
         @interaction = interaction
         @immediate = immediate
 
-        super(name, **)
+        options[:label] ||= interaction.label
+        options[:description] ||= interaction.description
+        options[:icon] ||= interaction.icon
+
+        super(name, **options)
       end
 
       # Get the confirmation message for the action
@@ -31,6 +35,8 @@ module Plutonium
 
       # Factory for creating Interactive actions
       class Factory
+        # TODO: move these into Plutonium::Action::Interactive
+
         # Create a new Interactive action based on the interaction type
         #
         # @param [Symbol] name The name of the action
@@ -50,6 +56,7 @@ module Plutonium
             interaction: interaction,
             immediate: immediate,
             route_options: route_options,
+            turbo: interaction.turbo,
             **action_options,
             **options
           )
@@ -69,11 +76,11 @@ module Plutonium
         # @return [Symbol] The determined action type
         def self.determine_action_type(attribute_names)
           if attribute_names.include?(:resource)
-            :interactive_resource_record_action
+            :interactive_record_action
           elsif attribute_names.include?(:resources)
-            :interactive_resource_collection_action
+            :interactive_collection_action
           else
-            :interactive_resource_recordless_action
+            :interactive_resource_action
           end
         end
 
@@ -91,10 +98,10 @@ module Plutonium
         # @return [Hash] The action options
         def self.determine_action_options(action_type)
           {
-            bulk_action: action_type == :interactive_resource_collection_action,
-            record_action: action_type == :interactive_resource_record_action,
-            collection_record_action: action_type == :interactive_resource_record_action,
-            resource_action: action_type == :interactive_resource_recordless_action
+            bulk_action: action_type == :interactive_collection_action,
+            record_action: action_type == :interactive_record_action,
+            collection_record_action: action_type == :interactive_record_action,
+            resource_action: action_type == :interactive_resource_action
           }
         end
 

data/lib/plutonium/definition/base.rb

@@ -27,6 +27,7 @@ module Plutonium
       include DefineableProps
       include ConfigAttr
       include Actions
+      include Sorting
       include Search
 
       class IndexPage < Plutonium::UI::Page::Index; end
@@ -37,6 +38,8 @@ module Plutonium
 
       class EditPage < Plutonium::UI::Page::Edit; end
 
+      class InteractiveActionPage < Plutonium::UI::Page::InteractiveAction; end
+
       class Form < Plutonium::UI::Form::Resource; end
 
       class Table < Plutonium::UI::Table::Resource; end
@@ -47,7 +50,7 @@ module Plutonium
       defineable_props :field, :input, :display, :column
 
       # queries
-      defineable_props :filter, :scope, :sort
+      defineable_props :filter, :scope
 
       # pages
       config_attr \
@@ -76,6 +79,10 @@ module Plutonium
         self.class::EditPage
       end
 
+      def interactive_action_page_class
+        self.class::InteractiveActionPage
+      end
+
       def form_class
         self.class::Form
       end

data/lib/plutonium/definition/sorting.rb

@@ -0,0 +1,15 @@
+module Plutonium
+  module Definition
+    module Sorting
+      extend ActiveSupport::Concern
+
+      included do
+        defineable_props :sort
+
+        def self.sorts(*names)
+          names.each { |name| sort name }
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/interaction/README.md

@@ -255,7 +255,7 @@ class MyInteraction < Plutonium::Interaction::Base
   include Plutonium::Interaction::Concerns::Presentable
 
   presents label: "My Interaction",
-           icon: "star",
+           icon: Phlex::TablerIcons::Activate,
            description: "Does something awesome"
 
   # ... rest of the interaction
@@ -366,4 +366,37 @@ module Orders
   end
 end
 ```
+
+
+  class Sample < Phlex::HTML
+    def view_template
+      p { "my custom template" }
+    end
+  end
+
+  class Rename < ResourceInteraction
+    attribute :resource
+
+    attribute :name
+    validates :name, presence: true
+
+    # input :name, as: :file
+    turbo false
+
+    presents label: "Rename resource",
+      icon: Phlex::TablerIcons::Pencil,
+      description: "Some cool stuff"
+
+    private
+
+    def execute
+      resource.name = name
+      if resource.save
+        succeed.with_message("Action completed").with_render_response(Sample.new)
+      else
+        failed resource.errors
+      end
+    end
+  end
+  # action :rename, interaction: Rename
 -->

data/lib/plutonium/interaction/base.rb

@@ -22,9 +22,16 @@ module Plutonium
     class Base
       include ActiveModel::Model
       include ActiveModel::Attributes
-      # include Concerns::Presentable
+      include Concerns::Presentable
+      include Plutonium::Definition::DefineableProps
+      include Plutonium::Definition::ConfigAttr
       # include Concerns::WorkflowDSL
 
+      class Form < Plutonium::UI::Form::Interaction; end
+
+      config_attr :turbo
+      defineable_props :field, :input
+
       # Executes the interaction with the given arguments.
       #
       # @param args [Hash] The arguments to initialize the interaction.
@@ -33,17 +40,30 @@ module Plutonium
         new(**args).call
       end
 
+      def self.build_form(instance)
+        self::Form.new(instance || new)
+      end
+
       # Executes the interaction.
       #
       # @return [Plutonium::Interaction::Outcome] The result of the interaction.
       def call
         if valid?
-          execute
+          outcome = execute
+          unless outcome.is_a?(Plutonium::Interaction::Outcome)
+            raise "#{self.class}#execute must return an instance of Plutonium::Interaction::Outcome.\n" \
+                  "#{outcome.inspect} received instead"
+          end
+          outcome
         else
-          failure(errors)
+          failure.with_message("An error occurred")
         end
       end
 
+      def build_form
+        self.class.build_form(self)
+      end
+
       private
 
       # Implement the main logic of the interaction.
@@ -59,16 +79,27 @@ module Plutonium
       #
       # @param value [Object] The value to be wrapped in the successful outcome.
       # @return [Plutonium::Interaction::Success] A successful outcome.
-      def success(value)
-        Success.new(value)
+      def succeed(value = nil)
+        Plutonium::Interaction::Outcome::Success.new(value)
+      end
+      alias_method :success, :succeed
+
+      def failed(errors = nil, attribute = :base)
+        case errors
+        when Hash
+          errors.each { |attribute, error| self.errors.add(attribute, error) }
+        else
+          Array(errors).each { |error| self.errors.add(attribute, error) }
+        end
+        failure
       end
 
       # Creates a failure outcome.
       #
       # @param errors [ActiveModel::Errors, Array<String>] The errors to be wrapped in the failure outcome.
       # @return [Plutonium::Interaction::Failure] A failure outcome.
-      def failure(errors)
-        Failure.new(errors)
+      def failure
+        Plutonium::Interaction::Outcome::Failure.new
       end
     end
   end

data/lib/plutonium/interaction/concerns/presentable.rb

@@ -33,27 +33,39 @@ module Plutonium
           def presents(**options)
             self.presentation_metadata = options
           end
+
+          # Returns the label for the interaction.
+          #
+          # @return [String] The label defined in the presentation metadata or a default generated from the class name.
+          def label
+            presentation_metadata[:label] || name.demodulize.titleize
+          end
+
+          # Returns the icon for the interaction.
+          #
+          # @return [String, nil] The icon defined in the presentation metadata.
+          def icon
+            presentation_metadata[:icon]
+          end
+
+          # Returns the description for the interaction.
+          #
+          # @return [String, nil] The description defined in the presentation metadata.
+          def description
+            presentation_metadata[:description]
+          end
         end
 
-        # Returns the label for the interaction.
-        #
-        # @return [String] The label defined in the presentation metadata or a default generated from the class name.
         def label
-          self.class.presentation_metadata[:label] || self.class.name.demodulize.titleize
+          self.class.label
         end
 
-        # Returns the icon for the interaction.
-        #
-        # @return [String, nil] The icon defined in the presentation metadata.
         def icon
-          self.class.presentation_metadata[:icon]
+          self.class.icon
         end
 
-        # Returns the description for the interaction.
-        #
-        # @return [String, nil] The description defined in the presentation metadata.
         def description
-          self.class.presentation_metadata[:description]
+          self.class.description
         end
       end
     end

data/lib/plutonium/interaction/outcome.rb

@@ -7,8 +7,7 @@ module Plutonium
     #
     # @abstract Subclass and override {#and_then}, {#map}, and {#to_response} to implement
     class Outcome
-      # @return [Array<Array(String, Symbol)>] Messages associated with the outcome.
-      attr_reader :messages
+      def messages = @messages || []
 
       # Checks if the outcome is successful.
       #
@@ -27,7 +26,7 @@ module Plutonium
       # Adds a message to the outcome.
       #
       # @param msg [String] The message to add.
-      # @param type [Symbol] The type of the message (e.g., :notice, :error).
+      # @param type [Symbol] The type of the message (e.g., :notice, :alert).
       # @return [self]
       def with_message(msg, type = :notice)
         @messages ||= []
@@ -60,69 +59,92 @@ module Plutonium
       def to_response
         raise NotImplementedError, "#{self.class} must implement #to_response"
       end
-    end
 
-    # Represents a successful outcome of an interaction.
-    class Success < Outcome
-      # @return [Object] The value wrapped by this successful outcome.
-      attr_reader :value
+      # Represents a successful outcome of an interaction.
+      class Success < Outcome
+        # @return [Object] The value wrapped by this successful outcome.
+        attr_reader :value
 
-      # @param value [Object] The value to be wrapped in this successful outcome.
-      def initialize(value)
-        @value = value
-      end
+        # @param value [Object] The value to be wrapped in this successful outcome.
+        def initialize(value)
+          @value = value
+        end
 
-      # Chains another operation to be executed with the value of this outcome.
-      #
-      # @yield [Object] The value wrapped by this outcome.
-      # @return [Outcome] The result of the yielded block.
-      def and_then
-        yield value
-      end
+        # Chains another operation to be executed with the value of this outcome.
+        #
+        # @yield [Object] The value wrapped by this outcome.
+        # @return [Outcome] The result of the yielded block.
+        def and_then
+          yield value
+        end
 
-      # Sets the response for this successful outcome.
-      #
-      # @param response [Plutonium::Interaction::Response::Base] The response to set.
-      # @return [self]
-      def with_response(response)
-        @to_response = nil
-        @response = response
-        self
-      end
+        # Sets the response for this successful outcome.
+        #
+        # @param response [Plutonium::Interaction::Response::Base] The response to set.
+        # @return [self]
+        def with_response(response)
+          @to_response = nil
+          @response = response
+          self
+        end
 
-      # Converts this successful outcome to a response object.
-      #
-      # @return [Plutonium::Interaction::Response::Base] The response object.
-      def to_response
-        @to_response ||= begin
-          @response ||= Response::Null.new(value)
-          @response.with_flash(messages)
+        def with_redirect_response(*, **)
+          with_response(Response::Redirect.new(*, **))
         end
-      end
-    end
 
-    # Represents a failed outcome of an interaction.
-    class Failure < Outcome
-      # @return [ActiveModel::Errors, Array<String>] The errors associated with this failure.
-      attr_reader :errors
+        def with_render_response(*, **)
+          with_response(Response::Render.new(*, **))
+        end
 
-      # @param errors [ActiveModel::Errors, Array<String>] The errors to be wrapped in this failure.
-      def initialize(errors)
-        @errors = errors
-      end
+        def with_file_response(*, **)
+          with_response(Response::File.new(*, **))
+        end
 
-      # Returns self without executing the given block, propagating the failure.
-      #
-      # @return [self]
-      def and_then
-        self
+        # Converts this successful outcome to a response object.
+        #
+        # @return [Plutonium::Interaction::Response::Base] The response object.
+        def to_response
+          @to_response ||= begin
+            @response ||= Response::Null.new(value)
+            @response.with_flash(messages)
+          end
+        end
       end
 
-      # Returns self without setting a response.
-      #
-      # @return [self]
-      def with_response(response)
-        self
+      # Represents a failed outcome of an interaction.
+      class Failure < Outcome
+        # Adds a message to the outcome.
+        #
+        # @param msg [String] The message to add.
+        # @param type [Symbol] The type of the message (e.g., :notice, :alert).
+        # @return [self]
+        def with_message(msg, type = :alert)
+          super
+        end
+
+        # Returns self without executing the given block, propagating the failure.
+        #
+        # @return [self]
+        def and_then
+          self
+        end
+
+        # Returns self without setting a response.
+        #
+        # @return [self]
+        def with_response(response)
+          self
+        end
+
+        # Converts this failure outcome to a response object.
+        #
+        # @return [Plutonium::Interaction::Response::Null] The response object.
+        def to_response
+          @to_response ||= begin
+            @response ||= Response::Failure.new
+            @response.with_flash(messages)
+          end
+        end
       end
     end
   end

data/lib/plutonium/interaction/response/base.rb

@@ -13,7 +13,9 @@ module Plutonium
         attr_reader :flash
 
         # Initializes a new Response::Base instance.
-        def initialize
+        def initialize(*args, **options)
+          @args = args
+          @options = options
           @flash = []
         end
 

data/lib/plutonium/interaction/response/failure.rb

@@ -0,0 +1,18 @@
+module Plutonium
+  module Interaction
+    module Response
+      # Represents a failed response, which doesn't perform any specific action.
+      class Failure < Base
+        private
+
+        # Executes the failure response by yielding.
+        #
+        # @param controller [ActionController::Base] The controller instance (unused).
+        # @return [void]
+        def execute(controller, &)
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/interaction/response/file.rb

@@ -0,0 +1,20 @@
+module Plutonium
+  module Interaction
+    module Response
+      # Represents a render response.
+      #
+      # This class is used to render views as a result of an interaction.
+      class File < Base
+        private
+
+        # Executes the render response.
+        #
+        # @param controller [ActionController::Base] The controller instance.
+        # @return [void]
+        def execute(controller)
+          controller.send_file(*@args, @options)
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/interaction/response/redirect.rb

@@ -5,16 +5,6 @@ module Plutonium
       #
       # This class is used to perform redirects as a result of an interaction.
       class Redirect < Base
-        # Initializes a new Redirect response.
-        #
-        # @param path [String, Symbol] The path or named route to redirect to.
-        # @param options [Hash] Additional options to pass to the redirect_to method.
-        def initialize(path, options = {})
-          super()
-          @path = path
-          @options = options
-        end
-
         private
 
         # Executes the redirect response.
@@ -22,7 +12,7 @@ module Plutonium
         # @param controller [ActionController::Base] The controller instance.
         # @return [void]
         def execute(controller)
-          controller.redirect_to @path, @options
+          controller.redirect_to(*@args, **@options)
         end
       end
     end

data/lib/plutonium/interaction/response/render.rb

@@ -5,14 +5,6 @@ module Plutonium
       #
       # This class is used to render views as a result of an interaction.
       class Render < Base
-        # Initializes a new Render response.
-        #
-        # @param options [Hash] Options to pass to the render method.
-        def initialize(options = {})
-          super()
-          @options = options
-        end
-
         private
 
         # Executes the render response.
@@ -20,7 +12,7 @@ module Plutonium
         # @param controller [ActionController::Base] The controller instance.
         # @return [void]
         def execute(controller)
-          controller.render @options
+          controller.render(*@args, @options)
         end
       end
     end