phlexi-table 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e05e322aef835f61e4d9c75e678c54ed3abd96675b7eaedb7db6b8138f826450
-  data.tar.gz: 3d2e8b90865ab5e8e5b5b405046277a51177508187f3fde2d708612bed01dc6f
+  metadata.gz: ea441f5dc6bff0752e14011507ba3274026a46f8900de536f7b1d253fff45c44
+  data.tar.gz: 05dd06af33197b2f8847d2bfab878340cf23d28d9c824b53382497343ae1de13
 SHA512:
-  metadata.gz: e9e99ffd0dff1b5e92cdc779c8cd3fd5dee46e20094916e50eeec337c1af2b88fd0b9fa637dd56f54ad3a12381e0d2b2434747d536a4bb5fff928d08ccd6dd1f
-  data.tar.gz: 4f97e0de92ea6e09b17d7e09c6d242ee968638c6d4766991515aa54d3e738a51219190ca4d1fd944205b06b627eb9c3a2b0e7125adf5cb22eda839f14a5c7668
+  metadata.gz: 5db97df1ef5cf3131212ee6ce6a9b043dffd5d97f68e783ceca071b95cbedbb3a7a57086d82d0285cd100714e6aa0994001615f99768a56154cd4296df2eac75
+  data.tar.gz: 48935e08c5e0dfb4b9fb110ebe7a14cffc5d3a73930a0ad7779e89fbe3579c4a19ebe72062deaac07df84b8a47fe73351ee7a0e8555bdadf79c01e02ba72d9df

data/lib/phlexi/table/base.rb

@@ -1,118 +1,400 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/module/delegation"
-require "active_support/core_ext/string/inflections"
-
 module Phlexi
   module Table
-    # A display component for rendering flexible and customizable data views.
+    # Base class for creating customizable table components
     #
     # @example Basic usage
-    #   Phlexi::Table.new(user) do |d|
-    #     render d.field(:name).text
-    #     render d.field(:email).text
+    #   class UsersTable < Phlexi::Table::Base
+    #     def table_template
+    #       table_caption "Caption"
+    #       table_description "Description"
+    #       selection_column :id
+    #       column :name
+    #       column :a_sorted_column, sort_params: {url: "url", reset_url: "reset_url", position: "multisort position", direction: "ASC|DESC"}
+    #       column_group :a_grouped_column do |g|
+    #         g.column :sub_col1
+    #         g.column :sub_col2
+    #       end
+    #       actions do |user|
+    #         link_to "Edit", edit_user_path(user)
+    #       end
+    #     end
     #   end
     #
-    # @attr_reader [Symbol] key The display's key, derived from the record or explicitly set
-    # @attr_reader [ActiveModel::Model, nil] object The display's associated object
-    class Base < COMPONENT_BASE
-      class Namespace < Structure::Namespace; end
-
-      class FieldBuilder < Structure::FieldBuilder; end
-
-      attr_reader :key, :object
-
-      delegate :field, :nest_one, :nest_many, to: :@namespace
-
-      # Initializes a new Table instance.
-      #
-      # @param record [ActiveModel::Model, Symbol, String] The display's associated record or key
-      # @param attributes [Hash] Additional HTML attributes for the display container
-      # @param options [Hash] Additional options for display configuration
-      # @option options [String] :class CSS classes for the display
-      # @option options [Class] :namespace_klass Custom namespace class
-      # @option options [Class] :builder_klass Custom field builder class
-      def initialize(record, attributes: {}, **options)
-        @display_class = options.delete(:class)
-        @attributes = attributes
-        @namespace_klass = options.delete(:namespace_klass) || default_namespace_klass
-        @builder_klass = options.delete(:builder_klass) || default_builder_klass
+    #   render UsersTable.new(User.all)
+    #
+    # @attr_reader [Enumerable] collection The collection of items to display in the table
+    # @attr_reader [Hash] columns The columns defined for the table
+    class Base < Phlexi::Table::HTML
+      include Phlex::DeferredRender
+      include Phlexi::Table::Options::Captions
+      include Phlexi::Table::Options::Descriptions
+
+      class DataColumn < Phlexi::Table::Components::DataColumn; end
+
+      class SelectionColumn < Phlexi::Table::Components::SelectionColumn; end
+
+      class ActionsColumn < Phlexi::Table::Components::ActionsColumn; end
+
+      class ColumnGroup < Phlexi::Table::Components::ColumnGroup; end
+
+      class Display < Phlexi::Display::Base; end
+
+      attr_reader :key, :collection, :columns, :options
+
+      # Initialize a new table component
+      #
+      # @param collection [Enumerable] The collection of items to display
+      # @param options [Hash] Additional options for customizing the table
+      # @option options [String] :id The ID attribute for the table
+      # @option options [String] :class The CSS class(es) for the table
+      # @raise [ArgumentError] If the collection is empty
+      def initialize(collection, **options)
+        @collection = Array(collection)
+        raise ArgumentError, "Collection cannot be empty" if @collection.empty?
+
+        @columns = {}
         @options = options
