katalyst-tables 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cda2701479ecd72f9964ab539c5203bd0c300aeb962cf926552904575474ddea
-  data.tar.gz: 6f43fc5e31c8536811e28cba0db4be3c0967db24d06ad22f2a72c89512030d87
+  metadata.gz: 196a8b7ff382215cbb156ff83099071aa983176353f819f5031aac774a88a572
+  data.tar.gz: 3d7463ccb20935e52500f186fb7c4024f3c8c236bfb9338a331a0830bf58edb5
 SHA512:
-  metadata.gz: 14acdb5b09216c84c06b2082ed2a11888f0930b1807f7ade14cbc7fa02751f3c888a69b5397df7eb028395b7902eaad47abaa710e33fa24ecc6d6ed98757616f
-  data.tar.gz: f3721287c65a5aa0d4e81c36d5f704b90e2995cf372376ba19c9b03cb5b0129a5f4c8a56b369a09b2c62e72eb585163d656abb303a8dd62aa8b7912193f710b5
+  metadata.gz: 325bfa1b161fa322acd419279a57ddb644f5a3e0289ca42294c9936fe7ea6fcded6f1d077f8866b5b70408d7d495c8dabe4733ba83a1f7652c4eb02115bc5438
+  data.tar.gz: 1382995a15fdc57829232223d67d20a691b9f5b908f4059c7b41dcfdb9396ce1d90f3431417ceb2b88a10eca880939608b20ec19dc421288f25b8c6bfad0c58c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [3.1.0]
+- Introduce summary tables
+- Update ruby requirement >= 3.3
+
 ## [3.0.0]
 
 - Breaking change: remove Turbo Streams from table and pagination components,

data/README.md

@@ -32,10 +32,11 @@ application.load(tables);
 ## Usage
 
 This gem provides entry points for backend and frontend concerns:
-* `Katalyst::TableComponent` can be used render encapsulated tables.
-* `Katalyst::Tables::Frontend` provides `table_with` for inline table generation
+* `Katalyst::TableComponent` can be used render encapsulated tables,
+* `Katalyst::SummaryTableComponent` can be used render a record using the table syntax,
+* `Katalyst::Tables::Frontend` provides `table_with` for inline table generation,
 * `Katalyst::Tables::Collection::Base` provides a default entry point for
-  building collections in your controller actions.
+  building collections in your controller actions
 
 ### Frontend
 
