plutonium 0.14.1 → 0.15.0.pre.rc2

data/lib/plutonium/resource/record.rb

@@ -2,6 +2,7 @@ module Plutonium
   module Resource
     module Record
       extend ActiveSupport::Concern
+      include Plutonium::Models::HasCents
 
       included do
         scope :from_path_param, ->(param) { where(id: param) }
@@ -14,12 +15,12 @@ module Plutonium
           # TODO: add logging
           # TODO: memoize this
 
-          own_association = klass.find_association_to_record(record)
+          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(record)
+          record_association = klass.find_association_to_self_from_record(record)
           if record_association
             # TODO: add a warning here about a potentially poor performing query
             return where(id: record.public_send(record_association.name))
@@ -43,7 +44,7 @@ module Plutonium
         # @param [Proc] scope The scope for the association
         # @param [Hash] options The options for the association
         def belongs_to(name, scope = nil, **options)
-          super(name, scope, **options)
+          super
 
           return unless options[:polymorphic]
 
@@ -155,31 +156,10 @@ module Plutonium
           end.compact.to_h
         end
 
-        # Returns the strong parameters definition for the given attribute names
-        # @param [Array<Symbol>] *attributes Attribute names
-        # @return [Array<Symbol, Hash>] A strong parameters compatible array
-        def strong_parameters_for(*attributes)
-          unbacked = attributes - strong_parameters_definition.keys
-
-          backed = strong_parameters_definition.slice(*attributes).values.reduce(:merge)
-            &.map { |key, value| value.nil? ? key : {key => value} } || {}
-
-          case backed.presence
-          when Hash
-            [*unbacked, **backed]
-          when Array
-            [*unbacked, *backed]
-          when nil
-            unbacked
-          else
-            raise "Unexpected strong parameters definition: #{backed.class}"
-          end
-        end
-
         # Finds the association to the given record
         # @param [ActiveRecord::Base] record The record to find the association with
         # @return [ActiveRecord::Reflection::AssociationReflection, nil]
-        def find_association_to_record(record)
+        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
@@ -191,7 +171,7 @@ module Plutonium
         # Finds the association to self in the given record
         # @param [ActiveRecord::Base] record The record to find the association with
         # @return [ActiveRecord::Reflection::AssociationReflection, nil]
-        def find_association_to_self(record)
+        def find_association_to_self_from_record(record)
           record.class.reflect_on_all_associations.find do |assoc|
             assoc.klass.name == name
           rescue
@@ -231,69 +211,6 @@ module Plutonium
 
         private
 
-        # Defines the strong parameters
-        # @return [Hash]
-        def strong_parameters_definition
-          unless Rails.env.local?
-            return @strong_parameters if defined?(@strong_parameters)
-          end
-
-          @strong_parameters = build_strong_parameters
-        end
-
-        # Builds the strong parameters hash
-        # @return [Hash]
-        def build_strong_parameters
-          parameters = content_column_field_names.map do |name|
-            column = columns_hash[name.to_s]
-            type = if column.try(:array?)
-              []
-            else
-              ([:json, :jsonb].include?(column&.type) ? {} : nil)
-            end
-            [name, {name => type}]
-          end.to_h
-
-          parameters.merge!(belongs_to_association_parameters)
-          parameters.merge!(has_many_association_parameters)
-          parameters.merge!(attachment_parameters)
-          parameters.merge!(nested_attributes_parameters)
-
-          parameters
-        end
-
-        # Returns the parameters for belongs_to associations
-        # @return [Hash]
-        def belongs_to_association_parameters
-          reflect_on_all_associations(:belongs_to).map do |reflection|
-            input_param = reflection.options[:foreign_key] || :"#{reflection.name}_id"
-            [reflection.name, {input_param => nil, :"#{reflection.name}_sgid" => nil}]
-          end.to_h
-        end
-
-        # Returns the parameters for has_many associations
-        # @return [Hash]
-        def has_many_association_parameters
-          has_many_association_field_names.map do |name|
-            [name, {"#{name.to_s.singularize}_ids": []}]
-          end.to_h
-        end
-
-        # Returns the parameters for attachments
-        # @return [Hash]
-        def attachment_parameters
-          has_many_attached_field_names.map { |name| [name, {name => []}] }.to_h
-            .merge(has_one_attached_field_names.map { |name| [name, {name => nil}] }.to_h)
-        end
-
-        # Returns the parameters for nested attributes
-        # @return [Hash]
-        def nested_attributes_parameters
-          all_nested_attributes_options.keys.map do |name|
-            [name, {"#{name}_attributes" => {}}]
-          end.to_h
-        end
-
         # Defines a scope and method for path parameters
         # @param [Symbol] param_name The name of the parameter
         def path_parameter(param_name)

