active_scaffold_export 3.11.2 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c5a31084ab9ee69ba6480602feacb14d935f144d26c17b90d3bd4698ceb0053
-  data.tar.gz: 5c37fc683df4653d2b71cca0ae24f890b8210e45dc13d8cb81515c6b94250358
+  metadata.gz: 15977d4b6b96c5445460882770d524ff2ca54682df081f8e5fb63337368b4ec4
+  data.tar.gz: 2fffe5855089bfd44f6f93dbcc514fe4908c56c3bda8cc06d8a11bf890ff7f00
 SHA512:
-  metadata.gz: 646be1b196f36730cd8331e9f2422227b556398973ad66c97e2ff014215709a6899e219cde633b66b530c37de80d4ba15059a33ad3188e902841e4f7e6402278
-  data.tar.gz: 5edae73a37d1b5e9caf3e85b0d071f1d3ccadf8ffce4c6adb7f6fecdf5e0d42504c1fc442c30384103f64a400b816f787ca60b64e08e16c169e908f3e971c3fa
+  metadata.gz: e328a1cd507d40e1bf98f6d6f90d868028753b2848d0de380c101140848ae78383f379b6accf9a07aaa78c331e16dd916f7ee46c983d917995566ea027ecdbd0
+  data.tar.gz: 8d782d92121c67022a7393ab9bae6a7d59040e2ded06674df98123159c7621beecf76b677f5cad151a8caa64ae8dc2413e2245860ff1aa7cc4919bef58771a3c

data/README.md

@@ -21,11 +21,9 @@ conf.export.default_file_format = 'csv' # or 'xlsx'
 
 Read important notes at the bottom about xlsx.
 
-Remember to bundle install.
-Add to application.css:
-```
- *= require active_scaffold_export
-```
+Remember to run `bundle install`. ActiveScaffold automatically includes the plugin stylesheet; no entry in `application.css` is needed.
+
+ActiveScaffold Export 3.12 requires ActiveScaffold 4.4 or newer.
 
 Now let's add it to controller, inside active_scaffold config block:
 ```ruby
@@ -36,9 +34,25 @@ conf.export.columns = %w(name last_name phone address)
 conf.export.default_deselected_columns = %w(phone address)
 conf.export.default_delimiter = ";"
 conf.export.force_quotes = "true"
+# allow users to drag selected columns into export order
+conf.export.draggable = true
 ```
 And enjoy happy exporting :)
 
+### UI adapter support
+
+The export form uses ActiveScaffold 4.4's standard form elements (`fields_container`, `form_element`, and `form_attribute`) and adds two plugin-specific elements:
+
+* `export_option` wraps one export option.
+* `export_option_row` groups related options.
+
+For example, an adapter can change their classes without overriding the export partial:
+
+```ruby
+ActiveScaffold.add_element_attributes :export_option, class: 'form-check'
+ActiveScaffold.add_element_attributes :export_option_row, class: 'd-flex gap-3'
+```
+
 ### Configuring
 
 There are other options for the action export, explained in the wiki [Export Configuration](https://github.com/activescaffold/active_scaffold_export/wiki/Export-Configuration),
@@ -86,4 +100,3 @@ Export supports grouped search from field_search action. When grouped search is
 ## Contact
 
 For contact, help, support, comments, please use Active Scaffold official mailing list  activescaffold@googlegroups.com
-

data/app/assets/stylesheets/active_scaffold_export.css

@@ -4,25 +4,11 @@
   background-repeat: no-repeat;
   padding-left: 19px;
 }