+        initialize_key
+      end
 
-        initialize_object_and_key(record)
-        initialize_namespace
+      def around_template
+        original_template = Phlexi::Display::Theme.instance
+        Phlexi::Display::Theme.instance = Phlexi::Table::DisplayTheme.instance
+        super
+      ensure
+        Phlexi::Display::Theme.instance = original_template
+      end
+
+      def before_template
+        super
+        table_template
       end
 
-      # Renders the display template.
-      #
-      # @return [void]
       def view_template
-        display_template
+        render_table
       end
 
-      # Executes the display's content block.
-      # Override this in subclasses to define a static display.
+      def table_template
+        # implement this in subclasses to define the column template
+      end
+
+      # Add a column to the table
       #
+      # @param column [Columns::Base] The column object to add
       # @return [void]
-      def display_template
-        instance_exec(&@_content_block) if @_content_block
+      # @raise [ArgumentError] If a column with the same key already exists
+      def add_column(column)
+        raise ArgumentError, "Column '#{column.key}' already exists" if @columns.key?(column.key)
+
+        @columns[column.key] = column
+      end
+
+      def column(key, **, &)
+        add_column(column_class.new(key, self, **, &))
+      end
+
+      def selection_column(key, **, &)
+        raise "Selection column already added" if @has_selection_column
+
+        @has_selection_column = true
+        add_column(selection_column_class.new(key, self, **, &))
+      end
+
+      def column_group(key, **, &)
+        @has_grouped_columns = true
+        add_column(column_group_class.new(key, self, **, &))
+      end
+
+      def actions(**, &)
+        raise "Action column already added" if @has_action_column
+
+        @has_action_column = true
+        add_column(actions_column_class.new(:phlexi_table_actions, self, label: "Actions", **, &))
+      end
+
+      def sample
+        collection[0]
+      end
+
+      def wrapped_sample
+        @wrapped_sample ||= WrappedObject.new(sample, index: -1, display_class: self.class::Display)
+      end
+
+      def dom_id
+        key
+      end
+
+      def column_class
+        self.class::DataColumn
+      end
+
+      def selection_column_class
+        self.class::SelectionColumn
+      end
+
+      def actions_column_class
+        self.class::ActionsColumn
+      end
+
+      def column_group_class
+        self.class::ColumnGroup
       end
 
       protected
 
-      attr_reader :options, :attributes, :namespace_klass, :builder_klass
+      # Render the complete table structure
+      #
+      # @return [void]
+      def render_table
+        div(**table_wrapper_attributes) {
+          table(**table_attributes) do
+            render_table_caption
+            render_table_header
+            render_table_body
+            render_table_footer
+          end
+        }
+      end
 
-      # Initializes the object and key based on the given record.
+      # Render the table caption
       #
-      # @param record [ActiveModel::Model, Symbol, String] The display's associated record or key
       # @return [void]
-      def initialize_object_and_key(record)
-        @key = options.delete(:key) || options.delete(:as)
+      def render_table_caption
+        return unless has_table_caption? || has_table_description?
 