data/lib/plutonium/resource/register.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module Resource
+    # Resource register manages the registration and lookup of resources.
+    class Register
+      include Plutonium::Lib::SmartCache
+
+      # Custom error class for frozen register operations
+      class FrozenRegisterError < StandardError; end
+
+      def initialize
+        @resources = Set.new
+        @frozen = false
+      end
+
+      # Registers a new resource with the register.
+      #
+      # @param resource [Class] The resource class to be registered.
+      # @raise [FrozenRegisterError] If the register is frozen.
+      # @return [void]
+      def register(resource)
+        raise FrozenRegisterError, "Cannot modify frozen resource register" if @frozen
+
+        @resources.add(resource.to_s)
+      end
+
+      # Returns an array of all registered resource classes and freezes the register.
+      #
+      # @return [Array<Class>] An array of registered resource classes.
+      def resources
+        freeze
+        @resources.map(&:constantize)
+      end
+      memoize_unless_reloading :resources
+
+      # Returns a hash mapping route keys to their corresponding resource classes.
+      # This method will freeze the register if it hasn't been frozen already.
+      #
+      # @return [Hash{Symbol => Class}] A hash where keys are route keys and values are resource classes.
+      def route_key_lookup
+        freeze
+        resources.to_h do |resource|
+          [resource.model_name.singular_route_key.to_sym, resource]
+        end
+      end
+      memoize_unless_reloading :route_key_lookup
+
+      # Clears all registered resources and invalidates the cache.
+      #
+      # @return [void]
+      def clear
+        @resources.clear
+        @frozen = false
+        invalidate_cache
+      end
+
+      # Checks if the register is frozen.
+      #
+      # @return [Boolean] True if the register is frozen, false otherwise.
+      def frozen?
+        @frozen
+      end
+
+      private
+
+      # Freezes the register
+      #
+      # @return [Boolean] Always returns true
+      def freeze
+        @frozen ||= true
+      end
+
+      # Invalidates the memoization cache
+      #
+      # @return [void]
+      def invalidate_cache
+        flush_smart_cache
+      end
+    end
+  end
+end

data/lib/plutonium/routing/mapper_extensions.rb

@@ -79,7 +79,7 @@ module Plutonium
       def define_nested_resource_routes(resource)
         nested_configs = route_set.resource_route_config_for(*resource.has_many_association_routes)
         nested_configs.each do |nested_config|
-          resources nested_config[:route_name], **nested_config[:route_options] do
+          resources "nested_#{nested_config[:route_name]}", **nested_config[:route_options] do
             instance_exec(&nested_config[:block]) if nested_config[:block]
           end
         end

data/lib/plutonium/routing/resource_registration.rb

@@ -8,7 +8,7 @@ module Plutonium
 
       class_methods do
         def resource_register
-          @resource_register ||= Plutonium::ResourceRegister.new
+          @resource_register ||= Plutonium::Resource::Register.new
         end
       end
     end

data/lib/plutonium/routing/route_set_extensions.rb

@@ -12,6 +12,9 @@ module Plutonium
     #     register_resource SomeModel
     #   end
     module RouteSetExtensions
+      extend ActiveSupport::Concern
+      include Plutonium::Engine::Validator
+
       # Clears all registered resources and route configurations.
       #
       # This method should be called when you want to reset all registered resources
@@ -30,7 +33,7 @@ module Plutonium
       # @return [void]
       # @yield Executes the given block in the context of route drawing.
       def draw(&block)
-        if supported_engine?
+        if self.class.supported_engine?(engine)
           ActiveSupport::Notifications.instrument("plutonium.resource_routes.draw", app: engine.to_s) do
             super do
               setup_shared_resource_concerns
@@ -48,9 +51,9 @@ module Plutonium
       # @param resource [Class] The resource class to be registered.
       # @yield An optional block for additional resource configuration.
       # @return [Hash] The configuration for the registered resource.
-      # @raise [ArgumentError] If the engine doesn't support Plutonium::Pkg::App.
+      # @raise [ArgumentError] If the engine is not supported.
       def register_resource(resource, &)
-        validate_engine!
+        self.class.validate_engine! engine
         engine.resource_register.register(resource)
 
         route_name = resource.model_name.plural
