plutonium 0.14.1 → 0.15.0.pre.rc2

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "phlex"
+
+module Plutonium
+  module UI
+    module Component
+      module Methods
+        extend ActiveSupport::Concern
+
+        private
+
+        def resource_class
+          helpers.controller.send(:resource_class)
+        end
+
+        def resource_record
+          helpers.controller.send(:resource_record)
+        end
+
+        def current_parent
+          helpers.controller.send(:current_parent)
+        end
+
+        def params
+          helpers.controller.params
+        end
+
+        def request
+          helpers.controller.request
+        end
+
+        def pagy_instance
+          helpers.controller.instance_variable_get(:@pagy)
+        end
+
+        delegate \
+          :resource_name,
+          :resource_name_plural,
+          :display_name_of,
+          :resource_url_for,
+          :current_definition,
+          :current_query_object,
+          :resource_query_params,
+          :current_policy,
+          :current_turbo_frame,
+          :policy_for,
+          :allowed_to?,
+          :registered_resources,
+          to: :helpers
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Display
+      class Base < Phlexi::Display::Base
+        include Plutonium::UI::Component::Behaviour
+
+        class Builder < Builder
+          def association_tag(**, &)
+            create_component(Plutonium::UI::Display::Component::Association, :association, **, &)
+          end
+        end
+
+        private
+
+        def fields_wrapper(&)
+          div(class: themed(:fields_wrapper)) {
+            yield
+          }
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/ui/display/component/association.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Display
+      module Component
+        class Association < Phlexi::Display::Components::Association
+          include Plutonium::UI::Component::Methods
+
+          def render_value(value)
+            p(**attributes) {
+              if registered_resources.include?(value.class)
+                href = resource_url_for(value, parent: (field.association_reflection.macro == :has_many) ? field.object : nil)
+                a(class: themed(:link), href:) {
+                  display_name_of value
+                }
+              else
+                display_name_of value
+              end
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Display
+      class Resource < Base
+        attr_reader :resource_fields, :resource_associations, :resource_definition
+
+        def initialize(*, resource_fields:, resource_associations:, resource_definition:, **, &)
+          super(*, **, &)
+          @resource_fields = resource_fields
+          @resource_associations = resource_associations
+          @resource_definition = resource_definition
+        end
+
+        def display_template
+          render_fields
+          render_associations if present_associations?
+        end
+
+        private
+
+        def render_fields
+          fields_wrapper {
+            resource_fields.each { |name|
+              render_resource_field name
+            }
+          }
+        end
+
+        def render_associations
+          nil
+          # TODO
+          # resource_associations.each do |name, renderer|
+          #   #     <%= render renderer.with(record: details.record) %>
+          # end
+        end
+
+        def render_resource_field(name)
+          # display :name, as: :string
+          # display :description, class: "col-span-full"
+          # display :age, field: {class: "max-h-fit"}
+          # display :dob do |f|
+          #   f.date_tag
+          # end
+
+          when_permitted(name) do
+            display_definition = resource_definition.defined_displays[name] || {}
+            display_options = display_definition[:options] || {}
+            display_field_as = display_options.delete(:as)
+
+            display_field_options = display_options.delete(:field) || {}
+            display_block = display_definition[:block] || ->(f) {
+              display_field_as ||= f.inferred_field_component
+              f.send(:"#{display_field_as}_tag", **display_field_options)
+            }
+
+            field_options = resource_definition.defined_fields[name] ? resource_definition.defined_fields[name][:options] : {}
+            render field(name, **field_options).wrapped(**display_options) do |f|
+              render display_block.call(f)
+            end
+          end
+        end
+
+        def when_permitted(name, &)
+          return unless @resource_fields.include? name
+
+          yield
+        end
+
+        def present_associations?
+          current_parent.nil?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Display
+      class Theme < Phlexi::Display::Theme
+        def self.theme
+          super.merge({
+            base: "relative bg-white dark:bg-gray-800 shadow-md sm:rounded-lg my-3",
+            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",
+            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",
+            prefixed_icon: "w-8 h-8 mr-2"
+          })
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/ui/dyna_frame/content.rb

@@ -0,0 +1,20 @@
+module Plutonium
+  module UI
+    module DynaFrame
+      class Content < Plutonium::UI::Component::Base
+        include Phlex::Rails::Helpers::TurboFrameTag
+
+        def view_template
+          if current_turbo_frame.present?
+            render turbo_frame_tag(current_turbo_frame) {
+              render "flash"
+              yield
+            }
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/ui/empty_card.rb

@@ -0,0 +1,20 @@
+module Plutonium
+  module UI
+    class EmptyCard < Plutonium::UI::Component::Base
+      attr_accessor :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def view_template
+        div(class: "relative bg-white dark:bg-gray-800 shadow-md") do
+          div(class: "p-6 flex items-center flex-col gap-2") do
+            p(class: "text-gray-500 sm:text-lg dark:text-gray-200 text-center") { message }
+            yield if block_given?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Form
+      class Base < Phlexi::Form::Base
+        include Plutonium::UI::Component::Behaviour
+
+        private
+
+        def render_actions
+          actions_wrapper {
+            render submit_button
+          }
+        end
+
+        def fields_wrapper(&)
+          div(class: themed(:fields_wrapper, nil)) {
+            yield
+          }
+        end
+
+        def actions_wrapper(&)
+          div(class: themed(:actions_wrapper, nil)) {
+            yield
+          }
+        end
+
+        def form_action
+          return @form_action unless object.present? && @form_action != false && helpers.present?
+
+          @form_action ||= url_for(object, action: object.new_record? ? :create : :update)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Form
+      class Resource < Base
+        attr_reader :resource_fields, :resource_definition
+
+        def initialize(*, resource_fields:, resource_definition:, **, &)
+          super(*, **, &)
+          @resource_fields = resource_fields
+          @resource_definition = resource_definition
+        end
+
+        def form_template
+          render_fields
+          render_actions
+        end
+
+        private
+
+        def render_fields
+          fields_wrapper {
+            resource_fields.each { |name|
+              render_resource_field name
+            }
+          }
+        end
+
+        def form_action
+          return @form_action unless object.present? && @form_action != false && helpers.present?
+
+          @form_action ||= resource_url_for(object, action: object.new_record? ? :create : :update)
+        end
+
+        def render_resource_field(name)
+          # input :name, as: :string
+          # input :description, class: "col-span-full"
+          # input :age, field: {class: "max-h-fit"}
+          # input :dob do |f|
+          #   f.date_tag
+          # end
+
+          when_permitted(name) do
+            input_definition = resource_definition.defined_inputs[name] || {}
+            input_options = input_definition[:options] || {}
+            input_field_as = input_options.delete(:as)
+
+            input_field_options = input_options.delete(:field) || {}
+            input_block = input_definition[:block] || ->(f) {
+              input_field_as ||= f.inferred_field_component
+              f.send(:"#{input_field_as}_tag", **input_field_options)
+            }
+
+            field_options = resource_definition.defined_fields[name] ? resource_definition.defined_fields[name][:options] : {}
+            if !input_options[:class] || !input_options[:class].include?("col-span")
+              # temp hack to allow col span overrides
+              # TODO: remove once we complete theming, which will support merges
+              input_options[:class] = tokens("col-span-full", input_options[:class])
+            end
+            render field(name, **field_options).wrapped(**input_options) do |f|
+              render input_block.call(f)
+            end
+          end
+        end
+
+        def when_permitted(name, &)
+          return unless @resource_fields.include? name
+
+          yield
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Form
+      class Theme < Phlexi::Form::Theme
+        def self.theme
+          super.merge({
+            base: "relative bg-white dark:bg-gray-800 shadow-md sm:rounded-lg my-3 p-6 space-y-6",
+            fields_wrapper: "grid grid-cols-1 md:grid-cols-2 2xl:grid-cols-4 gap-6 grid-flow-row-dense",
+            actions_wrapper: "flex justify-end space-x-2",
+            wrapper: nil,
+            inner_wrapper: "w-full",
+            # label themes
+            label: "mt-2 block mb-2 text-base font-bold",
+            invalid_label: "text-red-700 dark:text-red-500",
+            valid_label: "text-green-700 dark:text-green-500",
+            neutral_label: "text-gray-500 dark:text-gray-400",
+            # input themes
+            input: "w-full p-2 border rounded-md shadow-sm font-medium text-sm dark:bg-gray-700",
+            invalid_input: "bg-red-50 border-red-500 dark:border-red-500 text-red-900 dark:text-red-500 placeholder-red-700 dark:placeholder-red-500 focus:ring-red-500 focus:border-red-500",
+            valid_input: "bg-green-50 border-green-500 dark:border-green-500 text-green-900 dark:text-green-400 placeholder-green-700 dark:placeholder-green-500 focus:ring-green-500 focus:border-green-500",
+            neutral_input: "border-gray-300 dark:border-gray-600 dark:placeholder-gray-400 dark:text-white focus:ring-primary-500 focus:border-primary-500",
+            # color
+            color: "pu-color-input appearance-none bg-transparent border-none cursor-pointer w-10 h-10",
+            invalid_color: nil,
+            valid_color: nil,
+            neutral_color: nil,
+            # file
+            file: "w-full border rounded-md shadow-sm font-medium text-sm dark:bg-gray-700 focus:outline-none",
+            # hint themes
+            hint: "mt-2 text-sm text-gray-500 dark:text-gray-200",
+            # error themes
+            error: "mt-2 text-sm text-red-600 dark:text-red-500",
+            # button themes
+            button: "px-4 py-2 bg-primary-600 text-white rounded-md hover:bg-primary-700 focus:outline-none focus:ring-2 focus:ring-primary-500"
+          })
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Page
+      class Base < Plutonium::UI::Component::Base
+        def initialize(page_title: nil, page_description: nil, page_actions: nil)
+          @page_title = page_title
+          @page_description = page_description
+          @page_actions = page_actions
+        end
+
+        def view_template(&)
+          render_before_header
+          render_header
+          render_after_header
+
+          render_before_content
+          render_content(&)
+          render_after_content
+
+          render_before_footer
+          render_footer
+          render_after_footer
+        end
+
+        private
+
+        attr_reader :page_title, :page_description, :page_actions
+
+        def render_header
+          render_before_breadcrumbs
+          render_breadcrumbs
+          render_after_breadcrumbs
+
+          render_before_page_header
+          render_page_header
+          render_after_page_header
+
+          render_before_toolbar
+          render_toolbar
+          render_after_toolbar
+        end
+
+        def render_breadcrumbs
+          Breadcrumbs()
+        end
+
+        def render_page_header
+          return unless page_title
+
+          PageHeader(title: page_title, description: page_description, actions: page_actions)
+        end
+
+        def render_toolbar
+          # Implement toolbar content
+        end
+
+        def render_content(&block)
+          block ||= proc { render_default_content }
+
+          DynaFrameContent(&block)
+        end
+
+        def render_default_content
+          raise NotImplementedError, "#{self.class}#render_default_content"
+        end
+
+        def render_footer
+          # Implement footer content
+        end
+
+        # Customization hooks
+        def render_before_header
+        end
+
+        def render_after_header
+        end
+
+        def render_before_breadcrumbs
+        end
+
+        def render_after_breadcrumbs
+        end
+
+        def render_before_page_header
+        end
+
+        def render_after_page_header
+        end
+
+        def render_before_toolbar
+        end
+
+        def render_after_toolbar
+        end
+
+        def render_before_content
+        end
+
+        def render_after_content
+        end
+
+        def render_before_footer
+        end
+
+        def render_after_footer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Page
+      class Edit < Base
+        private
+
+        def page_title
+          current_definition.edit_page_title || super || "Edit"
+        end
+
+        def page_description
+          current_definition.edit_page_description || super
+        end
+
+        def render_default_content
+          render "resource_form"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Page
+      class Index < Base
+        private
+
+        def page_title
+          super || current_definition.index_page_title || resource_name_plural(resource_class)
+        end
+
+        def page_description
+          super || current_definition.index_page_description
+        end
+
+        def page_actions
+          super || current_definition.defined_actions.values.select { |a| a.resource_action? && a.permitted_by?(current_policy) }
+        end
+
+        def render_default_content
+          render "resource_table"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Page
+      class New < Base
+        private
+
+        def page_title
+          current_definition.new_page_title || super || "New"
+        end
+
+        def page_description
+          current_definition.new_page_description || super
+        end
+
+        def render_default_content
+          render "resource_form"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Page
+      class Show < Base
+        private
+
+        def page_title
+          current_definition.show_page_title || super || display_name_of(resource_record)
+        end
+
+        def page_description
+          current_definition.show_page_description || super
+        end
+
+        def page_actions
+          super || current_definition.defined_actions.values.select { |a| a.record_action? && a.permitted_by?(current_policy) }
+        end
+
+        def render_default_content
+          render "resource_details"
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/ui/page_header.rb

@@ -0,0 +1,49 @@
+module Plutonium
+  module UI
+    class PageHeader < Plutonium::UI::Component::Base
+      def initialize(title:, description:, actions:)
+        @title = title
+        @description = description
+        @actions = actions || []
+      end
+
+      def view_template
+        div(class: "sm:flex sm:space-y-0 sm:space-x-4 sm:flex-row items-center justify-between space-y-3 mb-6") {
+          div {
+            phlexi_render(@title) {
+              render_title @title
+            }
+
+            phlexi_render(@description) {
+              render_description @description
+            }
+          }
+          div(class: "flex flex-row space-x-2") {
+            render_actions
+          }
+        }
+      end
+
+      private
+
+      def render_title(title)
+        h2(class: "mb-2 text-3xl font-extrabold leading-none tracking-tight text-gray-900 md:text-4xl dark:text-white") {
+          title
+        }
+      end
+
+      def render_description(description)
+        p(class: "text-gray-500 dark:text-gray-400") {
+          description
+        }
+      end
+
+      def render_actions
+        @actions.each do |action|
+          url = resource_url_for(resource_record || resource_class, *action.route_options.url_args, **action.route_options.url_options)
+          ActionButton(action, url:)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Plutonium
+  module UI
+    module Table
+      class Base < Phlexi::Table::Base
+        include Plutonium::UI::Component::Behaviour
+
+        class Display < Plutonium::UI::Display::Base; end
+      end
+    end
+  end
+end