-        case record
-        when String, Symbol
-          @object = nil
-          @key = record
-        else
-          @object = record
-          @key = if @key.nil? && object.respond_to?(:model_name) && object.model_name.respond_to?(:param_key) && object.model_name.param_key.present?
-            object.model_name.param_key
-          else
-            :object
+        caption(**table_caption_attributes) {
+          plain table_caption if has_table_caption?
+          if has_table_description?
+            p(**table_description_attributes) {
+              table_description
+            }
+          end
+        }
+      end
+
+      # Render the table header
+      #
+      # @return [void]
+      def render_table_header
+        thead(**table_header_attributes) do
+          if @has_grouped_columns
+            tr(**table_header_grouping_row_attributes) do
+              blanks = 0
+              columns.each_value do |column|
+                if column.is_a?(Phlexi::Table::Components::Concerns::GroupsColumns)
+                  th(**table_header_grouping_cell_attributes(blanks)) {} if blanks > 0
+                  th(id: column.dom_id, **table_header_grouping_cell_attributes(column.colspan)) { column.label }
+                  blanks = 0
+                else
+                  blanks += 1
+                end
+              end
+              th(**table_header_grouping_cell_attributes(blanks)) { whitespace } if blanks > 0
+            end
+          end
+
+          tr(**table_header_row_attributes) do
+            columns.each_value do |column|
+              if column.is_a?(Phlexi::Table::Components::Concerns::GroupsColumns)
+                column.columns.each_value do |column|
+                  th(**table_header_cell_attributes(column)) { render column.header_cell }
+                end
+              else
+                th(**table_header_cell_attributes(column)) { render column.header_cell }
+              end
+            end
           end
         end
-        @key = @key.to_sym
       end
 
-      # Initializes the namespace for the display.
+      # Render the table body
       #
       # @return [void]
-      def initialize_namespace
-        @namespace = namespace_klass.root(key, object: object, builder_klass: builder_klass)
+      def render_table_body
+        tbody(**table_body_attributes) do
+          collection.each_with_index do |object, index|
+            wrapped_object = WrappedObject.new(object, index:, display_class: self.class::Display)
+            render_table_body_row(wrapped_object)
+          end
+        end
       end
-      # Retrieves the display's CSS classes.
+
+      # Render a table body row
       #
-      # @return [String] The display's CSS classes
-      attr_reader :display_class
+      # @param wrapped_object [Object] The current item from the collection
+      # @return [void]
+      def render_table_body_row(wrapped_object)
+        tr(**table_body_row_attributes(wrapped_object)) do
+          columns.each_value do |column|
+            if column.is_a?(Phlexi::Table::Components::Concerns::GroupsColumns)
+              column.columns.each_value do |column|
+                td(**table_data_cell_attributes(wrapped_object, column)) { render column.data_cell(wrapped_object) }
+              end
+            elsif column.is_a?(actions_column_class)
+              td(**table_data_cell_attributes(wrapped_object, column)) { column.render_actions(wrapped_object) }
+            else
+              td(**table_data_cell_attributes(wrapped_object, column)) { render column.data_cell(wrapped_object) }
+            end
+          end
+        end
+      end
 
-      # Generates the display attributes hash.
+      # Render the table footer
       #
-      # @return [Hash] The display attributes
-      def display_attributes
-        mix({
-          id: @namespace.dom_id,
-          class: display_class
-        }, attributes)
+      # @return [void]
+      def render_table_footer
+        # tfoot(**table_footer_attributes) do
+        #   # Implement footer content if needed
+        # end
       end
 
       private
 
