plutonium 0.12.9 → 0.12.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e23b355a86a4aa61a848f5a7778ce604a128f40b00283f50e12c8c39f5c4bc1e
-  data.tar.gz: 174b95054e17d4fd8d928f062380664ca2bf82ebe1d15685137a22e720f92281
+  metadata.gz: 053e7c4ed94242099eed9ecf819521ccb175ab5e8649a6b771ffe86b743cff64
+  data.tar.gz: 83a54d5ded5d6ed7fcf68179cc0ecd99d92975f1965edefb029731b749c1963c
 SHA512:
-  metadata.gz: e525fac1c4621b3923ebccb40ea61ff9771d2dfd6bd541f505965f4728ad7befee7051d01f161b3099f2ac6b91ec23d7120324144f787849e9b876d1386d950f
-  data.tar.gz: d4eacfd569c110fb060f1efb2c8cfb60a1fb8e146fdb95be9e4508a5023424ea63330f831d02eb9b2dd36267c079738358cce9a963055b895705e5e2813aa712
+  metadata.gz: bdeb350835e78ff12d69789507bb3be8ac9b36dfb174e56d0e85ec85b97a47a41d32080ba626fb19cfaa46b3bc31913f209c58a3a4484dc40c8588398c83ada9
+  data.tar.gz: cd0601de7a8d83add613e97695abad65639bdf988c609c3e587ca41d152aa21dfdb7384e602110dc87ac75d6007d583c52879c8311d4ae83f83022275a202a99

data/app/views/components/form/form_component.html.erb

@@ -8,20 +8,18 @@
       </svg>
       <div>
         <span class="font-medium"><%= f.error_notification %></span>
-        <!--
           <ul class="mt-1.5 list-disc list-inside">
             <% f.object.errors.full_messages.each do |message|  %>
               <li><%= f.error_notification message: message  %></li>
             <% end  %>
         </ul>
-        -->
       </div>
     </div>
   <% end %>
 
   <div>
   <% form.inputs.values.each do |input| %>
-    <%= input.render self, f, form.record %>
+    <%= render input.with(form: f, record: form.record) %>
   <% end %>
   </div>
 

data/app/views/components/interactive_action_form/interactive_action_form_component.html.erb

@@ -8,20 +8,18 @@
       </svg>
       <div>
         <span class="font-medium"><%= f.error_notification %></span>
-        <!--
-          <ul class="mt-1.5 list-disc list-inside">
-            <% f.object.errors.full_messages.each do |message|  %>
-              <li><%= f.error_notification message: message  %></li>
-            <% end  %>
+        <ul class="mt-1.5 list-disc list-inside">
+          <% f.object.errors.full_messages.each do |message|  %>
+            <li><%= f.error_notification message: message  %></li>
+          <% end  %>
         </ul>
-        -->
       </div>
     </div>
   <% end %>
 
   <div>
   <% interactive_action.inputs.values.each do |input| %>
-    <%= input.render self, f, interaction %>
+    <%= render input.with(form: f, record: interaction) %>
   <% end %>
   </div>
 

data/app/views/components/nested_resource_form_fields/nested_resource_form_fields_component.html.erb

@@ -11,7 +11,7 @@
     <%= form.simple_fields_for name, new_record, child_index: 'NEW_RECORD' do |nested| %>
       <fieldset class="border-t mt-4 pt-4 first:border-t-0 first:pt-0 nested-resource-form-fields" data-new-record="<%= nested.object.new_record? %>">
         <% inputs.values.each do |input| %>
-          <%= input.render self, nested, new_record %>
+          <%= render input.with(form: nested, record: new_record) %>
         <% end %>
 
         <div class="text-right">
@@ -34,7 +34,7 @@
     <%= form.simple_fields_for name do |nested| %>
       <fieldset class="border-t mt-4 pt-4 first:border-t-0 first:pt-0 nested-resource-form-fields" data-new-record="<%= nested.object.new_record? %>">
         <% inputs.values.each do |input| %>
-          <%= input.render self, nested, new_record %>
+          <%= render input.with(form: nested, record: new_record) %>
         <% end %>
 
         <div>

