active_scaffold_export 3.6.1 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 248e0924b010eb5822ad05cdb735f486bd848295091e3962d27c5d3717611f97
-  data.tar.gz: d19079c8bb42ee90124f5b97440b0c0564fc418b28f23d4d7de8dd47d466a2c2
+  metadata.gz: b710509185a1efb5c735e70ac427495e39798ba165dd9dd392f4dc6696511fdb
+  data.tar.gz: 25fe42fc33045159ab7cd6f47eef137e44ecf8703829fae6b263fcd2abebab8e
 SHA512:
-  metadata.gz: 882365bcd892ca7bdbda4a0638b30baca1a7e7c08220dbf53ab1751976d0904149dd1da50431210e09b9eaf9ad8a62999abd03f28f95660121ec6d054da66767
-  data.tar.gz: 2aeb345b8beff579c6ca03b5b2fc1a595c17ab471ac8de73ff4c492cd97c7782f41952369795ea0406af3d217b6776a9b0e6569b4868eae04b206a9219b9786f
+  metadata.gz: 446846da6e6032788f4f637d277e6a682afa71b1d1cbc3661ca5c55fbce5cd3dcdaf6161aace8f54b18cf8b8676547951a407aa146316836a062216b8517e361
+  data.tar.gz: 2bf4efd5ee989034947641d012e8ceedb97ff2c41cc466c925b9f23728635c4f9f9823002e961d412ce3577bad94e7d3eef319d9165c512fca92712d1592d83a

data/README.md

@@ -1,7 +1,7 @@
 # Active Scaffold Export
-### An [active scaffold](https://github.com/activescaffold/active_scaffold) addon to let it export data in CSV or XLSX format
+An [active scaffold](https://github.com/activescaffold/active_scaffold) addon to let it export data in CSV or XLSX format
 
-####How to?
+### How to?
 Easy. First get [active scaffold](https://github.com/activescaffold/active_scaffold) if you haven't yet. 
 Then, add this to your Gemfile:
 ```
@@ -14,7 +14,7 @@ gem 'fastercsv'
 ```
 if you want xlsx format, add:
 ```
-gem 'axlsx_rails'
+gem 'caxlsx_rails'
 ```
 if that gem is present, XLSX will be used by default. 
 You can change this by adding to active scaffold config:

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

@@ -9,10 +9,10 @@
   }
 
   data = CSV.generate(**fcsv_options) do |csv|
-    csv << fcsv_options[:headers] unless params[:skip_header] == 'true'
+    csv << fcsv_options[:headers] unless params[:skip_header]
     @records.each do |record|
       csv << @export_columns.collect { |column|
-        get_export_column_value(record, column, :csv)
+        get_export_column_value(record, column, :csv).first
       }
     end
   end

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

@@ -23,19 +23,24 @@
     <%= content_tag(:label, text_field_tag('delimiter', export_config.default_delimiter, :size => 1, :maxlength => 1) + " #{as_(:delimiter)}".html_safe) %>
   </div>
   <div class="separator"></div>
+  <% if export_config.allow_full_download %>
   <div class="option checkbox-wrapper">
-    <%= content_tag(:label, radio_button_tag('full_download', false, !export_config.default_full_download) + " #{as_(:this_page)}".html_safe) if export_config.allow_full_download %>
+    <%= content_tag(:label, radio_button_tag('full_download', false, !export_config.default_full_download) + " #{as_(:this_page)}".html_safe) %>
   </div>
   <div class="option checkbox-wrapper">
-    <%= content_tag(:label, radio_button_tag('full_download', true, export_config.default_full_download) + " #{as_(:all_pages)}".html_safe) if export_config.allow_full_download %>
+    <%= content_tag(:label, radio_button_tag('full_download', true, export_config.default_full_download) + " #{as_(:all_pages)}".html_safe) %>
   </div>
   <div class="separator"></div>
+  <% end %>
+  <% if export_config.formats.many? %>
+  <% export_config.formats.each do |format| %>
   <div class="option checkbox-wrapper">
-    <%= content_tag(:label, radio_button_tag('format', :xlsx, export_config.default_file_format.to_sym == :xlsx) + ' XLSX') %>
-  </div>
-  <div class="option checkbox-wrapper">
-    <%= content_tag(:label, radio_button_tag('format', :csv, export_config.default_file_format.to_sym == :csv) + ' CSV') %>
+    <%= content_tag(:label, safe_join([radio_button_tag('format', format, export_config.default_file_format.to_sym == format), format.upcase], ' ')) %>
   </div>
+  <% end %>
+  <% else %>
+  <%= hidden_field_tag 'format', export_config.formats[0] %>
+  <% end %>
   &nbsp;
 </div>
 <div class="separator"></div>

data/lib/active_scaffold/actions/export.rb

@@ -49,17 +49,13 @@ module ActiveScaffold::Actions
       end
       response.headers['Content-Disposition'] = "attachment; filename=#{export_file_name}"
 
-      unless defined? Mime::XLSX
-        Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
-      end
-
       respond_to_action(:export)
     end
 
     protected
 
     def export_respond_to_csv
-      response.headers['Content-type'] = 'text/csv'
+      response.headers['Content-type'] = Mime[:csv]
       # start streaming output
       self.response_body = Enumerator.new do |y|
         find_items_for_export do |records|
@@ -72,17 +68,30 @@ module ActiveScaffold::Actions
     end
 
     def export_respond_to_xlsx
-      response.headers['Content-type'] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+      response.headers['Content-type'] = Mime[:xlsx]
       pkg = Axlsx::Package.new
-      header = pkg.workbook.styles.add_style sz: 11, b: true,:bg_color => "69B5EF", :fg_color => "FF", alignment: { horizontal: :center }
       pkg.workbook.add_worksheet(name: worksheet_name) do |sheet|
-        sheet.add_row(@export_columns.collect { |column| view_context.format_export_column_header_name(column) }, style: header) unless params[:skip_header]
+        styles = @export_columns.collect { |column| view_context.export_column_header_style(column, :xlsx) }
+        widths = @export_columns.map.with_index { |column, i| styles.dig(i, :width) || column.export_options&.dig(:xlsx, :width) || :auto }
+        unless params[:skip_header]
+          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 do |records|
           records.each do |record|
-            sheet.add_row @export_columns.collect { |column| view_context.get_export_column_value(record, column, :xlsx) }
+            row = []
+            styles = []
+            @export_columns.each do |column|
+              data, style = view_context.get_export_column_value(record, column, :xlsx)
+              style = pkg.workbook.styles.add_style style if style
+              row << data
+              styles << style
+            end
+            sheet.add_row row, style: styles, widths: widths
           end
         end
       end
+      customize_xlsx(pkg)
       stream = pkg.to_stream # when adding rows to sheet, they won't pass to this stream if declared before. axlsx issue?
       self.response_body = Enumerator.new do |y|
         y << stream.read
@@ -95,6 +104,9 @@ module ActiveScaffold::Actions
         truncate(Axlsx::WORKSHEET_MAX_NAME_LENGTH, options)
     end
 
+    def customize_xlsx(package)
+    end
+
     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? }