-.active-scaffold div.show_export-view h3 {
-  font-weight: bold;
+.active-scaffold .show_export-view .export-option-row {
+  display: flex;
+  gap: 1em;
 }
-.active-scaffold div.show_export-view div.separator {
-  clear: both;
-  padding: .5em;
-}
-.active-scaffold div.show_export-view div.options div.separator {
-  padding: 0;
-}
-.active-scaffold div.show_export-view div.options div.checkbox-wrapper {
-  margin-bottom: .5em;
-}
-.active-scaffold div.show_export-view div div.checkbox-wrapper {
-  min-width: 20%;
-  margin-bottom: .25em;
-  float: left;
-}
-.active-scaffold div.show_export-view label #delimiter {
+.active-scaffold .show_export-view label [name=delimiter] {
   font-family: monospace;
 }
 

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

@@ -1,34 +1,61 @@
-<h5><%=as_(:columns_for_export)%></h5>
-<%# 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' %>
-<div class="columns checkbox-list">
-<% export_columns_names(true).each_column do |column| -%>
-  <div class="column checkbox-wrapper">
-    <label>
-      <%= check_box_tag("export_columns[#{column.name}]", 1, !active_scaffold_config.export.default_deselected_columns.include?(column.name), :class => 'columnCheckbox') %>
-      <%= column_heading_label(column) %>
-    </label>
-  </div>
-<% end -%>
-&nbsp;
-</div>
-<div class="separator"></div>
-<h5><%=as_(:options)%></h5>
-<div class="options checkbox-list">
-  <% export_options.each do |row_optionss| %>
-    <% row_optionss.each do |(option, label)| %>
-      <div class="option checkbox-wrapper">
-        <% if label %>
-        <%= content_tag(:label, safe_join([option, label.is_a?(Symbol) ? as_(label) : label], ' ')) %>
-        <% else %>
-        <%= option %>
-        <% end %>
-      </div>
+<% export_config = active_scaffold_config.export %>
+<%= as_element :fields_container, class: 'form' do %>
+  <%= as_element :form_element, class: 'form-element' do %>
+    <%
+      columns = export_columns_names(true).visible_columns
+      selected_columns = columns.map(&:name).reject { |name| export_config.default_deselected_columns.include?(name) }
+      content = active_scaffold_checkbox_list(
+        nil,
+        columns.map { |column| [column_heading_label(column), column.name] },
+        selected_columns,
+        {
+          name: 'export_columns',
+          id: "#{element_form_id(action: :export)}-columns",
+          class: 'columns'
+        },
+        ui_options: {draggable_lists: export_config.draggable, item_options: {class: 'sortable'}}
+      )
+    %>
+    <%= form_attribute_html(nil, as_(:columns_for_export), content, nil, {}) %>
+  <% end %>
+
+  <%= as_element :form_element, class: 'form-element' do %>
+    <%
+      content = export_options.map do |row_options|
+        row_html = row_options.map do |(option, label)|
+          as_element(:export_option) do
+            label ? content_tag(:label, safe_join([option, label.is_a?(Symbol) ? as_(label) : label], ' ')) : option
+          end
+        end
+        as_element :export_option_row, safe_join(row_html)
+      end
+    %>
+    <%= form_attribute_html(nil, as_(:export_options), safe_join(content), nil, {}) %>
+  <% end %>
+
+  <% if export_config.allow_full_download %>
+    <%= as_element :form_element, class: 'form-element' do %>
+      <%
+        content = [
+          [radio_button_tag('full_download', false, !export_config.default_full_download), as_(:this_page)],
+          [radio_button_tag('full_download', true, export_config.default_full_download), as_(:all_pages)]
+        ].map { |option| content_tag(:label, safe_join(option, ' ')) }
+      %>
+      <%= form_attribute_html(nil, as_(:export_pages), safe_join(content), nil, {}) %>
+    <% end %>
+  <% end %>
+
+  <% if export_config.formats.many? %>
+    <%= as_element :form_element, class: 'form-element' do %>
+      <%
+        content = export_config.formats.map do |format|
+          radio = radio_button_tag('format', format, export_config.default_file_format.to_sym == format)
+          content_tag(:label, safe_join([radio, format.upcase.to_s], ' '))
+        end
+      %>
+      <%= form_attribute_html(nil, as_(:export_format), safe_join(content), nil, {}) %>
     <% end %>
-    <div class="separator"></div>
+  <% else %>
+    <%= hidden_field_tag('format', export_config.formats[0]) %>
   <% end %>
-  &nbsp;
-</div>
-<div class="separator"></div>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  active_scaffold:
+    all_pages: All pages
+    columns_for_export: Columns for export
+    export: Export
+    export_format: Format
+    export_options: Options
+    export_pages: Pages
+    this_page: This page

data/config/locales/es.yml

@@ -0,0 +1,9 @@
+es:
+  active_scaffold:
+    all_pages: Todas las páginas
+    columns_for_export: Columnas a exportar
+    export: Exportar
+    export_format: Formato
+    export_options: Opciones
+    export_pages: Páginas
+    this_page: Esta página

data/lib/active_scaffold/actions/export.rb

@@ -21,10 +21,8 @@ module ActiveScaffold::Actions
     def export
       export_config = active_scaffold_config.export
       if params[:export_columns].nil?
-        export_columns = {}
-        export_columns_names.each { |col| export_columns[col.to_sym] = 1 }
         options = {
-          :export_columns => export_columns,
+          :export_columns => export_columns_names.map(&:to_s),
           :full_download => export_config.default_full_download.to_s,
           :delimiter => export_config.default_delimiter,
           :skip_header => export_config.default_skip_header.to_s
@@ -111,9 +109,16 @@ module ActiveScaffold::Actions
 
     def export_columns
       return @export_columns if defined? @export_columns
-      @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)
+      selected_columns = if params[:export_columns].respond_to?(:each_pair)
+        params[:export_columns].each_pair.filter_map { |name, selected| name.to_s if selected.present? }
+      else
+        Array(params[:export_columns]).reject(&:blank?).map(&:to_s)
+      end
+      available_columns = export_columns_names.map(&:to_s)
+      @export_columns = selected_columns.uniq.filter_map do |col|
+        next unless available_columns.include?(col)
+        next unless active_scaffold_config.model.authorized_for?(crud_type: :read, column: col.to_sym)
+        col
       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)