@@ -85,21 +88,6 @@ module Plutonium
         @resource_route_config_lookup ||= {}
       end
 
-      # Validates that the current engine supports Plutonium features.
-      #
-      # @raise [ArgumentError] If the engine doesn't include Plutonium::Pkg::App.
-      # @return [void]
-      def validate_engine!
-        raise ArgumentError, "#{engine} must include Plutonium::Pkg::App to register resources" unless supported_engine?
-      end
-
-      # Checks if the current engine supports Plutonium features.
-      #
-      # @return [Boolean] True if the engine includes Plutonium::Pkg::App, false otherwise.
-      def supported_engine?
-        engine.include?(Plutonium::Pkg::App)
-      end
-
       # Determines the appropriate engine based on the current scope.
       #
       # @return [Class] The determined engine class.

data/lib/plutonium/ui/action_button.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    class ActionButton < Plutonium::UI::Component::Base
+      include Phlex::Rails::Helpers::LinkTo
+      include Phlex::Rails::Helpers::ButtonTo
+
+      def initialize(action, url:, variant: :default)
+        @action = action
+        @url = url
+        @variant = variant
+      end
+
+      def view_template
+        if @action.route_options.method == :get
+          render_link
+        else
+          render_button
+        end
+      end
+
+      private
+
+      def render_link
+        link_to(
+          @url,
+          class: button_classes,
+          data: {turbo_frame: @action.turbo_frame}
+        ) do
+          render_button_content
+        end
+      end
+
+      def render_button
+        button_to(
+          @url,
+          method: @action.route_options.method,
+          name: :return_to, value: request.original_url,
+          class: "inline-block",
+          form: {
+            data: {
+              turbo_confirm: @action.confirmation,
+              turbo_frame: @action.turbo_frame
+            }
+          }
+        ) do
+          span(class: button_classes) do
+            render_button_content
+          end
+        end
+      end
+
+      def render_button_content
+        if @action.icon
+          render @action.icon.new(class: icon_classes)
+        end
+        span { @action.label } unless @variant == :table
+      end
+
+      def button_classes
+        tokens(
+          base_classes,
+          color_classes,
+          size_classes,
+          -> { @action.icon && @variant != :table } => "space-x-1"
+        )
+      end
+
+      def base_classes
+        if @variant == :table
+          "inline-flex items-center justify-center p-1 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
+      end
+
+      def icon_classes
+        if @variant == :table
+          "h-4 w-4"
+        else
+          "h-3.5 w-3.5 mr-2 -ml-1"
+        end
+      end
+
+      def size_classes
+        (@variant == :table) ? "text-xs" : "text-sm"
+      end
+
+      def color_classes
+        case @action.color || @action.category.to_sym
+        when :primary
+          table_variant_class(
+            "bg-primary-100 text-primary-700 hover:bg-primary-200 focus:ring-primary-300 dark:bg-primary-700 dark:text-primary-100 dark:hover:bg-primary-600 dark:focus:ring-primary-600",
+            "bg-primary-700 text-white hover:bg-primary-800 focus:ring-primary-300 dark:bg-primary-600 dark:hover:bg-primary-700 dark:focus:ring-primary-800"
+          )
+        when :warning
+          table_variant_class(
+            "bg-yellow-100 text-yellow-700 hover:bg-yellow-200 focus:ring-yellow-300 dark:bg-yellow-700 dark:text-yellow-100 dark:hover:bg-yellow-600 dark:focus:ring-yellow-600",
+            "bg-yellow-400 text-white hover:bg-yellow-500 focus:ring-yellow-300 dark:bg-yellow-600 dark:hover:bg-yellow-700 dark:focus:ring-yellow-800"
+          )
+        when :danger
+          table_variant_class(
+            "bg-red-100 text-red-700 hover:bg-red-200 focus:ring-red-300 dark:bg-red-700 dark:text-red-100 dark:hover:bg-red-600 dark:focus:ring-red-600",
+            "bg-red-700 text-white hover:bg-red-800 focus:ring-red-300 dark:bg-red-600 dark:hover:bg-red-700 dark:focus:ring-red-900"
+          )
+        when :success
+          table_variant_class(
+            "bg-green-100 text-green-700 hover:bg-green-200 focus:ring-green-300 dark:bg-green-700 dark:text-green-100 dark:hover:bg-green-600 dark:focus:ring-green-600",
+            "bg-green-700 text-white hover:bg-green-800 focus:ring-green-300 dark:bg-green-600 dark:hover:bg-green-700 dark:focus:ring-green-800"
+          )
+        else
+          table_variant_class(
+            "bg-gray-100 text-gray-700 hover:bg-gray-200 focus:ring-gray-300 dark:bg-gray-700 dark:text-gray-100 dark:hover:bg-gray-600 dark:focus:ring-gray-600",
+            "border border-gray-200 bg-white text-gray-900 hover:bg-gray-100 hover:text-primary-700 focus:z-10 focus:ring-gray-100 dark:border-gray-600 dark:bg-gray-800 dark:text-gray-200 dark:hover:bg-gray-700 dark:hover:text-white dark:focus:ring-gray-700"
+          )
+        end
+      end
+
+      def table_variant_class(table_class, default_class)
+        (@variant == :table) ? table_class : default_class
+      end
+    end
+  end
+end