@@ -138,12 +150,8 @@ module ActiveScaffold::Actions
     def export_file_name
       filename = self.controller_name.clone
 
-      if params[:format]
-        if params[:format].to_sym == :xlsx
-          filename << '.xlsx'
-        elsif params[:format].to_sym == :csv
-          filename << '.csv'
-        end
+      if params[:format] && active_scaffold_config.export.formats.map(&:to_s).include?(params[:format])
+        filename << ".#{params[:format]}"
       else
         filename << ".#{active_scaffold_config.export.default_file_format}"
       end

data/lib/active_scaffold/config/export.rb

@@ -3,7 +3,15 @@ module ActiveScaffold::Config
     self.crud_type = :read
 
     def initialize(core_config)
+      super
       @core = core_config
+      self.show_form = self.class.show_form
+      self.allow_full_download = self.class.allow_full_download
+      self.force_quotes = self.class.force_quotes
+      self.default_full_download = self.class.default_full_download
+      self.default_delimiter = self.class.default_delimiter
+      self.default_skip_header = self.class.default_skip_header
+      self.default_file_format = self.class.default_file_format
       @formats = [:csv, :xlsx]
     end
 
@@ -30,45 +38,63 @@ module ActiveScaffold::Config
       end
     end
 
-    attr_writer :show_form, :allow_full_download, :force_quotes, :default_full_download, :default_delimiter, :default_skip_header, :default_deselected_columns, :default_file_format
-    def show_form
-      self.show_form = @core.export_show_form if @show_form.nil?
-      @show_form
-    end
-    def allow_full_download
-      self.allow_full_download = @core.export_allow_full_download if @allow_full_download.nil?
-      @allow_full_download
-    end
-    def force_quotes
-      self.force_quotes = @core.export_force_quotes if @force_quotes.nil?
-      @force_quotes
-    end
-    def default_full_download
-      self.default_full_download = @core.export_default_full_download if @default_full_download.nil?
-      @default_full_download
-    end
-    def default_delimiter
-      self.default_delimiter = @core.export_default_delimiter if @default_delimiter.nil?
-      @default_delimiter
-    end
-    def default_skip_header
-      self.default_skip_header = @core.export_default_skip_header if @default_skip_header.nil?
-      @default_skip_header
-    end
+    # whether open a form to allow selecting columns and format settings, or export directly with the defined settings in the controller
+    cattr_accessor :show_form, instance_accessor: false
+    @@show_form = true
+
+    # whether user can ask for full or page export, or default is forced
+    cattr_accessor :allow_full_download, instance_accessor: false
+    @@allow_full_download = true
+
+    # force_quotes option for CSV library
+    cattr_accessor :force_quotes, instance_accessor: false
+    @@force_quotes = false
+
+    # default setting for full export or page export, it can be changed in the form if show_form is enabled
+    cattr_accessor :default_full_download, instance_accessor: false
+    @@default_full_download = true
+
+    # default column separator for CSV, it can be changed in the form if show_form is enabled
+    cattr_accessor :default_delimiter, instance_accessor: false
+    @@default_delimiter = ','
+
+    # wheter export a header (false) or skip exporting a header (true), it can be changed in the form if show_form is enabled
+    cattr_accessor :default_skip_header, instance_accessor: false
+    @@default_skip_header = false
+
+    # default file format to export, it can be changed in the form if show_form is enabled
+    cattr_accessor :default_file_format, instance_accessor: false
+    @@default_file_format = Gem::Specification::find_all_by_name('caxlsx').any? ? 'xlsx' : 'csv'
+
+    # instance-level configuration
+    # ----------------------------
+
+    # whether open a form to allow selecting columns and format settings, or export directly with the defined settings in the controller
+    attr_accessor :show_form
+
+    # whether user can ask for full or page export, or default is forced
+    attr_accessor :allow_full_download
+
+    # force_quotes option for CSV library
+    attr_accessor :force_quotes
+
+    # default setting for full export or page export, it can be changed in the form if show_form is enabled
+    attr_accessor :default_full_download
+
+    # default column separator for CSV, it can be changed in the form if show_form is enabled
+    attr_accessor :default_delimiter
+
+    # wheter export a header (false) or skip exporting a header (true), it can be changed in the form if show_form is enabled
+    attr_accessor :default_skip_header
+
+    # default file format to export, it can be changed in the form if show_form is enabled
+    attr_accessor :default_file_format
+
+    attr_writer :default_deselected_columns
     def default_deselected_columns
       self.default_deselected_columns = [] if @default_deselected_columns.nil?
       @default_deselected_columns
     end