@@ -205,6 +206,17 @@ detect features such as sorting and generate the appropriate table header links.
 <%= table_with(collection:) %>
 ```
 
+## Summary tables
+You can use the `Katalyst::SummaryTableComponent` to render a single record utilizing all the functionality from the 
+`Katalyst::TableComponent`. 
+
+```erb
+<%= summary_table_with model: @person do |row| %>
+  <% row.text :name %>
+  <% row.text :email %>
+<% end %>
+```
+
 ## Extensions
 
 The following extensions are available and activated by default:

data/app/assets/stylesheets/katalyst/tables/_index.scss

@@ -1 +1,2 @@
 @use "table";
+@use "summary";

data/app/assets/stylesheets/katalyst/tables/_summary.scss

@@ -0,0 +1,14 @@
+table.summary-table {
+  width: unset;
+  border-top: 1px solid var(--row-border-color);
+
+  th {
+    min-width: 12rem;
+  }
+
+  th,
+  td {
+    vertical-align: baseline;
+    text-align: left;
+  }
+}

data/app/assets/stylesheets/katalyst/tables/typed-columns/_boolean.scss

@@ -1,4 +1,4 @@
 // where psuedo selector has a specificity of 0 so it can be easily overwritten with simple selectors
-:where(th.type-boolean) {
+:where(th.type-boolean, td.type-boolean) {
   width: var(--width-small);
 }

data/app/assets/stylesheets/katalyst/tables/typed-columns/_currency.scss

@@ -1,5 +1,8 @@
 // where psuedo selector has a specificity of 0 so it can be easily overwritten with simple selectors
 :where(th.type-currency, td.type-currency) {
   width: var(--width-small);
+}
+
+:where(thead th.type-currency, td.type-currency) {
   text-align: right;
 }

data/app/assets/stylesheets/katalyst/tables/typed-columns/_date.scss

@@ -1,4 +1,4 @@
 // where psuedo selector has a specificity of 0 so it can be easily overwritten with simple selectors
-:where(th.type-date) {
+:where(th.type-date, td.type-date) {
   width: var(--width-medium);
 }

data/app/assets/stylesheets/katalyst/tables/typed-columns/_datetime.scss

@@ -1,4 +1,4 @@
 // where psuedo selector has a specificity of 0 so it can be easily overwritten with simple selectors
-:where(th.type-datetime) {
+:where(th.type-datetime, td.type-date) {
   width: var(--width-medium);
 }

data/app/assets/stylesheets/katalyst/tables/typed-columns/_number.scss

@@ -1,5 +1,8 @@
 // where psuedo selector has a specificity of 0 so it can be easily overwritten with simple selectors
 :where(th.type-number, td.type-number) {
   width: var(--width-small);
+}
+
+:where(thead th.type-number, td.type-number) {
   text-align: right;
 }

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

@@ -5,8 +5,8 @@ module Katalyst
     module HasTableContent # :nodoc:
       extend ActiveSupport::Concern
 
-      def initialize(object_name: nil, partial: nil, as: nil, **options)
-        super(**options)
+      def initialize(object_name: nil, partial: nil, as: nil, **)
+        super(**)
 
         @object_name = object_name || model_name&.i18n_key
         @partial     = partial

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

@@ -50,7 +50,7 @@ module Katalyst
       def render_partial_template(view, locals, template, layout, block)
         locals[@local_name || template.variable] = @object
         locals[:row]                             = @row
-        super(view, locals, template, layout, block)
+        super
       end
     end
   end

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

@@ -8,7 +8,7 @@ module Katalyst
       extend ActiveSupport::Concern
 
       def initialize(**)
-        super(**)
+        super
 
         @header_row_cell_callbacks << method(:add_sorting_to_cell) if collection.sortable?
       end

data/app/components/katalyst/summary_table_component.html.erb

@@ -0,0 +1,15 @@
+<%# Simulating a normal table render for the side effects %>
+<% capture do %>
+  <%= header_row %>
+  <% body_rows.each do |body| %>
+    <%= body %>
+  <% end %>
+<% end %>
+
+<%= tag.table(**html_attributes) do %>
+  <%= tag.tbody(**tbody_attributes) do %>
+    <% summary_rows.each do |summary_row| %>
+      <%= summary_row %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/katalyst/summary_table_component.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Katalyst
+  # A component for rendering a summary table for a model.
+  # @example
+  #    <%= Katalyst::SummaryTableComponent.new(model: @person) do |row, person| %>
+  #      <%= row.text :name do |cell| %>
+  #        <%= link_to cell.value, person %>
+  #      <% end %>
+  #      <%= row.text :email %>
+  #    <% end %>
+  # Generates:
+  #     <table>
+  #       <tr><th>Name</th><td><a href="/people/1">Aaron</a></td></tr>
+  #       <tr><th>Email</th><td>aaron@example.com</td></tr>
+  #     </table>
+  class SummaryTableComponent < TableComponent
+    renders_many :summary_rows, Tables::Summary::RowComponent
+
+    def initialize(model:, **)
+      super(collection: [model], **)
+
+      @summary_rows = []
+
+      update_html_attributes(class: "summary-table")
+    end
+
+    def with_cell(cell, &)
+      if row.header?
+        @summary_rows << with_summary_row do |row|
+          row.with_header do |header|
+            header.with_cell(cell)
+          end
+        end
+        @index = 0
+      else
+        @summary_rows[@index].with_body do |body|
+          body.with_cell(cell, &)
+        end
+        @index += 1
+      end
+    end
+  end
+end

data/app/components/katalyst/tables/summary/body_component.html.erb

@@ -0,0 +1,3 @@
+<% cells.each do |cell| %>
+  <%= cell %>
+<% end %>

data/app/components/katalyst/tables/summary/body_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Summary
+      class BodyComponent < Katalyst::Tables::BodyRowComponent
+      end
+    end
+  end
+end

data/app/components/katalyst/tables/summary/header_component.html.erb

@@ -0,0 +1,3 @@
+<% cells.each do |cell| %>
+  <%= cell %>
+<% end %>

data/app/components/katalyst/tables/summary/header_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Summary
+      class HeaderComponent < Katalyst::Tables::HeaderRowComponent
+      end
+    end
+  end
+end

data/app/components/katalyst/tables/summary/row_component.html.erb

@@ -0,0 +1,4 @@
+<tr>
+  <%= header %>
+  <%= body %>
+</tr>

data/app/components/katalyst/tables/summary/row_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Summary
+      class RowComponent < ViewComponent::Base
+        renders_one :header, Summary::HeaderComponent
+        renders_one :body, Summary::BodyComponent
+      end
+    end
+  end
+end

data/app/controllers/concerns/katalyst/tables/backend.rb

@@ -8,6 +8,7 @@ module Katalyst
 
       included do
         class_attribute :_default_table_component, instance_accessor: false
+        class_attribute :_default_summary_table_component, instance_accessor: false
       end
 
       class_methods do
@@ -18,12 +19,26 @@ module Katalyst
         def default_table_component(component)
           self._default_table_component = component
         end
+
+        # Set the summary table component to be used as the default for all
+        # summary tables in the views rendered by this controller and its
+        # subclasses.
+        #
+        # @param component [Class] the summary table component class to use
+        def default_summary_table_component(component)
+          self._default_summary_table_component = component
+        end
       end
 
       # Default table component for this controller
       def default_table_component
         self.class._default_table_component
       end
+
+      # Default summary table component for this controller
+      def default_summary_table_component
+        self.class._default_summary_table_component
+      end
     end
   end
 end

data/app/helpers/katalyst/tables/frontend.rb

@@ -55,12 +55,31 @@ module Katalyst
         render(Selectable::FormComponent.new(collection:, id:, primary_key:), &)
       end
 
+      # Construct a new summary table component.
+      #
+      # @param model [ActiveRecord::Base] subject for the table
+      #
+      # Blocks will receive the table in row-rendering mode (with row and record defined):
+      # @yieldparam [Katalyst::TableComponent] the table component to render rows
+      # @yieldparam [nil, Object] nil for the header column, or the given model for the value column
+      def summary_table_with(model:, **, &)
+        component ||= default_summary_table_component_class
+        component = component.new(model:, **)
+
+        render(component, &)
+      end
+
       private
 
       def default_table_component_class
         component = controller.try(:default_table_component) || TableComponent
         component.respond_to?(:constantize) ? component.constantize : component
       end
+
+      def default_summary_table_component_class
+        component = controller.try(:default_summary_table_component) || SummaryTableComponent
+        component.respond_to?(:constantize) ? component.constantize : component
+      end
     end
   end
 end

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

@@ -45,10 +45,10 @@ module Katalyst
           attr_reader :default_sort
         end
 
-        def initialize(sorting: config.sorting, **options)
+        def initialize(sorting: config.sorting, **)
           @default_sort = sorting.to_param if sorting.present?
 
-          super(sort: @default_sort, **options) # set default sort based on config
+          super(sort: @default_sort, **) # set default sort based on config
         end
 
         def default_sort?

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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-14 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
@@ -69,6 +70,8 @@ files:
 - 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_row_component.html.erb
@@ -92,6 +95,12 @@ files:
 - 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/javascript/tables/application.js
@@ -131,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:
   - - ">="