katalyst-tables 2.6.0.beta → 3.0.0.beta1

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

@@ -10,25 +10,43 @@ module Katalyst
 
         attr_accessor :column, :direction, :default
 
-        def self.parse(param, default: nil)
-          column, direction = param.to_s.split
-          direction         = "asc" unless DIRECTIONS.include?(direction)
-
-          default = SortForm.parse(default).to_param if default.present?
+        def self.normalize(param)
+          new(param:).to_param
+        end
 
-          SortForm.new(column: column, direction: direction, default: default)
+        def self.parse(param, **args)
+          new(param:, **args)
         end
 
-        def initialize(column: nil, direction: nil, default: nil)
+        def initialize(param: nil, column: nil, direction: nil, default: nil)
+          if param.present?
+            column, direction = param.to_s.split
+            direction         = "asc" unless DIRECTIONS.include?(direction)
+          end
+
           self.column    = column
           self.direction = direction
-          self.default   = default
+          self.default   = SortForm.normalize(default) if default
         end
 
         def to_param
           "#{column} #{direction}"
         end
 
+        def default?
+          to_param == default.to_param
+        end
+
+        def hash
+          to_param.hash
+        end
+
+        def eql?(other)
+          to_param == other.to_param
+        end
+
+        alias to_s to_param
+
         # Returns true if the given 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)`.

data/config/locales/tables.en.yml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 2.6.0.beta
+  version: 3.0.0.beta1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -54,26 +54,50 @@ files:
 - app/assets/builds/katalyst/tables.min.js
 - app/assets/builds/katalyst/tables.min.js.map
 - 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/_table.scss
+- app/assets/stylesheets/katalyst/tables/typed-columns/_boolean.scss
+- app/assets/stylesheets/katalyst/tables/typed-columns/_currency.scss
+- app/assets/stylesheets/katalyst/tables/typed-columns/_date.scss
+- 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/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/concerns/katalyst/tables/turbo_replaceable.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.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.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/turbo/pagy_nav_component.rb
-- app/components/katalyst/turbo/table_component.rb
 - app/controllers/concerns/katalyst/tables/backend.rb
 - app/helpers/katalyst/tables/frontend.rb
 - app/helpers/katalyst/tables/frontend/helper.rb
@@ -114,14 +138,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: HTML table generator for Rails views

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

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    # Adds support for turbo stream replacement to ViewComponents. Components
-    # that are rendered from a turbo-stream-compatible response will be rendered
-    # using turbo stream replacement. Components must define `id`.
-    #
-    # Turbo stream replacement rendering will only be enabled if the component
-    # passes `turbo: true` as a constructor option.
-    module TurboReplaceable
-      extend ActiveSupport::Concern
-
-      include ::Turbo::StreamsHelper
-
-      # Is turbo rendering enabled for this component?
-      def turbo?
-        @turbo
-      end
-
-      # Are we rendering a turbo stream response?
-      def turbo_stream_response?
-        response.media_type.eql?("text/vnd.turbo-stream.html")
-      end
-
-      def initialize(turbo: true, **options)
-        super(**options)
-
-        @turbo = turbo
-      end
-
-      class_methods do
-        # Redefine the compiler to use our custom compiler.
-        # Compiler is set on `inherited` so we need to re-set it if it's not the expected type.
-        def compiler
-          @vc_compiler = @vc_compiler.is_a?(TurboCompiler) ? @vc_compiler : TurboCompiler.new(self)
-        end
-      end
-
-      included do
-        # ensure that our custom compiler is used, as `inherited` calls `compile` before our module is included.
-        compile(force: true) if compiled?
-      end
-
-      # Wraps the default compiler provided by ViewComponent to add turbo support.
-      class TurboCompiler < ViewComponent::Compiler
-        private
-
-        def define_render_template_for # rubocop:disable Metrics/MethodLength
-          super
-
-          redefinition_lock.synchronize do
-            # Capture the instance method added by the default compiler and
-            # wrap it in a turbo stream replacement. Take care to ensure that
-            # subclasses of this component don't break delegation, as each
-            # subclass of ViewComponent::Base defines its own version of this
-            # method.
-            vc_render_template = component_class.instance_method(:render_template_for)
-            component_class.define_method(:render_template_for) do |variant = nil|
-              # VC discards the output from this method and uses the buffer
-              # if both are set. Capture and wrap the output.
-              content = capture { vc_render_template.bind_call(self, variant) }
-              # In turbo mode, replace the inner-most element using a turbo
-              # stream. Note that we only want one turbo stream per component
-              # from this mechanism, as subclasses may want to concat their
-              # own additional streams.
-              if turbo? && turbo_stream_response? && !@streamed
-                @streamed = true
-                concat(turbo_stream.replace(id, content))
-              else
-                concat(content)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/turbo/pagy_nav_component.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Turbo
-    class PagyNavComponent < Tables::PagyNavComponent # :nodoc:
-      include Tables::TurboReplaceable
-
-      def initialize(id:, **options)
-        super(pagy_id: id, **options)
-      end
-
-      def id
-        pagy_options[:pagy_id]
-      end
-
-      private
-
-      def pagy_options
-        super.merge(link_extra: "data-turbo-stream")
-      end
-    end
-  end
-end

data/app/components/katalyst/turbo/table_component.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Turbo
-    # Renders a table that uses turbo stream replacement when sorting or
-    # paginating.
-    class TableComponent < ::Katalyst::TableComponent
-      include Tables::TurboReplaceable
-
-      attr_reader :id
-
-      def initialize(collection:, id:, header: true, **options)
-        header = if header.is_a?(Hash)
-                   default_header_options.merge(header)
-                 elsif header
-                   default_header_options
-                 end
-
-        @id = id
-
-        super(collection: collection, header: header, id: id, **options)
-      end
-
-      private
-
-      def default_html_attributes
-        {
-          data: {
-            controller:                            "tables--turbo--collection",
-            tables__turbo__collection_query_value: current_query,
-            tables__turbo__collection_sort_value:  collection.sort,
-          },
-        }
-      end
-
-      def current_query
-        Rack::Utils.build_nested_query(collection.to_params)
-      end
-
-      def default_header_options
-        { link: { data: { turbo_stream: "" } } }
-      end
-    end
-  end
-end