data/app/views/components/table_search_input/table_search_input_component.html.erb

@@ -7,7 +7,11 @@
                 <path fill-rule="evenodd" d="M8 4a4 4 0 100 8 4 4 0 000-8zM2 8a6 6 0 1110.89 3.476l4.817 4.817a1 1 0 01-1.414 1.414l-4.816-4.816A6 6 0 012 8z" clip-rule="evenodd" />
             </svg>
         </div>
-        <%= search_object.search_filter.input_definitions[:search].render self, f, nil,
+
+        <%=
+          render search_object.search_filter.input_definitions[:search].with(
+            form: f,
+            record:nil,
             wrapper: false, label: false,
             as: :string, # force string for search
             placeholder: "search...",
@@ -21,7 +25,9 @@
                 # form_target: "focus",
                 turbo_permanent: true
               }
-        } %>
+            }
+          )
+        %>
     </div>
 
 

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

@@ -25,7 +25,7 @@
               </div>
               <div class="form-inputs">
                 <% interactive_action.inputs.values.each do |input| %>
-                  <%= input.render self, f, @interaction %>
+                  <%= render input.with(form: f, record: @interaction) %>
                 <% end %>
               </div>
             </div>

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

@@ -9,12 +9,19 @@
   <div class="p-4">
     <dl class="divide-y divide-gray-100">
       <% details.fields.each do |name, renderer| %>
+        <%#
+          TODO:
+          For now, we are hacking around the need to call #with before #label
+          This proves there's an issue with the rendering api.
+          While I think of an elegant solution, this works for now.
+        %>
+        <% renderer.with(record: details.record) %>
         <div class="py-6 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-0">
           <dt class="text-sm font-medium leading-6 text-gray-900 dark:text-gray-300">
             <%= renderer.label %>
           </dt>
           <dd class="mt-1 text-sm leading-6 text-gray-700 dark:text-gray-200 sm:col-span-2 sm:mt-0">
-            <%= renderer.render self, details.record %>
+            <%= render renderer %>
           </dd>
         </div>
       <% end %>
@@ -24,6 +31,6 @@
 
 <% if present_associations? %>
   <% details.associations.each do |name, renderer| %>
-    <%= renderer.render self, details.record %>
+    <%= render renderer.with(record: details.record) %>
   <% end %>
 <% end %>

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

@@ -71,8 +71,16 @@
       <% end %>
 
       <% fields.each do |name, field| %>
+        <%#
+          TODO:
+          For now, we are hacking around the need to call #with before #label
+          This proves there's an issue with the rendering api.
+          While I think of an elegant solution, this works for now.
+        %>
+        <% field.with(record: resources[0]) %>
         <% table.column(name:, label: field.label, search_object: search_object) do |resource| %>
-          <%= field.render self, resource %>
+          <% field.with(record: resource) %>
+          <%= render field %>
         <% end %>
       <% end %>
     <% end %>

data/lib/generators/pu/core/assets/templates/tailwind.config.js

@@ -13,6 +13,8 @@ module.exports = {
     `${__dirname}/app/helpers/**/*.rb`,
     `${__dirname}/app/assets/stylesheets/**/*.css`,
     `${__dirname}/app/javascript/**/*.js`,
+    `${__dirname}/app/plutonium/**/*.rb`,
+    `${__dirname}/packages/**/app/plutonium/**/*.rb`,
     `${__dirname}/packages/**/app/views/**/*.html.erb`,
   ].concat(plutoniumTailwindConfig.content),
 }

data/lib/generators/pu/core/install/install_generator.rb

@@ -29,7 +29,7 @@ module Pu
       end
 
       def setup_app
-        # directory "config"
+        directory "config"
         directory "app"
 
         environment "# config.plutonium.assets.favicon = \"favicon.ico\""

data/lib/generators/pu/core/install/templates/config/initializers/plutonium.rb

@@ -1 +1,5 @@
 # Configure plutonium
+
+Rails.application.config.to_prepare do
+  # Register components here
+end

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

