active_scaffold_export 3.8.1 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a405407d5f6c1a7de0d857efbb777c85e6ef41ae95f15e1733578d2beeacac7e
-  data.tar.gz: 81603f42c9f23e4229f073ee36ef6fa149ab8b1871483d28aff5e512f95a6daf
+  metadata.gz: '028314bd560c02524ab75e89fa886e1e6aa4e547fc2d897586ce8f512a33abb5'
+  data.tar.gz: 34b28d3afa5cc307d9728f59ea4a1b9e69ecd4fa66d27f3529d2e81da47801bc
 SHA512:
-  metadata.gz: ba855f054a8c886d2c0e8cec19c514acc74d7e2867a546b94d3f672982f74f53a37275c53b74abd399e33cf6f57028e78cf29a534ecb5ac223a557f195c59f2d
-  data.tar.gz: 359fbfa1916a68976b67acd77b8d9d9c97b4f0b013786161412c02f9e726d440b5c3280567d9b2e294afae6676dafeddb21106f3b66cc9bf9976cdd1064e9f3b
+  metadata.gz: f73011a115e19299e76b45eebc6abaa485ac3a86e57db94c3c96902ebe8fbc828f1e506de388a44791a671fc9018c88b6736f904bfe462804734ddff002b1689
+  data.tar.gz: d2f05275d642ea686552a01f29484ad108e2e16e18c0e1bb0e7ce66b33b3aee44adb2f2cf4c69d3f56d0b3436cb544ffdb67436cc3d967cf40f91095eda3f3ab

data/README.md

@@ -7,21 +7,19 @@ Then, add this to your Gemfile:
 ```
 gem 'active_scaffold_export'
 ```
-if you're using REE or Ruby 1.8.7, you need to add backports gem as well as fastercsv since REE lacks ruby 1.9 streaming features and fastercsv is in core in 1.9
-```
-gem 'backports'
-gem 'fastercsv'
-```
-if you want xlsx format, add:
+
+If you want xlsx format, add:
 ```
 gem 'caxlsx_rails'
 ```
-if that gem is present, XLSX will be used by default. 
+
+If that gem is present, XLSX will be used by default. 
 You can change this by adding to active scaffold config:
 ```
 conf.export.default_file_format = 'csv' # or 'xlsx' 
 ```
-read important notes at the bottom about xlsx.
+
+Read important notes at the bottom about xlsx.
 
 Remember to bundle install.
 Add to application.css:

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

@@ -1,14 +1,16 @@
 <% export_config = active_scaffold_config.export %>
 <h3><%=as_(:columns_for_export)%></h3>
-<% if ActiveScaffold.js_framework == :jquery # TODO: use JS asset instead of inline JS %>
+<%# TODO: use JS asset instead of inline JS %>
 <%= link_to as_(:select_all), '#', onclick: 'jQuery(".columnCheckbox").prop("checked", true); return false', class: 'active-scaffold-footer' %>
  |
 <%= link_to as_(:select_none), '#', onclick: 'jQuery(".columnCheckbox").prop("checked", false); return false', class: 'active-scaffold-footer' %>
-<% end %>
 <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,21 +34,22 @@ 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
+      @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
-        response.headers['Pragma'] = "public"
-        response.headers['Cache-Control'] = "no-cache, must-revalidate, post-check=0, pre-check=0"
-        response.headers['Expires'] = "0"
+        response.headers['pragma'] = "public"
+        response.headers['cache-control'] = "no-cache, must-revalidate, post-check=0, pre-check=0"
+        response.headers['expires'] = "0"
       end
-      response.headers['Content-Disposition'] = "attachment; filename=#{export_file_name}"
+      response.headers['content-disposition'] = "attachment; filename=#{export_file_name}"
 
       respond_to_action(:export)
     end
@@ -55,7 +57,8 @@ module ActiveScaffold::Actions
     protected
 
     def export_respond_to_csv
-      response.headers['Content-type'] = Mime[:csv]
+      response.headers['content-type'] = Mime[:csv]
+      response.headers['last-modified'] = '0'
       # start streaming output
       self.response_body = Enumerator.new do |y|
         find_items_for_export do |records|
@@ -68,7 +71,8 @@ module ActiveScaffold::Actions
     end
 
     def export_respond_to_xlsx
-      response.headers['Content-type'] = Mime[:xlsx]
+      response.headers['content-type'] = Mime[:xlsx]
+      response.headers['last-modified'] = '0'
       pkg = Axlsx::Package.new
       pkg.workbook.add_worksheet(name: worksheet_name) do |sheet|
         styles = @export_columns.collect { |column| view_context.export_column_header_style(column, :xlsx) }