-      def default_namespace_klass
-        self.class::Namespace
+      def table_wrapper_attributes
+        {
+          id: @options[:id] || "#{dom_id}_table_wrapper",
+          class: tokens("phlexi_table_wrapper", themed(:wrapper))
+        }
+      end
+
+      # Get the attributes for the table element
+      #
+      # @return [Hash] The table attributes
+      def table_attributes
+        {
+          id: @options[:id] || "#{dom_id}_table",
+          class: tokens("phlexi_table", themed(:base), @options[:class])
+        }
+      end
+
+      # Get the attributes for the table caption element
+      #
+      # @return [Hash] The caption attributes
+      def table_caption_attributes
+        {
+          id: "#{dom_id}_table_caption",
+          class: tokens("phlexi_table_caption", themed(:caption))
+        }
+      end
+
+      # Get the attributes for the table description
+      #
+      # @return [Hash] The description attributes
+      def table_description_attributes
+        {
+          id: "#{dom_id}_table_description",
+          class: tokens("phlexi_table_description", themed(:description))
+        }
+      end
+
+      # Get the attributes for the table header element
+      #
+      # @return [Hash] The header attributes
+      def table_header_attributes
+        {
+          id: "#{dom_id}_table_header",
+          class: tokens("phlexi_table_header", themed(:header))
+        }
+      end
+
+      def table_header_grouping_row_attributes
+        {
+          id: "#{dom_id}_table_header_grouping_row",
+          class: tokens("phlexi_table_header_grouping_row", themed(:header_grouping_row))
+        }
+      end
+
+      def table_header_grouping_cell_attributes(colspan)
+        {
+          colspan:,
+          class: tokens("phlexi_table_header_grouping_cell", themed(:header_grouping_cell))
+        }
+      end
+
+      # Get the attributes for the table header row element
+      #
+      # @return [Hash] The header row attributes
+      def table_header_row_attributes
+        {
+          id: "#{dom_id}_table_header_row",
+          class: tokens("phlexi_table_header_row", themed(:header_row))
+        }
+      end
+
+      # Get the attributes for a table header cell element
+      #
+      # @param column [Columns::Base] The column object
+      # @return [Hash] The header cell attributes
+      def table_header_cell_attributes(column)
+        mix(
+          {
+            scope: "col",
+            class: tokens("phlexi_table_header_cell", themed(:header_cell))
+          },
+          column.header_cell_attributes
+        )
+      end
+
+      # Get the attributes for the table body element
+      #
+      # @return [Hash] The body attributes
+      def table_body_attributes
+        {
+          id: "#{dom_id}_table_body",
+          class: tokens("phlexi_table_body", themed(:body))
+        }
+      end
+
+      # Get the attributes for a table body row element
+      #
+      # @param wrapped_object [Object] The current item from the collection
+      # @return [Hash] The body row attributes
+      def table_body_row_attributes(wrapped_object)
+        {
+          id: "#{dom_id}_table_row_#{wrapped_object.identifier}",
+          class: tokens("phlexi_table_body_row", themed(:body_row))
+        }
       end
 
-      def default_builder_klass
-        self.class::FieldBuilder
+      # Get the attributes for a table body cell element
+      #
+      # @param wrapped_object [Object] The current item from the collection
+      # @param column [Columns::Base] The column object
+      # @return [Hash] The body cell attributes
+      def table_data_cell_attributes(wrapped_object, column)
+        mix(
+          {
+            id: "#{dom_id}_table_row_#{wrapped_object.identifier}_#{column.key}",
+            class: tokens("phlexi_table_data_cell", themed(:body_cell))
+          },
+          column.data_cell_attributes(wrapped_object)
+        )
+      end
+
+      # Get the attributes for the table footer element
+      #
+      # @return [Hash] The footer attributes
+      def table_footer_attributes
+        {
+          id: "#{dom_id}_table_footer",
+          class: tokens("phlexi_table_footer", themed(:footer))
+        }
+      end
+
+      def initialize_key
+        # always pop these keys
+        # add support for `as` to make it more rails friendly
+        @key = options.delete(:key) || options.delete(:as)
+        if @key.nil?
+          @key = if sample.respond_to?(:model_name) && sample.model_name.respond_to?(:param_key) && sample.model_name.param_key.present?
+            sample.model_name.plural.underscore
+          else
+            sample.class.name.demodulize.pluralize.underscore
+          end
+        end
+        @key = @key.to_sym
       end
     end
   end