@@ -15,11 +15,11 @@ module Pu
       class_option :rodauth, type: :boolean
 
       def start
-        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views/#{destination_app}"
+        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views/"
         [
           "layouts/resource.html.erb"
         ].each do |file|
-          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir)
+          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir, file)
         end
       rescue => e
         exception "#{self.class} failed:", e
@@ -33,6 +33,7 @@ module Pu
 
       def copy_file(source_path, destination_path)
         if File.exist?(source_path)
+          FileUtils.mkdir_p(File.dirname(destination_path))
           FileUtils.cp(source_path, destination_path)
           say_status("info", "Copied #{source_path} to #{destination_path}", :green)
         else

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

@@ -14,12 +14,12 @@ module Pu
       class_option :dest, type: :string
 
       def start
-        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views/#{destination_app}"
+        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views"
         [
           "application/_resource_header.html.erb",
           "application/_resource_sidebar.html.erb"
         ].each do |file|
-          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir)
+          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir, file)
         end
       rescue => e
         exception "#{self.class} failed:", e
@@ -33,6 +33,7 @@ module Pu
 
       def copy_file(source_path, destination_path)
         if File.exist?(source_path)
+          FileUtils.mkdir_p(File.dirname(destination_path))
           FileUtils.cp(source_path, destination_path)
           say_status("info", "Copied #{source_path} to #{destination_path}", :green)
         else

data/lib/generators/pu/field/input/input_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Field
+    class InputGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates a field input"
+
+      argument :name
+
+      def start
+        in_root do
+          template "input.rb", "app/plutonium/fields/inputs/#{name.underscore}_input.rb"
+          insert_into_file "config/initializers/plutonium.rb", registration_statement, after: /.*# Register components here.*\n/
+        end
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def registration_statement
+        indent "Plutonium::Core::Fields::Inputs::Factory.map_type :#{name.underscore}, to: Fields::Inputs::#{name.camelize}Input\n", 2
+      end
+    end
+  end
+end

data/lib/generators/pu/field/input/templates/input.rb.tt

@@ -0,0 +1,15 @@
+module Fields
+  module Inputs
+    class <%= name.camelize %>Input < Plutonium::Core::Fields::Inputs::Base
+      def render
+        form.input name, **options
+      end
+
+      private
+
+      def input_options
+        {}
+      end
+    end
+  end
+end

data/lib/generators/pu/field/renderer/renderer_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Field
+    class RendererGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates a field renderer"
+
+      argument :name
+
+      def start
+        in_root do
+          template "renderer.rb", "app/plutonium/fields/renderers/#{name.underscore}_renderer.rb"
+          insert_into_file "config/initializers/plutonium.rb", registration_statement, after: /.*# Register components here.*\n/
+        end
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def registration_statement
+        indent "Plutonium::Core::Fields::Renderers::Factory.map_type :#{name.underscore}, to: Fields::Renderers::#{name.camelize}Renderer\n", 2
+      end
+    end
+  end
+end

data/lib/generators/pu/field/renderer/templates/renderer.rb.tt

@@ -0,0 +1,9 @@
+module Fields
+  module Renderers
+    class <%= name.camelize %>Renderer < Plutonium::Core::Fields::Renderers::Base
+      def render
+        tag.span value
+      end
+    end
+  end
+end

data/lib/plutonium/core/actions/interactive_action.rb

@@ -2,7 +2,7 @@ module Plutonium
   module Core
     module Actions
       class InteractiveAction < Plutonium::Core::Action
-        include Plutonium::Core::Definers::InputDefiner
+        include Plutonium::Core::Definers::FieldInputDefiner
 
         Context = Data.define :resource_class
 
@@ -37,7 +37,7 @@ module Plutonium
 
         def set_interaction(interaction)
           @interaction = interaction
-          @inputs = defined_inputs_for(*(interaction.filters.keys - [:resource, :resources]))
+          @inputs = defined_field_inputs_for(*(interaction.filters.keys - [:resource, :resources]))
           @inline = @inputs.blank? unless inline == false
         end
 

data/lib/plutonium/core/associations/renderers/base.rb

