katalyst-tables 2.0.0 → 2.1.1

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      # Entry point for creating a collection for use with table components.
+      # This class is intended to be subclassed, i.e.:
+      #
+      # class ApplicationController < ActionController::Base
+      #   class Collection < Katalyst::Tables::Collection::Base
+      #     ...
+      #   end
+      # end
+      #
+      # In the context of a controller action, construct a collection, apply it
+      # to a model, then pass the result to the view component:
+      # ```
+      # collection = Collection.new.with_params(params).apply(People.all)
+      # table = Katalyst::TableComponent.new(collection: collection)
+      # render table
+      # ````
+      class Base
+        include Core
+        include Pagination
+        include Sorting
+
+        use(Sorting::Sort)
+        use(Pagination::Paginate)
+      end
+    end
+  end
+end

data/config/importmap.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
+
+pin_all_from Katalyst::Tables::Engine.root.join("app/assets/javascripts"),
+             # preload in tests so that we don't start clicking before controllers load
+             preload: Rails.env.test?

data/lib/katalyst/tables/backend/sort_form.rb

@@ -8,11 +8,25 @@ module Katalyst
       class SortForm
         DIRECTIONS = %w[asc desc].freeze
 
-        attr_accessor :column, :direction
+        attr_accessor :column, :direction, :default
 
-        def initialize(column: nil, direction: nil)
+        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?
+
+          SortForm.new(column: column, direction: direction, default: default)
+        end
+
+        def initialize(column: nil, direction: nil, default: nil)
           self.column    = column
           self.direction = direction
+          self.default   = default
+        end
+
+        def to_param
+          "#{column} #{direction}"
         end
 
         # Returns true if the given collection supports sorting on the given

data/lib/katalyst/tables/engine.rb

@@ -6,6 +6,19 @@ module Katalyst
   module Tables
     class Engine < ::Rails::Engine # :nodoc:
       isolate_namespace Katalyst::Tables
+
+      initializer "katalyst-tables.asset" do
+        config.after_initialize do |app|
+          app.config.assets.precompile += %w[katalyst-tables.js] if app.config.respond_to?(:assets)
+        end
+      end
+
+      initializer "katalyst-tables.importmap", before: "importmap" do |app|
+        if app.config.respond_to?(:importmap)
+          app.config.importmap.paths << root.join("config/importmap.rb")
+          app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+        end
+      end
     end
   end
 end

data/lib/katalyst/tables/frontend/helper.rb

@@ -3,30 +3,20 @@
 module Katalyst
   module Tables
     module Frontend
+      # @deprecated Use {Katalyst::TableComponent} instead.
       module Helper # :nodoc:
         extend ActiveSupport::Concern
 
-        def initialize(**options)
-          super()
-
-          options(**options)
-        end
-
-        # Add HTML options to the current component.
-        def options(html: {}, **options)
-          @html_options = options.slice(:id, :aria, :class, :data).merge(html)
-          @html_options.stringify_keys!
-        end
-
         # Generates a url for applying/toggling sort for the given column.
         #
         # @param sort [String, nil] sort parameter to apply, or nil to remove sorting
         # @return [String] URL for toggling column sorting
-        def sort_url_for(sort: nil)
+        # @deprecated Use {Katalyst::TablesComponent} instead.
+        def sort_url_for(sort: nil, default: nil)
           # Implementation inspired by pagy's `pagy_url_for` helper.
           # Preserve any existing GET parameters
           # CAUTION: these parameters are not sanitised
-          params = if sort
+          params = if sort && !sort.eql?(default)
                      request.GET.merge("sort" => sort).except("page")
                    else
                      request.GET.except("page", "sort")

data/lib/katalyst/tables/version.rb

@@ -2,6 +2,6 @@
 
 module Katalyst
   module Tables
-    VERSION = "2.0.0"
+    VERSION = "2.1.1"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-20 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-attributes-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -35,11 +49,29 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- app/assets/config/katalyst-tables.js
+- app/assets/javascripts/controllers/tables/turbo_collection_controller.js
+- app/components/concerns/katalyst/tables/configurable_component.rb
+- app/components/concerns/katalyst/tables/has_html_attributes.rb
+- app/components/concerns/katalyst/tables/has_table_content.rb
+- app/components/concerns/katalyst/tables/sortable.rb
+- app/components/concerns/katalyst/tables/turbo_replaceable.rb
 - app/components/katalyst/table_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_cell_component.rb
 - app/components/katalyst/tables/header_row_component.rb
+- app/components/katalyst/tables/pagy_nav_component.rb
+- app/components/katalyst/turbo/pagy_nav_component.rb
+- app/components/katalyst/turbo/table_component.rb
+- app/models/concerns/katalyst/tables/collection/core.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.rb
+- config/importmap.rb
 - lib/katalyst/tables.rb
 - lib/katalyst/tables/backend.rb
 - lib/katalyst/tables/backend/sort_form.rb