-    def default_file_format
-      if @core.export_xlsx_avaliable
-        self.default_file_format = @default_file_format || 'xlsx'
-      else
-        self.default_file_format = @default_file_format || @core.export_default_file_format
-      end
-    end
-    def xlsx_present?
-      Gem::Specification::find_all_by_name('axlsx_rails').any?
-    end
 
     columns_accessor :columns
 

data/lib/active_scaffold/helpers/export_helpers.rb

@@ -11,19 +11,25 @@ module ActiveScaffold
       # format_plural_association_export_column(association_records)
       def get_export_column_value(record, column, format)
         if (method = export_column_override(column))
-          send(method, record)
+          value, options = send(method, record, format)
+          [value, options || column.export_options&.dig(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)]
         else
           raw_value = record.send(column.name)
 
-          if column.association.nil? or column_empty?(raw_value)
-            format_export_column(raw_value, format)
-          elsif column.association
-            if column.association.collection?
-              format_plural_association_export_column(raw_value)
-            else
-              format_singular_association_export_column(raw_value)
+          value =
+            if column.association.nil? or column_empty?(raw_value)
+              format_export_column(raw_value, format)
+            elsif column.association
+              if column.association.collection?
+                format_plural_association_export_column(raw_value, format)
+              else
+                format_singular_association_export_column(raw_value, format)
+              end
             end
-          end
+          [value, column.export_options&.dig(format)]
         end
       end
 
@@ -31,6 +37,15 @@ module ActiveScaffold
         override_helper column, 'export_column'
       end
 
