activeadmin_table_footer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fa5ab83f8cc3ef9268b501ee4fd09d7fb3d1b6cab32b83dccc80a888bdec44e
+  data.tar.gz: 506c5310ec7706b0314641334ab4558b92a2cdcd37e9d861fb6b6ee17adf1c73
+SHA512:
+  metadata.gz: c415a857de380ae03c0f90f3d0d47ecfb2b55fa7e8569f009bc6f4b550127ac11b3a39911e8f785738d03227abaeed6d614be605acd28b04d4cc2d0bc926c946
+  data.tar.gz: 9498192db2a62f42d2f52f9e68a6e2aa038d4c2c9e5448e450128c4c4cb43cfecaa5ed4dab29c9dabf039c375ab9bb46ef58c295adb7bd5c7a9104dafb075653

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Igor Fedoronchuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# activeadmin_table_footer
+
+![CI](https://github.com/activeadmin-plugins/activeadmin_table_footer/workflows/CI/badge.svg)
+![Coverage](https://img.shields.io/endpoint?url=https://activeadmin-plugins.github.io/activeadmin_table_footer/badge.json)
+![Ruby](https://img.shields.io/badge/ruby-3.3%2B-blue)
+
+Adds a `<tfoot>` row to ActiveAdmin index tables. Totals are aggregated
+across **all pages** of the filtered scope — not just the visible one — in a
+single SQL query when you use `footer_data:`.
+
+Works with **ActiveAdmin 3.5+ and 4.x**.
+
+### ActiveAdmin 4
+
+![Subscriptions index with footer totals on AA 4](https://github.com/activeadmin-plugins/activeadmin_table_footer/releases/download/assets-v1/subscriptions_with_footer_4_0.png)
+
+### ActiveAdmin 3
+
+![Subscriptions index with footer totals on AA 3.5](https://github.com/activeadmin-plugins/activeadmin_table_footer/releases/download/assets-v1/subscriptions_with_footer_3_5.png)
+
+The page shows 30 rows, but the footer row reports the sum across all 42
+subscriptions — that's the point.
+
+## Install
+
+```ruby
+# Gemfile
+gem "activeadmin_table_footer"
+```
+
+## Usage
+
+```ruby
+ActiveAdmin.register Subscription do
+  index footer_data: ->(collection) {
+          totals = collection.joins(:plan).pick(
+            Arel.sql("COALESCE(SUM(seats), 0)"),
+            Arel.sql("COALESCE(SUM(seats * plans.monthly_price), 0)")
+          )
+          { total_seats: totals[0], total_cost: totals[1] }
+        } do
+    column :customer
+    column :plan
+    column :is_operator, footer: -> { strong { "Total (all pages)" } }
+    column "Seats",      footer: -> { strong { footer_data[:total_seats].to_s } }, &:seats
+    column :total_cost,  footer: -> { strong { number_to_currency(footer_data[:total_cost]) } } do |row|
+      number_to_currency row.total_cost
+    end
+  end
+end
+```
+
+The `footer_data:` Proc runs once over the filtered scope (LIMIT/OFFSET/ORDER
+are stripped automatically). The result is exposed inside each
+`column …, footer: …` Proc via `footer_data`.
+
+`footer:` accepts a string, a symbol (`:sum`, `:count`, `:average`,
+`:minimum`, `:maximum`), or a Proc — Procs run inside the table view, so view
+helpers (`number_to_currency`, `link_to`) and Arbre tags (`strong`, `span`)
+work as expected.
+
+## License
+
+MIT

data/lib/activeadmin_table_footer/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+
+module ActiveadminTableFooter
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      require "activeadmin_table_footer/table_for_extension"
+      require "activeadmin_table_footer/index_as_table_extension"
+
+      ActiveAdmin::Views::TableFor.prepend(ActiveadminTableFooter::TableForExtension)
+      ActiveAdmin::Views::IndexAsTable.prepend(ActiveadminTableFooter::IndexAsTableExtension)
+    end
+  end
+end

data/lib/activeadmin_table_footer/index_as_table_extension.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveadminTableFooter
+  # IndexAsTable#build constructs its own table_options hash and does not pass
+  # unknown options through. We wrap the user block so the TableFor instance
+  # receives @footer_data_proc before columns are evaluated.
+  module IndexAsTableExtension
+    def build(page_presenter, collection)
+      footer_proc = page_presenter[:footer_data]
+
+      if footer_proc && page_presenter.block
+        original_block = page_presenter.block
+        wrapped = lambda do |table|
+          table.instance_variable_set(:@footer_data_proc, footer_proc)
+          instance_exec(table, &original_block)
+        end
+        page_presenter.instance_variable_set(:@block, wrapped)
+      end
+
+      super
+    end
+  end
+end

data/lib/activeadmin_table_footer/styles.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveadminTableFooter
+  module Styles
+    TAILWIND_TH = "px-3 py-2 bg-gray-50 dark:bg-gray-800/50 font-semibold border-t border-gray-200 dark:border-gray-700 text-left"
+
+    module_function
+
+    def aa_v4?
+      Gem::Version.new(ActiveAdmin::VERSION) >= Gem::Version.new("4.0.0.beta1")
+    end
+
+    def footer_th_class
+      aa_v4? ? TAILWIND_TH : ""
+    end
+
+    def footer_tr_class
+      aa_v4? ? "" : "footer"
+    end
+  end
+end

data/lib/activeadmin_table_footer/table_for_extension.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module ActiveadminTableFooter
+  module TableForExtension
+    def build(obj, *attrs)
+      options = attrs.extract_options!
+      @footer_data_proc = options.delete(:footer_data)
+      super(obj, *attrs, options)
+    end
+
+    def footer_data
+      return @footer_data if defined?(@footer_data)
+      return (@footer_data = nil) unless @footer_data_proc
+      @footer_data = @footer_data_proc.call(unscoped_collection_for_footer)
+    end
+
+    # The collection AA passes us is the paginated + ordered slice. Aggregates
+    # over "all rows" need the underlying relation without LIMIT/OFFSET/ORDER —
+    # otherwise SUM/COUNT on page 2 would only see the page-2 slice and ORDER
+    # confuses some aggregate queries.
+    def unscoped_collection_for_footer
+      return @collection unless @collection.respond_to?(:except)
+      @collection.except(:limit, :offset, :order)
+    end
+
+    def column(*args, &block)
+      super
+      col = @columns.last
+
+      if @aatf_footer_row
+        # Tfoot already exists — every subsequent column gets a cell
+        # (with content if it has :footer, empty otherwise) so columns align.
+        build_footer_cell_for(col)
+      elsif column_has_footer?(col)
+        # First column with :footer — open tfoot and back-fill empty cells
+        # for all previously-added columns so the row aligns with headers.
+        ensure_tfoot!
+        @columns[0...-1].each { |prior| build_footer_cell_for(prior) }
+        build_footer_cell_for(col)
+      end
+    end
+
+    private
+
+    def column_has_footer?(col)
+      col.instance_variable_get(:@options).key?(:footer)
+    end
+
+    def build_footer_cell_for(col)
+      within @aatf_footer_row do
+        column_key = column_key_for(col)
+        # Always include `col col-<key>` so capybara_active_admin matchers
+        # (`have_table_cell(column: ...)`) work in both AA 3 and AA 4 — the
+        # selector convention is `td.col.col-<key>`.
+        compat_classes = column_key ? "col col-#{column_key}" : "col"
+        classes = [col.html_class, compat_classes, ActiveadminTableFooter.footer_th_class]
+                    .reject { |c| c.nil? || c.to_s.empty? }
+                    .join(" ")
+        attrs = { class: classes.empty? ? nil : classes }
+        attrs[:"data-column"] = column_key if column_key
+        td(**attrs) do
+          render_footer_value(col) if column_has_footer?(col)
+        end
+      end
+    end
+
+    def column_key_for(col)
+      # AA 4 exposes Column#title_id; AA 3 does not — derive from title.
+      if col.respond_to?(:title_id) && col.title_id.respond_to?(:presence)
+        return col.title_id.presence
+      end
+      title = col.title.to_s
+      return nil if title.empty?
+      title.parameterize(separator: "_")
+    end
+
+    def ensure_tfoot!
+      return if @aatf_footer_row
+      tfoot_classes = ActiveadminTableFooter.footer_tr_class
+      tfoot do
+        @aatf_footer_row = tr(class: tfoot_classes.presence)
+      end
+    end
+
+    def render_footer_value(col)
+      footer = col.instance_variable_get(:@options)[:footer]
+      case footer
+      when nil
+        nil
+      when Symbol
+        text_node aggregate_collection(footer, col.data).to_s
+      when Proc
+        arg = unscoped_collection_for_footer
+        result = footer.arity == 0 ? instance_exec(&footer) : instance_exec(arg, &footer)
+        text_node(result.to_s) unless result.is_a?(Arbre::Element)
+      else
+        text_node footer.to_s
+      end
+    end
+
+    # Symbol footer (`:sum`, `:count`, ...) works for both AR relations and
+    # plain Arrays. AR uses native SQL aggregates; Arrays fall back to
+    # in-Ruby Enumerable equivalents.
+    def aggregate_collection(method, attribute)
+      scope = unscoped_collection_for_footer
+      if ar_relation?(scope)
+        scope.public_send(method, attribute)
+      else
+        values = Array(scope).map { |r| r.public_send(attribute) }.compact
+        case method
+        when :sum     then values.sum
+        when :count   then values.size
+        when :average then values.empty? ? 0 : values.sum.to_f / values.size
+        when :minimum then values.min
+        when :maximum then values.max
+        else scope.public_send(method, attribute)
+        end
+      end
+    end
+
+    def ar_relation?(scope)
+      defined?(ActiveRecord::Relation) && scope.is_a?(ActiveRecord::Relation)
+    end
+  end
+end

data/lib/activeadmin_table_footer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveadminTableFooter
+  VERSION = "1.0.0"
+end

data/lib/activeadmin_table_footer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "activeadmin_table_footer/version"
+require "activeadmin_table_footer/styles"
+
+module ActiveadminTableFooter
+  class << self
+    attr_writer :footer_th_class, :footer_tr_class
+
+    def footer_th_class
+      @footer_th_class || Styles.footer_th_class
+    end
+
+    def footer_tr_class
+      @footer_tr_class || Styles.footer_tr_class
+    end
+
+    def configure
+      yield self
+    end
+  end
+end
+
+require "activeadmin_table_footer/engine" if defined?(Rails)

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin_table_footer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Igor Fedoronchuk
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: arbre
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Adds a `footer:` option to columns and a top-level `footer_data:` proc
+  so index tables can render a <tfoot> with aggregated values in a single SQL query.
+email:
+- fedoronchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/activeadmin_table_footer.rb
+- lib/activeadmin_table_footer/engine.rb
+- lib/activeadmin_table_footer/index_as_table_extension.rb
+- lib/activeadmin_table_footer/styles.rb
+- lib/activeadmin_table_footer/table_for_extension.rb
+- lib/activeadmin_table_footer/version.rb
+homepage: https://github.com/activeadmin-plugins/activeadmin_table_footer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/activeadmin-plugins/activeadmin_table_footer
+  source_code_uri: https://github.com/activeadmin-plugins/activeadmin_table_footer
+  changelog_uri: https://github.com/activeadmin-plugins/activeadmin_table_footer/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Table footer DSL for ActiveAdmin index tables
+test_files: []