active_scaffold_export 3.9.3 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a2384e4ea87f37820137c5a5b4d77263e1c897b286229ed4c1c3da0ee1a5cd
-  data.tar.gz: 2b37e2b9b189725d3c3735d782d262a9d3df8e8f816a83dfe36a65545147da07
+  metadata.gz: 3129ecc7a827c1e0f9d4052d2661751d8ed18124dd041b616694b6b74edfc511
+  data.tar.gz: 03d88fa2f813a8b841aa64f5de94439d7c4392e30e729641dc2f46076741d35b
 SHA512:
-  metadata.gz: aea5b9dd175581c8d730271cdb0067d7c7721c271ab57593a2c92de7bef9365356c923af7834d43b6d3adbc49b53135f79d5c22121223a560e1e59a1685036ea
-  data.tar.gz: 07f93b89c04d65fcfbc5630a1bf932e0aab23e0772b90569d3cc495aa19b1304b23fdeb87394a73822080243ee5cdca285d70fe76554b108168211385526a144
+  metadata.gz: 50b9a7a2e813c0526da48a17c2dc72ed8ce72cdadc4618e30b832ba48a7913c94e211f34954c5c16e67b1b655a5b96d8b1219fa23d028420bb15b5f34e39d625
+  data.tar.gz: b45b8846a4ccae25bea17e4eda5573931f6346b913ff16029b09bac721b82f90c77911085b0e76133584ff6920160d97414be02394c0a191286fdab53623df01

data/README.md