data/lib/phlexi/table/components/actions_column.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class ActionsColumn < Base
+        include Phlexi::Table::Components::Concerns::DisplaysHeader
+
+        def initialize(*, **, &block)
+          raise ArgumentError, "block is required" unless block.present?
+
+          super(*, **)
+          @block = block
+        end
+
+        def label(label = nil)
+          if label.nil?
+            options[:label]
+          else
+            options[:label] = label
+            self
+          end
+        end
+
+        def render_actions(object)
+          @block.call(object)
+        end
+
+        def dom_id
+          "#{super}_actions_cell"
+        end
+
+        def data_cell_attributes(object)
+          @attributes
+        end
+
+        def type = "actions"
+
+        def alignment = nil
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/base.rb

@@ -3,34 +3,38 @@
 module Phlexi
   module Table
     module Components
-      class Base < COMPONENT_BASE
-        attr_reader :field, :attributes
+      class Base
+        include Phlex::Helpers
+        include Phlexi::Table::HTML::Behaviour
 
-        def initialize(field, **attributes)
-          @field = field
-          @attributes = attributes
+        attr_reader :key, :parent, :options
+
+        delegate :sample, :wrapped_sample, to: :parent
+
+        def initialize(key, parent, **options)
+          @key = key
+          @parent = parent
+          @options = options
 
           build_attributes
-          append_attribute_classes
         end
 
-        protected
-
-        def build_attributes
-          attributes.fetch(:id) { attributes[:id] = "#{field.dom.id}_#{component_name}" }
+        def dom_id
+          "#{parent.dom_id}_#{key}"
         end
 
-        def append_attribute_classes
-          return if attributes[:class] == false
+        private
 
-          attributes[:class] = tokens(
-            component_name,
-            attributes[:class]
-          )
+        def build_attributes
+          @attributes = {
+            class: tokens(
+              type
+            )
+          }
         end
 
-        def component_name
-          @component_name ||= self.class.name.demodulize.underscore
+        def type
+          options[:as] || wrapped_sample.field(key).inferred_field_type
         end
       end
     end

data/lib/phlexi/table/components/column.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class Column < Base
+        include Phlexi::Table::Components::Options::Labels
+        include Phlexi::Table::Components::Options::Alignment
+        include Phlexi::Table::Components::Concerns::DisplaysHeader
+        include Phlexi::Table::Components::Concerns::DisplaysData
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/column_group.rb

@@ -0,0 +1,23 @@
+module Phlexi
+  module Table
+    module Components
+      class ColumnGroup < Base
+        include Phlexi::Table::Components::Options::Labels
+        include Phlexi::Table::Components::Concerns::DisplaysHeader
+        include Phlexi::Table::Components::Concerns::GroupsColumns
+
+        def colspan
+          @columns.size
+        end
+
+        def dom_id
+          "#{super}_header_grouping_cell"
+        end
+
+        def type = "column_group"
+
+        def alignment = nil
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/concerns/displays_data.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      module Concerns
+        module DisplaysData
+          extend ActiveSupport::Concern
+
+          def data_cell(wrapped_object)
+            raise NotImplementedError, "#{self.class} must implement #data_cell"
+          end
+
+          def data_cell_attributes(wrapped_object)
+            attributes = @attributes.dup
+            attributes[:class] = tokens(
+              attributes[:class],
+              themed(:"align_#{alignment}"),
+              themed(:"#{type}_column")
+            )
+            attributes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/concerns/displays_header.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      module Concerns
+        module DisplaysHeader
+          extend ActiveSupport::Concern
+
+          def header_cell
+            HeaderCell.new(label)
+          end
+
+          def header_cell_attributes
+            attributes = @attributes.dup
+            attributes[:id] = "#{dom_id}_header_cell"
+            attributes[:class] = tokens(
+              attributes[:class],
+              themed(:"align_#{alignment}"),
+              themed(:"#{type}_column")
+            )
+            attributes
+          end
+
+          def colspan = 1
+        end
+      end
+    end
+  end
+end