+      # the naming convention for overriding column types with helpers
+      def override_export_ui(list_ui)
+        ActiveScaffold::Registry.cache :export_ui_overrides, list_ui do
+          method = "active_scaffold_export_#{list_ui}"
+          method if respond_to? method
+        end
+      end
+      alias override_export_ui? override_export_ui
+
       def format_export_column(raw_value, format)
         method = "format_value_for_#{format}"
         respond_to?(method) ? send(method, raw_value) : raw_value
@@ -48,22 +63,29 @@ module ActiveScaffold
         end
       end
 
-      def format_singular_association_export_column(association_record)
+      def format_singular_association_export_column(association_record, format)
         format_value(association_record.to_label)
       end
 
-      def format_plural_association_export_column(association_records)
+      def format_plural_association_export_column(association_records, format)
         firsts = association_records.first(4).collect { |v| v.to_label }
         firsts[3] = ' ' if firsts.length == 4
         format_value(firsts.join(','))
       end
 
-      ## This helper can be overridden to change the way that the headers
-      # are formatted. For instance, you might want column.name.to_s.humanize
+      ## 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
       end
 
+      ## This helper can be overridden to change the style of the headers
+      def export_column_header_style(column, format)
+        if format == :xlsx
+          @default_style ||= {sz: 11, b: true, bg_color: "69B5EF", fg_color: "FF", alignment: {horizontal: :center}}
+        end
+      end
+
     end
   end
 end

data/lib/active_scaffold_export/column.rb

@@ -0,0 +1,5 @@
+module ActiveScaffoldExport
+  module Column
+    attr_accessor :export_options
+  end
+end

data/lib/active_scaffold_export/engine.rb

@@ -4,11 +4,17 @@ module ActiveScaffoldExport
       ActiveSupport.on_load :active_scaffold_routing do
         self::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:show_export] = :get
         self::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:export] = :post
+        unless Mime[:xlsx]
+          Mime::Type.register 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx
+        end
+        unless Mime[:csv]
+          Mime::Type.register 'text/csv', :csv
+        end
       end
     end
 
-    initializer 'active_scaffold_sortable.extensions' do
-      require "active_scaffold_export/config/core.rb"
+    initializer 'active_scaffold_export.extensions' do
+      ActiveScaffold::DataStructures::Column.send :include, ActiveScaffoldExport::Column
     end
   end
 end

data/lib/active_scaffold_export/version.rb

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

data/lib/active_scaffold_export.rb

@@ -8,6 +8,7 @@ module ActiveScaffoldExport
   def self.root
     File.dirname(__FILE__) + "/.."
   end
+  autoload 'Column', 'active_scaffold_export/column.rb'
 end
 
 module ActiveScaffold

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold_export
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.8.0
 platform: ruby
 authors:
 - Volker Hochstein
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_scaffold
@@ -47,7 +47,7 @@ files:
 - lib/active_scaffold/config/export.rb
 - lib/active_scaffold/helpers/export_helpers.rb
 - lib/active_scaffold_export.rb
-- lib/active_scaffold_export/config/core.rb
+- lib/active_scaffold_export/column.rb
 - lib/active_scaffold_export/engine.rb
 - lib/active_scaffold_export/version.rb
 homepage: http://github.com/active_scaffold/active_scaffold_export

data/lib/active_scaffold_export/config/core.rb

@@ -1,17 +0,0 @@
-# Need to open the AS module carefully due to Rails 2.3 lazy loading
-ActiveScaffold::Config::Core.class_eval do
-  # For some note obvious reasons, the class variables need to be defined
-  # *before* the cattr !!
-  self.send :class_variable_set, :@@export_show_form, true
-  self.send :class_variable_set, :@@export_allow_full_download, true
-  self.send :class_variable_set, :@@export_default_full_download, true
-  self.send :class_variable_set, :@@export_force_quotes, false
-  self.send :class_variable_set, :@@export_default_skip_header, false
-  self.send :class_variable_set, :@@export_default_delimiter, ','
-  self.send :class_variable_set, :@@export_default_file_format, Gem::Specification::find_all_by_name('axlsx_rails').any? ? 'xlsx' : 'csv'
-  
-  cattr_accessor :export_show_form, :export_allow_full_download,
-      :export_force_quotes, :export_default_full_download,
-      :export_default_delimiter, :export_default_skip_header, 
-      :export_default_file_format, :export_xlsx_avaliable
-end