@@ -0,0 +1,77 @@
+module Plutonium
+  module Core
+    module Associations
+      module Renderers
+        class Base
+          include Plutonium::Core::Renderable
+
+          attr_reader :name, :reflection
+
+          def initialize(name, reflection:, **user_options)
+            @name = name
+            @reflection = reflection
+            @user_options = user_options
+          end
+
+          # Sets the record object on the renderer and merges render options.
+          #
+          # @param record [Object] the record object.
+          # @param render_options [Hash] additional options for rendering.
+          # @return [self] the renderer instance.
+          def with(record:, **render_options)
+            @record = record
+            @render_options = render_options
+            @options = build_options(render_options)
+
+            self
+          end
+
+          private
+
+          # Returns the merged options for rendering.
+          #
+          # @raise [RuntimeError] if accessed before rendering.
+          # @return [Hash] the merged options.
+          def options
+            raise "cannot access #options before calling #with" unless defined?(@options)
+
+            @options
+          end
+
+          # Returns the record object.
+          #
+          # @raise [RuntimeError] if accessed before rendering.
+          # @return [Object] the record object.
+          def record
+            raise "cannot access #record before calling #with" unless defined?(@record)
+
+            @record
+          end
+
+          def renderer_options
+            {}
+          end
+
+          def label
+            options[:label] || record.class.human_attribute_name(name)
+          end
+
+          # Returns the value of the record's attribute corresponding to the renderer's name.
+          #
+          # @return [Object] the value of the attribute.
+          def value
+            record.public_send(name)
+          end
+
+          # Builds the options for rendering by merging renderer options, user options, and render options.
+          #
+          # @param render_options [Hash] additional options for rendering.
+          # @return [Hash] the merged options.
+          def build_options(render_options)
+            renderer_options.deep_merge(@user_options).deep_merge(render_options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/core/associations/renderers/factory.rb

@@ -17,8 +17,6 @@ module Plutonium
           end
 
           def self.for_resource_association(resource_class, attr_name, **options)
-            options[:label] ||= resource_class.human_attribute_name(attr_name)
-
             association = resource_class.try(:reflect_on_association, attr_name)
             raise ArgumentError, "#{attr_name} is not a valid association of #{resource_class}" unless association.present?
             raise ArgumentError, "#{association.klass} does is not a resource record" unless association.klass.include?(Plutonium::Resource::Record)

data/lib/plutonium/core/associations/renderers/has_many_renderer.rb

@@ -2,12 +2,14 @@ module Plutonium
   module Core
     module Associations
       module Renderers
-        class HasManyRenderer < BasicRenderer
-          def render(view_context, record)
-            view_context.render_component :has_many_panel,
+        class HasManyRenderer < Base
+          def render
+            render_component(
+              :has_many_panel,
               title: label,
-              src: view_context.resource_url_for(reflection.klass, parent: record),
+              src: resource_url_for(reflection.klass, parent: record),
               **options
+            )
           end
         end
       end

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

@@ -15,7 +15,7 @@ module Plutonium
           @search_object = current_query_object
           base_query = policy_scope(resource_class)
           base_query = @search_object.apply(base_query)
-          base_query = base_query.send(params[:scope].to_sym) if params[:scope].present?
+          base_query = base_query.public_send(params[:scope].to_sym) if params[:scope].present?
           @pagy, @resource_records = pagy base_query
           @collection = build_collection
 

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

@@ -32,7 +32,7 @@ module Plutonium
           Plutonium::Core::Ui::Collection.new(
             resource_class:,
             records: @resource_records,
-            fields: current_presenter.defined_renderers_for(*presentable_attributes),
+            fields: current_presenter.defined_field_renderers_for(*presentable_attributes),
             actions: current_presenter.actions,
             pager: @pagy,
             search_object: @search_object
@@ -43,7 +43,7 @@ module Plutonium
           Plutonium::Core::Ui::Detail.new(
             resource_class:,
             record: resource_record,
-            fields: current_presenter.defined_renderers_for(*presentable_attributes),
+            fields: current_presenter.defined_field_renderers_for(*presentable_attributes),
             associations: current_presenter.defined_association_renderers_for(*permitted_associations),
             actions: current_presenter.actions
           )
@@ -52,7 +52,7 @@ module Plutonium
         def build_form
           Plutonium::Core::Ui::Form.new(
             record: resource_record,
-            inputs: current_presenter.defined_inputs_for(*presentable_attributes)
+            inputs: current_presenter.defined_field_inputs_for(*presentable_attributes)
           )
         end
 

data/lib/plutonium/core/definers/field_definer.rb

@@ -4,14 +4,14 @@ module Plutonium
       module FieldDefiner
         extend ActiveSupport::Concern
 
-        include InputDefiner
-        include RendererDefiner
+        include FieldInputDefiner
+        include FieldRendererDefiner
 
         private
 
         def define_field(name, type: nil, input: nil, renderer: nil, input_options: {}, renderer_options: {})
-          define_input(name, type:, input:, **input_options)
-          define_renderer(name, type:, renderer:, **renderer_options)
+          define_field_input(name, type:, input:, **input_options)
+          define_field_renderer(name, type:, renderer:, **renderer_options)
         end
       end
     end

data/lib/plutonium/core/definers/{input_definer.rb → field_input_definer.rb}

@@ -1,7 +1,7 @@
 module Plutonium
   module Core
     module Definers
-      module InputDefiner
+      module FieldInputDefiner
         extend ActiveSupport::Concern
         include Plutonium::Core::Autodiscovery::InputDiscoverer
 
@@ -47,14 +47,14 @@ module Plutonium
           attr_reader :hash
         end
 
-        def defined_inputs_for(*names)
+        def defined_field_inputs_for(*names)
           (names - input_definitions.keys).each do |name|
-            define_input(name, input: autodiscover_input(name))
+            define_field_input(name, input: autodiscover_input(name))
           end
           input_definitions.slice(*names)
         end
 
-        def define_input(name, input: nil, type: nil, **options)
+        def define_field_input(name, input: nil, type: nil, **options)
           input_definitions[name] = if input.present?
             input
           elsif type.present?

data/lib/plutonium/core/definers/{renderer_definer.rb → field_renderer_definer.rb}

@@ -1,23 +1,23 @@
 module Plutonium
   module Core
     module Definers
-      module RendererDefiner
+      module FieldRendererDefiner
         extend ActiveSupport::Concern
         include Plutonium::Core::Autodiscovery::RendererDiscoverer
 
-        def defined_renderers_for(*names)
-          (names - renderer_definitions.keys).each do |name|
-            define_renderer(name, renderer: autodiscover_renderer(name))
+        def defined_field_renderers_for(*names)
+          (names - field_renderer_definitions.keys).each do |name|
+            define_field_renderer(name, renderer: autodiscover_renderer(name))
           end
-          renderer_definitions.slice(*names)
+          field_renderer_definitions.slice(*names)
         end
 
         private
 
-        def renderer_definitions = @renderer_definitions ||= {}
+        def field_renderer_definitions = @field_renderer_definitions ||= {}
 
-        def define_renderer(name, renderer: nil, type: nil, **options)
-          renderer_definitions[name] = if renderer.present?
+        def define_field_renderer(name, renderer: nil, type: nil, **options)
+          field_renderer_definitions[name] = if renderer.present?
             renderer
           elsif type.present?
             Plutonium::Core::Fields::Renderers::Factory.build(name, type:, **options)
@@ -28,8 +28,8 @@ module Plutonium
           end
         end
 
-        def renderer_defined?(name)
-          renderer_definitions.key? name
+        def field_renderer_defined?(name)
+          field_renderer_definitions.key? name
         end
       end
     end

data/lib/plutonium/core/fields/inputs/attachment_input.rb

@@ -5,9 +5,9 @@ module Plutonium
         class AttachmentInput < SimpleFormInput
           attr_reader :reflection
 
-          def initialize(name, reflection:, **user_options)
+          def initialize(name, reflection:, **options)
             @reflection = reflection
-            super(name, **user_options)
+            super(name, **options)
           end
 
           private