data/lib/active_scaffold/config/export.rb

@@ -12,6 +12,7 @@ module ActiveScaffold::Config
       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
+      self.draggable = self.class.draggable
       @formats = [:csv, :xlsx]
     end
 
@@ -66,6 +67,10 @@ module ActiveScaffold::Config
     cattr_accessor :default_file_format, instance_accessor: false
     @@default_file_format = Gem::Specification::find_all_by_name('caxlsx').any? ? 'xlsx' : 'csv'
 
+    # whether selected export columns can be reordered with drag and drop
+    cattr_accessor :draggable, instance_accessor: false
+    @@draggable = false
+
     # instance-level configuration
     # ----------------------------
 
@@ -90,6 +95,9 @@ module ActiveScaffold::Config
     # default file format to export, it can be changed in the form if show_form is enabled
     attr_accessor :default_file_format
 
+    # whether selected export columns can be reordered with drag and drop
+    attr_accessor :draggable
+
     def default_deselected_columns=(val)
       @default_deselected_columns = ActiveScaffold::DataStructures::Set.new(*val)
     end

data/lib/active_scaffold/helpers/export_helpers.rb

@@ -99,21 +99,8 @@ module ActiveScaffold
         rows = []
         rows << [
           [check_box_tag('skip_header', 1, export_config.default_skip_header), :omit_header],
-          [text_field_tag('delimiter', export_config.default_delimiter, :size => 1, :maxlength => 1), :delimiter]
+          [text_field_tag('delimiter', export_config.default_delimiter, size: 1, maxlength: 1, id: nil), :delimiter]
         ]
-        if export_config.allow_full_download
-          rows << [
-            [radio_button_tag('full_download', false, !export_config.default_full_download), :this_page],
-            [radio_button_tag('full_download', true, export_config.default_full_download), :all_pages]
-          ]
-        end
-        if export_config.formats.many?
-          rows << export_config.formats.map do |format|
-            [radio_button_tag('format', format, export_config.default_file_format.to_sym == format), format.upcase.to_s]
-          end
-        else
-          rows << [hidden_field_tag('format', export_config.formats[0])]
-        end
       end
 
     end

data/lib/active_scaffold_export/version.rb

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

data/lib/active_scaffold_export.rb

@@ -24,3 +24,5 @@ end
 
 ActionView::Base.send(:include, ActiveScaffold::Helpers::ExportHelpers)
 ActiveScaffold.stylesheets << 'active_scaffold_export'
+ActiveScaffold.set_element :export_option, tag: :div, attributes: {class: 'export-option'}
+ActiveScaffold.set_element :export_option_row, tag: :div, attributes: {class: 'export-option-row'}

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold_export
 version: !ruby/object:Gem::Version
-  version: 3.11.2
+  version: 3.12.0
 platform: ruby
 authors:
 - Volker Hochstein
 - Sergio Cambra
 - Hernan Astudillo
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_scaffold
@@ -18,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.4.0
 description: Exporting Records with ActiveScaffold
 email: activescaffold@googlegroups.com
 executables: []
@@ -43,6 +42,8 @@ files:
 - app/views/active_scaffold_overrides/_export_form_body.html.erb
 - app/views/active_scaffold_overrides/_show_export.html.erb
 - app/views/active_scaffold_overrides/show_export.html.erb
+- config/locales/en.yml
+- config/locales/es.yml
 - lib/active_scaffold/actions/export.rb
 - lib/active_scaffold/config/export.rb
 - lib/active_scaffold/helpers/export_helpers.rb
@@ -54,7 +55,6 @@ homepage: http://github.com/active_scaffold/active_scaffold_export
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ability to export records to CSV/XLSX with ActiveScaffold
 test_files: []