@@ -109,39 +113,47 @@ 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 { |col| params[:export_columns][col.to_sym].nil? }
       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
 
-    # The actual algorithm to do the export
-    def find_items_for_export(&block)
-      find_options = { :sorting =>
-        active_scaffold_config.list.user.sorting.nil? ?
-          active_scaffold_config.list.sorting : active_scaffold_config.list.user.sorting,
-        :pagination => true
-      }
+    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
-      params[:segment_id] = session[:segment_id]
-      do_segment_search rescue nil
 
       if params[:full_download] == 'true'
-        find_options.merge!({
-          :per_page => 3000,
-          :page => 1
-        })
-        find_page(find_options).pager.each do |page|
+        find_options.merge!(per_page: 3000, page: 1)
+      else
+        find_options.merge!(
+          pagination: active_scaffold_config.list.pagination,
+          per_page: active_scaffold_config.list.user.per_page,
+          page: active_scaffold_config.list.user.page
+        )
+      end
+      find_options
+    end
+
+    # The actual algorithm to do the export
+    def find_items_for_export(&block)
+      if params[:full_download] == 'true'
+        @page.pager.each do |page|
           yield page.items
         end
       else
-        find_options.merge!({
-          :pagination => active_scaffold_config.list.pagination,
-          :per_page => active_scaffold_config.list.user.per_page,
-          :page => active_scaffold_config.list.user.page
-        })
-        yield find_page(find_options).items
+        yield @page.items
       end
     end
 

data/lib/active_scaffold/config/export.rb

@@ -95,7 +95,7 @@ module ActiveScaffold::Config
     end
 
     def default_deselected_columns
-      self.default_deselected_columns = ActiveScaffold::DataStructures::Set.new if @default_deselected_columns.nil?
+      @default_deselected_columns ||= ActiveScaffold::DataStructures::Set.new unless frozen?
       @default_deselected_columns
     end
 
@@ -104,5 +104,21 @@ module ActiveScaffold::Config
     def multipart?
       false
     end
+
+    UserSettings.class_eval do
+      user_attr :show_form, :allow_full_download, :force_quotes, :default_file_format,
+                :default_delimiter, :default_skip_header, :default_file_format
+
+      def default_deselected_columns=(val)
+        @default_deselected_columns = ActiveScaffold::DataStructures::Set.new(*val)
+      end
+
+      def default_deselected_columns
+        if @default_deselected_columns.nil? && @conf.default_deselected_columns
+          return @conf.default_deselected_columns
+        end
+        @default_deselected_columns ||= ActiveScaffold::DataStructures::Set.new
+      end
+    end
   end
 end

data/lib/active_scaffold/helpers/export_helpers.rb

@@ -12,10 +12,12 @@ module ActiveScaffold
       def get_export_column_value(record, column, format)
         if (method = export_column_override(column))
           value, options = send(method, record, format)
-          [value, options || column.export_options&.dig(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 || column.export_options&.dig(format)]
+          [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)
 
@@ -29,12 +31,17 @@ module ActiveScaffold
                 format_singular_association_export_column(raw_value, format)
               end
             end
-          [value, column.export_options&.dig(format)]
+          [value, export_column_style(column, format)]
         end
       end
 
+      def export_column_style(column, format)
+        style = column.export_options&.dig(format)
+        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
@@ -76,7 +83,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/column.rb

@@ -1,5 +1,8 @@
 module ActiveScaffoldExport
   module Column
-    attr_accessor :export_options
+    extend ActiveSupport::Concern
+    included do
+      attr_accessor :export_options
+    end
   end
 end

data/lib/active_scaffold_export/engine.rb

@@ -15,6 +15,9 @@ module ActiveScaffoldExport
 
     initializer 'active_scaffold_export.extensions' do
       ActiveScaffold::DataStructures::Column.send :include, ActiveScaffoldExport::Column
+      if defined? ActiveScaffold::DataStructures::ProxyColumn
+        ActiveScaffold::DataStructures::ProxyColumn.send :include, ActiveScaffoldExport::Column
+      end
     end
   end
 end

data/lib/active_scaffold_export/version.rb

@@ -1,8 +1,8 @@
 module ActiveScaffoldExport
   module Version
     MAJOR = 3
-    MINOR = 8
-    PATCH = 1
+    MINOR = 10
+    PATCH = 0
 
     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.8.1
+  version: 3.10.0
 platform: ruby
 authors:
 - Volker Hochstein
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2025-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_scaffold
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.1
+        version: 4.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.1
+        version: 4.0.0.rc1
 description: Exporting Records with ActiveScaffold
 email: activescaffold@googlegroups.com
 executables: []
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Ability to export records to CSV/XLSX with ActiveScaffold