Add sort_joins to column, defaults to includes value

So it's possible to set sort by SQL without joining the includes, or join with some associations, and preload others.

Author: scambra

CHANGELOG.rdoc

@@ -1,23 +1,24 @@
-- Integrate LogicalQueryParser, supporting full logical search, or simplified searches with 'all keywords' and 'any keyword' operators
-- Display unauthorized column in form as show action, so show_ui or show override is used if exists
-- Display unauthorized subform with show_ui as show action, to display readonly subform tables
-- Add subform_includes to column, and preload_for_form method to preload associations on edit action, speed up on big forms with long subforms or many nested subforms
-- Speedup on refreshing columns and saving big forms
-- Support add_new with chosen bridge
-- Added translations for millisec and microsec prompts in jquery UI datetime picker
-- Speed up validating big forms (e.g. nested subforms with many records on each subform)
-- Support hiding field descriptions by default and show them with hover or click
-- Fix for usage with frozen literal strings enabled, add magic comments to enable frozen string literals in ActiveScaffold
-- Update code for tabs to work with bootstrap 5
-- Add ActiveScaffold.setup_callbacks array, so functions can be added to be called when ActiveScaffold.setup is called (form open, page load)
-- Add add_new_link to config.nested, adding a link to create form on an association, refreshing this record instead of adding new row in the list
+- Integrate LogicalQueryParser, supporting full logical search, or simplified searches with 'all keywords' and 'any keyword' operators.
+- Display unauthorized column in form as show action, so show_ui or show override is used if exists.
+- Display unauthorized subform with show_ui as show action, to display readonly subform tables.
+- Add subform_includes to column, and preload_for_form method to preload associations on edit action, speed up on big forms with long subforms or many nested subforms.
+- Speedup on refreshing columns and saving big forms.
+- Support add_new with chosen bridge.
+- Added translations for millisec and microsec prompts in jquery UI datetime picker.
+- Speed up validating big forms (e.g. nested subforms with many records on each subform).
+- Support hiding field descriptions by default and show them with hover or click.
+- Fix for usage with frozen literal strings enabled, add magic comments to enable frozen string literals in ActiveScaffold.
+- Update code for tabs to work with bootstrap 5.
+- Add ActiveScaffold.setup_callbacks array, so functions can be added to be called when ActiveScaffold.setup is called (form open, page load).
+- Add add_new_link to config.nested, adding a link to create form on an association, refreshing this record instead of adding new row in the list.
 - Support hashes in update_columns, keys are association names or :__root__ to refresh fields on subforms or at top of the form, values are list of columns or nested hashes.
 - Add custom_modules, in active_scaffold_config and global, to add modules which will be included after ActiveScaffold action modules, to customize the controllers.
-- Add active_scaffold_subform_record_actions helper to render the destroy action on the rows of a subform, so it can be used to add more actions
-- Improve ActiveStorage bridge to keep existing files in has_many_attachments
-- Helpers used by file upload bridges have been renamed and moved the JS code to active_scaffold.js
-- Support action link groups to open with click, like actions showing dynamic action link group
-- Open dynamic action link group nested in the menu tree, under the action opening it
+- Add active_scaffold_subform_record_actions helper to render the destroy action on the rows of a subform, so it can be used to add more actions.
+- Improve ActiveStorage bridge to keep existing files in has_many_attachments.
+- Helpers used by file upload bridges have been renamed and moved the JS code to active_scaffold.js.
+- Support action link groups to open with click, like actions showing dynamic action link group.
+- Open dynamic action link group nested in the menu tree, under the action opening it.
+- Add sort_joins to column, defaults to includes value, so it's possible to set sort by SQL without joining the includes, or join with some associations, and preload others.
 
 = 4.1.4
 - Fix dirty attributes on refresh_field action, record is built on unsaved instance copying attributes, but it reports only changed attributes from the form now

lib/active_scaffold/actions/list.rb

@@ -88,11 +88,9 @@ def action_links_menu_respond_to_js
     def set_includes_for_columns(action = :list, sorting = active_scaffold_config.list.user.sorting)
       @cache_associations = true
       columns = columns_for_action(action)
-      joins_cols, preload_cols = columns.select { |c| c.includes.present? }.partition do |col|
-        includes_need_join?(col, sorting) && !grouped_search?
-      end
-      active_scaffold_references.concat joins_cols.map(&:includes).flatten.uniq
-      active_scaffold_preload.concat preload_cols.map(&:includes).flatten.uniq
+      joins_cols = columns.select { |col| col.sort_joins.present? && includes_need_join?(col, sorting) && !grouped_search? }
+      active_scaffold_references.concat joins_cols.map(&:sort_joins).flatten.uniq
+      active_scaffold_preload.concat columns.filter_map { |c| c.includes.presence }.flatten.uniq
       set_includes_for_sorting(columns, sorting) if sorting.sorts_by_sql?
     end
 

lib/active_scaffold/data_structures/column.rb

@@ -191,6 +191,19 @@ def sort_by(options)
         self.sort = options
       end
 
+      # a collection of associations to do left join when the list is sorted by this column
+      def sort_joins
+        @sort_joins || includes
+      end
+
+      def sort_joins=(value)
+        @sort_joins =
+          case value
+          when Array then value
+          else [value] # automatically convert to an array
+          end
+      end
+
       def associated_number?
         @associated_number
       end