@@ -71,5 +71,11 @@ def worksheet_name(options = {})
 end
 ```
 
+### Grouped search
+
+Export supports grouped search from field_search action. When grouped search is used, instead of exporting the normal columns, only the listed columns will be exported, the ones in `conf.list.columns` with calculation, or the ones in `conf.field_search.grouped_columns`. In this case, the normal helper overrides won't be used, and will use `grouped_export_column` suffix instead.
+
+## Contact
+
 For contact, help, support, comments, please use Active Scaffold official mailing list  activescaffold@googlegroups.com
 

data/app/views/active_scaffold_overrides/_export.csv.erb

@@ -12,7 +12,7 @@
     csv << fcsv_options[:headers] unless params[:skip_header]
     @records.each do |record|
       csv << @export_columns.collect { |column|
-        get_export_column_value(record, column, :csv).first
+        get_export_column_value(record, column, :csv)&.first
       }
     end
   end

data/app/views/active_scaffold_overrides/_export_form_body.html.erb

@@ -5,9 +5,12 @@
  |
 <%= link_to as_(:select_none), '#', onclick: 'jQuery(".columnCheckbox").prop("checked", false); return false', class: 'active-scaffold-footer' %>
 <div class="columns checkbox-list">
-<% export_config.columns.each_column do |column| -%>
+<% export_columns_names(true).each_column do |column| -%>
   <div class="column checkbox-wrapper">
-    <%= content_tag(:label, check_box_tag("export_columns[#{column.name}]", 1, !export_config.default_deselected_columns.include?(column.name), :class => 'columnCheckbox') + "&nbsp;#{column.label}".html_safe) %>
+    <label>
+      <%= check_box_tag("export_columns[#{column.name}]", 1, !export_config.default_deselected_columns.include?(column.name), :class => 'columnCheckbox') %>
+      <%= column_heading_label(column) %>
+    </label>
   </div>
 <% end -%>
 &nbsp;

data/lib/active_scaffold/actions/export.rb

@@ -3,6 +3,7 @@ module ActiveScaffold::Actions
     def self.included(base)
       base.before_action :export_authorized?, :only => [:export]
       base.before_action :show_export_authorized?, :only => [:show_export]
+      base.helper_method :export_columns_names
     end
 
     # display the customization form or skip directly to export
@@ -23,7 +24,7 @@ module ActiveScaffold::Actions
       export_config = active_scaffold_config.export
       if params[:export_columns].nil?
         export_columns = {}
-        export_config.columns.each { |col| export_columns[col.to_sym] = 1 }
+        export_columns_names.each { |col| export_columns[col.to_sym] = 1 }
         options = {
           :export_columns => export_columns,
           :full_download => export_config.default_full_download.to_s,
@@ -33,14 +34,14 @@ module ActiveScaffold::Actions
         params.merge!(options)
       end
 
-      set_includes_for_columns(:export)
+      set_includes_for_columns(:export) # will call export_columns which will set @export_columns
       @export_config = export_config
       # Make sure active_scaffold's find_page is dealing with the same list of
       # columns. Prevents an invalid SQL query when exporting after filtering
       # with field_search against a relation column, and that relation column is
       # not included in the set of export columns.
       @list_columns = @export_columns
-      @find_options = find_options_for_export
+      @page = find_page(find_options_for_export)
 
       # this is required if you want this to work with IE
       if request.env['HTTP_USER_AGENT'] =~ /msie/i
@@ -60,7 +61,7 @@ module ActiveScaffold::Actions
       response.headers['last-modified'] = '0'
       # start streaming output
       self.response_body = Enumerator.new do |y|
-        find_items_for_export(@find_options) do |records|
+        find_items_for_export do |records|
           @records = records
           str = render_to_string :partial => 'export', :layout => false, :formats => [:csv]
           y << str
@@ -80,7 +81,7 @@ module ActiveScaffold::Actions
           styles.map! { |style| pkg.workbook.styles.add_style style if style }
           sheet.add_row(@export_columns.collect { |column| view_context.format_export_column_header_name(column) }, style: styles, widths: widths)
         end
-        find_items_for_export(@find_options) do |records|
+        find_items_for_export do |records|
           records.each do |record|
             row = []
             styles = []
@@ -112,13 +113,26 @@ module ActiveScaffold::Actions
 
     def export_columns
       return @export_columns if defined? @export_columns
-      @export_columns = active_scaffold_config.export.columns.reject { |col| params[:export_columns][col.to_sym].nil? }
+      @export_columns = export_columns_names.reject do |col|
+        params[:export_columns][col.to_sym].nil? ||
+          !active_scaffold_config.model.authorized_for?(crud_type: :read, column: col.to_sym)
+      end
       sorting = active_scaffold_config.list.user.sorting || active_scaffold_config.list.sorting
       sorting_columns = sorting.reject { |col, _| @export_columns.include?(col.name) }.map(&:first)
       @export_columns.map! { |col| active_scaffold_config.columns[col] }
       @export_columns += sorting_columns
     end
 
+    def export_columns_names(action_columns = false)
+      if grouped_search?
+        list_columns_names.then do |cols|
+          action_columns ? active_scaffold_config.build_action_columns(:export, cols) : cols
+        end
+      else
+        active_scaffold_config.export.columns
+      end
+    end
+
     def find_options_for_export
       find_options = {sorting: active_scaffold_config.list.sorting, pagination: true}
       do_search rescue nil
@@ -136,13 +150,13 @@ module ActiveScaffold::Actions
     end
 
     # The actual algorithm to do the export
-    def find_items_for_export(find_options, &block)
+    def find_items_for_export(&block)
       if params[:full_download] == 'true'
-        find_page(find_options).pager.each do |page|
+        @page.pager.each do |page|
           yield page.items
         end
       else
-        yield find_page(find_options).items
+        yield @page.items
       end
     end
 

data/lib/active_scaffold/helpers/export_helpers.rb

@@ -10,12 +10,15 @@ module ActiveScaffold
       # format_singular_association_export_column(association_record)
       # format_plural_association_export_column(association_records)
       def get_export_column_value(record, column, format)
+        return unless record.authorized_for?(crud_type: :read, column: column.name)
         if (method = export_column_override(column))
           value, options = send(method, record, format)
           [value, options || export_column_style(column, format)]
         elsif column.list_ui && (method = override_export_ui(column.list_ui))
           value, options = send(method, record, column, format, ui_options: column.list_ui_options || column.options)
           [value, options || export_column_style(column, format)]
+        elsif grouped_search? && column == search_group_column && search_group_function
+          [format_grouped_search_column(record[column.name], column.options), export_column_style(column, format)]
         else
           raw_value = record.send(column.name)
 
@@ -35,11 +38,11 @@ module ActiveScaffold
 
       def export_column_style(column, format)
         style = column.export_options&.dig(format)
-        format = :xlsx && style.frozen? ? style.deep_dup : style
+        format == :xlsx && style.frozen? ? style.deep_dup : style
       end
 
       def export_column_override(column)
-        override_helper column, 'export_column'
+        override_helper column, grouped_search? ? 'grouped_export_column' : 'export_column'
       end
 
       # the naming convention for overriding column types with helpers
@@ -81,7 +84,7 @@ module ActiveScaffold
       ## This helper can be overridden to change the name of the headers
       # For instance, you might want column.name.to_s.humanize
       def format_export_column_header_name(column)
-        column.label
+        column_heading_label column
       end
 
       ## This helper can be overridden to change the style of the headers

data/lib/active_scaffold_export/version.rb

@@ -1,8 +1,8 @@
 module ActiveScaffoldExport
   module Version
     MAJOR = 3
-    MINOR = 9
-    PATCH = 3
+    MINOR = 10
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold_export
 version: !ruby/object:Gem::Version
-  version: 3.9.3
+  version: 3.10.1
 platform: ruby
 authors:
 - Volker Hochstein
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_scaffold