data/lib/plutonium/ui/breadcrumbs.rb

@@ -0,0 +1,163 @@
+module Plutonium
+  module UI
+    class Breadcrumbs < Plutonium::UI::Component::Base
+      include Phlex::Rails::Helpers::ActionName
+      include Phlex::Rails::Helpers::LinkTo
+
+      def view_template
+        nav(
+          class:
+            "flex py-3 text-gray-700 mb-2",
+          aria_label: "Breadcrumb"
+        ) do
+          ol(
+            class:
+              "inline-flex items-center space-x-1 md:space-x-2 rtl:space-x-reverse"
+          ) do
+            # Dashboard
+            li(class: "inline-flex items-center") do
+              a(
+                href: helpers.root_path,
+                class:
+                  "inline-flex items-center text-sm font-medium text-gray-700 hover:text-primary-600 dark:text-gray-200 dark:hover:text-white"
+              ) do
+                svg(
+                  class: "w-3 h-3 me-2.5",
+                  aria_hidden: "true",
+                  xmlns: "http://www.w3.org/2000/svg",
+                  fill: "currentColor",
+                  viewbox: "0 0 20 20"
+                ) do |s|
+                  s.path(
+                    d:
+                      "m19.707 9.293-2-2-7-7a1 1 0 0 0-1.414 0l-7 7-2 2a1 1 0 0 0 1.414 1.414L2 10.414V18a2 2 0 0 0 2 2h3a1 1 0 0 0 1-1v-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v4a1 1 0 0 0 1 1h3a2 2 0 0 0 2-2v-7.586l.293.293a1 1 0 0 0 1.414-1.414Z"
+                  )
+                end
+                plain " Dashboard "
+              end
+            end
+
+            # Parent
+            if current_parent.present?
+              # Parent Resource
+              li(class: "flex items-center") do
+                svg(
+                  class: "rtl:rotate-180 block w-3 h-3 mx-1 text-gray-400",
+                  aria_hidden: "true",
+                  xmlns: "http://www.w3.org/2000/svg",
+                  fill: "none",
+                  viewbox: "0 0 6 10"
+                ) do |s|
+                  s.path(
+                    stroke: "currentColor",
+                    stroke_linecap: "round",
+                    stroke_linejoin: "round",
+                    stroke_width: "2",
+                    d: "m1 9 4-4-4-4"
+                  )
+                end
+                link_to resource_name_plural(current_parent.class),
+                  resource_url_for(current_parent.class, parent: nil),
+                  class:
+                    "ms-1 text-sm font-medium text-gray-700 hover:text-primary-600 md:ms-2 dark:text-gray-200 dark:hover:text-white"
+              end
+
+              # Parent Itself
+              li(class: "flex items-center") do
+                svg(
+                  class: "rtl:rotate-180 block w-3 h-3 mx-1 text-gray-400",
+                  aria_hidden: "true",
+                  xmlns: "http://www.w3.org/2000/svg",
+                  fill: "none",
+                  viewbox: "0 0 6 10"
+                ) do |s|
+                  s.path(
+                    stroke: "currentColor",
+                    stroke_linecap: "round",
+                    stroke_linejoin: "round",
+                    stroke_width: "2",
+                    d: "m1 9 4-4-4-4"
+                  )
+                end
+                link_to display_name_of(current_parent),
+                  resource_url_for(current_parent, parent: nil),
+                  class:
+                    "ms-1 text-sm font-medium text-gray-700 hover:text-primary-600 md:ms-2 dark:text-gray-200 dark:hover:text-white"
+              end
+            end
+
+            # Record
+            if resource_record.present?
+              # Record Resource
+              li(class: "flex items-center") do
+                svg(
+                  class: "rtl:rotate-180 block w-3 h-3 mx-1 text-gray-400",
+                  aria_hidden: "true",
+                  xmlns: "http://www.w3.org/2000/svg",
+                  fill: "none",
+                  viewbox: "0 0 6 10"
+                ) do |s|
+                  s.path(
+                    stroke: "currentColor",
+                    stroke_linecap: "round",
+                    stroke_linejoin: "round",
+                    stroke_width: "2",
+                    d: "m1 9 4-4-4-4"
+                  )
+                end
+                link_to resource_name_plural(resource_class),
+                  resource_url_for(resource_class),
+                  class:
+                    "ms-1 text-sm font-medium text-gray-700 hover:text-primary-600 md:ms-2 dark:text-gray-200 dark:hover:text-white"
+              end
+
+              # Record Itself
+              if resource_record.persisted? && action_name != "show"
+                li(class: "flex items-center") do
+                  svg(
+                    class: "rtl:rotate-180 block w-3 h-3 mx-1 text-gray-400",
+                    aria_hidden: "true",
+                    xmlns: "http://www.w3.org/2000/svg",
+                    fill: "none",
+                    viewbox: "0 0 6 10"
+                  ) do |s|
+                    s.path(
+                      stroke: "currentColor",
+                      stroke_linecap: "round",
+                      stroke_linejoin: "round",
+                      stroke_width: "2",
+                      d: "m1 9 4-4-4-4"
+                    )
+                  end
+                  link_to display_name_of(resource_record),
+                    resource_url_for(resource_record),
+                    class:
+                      "ms-1 text-sm font-medium text-gray-700 hover:text-primary-600 md:ms-2 dark:text-gray-200 dark:hover:text-white"
+                end
+              end
+            end
+
+            # Trailing Caret
+            li(class: "flex items-center") do
+              svg(
+                class: "rtl:rotate-180 block w-3 h-3 mx-1 text-gray-400",
+                aria_hidden: "true",
+                xmlns: "http://www.w3.org/2000/svg",
+                fill: "none",
+                viewbox: "0 0 6 10"
+              ) do |s|
+                s.path(
+                  stroke: "currentColor",
+                  stroke_linecap: "round",
+                  stroke_linejoin: "round",
+                  stroke_width: "2",
+                  d: "m1 9 4-4-4-4"
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "phlex"
+
+module Plutonium
+  module UI
+    module Component
+      class Base < (defined?(::ApplicationComponent) ? ::ApplicationComponent : Phlex::HTML)
+        include Plutonium::UI::Component::Behaviour
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Component
+      module Behaviour
+        extend ActiveSupport::Concern
+        include Methods
+        include Kit
+
+        if Rails.env.development?
+          def around_template(&)
+            comment { "open:#{self.class.name}" }
+            super
+            comment { "close:#{self.class.name}" }
+          end
+        end
+
+        protected
+
+        def phlexi_render(arg, &)
+          return unless arg
+          raise ArgumentError, "phlexi_render requires a default render block" unless block_given?
+
+          # Handle Phlex components or Rails Renderables
+          if arg.class < Phlex::SGML || arg.respond_to?(:render_in)
+            render arg
+          # Handle procs
+          elsif arg.respond_to?(:to_proc)
+            instance_exec(&arg)
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "phlex"
+
+module Plutonium
+  module UI
+    module Component
+      module Kit
+        extend ActiveSupport::Concern
+
+        def Breadcrumbs(...) = render Plutonium::UI::Breadcrumbs.new(...)
+
+        def DynaFrameContent(...) = render Plutonium::UI::DynaFrame::Content.new(...)
+
+        def PageHeader(...) = render Plutonium::UI::PageHeader.new(...)
+
+        def ActionButton(...) = render Plutonium::UI::ActionButton.new(...)
+
+        def EmptyCard(...) = render Plutonium::UI::EmptyCard.new(...)
+
+        def TableSearchBar(...) = render Plutonium::UI::Table::Components::SearchBar.new(...)
+
+        def TableScopesBar(...) = render Plutonium::UI::Table::Components::ScopesBar.new(...)
+
+        def TableInfo(...) = render Plutonium::UI::Table::Components::PagyInfo.new(...)
+
+        def TablePagination(...) = render Plutonium::UI::Table::Components::PagyPagination.new(...)
+      end
+    end
+  end
+end