katalyst-tables 3.0.0.beta1 → 3.1.0

data/app/javascript/tables/orderable/form_controller.js

@@ -1,13 +1,15 @@
 import { Controller } from "@hotwired/stimulus";
 
 export default class OrderableFormController extends Controller {
+  static values = { scope: String };
+
   add(item) {
-    const { id_name, id_value, index_name } = item.paramsValue;
-    this.element.insertAdjacentHTML(
-      "beforeend",
-      `<input type="hidden" name="${id_name}" value="${id_value}" data-generated>
-              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`,
-    );
+    item.params(this.scopeValue).forEach(({ name, value }) => {
+      this.element.insertAdjacentHTML(
+        "beforeend",
+        `<input type="hidden" name="${name}" value="${value}" data-generated>`,
+      );
+    });
   }
 
   submit() {

data/app/javascript/tables/orderable/item_controller.js

@@ -48,6 +48,15 @@ export default class OrderableRowController extends Controller {
     this.index = index;
   }
 
+  /** Retrieve params for use in the form */
+  params(scope) {
+    const { id_name, id_value, index_name } = this.paramsValue;
+    return [
+      { name: `${scope}[${id_value}][${id_name}]`, value: this.id },
+      { name: `${scope}[${id_value}][${index_name}]`, value: this.index },
+    ];
+  }
+
   /**
    * Restore any visual changes made during drag and remove the drag state.
    */

data/app/models/concerns/katalyst/tables/collection/core.rb

@@ -18,7 +18,7 @@ module Katalyst
           def permitted_params
             _default_attributes.to_h.each_with_object([]) do |(k, v), h|
               h << case v
-                   when Array
+                   when ::Array
                      { k => [] }
                    else
                      k
@@ -39,6 +39,11 @@ module Katalyst
           clear_changes_information
         end
 
+        # Collections that do not include Sorting are never sortable.
+        def sortable?
+          false
+        end
+
         def apply(items)
           @items = items
           reducers.build do |_|

data/app/models/concerns/katalyst/tables/collection/pagination.rb

@@ -24,8 +24,8 @@ module Katalyst
           config_accessor :paginate
         end
 
-        def initialize(paginate: config.paginate, **options)
-          super(**options)
+        def initialize(paginate: config.paginate, **)
+          super(**)
 
           @paginate = paginate.freeze
         end

data/app/models/concerns/katalyst/tables/collection/sorting.rb

@@ -14,27 +14,88 @@ module Katalyst
       module Sorting
         extend ActiveSupport::Concern
 
-        included do
-          config_accessor :sorting
-          attr_accessor :sorting
+        DIRECTIONS = %w[asc desc].freeze
+
+        module SortParams
+          refine Hash do
+            def to_param
+              "#{self[:column]} #{self[:direction]}"
+            end
+          end
+
+          refine String do
+            def to_param
+              to_h.to_param
+            end
 
+            def to_h
+              column, direction = split(/[ +]/, 2)
+
+              direction = "asc" unless DIRECTIONS.include?(direction)
+              { column:, direction: }
+            end
+          end
+        end
+
+        using SortParams
+
+        included do
           attribute :sort, :string
+
+          attr_reader :default_sort
         end
 
-        def initialize(sorting: config.sorting, **options)
-          @sorting = SortForm.parse(sorting, default: sorting) if sorting
+        def initialize(sorting: config.sorting, **)
+          @default_sort = sorting.to_param if sorting.present?
+
+          super(sort: @default_sort, **) # set default sort based on config
+        end
 
-          super(sort: @sorting.to_param, **options) # set default sort based on config
+        def default_sort?
+          sort == @default_sort
         end
 
+        # Returns true if the collection supports sorting on the given column.
+        # A column supports sorting if it is a database column or if
+        # the collection responds to `order_by_#{column}(direction)`.
+        #
+        # @param column [String, Symbol]
+        # @return [true, false]
+        def sortable?(column = nil)
+          if column.nil?
+            @default_sort.present?
+          else
+            items.respond_to?(:"order_by_#{column}") || items.model.has_attribute?(column.to_s)
+          end
+        end
+
+        # Set the current sort behaviour of the collection.
+        #
+        # @param value [String, Hash] "column direction", or { column:, direction: }
         def sort=(value)
-          return unless @sorting
+          super(value.to_param) if @default_sort
+        end
+
+        # Returns the current sort behaviour of the given column, for use as a
+        # column heading class in the table view.
+        #
+        # @param column [String, Symbol] the table column as defined in table_with
+        # @return [String] the current sort behaviour of the given column
+        def sort_status(column)
+          current, direction = sort.to_h.values_at(:column, :direction)
+          direction if column.to_s == current
+        end
 
-          # update internal proxy
-          @sorting = SortForm.parse(value, default: @sorting.default)
+        # Calculates the sort parameter to apply when the given column is toggled.
+        #
+        # @param column [String, Symbol]
+        # @return [String]
+        def toggle_sort(column)
+          current, direction = sort.to_h.values_at(:column, :direction)
 
-          # update attribute based on normalized value
-          super(@sorting.to_param)
+          return "#{column} asc" unless column.to_s == current
+
+          direction == "asc" ? "#{column} desc" : "#{column} asc"
         end
 
         class Sort # :nodoc:
@@ -44,15 +105,22 @@ module Katalyst
             @app = app
           end
 
+          using SortParams
+
           def call(collection)
-            @collection                            = @app.call(collection)
-            @collection.sorting, @collection.items = @collection.sorting.apply(@collection.items) if @collection.sorting
-            @collection
-          end
+            collection = @app.call(collection)
+
+            column, direction = collection.sort.to_h.values_at(:column, :direction)
+
+            return collection if column.nil?
+
+            if collection.items.respond_to?(:"order_by_#{column}")
+              collection.items = collection.items.reorder(nil).public_send(:"order_by_#{column}", direction.to_sym)
+            elsif collection.items.model.has_attribute?(column)
+              collection.items = collection.items.reorder(column => direction)
+            end
 
-          # pagy shim
-          def params
-            @collection.attributes
+            collection
           end
         end
       end

data/app/models/katalyst/tables/collection/array.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      # Entry point for creating a collection from an array for use with table components.
+      class Array
+        include Core
+        include Filtering
+
+        def self.with_params(params)
+          new.with_params(params)
+        end
+
+        def model
+          items.first&.class || ActiveRecord::Base
+        end
+
+        def model_name
+          @model_name ||= items.first&.model_name || ActiveModel::Name.new(Object, nil, "record")
+        end
+
+        def with_params(params)
+          # test support
+          params = ActionController::Parameters.new(params) unless params.is_a?(ActionController::Parameters)
+
+          self.attributes = params.permit(self.class.permitted_params)
+
+          self
+        end
+
+        def inspect
+          "#<#{self.class.name} @attributes=#{attributes.inspect} @model_name=\"#{model_name}\" @count=#{items&.count}>"
+        end
+      end
+    end
+  end
+end

data/app/models/katalyst/tables/collection/base.rb

@@ -34,6 +34,10 @@ module Katalyst
           new.with_params(params)
         end
 
+        def model
+          items.model
+        end
+
         def model_name
           @model_name ||= items.model_name.dup.tap do |name|
             name.param_key = ""

data/app/models/katalyst/tables/collection/filter.rb

@@ -40,8 +40,8 @@ module Katalyst
 
         attr_reader :param_key
 
-        def initialize(param_key: :filters, **options)
-          super(**options)
+        def initialize(param_key: :filters, **)
+          super(**)
 
           @param_key = param_key.to_sym
         end

data/config/importmap.rb

@@ -1,2 +1,3 @@
 # frozen_string_literal: true
+
 pin "@katalyst/tables", to: "katalyst/tables.js"

data/config/locales/tables.en.yml

@@ -1,10 +1,4 @@
 en:
-  time:
-    formats:
-      table: "%e %B %Y, %l:%M%P"
-  date:
-    formats:
-      table: "%e %B %Y"
   katalyst:
     tables:
       orderable:

data/lib/katalyst/tables/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "active_support/configurable"
+
+module Katalyst
+  module Tables
+    class Config
+      include ActiveSupport::Configurable
+
+      config_accessor(:component_extensions) do
+        %w[
+          Katalyst::Tables::Identifiable
+          Katalyst::Tables::Orderable
+          Katalyst::Tables::Selectable
+          Katalyst::Tables::Sortable
+        ]
+      end
+
+      config_accessor(:date_format) { :default }
+      config_accessor(:datetime_format) { :default }
+    end
+  end
+end

data/lib/katalyst/tables.rb

@@ -3,10 +3,19 @@
 require "view_component"
 require "katalyst/html_attributes"
 
+require_relative "tables/config"
 require_relative "tables/engine"
 
 module Katalyst
   module Tables
     class Error < StandardError; end
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.configure
+      yield config
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta1
+  version: 3.1.0
 platform: ruby
 authors:
 - Katalyst Interactive
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -56,6 +56,7 @@ files:
 - app/assets/config/katalyst-tables.js
 - app/assets/stylesheets/katalyst/tables/_index.scss
 - app/assets/stylesheets/katalyst/tables/_ordinal.scss
+- app/assets/stylesheets/katalyst/tables/_summary.scss
 - app/assets/stylesheets/katalyst/tables/_table.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_boolean.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_currency.scss
@@ -63,63 +64,64 @@ files:
 - app/assets/stylesheets/katalyst/tables/typed-columns/_datetime.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_index.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_number.scss
-- app/components/concerns/katalyst/tables/body/typed_columns.rb
-- app/components/concerns/katalyst/tables/configurable_component.rb
 - app/components/concerns/katalyst/tables/has_table_content.rb
-- app/components/concerns/katalyst/tables/header/typed_columns.rb
+- app/components/concerns/katalyst/tables/identifiable.rb
 - app/components/concerns/katalyst/tables/orderable.rb
 - app/components/concerns/katalyst/tables/row_renderer.rb
 - app/components/concerns/katalyst/tables/selectable.rb
 - app/components/concerns/katalyst/tables/sortable.rb
+- app/components/katalyst/summary_table_component.html.erb
+- app/components/katalyst/summary_table_component.rb
 - app/components/katalyst/table_component.html.erb
 - app/components/katalyst/table_component.rb
-- app/components/katalyst/tables/body/attachment_component.rb
-- app/components/katalyst/tables/body/boolean_component.rb
-- app/components/katalyst/tables/body/currency_component.rb
-- app/components/katalyst/tables/body/date_component.rb
-- app/components/katalyst/tables/body/date_time_component.rb
-- app/components/katalyst/tables/body/link_component.rb
-- app/components/katalyst/tables/body/number_component.rb
-- app/components/katalyst/tables/body/rich_text_component.rb
-- app/components/katalyst/tables/body_cell_component.rb
+- app/components/katalyst/tables/body_row_component.html.erb
 - app/components/katalyst/tables/body_row_component.rb
+- app/components/katalyst/tables/cell_component.rb
+- app/components/katalyst/tables/cells/boolean_component.rb
+- app/components/katalyst/tables/cells/currency_component.rb
+- app/components/katalyst/tables/cells/date_component.rb
+- app/components/katalyst/tables/cells/date_time_component.rb
+- app/components/katalyst/tables/cells/number_component.rb
+- app/components/katalyst/tables/cells/ordinal_component.rb
+- app/components/katalyst/tables/cells/rich_text_component.rb
+- app/components/katalyst/tables/cells/select_component.rb
+- app/components/katalyst/tables/data.rb
 - app/components/katalyst/tables/empty_caption_component.html.erb
 - app/components/katalyst/tables/empty_caption_component.rb
-- app/components/katalyst/tables/header/attachment_component.rb
-- app/components/katalyst/tables/header/boolean_component.rb
-- app/components/katalyst/tables/header/currency_component.rb
-- app/components/katalyst/tables/header/date_component.rb
-- app/components/katalyst/tables/header/date_time_component.rb
-- app/components/katalyst/tables/header/link_component.rb
-- app/components/katalyst/tables/header/number_component.rb
-- app/components/katalyst/tables/header/rich_text_component.rb
-- app/components/katalyst/tables/header_cell_component.rb
+- app/components/katalyst/tables/header_row_component.html.erb
 - app/components/katalyst/tables/header_row_component.rb
+- app/components/katalyst/tables/label.rb
+- app/components/katalyst/tables/orderable/form_component.rb
 - app/components/katalyst/tables/pagy_nav_component.rb
 - app/components/katalyst/tables/selectable/form_component.html.erb
 - app/components/katalyst/tables/selectable/form_component.rb
+- app/components/katalyst/tables/summary/body_component.html.erb
+- app/components/katalyst/tables/summary/body_component.rb
+- app/components/katalyst/tables/summary/header_component.html.erb
+- app/components/katalyst/tables/summary/header_component.rb
+- app/components/katalyst/tables/summary/row_component.html.erb
+- app/components/katalyst/tables/summary/row_component.rb
 - app/controllers/concerns/katalyst/tables/backend.rb
 - app/helpers/katalyst/tables/frontend.rb
-- app/helpers/katalyst/tables/frontend/helper.rb
 - app/javascript/tables/application.js
 - app/javascript/tables/orderable/form_controller.js
 - app/javascript/tables/orderable/item_controller.js
 - app/javascript/tables/orderable/list_controller.js
 - app/javascript/tables/selection/form_controller.js
 - app/javascript/tables/selection/item_controller.js
-- app/javascript/tables/turbo/collection_controller.js
 - app/models/concerns/katalyst/tables/collection/core.rb
 - app/models/concerns/katalyst/tables/collection/filtering.rb
 - app/models/concerns/katalyst/tables/collection/has_params.rb
 - app/models/concerns/katalyst/tables/collection/pagination.rb
 - app/models/concerns/katalyst/tables/collection/reducers.rb
 - app/models/concerns/katalyst/tables/collection/sorting.rb
+- app/models/katalyst/tables/collection/array.rb
 - app/models/katalyst/tables/collection/base.rb
 - app/models/katalyst/tables/collection/filter.rb
-- app/models/katalyst/tables/collection/sort_form.rb
 - config/importmap.rb
 - config/locales/tables.en.yml
 - lib/katalyst/tables.rb
+- lib/katalyst/tables/config.rb
 - lib/katalyst/tables/engine.rb
 homepage: https://github.com/katalyst/tables
 licenses:
@@ -130,7 +132,7 @@ metadata:
   homepage_uri: https://github.com/katalyst/tables
   source_code_uri: https://github.com/katalyst/tables
   changelog_uri: https://github.com/katalyst/tables/blobs/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -146,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.9
-signing_key:
+signing_key: 
 specification_version: 4
 summary: HTML table generator for Rails views
 test_files: []

data/app/components/concerns/katalyst/tables/body/typed_columns.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    module Body
-      module TypedColumns
-        extend ActiveSupport::Concern
-
-        # Generates a column from boolean values rendered as "Yes" or "No".
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param attributes [Hash] HTML attributes to be added to the cell
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @example Render a boolean column indicating whether the record is active
-        #   <% row.boolean :active %> # => <td>Yes</td>
-        def boolean(method, **attributes, &)
-          with_column(Body::BooleanComponent.new(@table, @record, method, **attributes), &)
-        end
-
-        # Generates a column from date values rendered using I18n.l.
-        # The default format is :admin, but it can be overridden.
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param format [Symbol] the I18n date format to use when rendering
-        # @param attributes [Hash] HTML attributes to be added to the cell tag
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @example Render a date column describing when the record was created
-        #   <% row.date :created_at %> # => <td>29 Feb 2024</td>
-        def date(method, format: :table, **attributes, &)
-          with_column(Body::DateComponent.new(@table, @record, method, format:, **attributes), &)
-        end
-
-        # Generates a column from datetime values rendered using I18n.l.
-        # The default format is :admin, but it can be overridden.
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param format [Symbol] the I18n datetime format to use when rendering
-        # @param attributes [Hash] HTML attributes to be added to the cell tag
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @example Render a datetime column describing when the record was created
-        #   <% row.datetime :created_at %> # => <td>29 Feb 2024, 5:00pm</td>
-        def datetime(method, format: :table, **attributes, &)
-          with_column(Body::DateTimeComponent.new(@table, @record, method, format:, **attributes), &)
-        end
-
-        # Generates a column from numeric values formatted appropriately.
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param attributes [Hash] HTML attributes to be added to the cell tag
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @example Render the number of comments on a post
-        #   <% row.number :comment_count %> # => <td>0</td>
-        def number(method, **attributes, &)
-          with_column(Body::NumberComponent.new(@table, @record, method, **attributes), &)
-        end
-
-        # Generates a column from numeric values rendered using `number_to_currency`.
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param options [Hash] options to be passed to `number_to_currency`
-        # @param attributes [Hash] HTML attributes to be added to the cell tag
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @example Render a currency column for the price of a product
-        #   <% row.currency :price %> # => <td>$3.50</td>
-        def currency(method, options: {}, **attributes, &)
-          with_column(Body::CurrencyComponent.new(@table, @record, method, options:, **attributes), &)
-        end
-
-        # Generates a column containing HTML markup.
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param attributes [Hash] HTML attributes to be added to the cell tag
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @note This method assumes that the method returns HTML-safe content.
-        #   If the content is not HTML-safe, it will be escaped.
-        #
-        # @example Render a description column containing HTML markup
-        #   <% row.rich_text :description %> # => <td><em>Emphasis</em></td>
-        def rich_text(method, **attributes, &)
-          with_column(Body::RichTextComponent.new(@table, @record, method, **attributes), &)
-        end
-
-        # Generates a column that links to the record's show page (by default).
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param link [Hash] options to be passed to the link_to helper
-        # @option opts [Hash, Array, String, Symbol] :url ([:admin, object]) options for url_for,
-        # or a symbol to be passed to the route helper
-        # @param attributes [Hash] HTML attributes to be added to the cell tag
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @example Render a column containing the record's title, linked to its show page
-        #   <% row.link :title %> # => <td><a href="/admin/post/15">About us</a></td>
-        # @example Render a column containing the record's title, linked to its edit page
-        #   <% row.link :title, url: :edit_admin_post_path do |cell| %>
-        #      Edit <%= cell %>
-        #   <% end %>
-        #   # => <td><a href="/admin/post/15/edit">Edit About us</a></td>
-        def link(method, url: @record, link: {}, **attributes, &)
-          with_column(Body::LinkComponent.new(@table, @record, method, url:, link:, **attributes), &)
-        end
-
-        # Generates a column that renders an ActiveStorage attachment as a downloadable link.
-        #
-        # @param method [Symbol] the method to call on the record
-        # @param variant [Symbol] the variant to use when rendering the image (default :thumb)
-        # @param attributes [Hash] HTML attributes to be added to the cell tag
-        # @param block [Proc] optional block to alter the cell content
-        # @return [void]
-        #
-        # @example Render a column containing a download link to the record's background image
-        #   <% row.attachment :background %> # => <td><a href="...">background.png</a></td>
-        def attachment(method, variant: :thumb, **attributes, &)
-          with_column(Body::AttachmentComponent.new(@table, @record, method, variant:, **attributes), &)
-        end
-      end
-    end
-  end
-end

data/app/components/concerns/katalyst/tables/configurable_component.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    module ConfigurableComponent # :nodoc:
-      extend ActiveSupport::Concern
-
-      include ActiveSupport::Configurable
-
-      included do
-        # Workaround: ViewComponent::Base.config is incompatible with ActiveSupport::Configurable
-        @_config = Class.new(ActiveSupport::Configurable::Configuration).new
-      end
-
-      class_methods do
-        # Define a configurable sub-component.
-        # Sub-components are cached on the table instance. We want to allow run
-        # time mixins for tables so that we can extend tables with cross-cutting
-        # concerns that affect multiple sub-components by including the concern
-        # into the top-level table class. We achieve this by subclassing the
-        # component as soon as it is created so that when a mixin is added to
-        # the table class, it can immediately retrieve and modify the
-        # sub-component class as well without needing to worry about affecting
-        # other tables.
-        def config_component(name, component_name: "#{name}_component", default: nil) # rubocop:disable Metrics/MethodLength
-          config_accessor(name)
-          config.public_send(:"#{name}=", default)
-          define_method(component_name) do
-            return instance_variable_get(:"@#{component_name}") if instance_variable_defined?(:"@#{component_name}")
-
-            klass     = config.public_send(name)
-            component = klass ? self.class.const_get(klass) : nil
-
-            # subclass to allow table-specific extensions
-            if component
-              component = Class.new(component)
-              component.extend(HiddenSubcomponent)
-            end
-
-            instance_variable_set(:"@#{component_name}", component) if component
-          end
-        end
-      end
-
-      # View Component uses `name` to resolve the template path, so we need to
-      # hide the subclass from the template resolver.
-      module HiddenSubcomponent
-        delegate :name, to: :superclass
-      end
-    end
-  end
-end