administrate_exportable 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66d0a1d7b10a17a14ff7c4553f751d34c756b1f1138614c15f1144b807e9161f
-  data.tar.gz: e7669105bcb5d34ddfb92520a57f07eb9c28871510cc7aa28a7bbd21189818b3
+  metadata.gz: 9cbff1fff937f0640ccdb42b0f80363220ae4d91a8a4f98a22394c2481a3c86a
+  data.tar.gz: b54ba5b4180434920f8eddf45ea38b51371d51fef4a61336252c6560edf4c2be
 SHA512:
-  metadata.gz: afd7af1c25b548fac0bea63635190d6ac3a98cc30622390db4f02535ea33b7b3494a4bf71d672845466ba6caa5bbbe92e21e2bc2e79a98d96a5ec83bfe745840
-  data.tar.gz: 82b748cbd381e7890a2ce35a6f05029a4cab127c676f2c344237398734a59b499472ef863c417d3a7d835840ed3592f2a1ae1200dcfc604a9117727690a4ba2a
+  metadata.gz: aca50be90261668a6eeabd518cdb12846ffe35e68b61c1196164b352ffa9417295a757981950c66ae968254e1343e8fc00876de9190439f72e10bdbd16b74c0a
+  data.tar.gz: 0aa6961811d2dbd28b20af2a9d47bb0e713ce3e6b099b61a712ac2c9de89f5ce7a9e3cd5bdbf114ac7443a85b860711e221401be508775e61205dfca5e92abdd

data/.github/workflows/ci.yml

@@ -12,10 +12,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ["3.1", "3.2", "3.3", "3.4"]
+        ruby: ["3.2", "3.3", "3.4", "4.0"]
 
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v7
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -33,11 +33,11 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v7
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.3
+          ruby-version: "4.0"
           bundler: default
           bundler-cache: true
       - name: Build docs

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.6
+ruby 4.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    administrate_exportable (0.7.0)
+    administrate_exportable (0.8.0)
       actionview (>= 5.2.2.1)
       administrate (>= 0.17.0)
       csv (~> 3.0)
@@ -172,10 +172,10 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.5)
-    nokogiri (1.18.10)
+    nokogiri (1.19.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.18.10-arm64-darwin)
+    nokogiri (1.19.4-arm64-darwin)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.10.1)
@@ -298,9 +298,9 @@ GEM
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       sprockets (>= 3.0.0)
-    sqlite3 (2.8.1)
+    sqlite3 (2.10.1)
       mini_portile2 (~> 2.8.0)
-    sqlite3 (2.8.1-arm64-darwin)
+    sqlite3 (2.10.1-arm64-darwin)
     standard (1.53.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)

data/README.md

@@ -63,7 +63,7 @@ ATTRIBUTE_TYPES = {
 By default the gem adds the Export button to the partial `views/admin/application/_index_header.html.erb`. But if you have your own Administrate `index` views or override that partial in your application you can add the link manually:
 
 ```ruby
-link_to('Export', [:export, namespace.to_sym, page.resource_name.to_s.pluralize.to_sym, sanitized_order_params(page, :id).to_h.merge(format: :csv)], class: 'button') if existing_action?(resource_class, :export)
+link_to('Export', url_for(sanitized_order_params(page, :id).to_h.merge(action: :export, format: :csv)), class: 'button', target: '_blank', data: { turbolinks: false, turbo: false }) if existing_action?(resource_class, :export) && authorized_action?(resource_name, :export)
 ```
 
 Example:
@@ -82,13 +82,31 @@ Example:
 
     <%= link_to(
       'Export',
-      [:export, namespace.to_sym, page.resource_name.to_s.pluralize.to_sym, sanitized_order_params(page, :id).to_h.merge(format: :csv)],
-      class: 'button'
-    ) if existing_action?(resource_class, :export) %>
+      url_for(sanitized_order_params(page, :id).to_h.merge(action: :export, format: :csv)),
+      class: 'button',
+      target: '_blank',
+      data: { turbolinks: false, turbo: false }
+    ) if existing_action?(resource_class, :export) && authorized_action?(resource_name, :export) %>
   </div>
 ....
 ```
 
+The link uses `url_for(action: :export)` so it works regardless of the route name (e.g. models with plural names such as `UserSettings`, whose collection routes end in `_index`), and sets `data-turbolinks="false"`/`data-turbo="false"` so the CSV is downloaded instead of being rendered by Turbolinks/Turbo.
+
+### Associations and performance
+
+Associations (`Field::BelongsTo`, `Field::HasMany`, `Field::HasOne`, `Field::Polymorphic`, ...) that are exported are preloaded automatically to avoid N+1 queries. Associations excluded with `export: false` are not loaded.
+
+If your `transform_on_export` procs access nested associations, you can preload them by overriding `scoped_resource` in your controller:
+
+```ruby
+def scoped_resource
+  return super.preload(organizations: :address) if action_name == "export"
+
+  super
+end
+```
+
 ### Using with Pundit
 
 If you are using [Pundit](https://github.com/varvet/pundit) in your project you will receive an error saying `undefined method 'export?' for #<Admin::OrganizationPolicy>`. This is because the `export` action is not defined in the policy.

data/administrate_exportable.gemspec

@@ -12,14 +12,8 @@ Gem::Specification.new do |spec|
   spec.description = spec.summary
   spec.license = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -28,10 +22,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.0"
   spec.add_dependency "administrate", ">= 0.17.0"
   spec.add_dependency "rails", ">= 4.2"
   spec.add_dependency "actionview", ">= 5.2.2.1"

data/app/views/admin/application/_index_header.html.erb

@@ -27,9 +27,10 @@
 
     <%= link_to(
       'Export',
-      [:export, namespace, page.resource_name.to_s.pluralize.to_sym, sanitized_order_params(page, :id).to_h.merge(format: :csv)],
+      url_for(sanitized_order_params(page, :id).to_h.merge(action: :export, format: :csv)),
       class: 'button',
-      target: '_blank'
+      target: '_blank',
+      data: { turbolinks: false, turbo: false }
     ) if existing_action?(resource_class, :export) && authorized_action?(resource_name, :export) %>
   </div>
 </header>

data/app/views/admin/application/_pagination.html.erb

@@ -1 +1,2 @@
-<%= paginate resources, param_name: AdministrateExportable::PAGE_PARAM %>
+<% param_name = local_assigns.fetch(:param_name, AdministrateExportable::PAGE_PARAM) %>
+<%= paginate resources, param_name: param_name %>

data/lib/administrate_exportable/exporter.rb

@@ -10,9 +10,12 @@ module AdministrateExportable
       def exportable
         define_method(:export) do
           search_term = params[:search].to_s.strip
-          resources = Administrate::Search.new(scoped_resource,
-            dashboard,
-            search_term).run
+          resources = if respond_to?(:filter_resources, true)
+            filter_resources(scoped_resource, search_term: search_term)
+          else
+            # Administrate < 0.18 has no filter_resources hook
+            Administrate::Search.new(scoped_resource, dashboard, search_term).run
+          end
           resources = apply_collection_includes(resources)
           resources = order.apply(resources)
 

data/lib/administrate_exportable/exporter_service.rb

@@ -7,7 +7,7 @@ module AdministrateExportable
     end
 
     def initialize(dashboard, resource_class, resources)
-      @dashboard = dashboard
+      @dashboard = dashboard.is_a?(Class) ? dashboard.new : dashboard
       @resource_class = resource_class
       @resources = resources
     end
@@ -40,7 +40,7 @@ module AdministrateExportable
       when Administrate::Field::BelongsTo.to_s, Administrate::Field::HasOne.to_s, Administrate::Field::Polymorphic.to_s
         field.display_associated_resource if field.data
       when Administrate::Field::HasMany.to_s
-        field.data&.count
+        field.data&.size
       when Administrate::Field::DateTime.to_s
         field.datetime if field.data
       when Administrate::Field::Date.to_s
@@ -72,7 +72,7 @@ module AdministrateExportable
     end
 
     def attributes_to_export
-      @attributes_to_export ||= dashboard.class::ATTRIBUTE_TYPES.select do |attribute_key, attribute_type|
+      @attributes_to_export ||= dashboard.attribute_types.select do |attribute_key, attribute_type|
         attribute_options = attribute_type.try(:options)
 
         !attribute_options || attribute_options[:export] != false
@@ -80,7 +80,18 @@ module AdministrateExportable
     end
 
     def collection
-      resources
+      return resources if associations_to_preload.empty?
+
+      resources.preload(*associations_to_preload)
+    end
+
+    # Preload every exported association to avoid N+1 queries
+    def associations_to_preload
+      @associations_to_preload ||= attributes_to_export.select do |attribute_key, attribute_type|
+        attribute_type.respond_to?(:associative?) &&
+          attribute_type.associative? &&
+          resource_class.reflect_on_association(attribute_key)
+      end.keys
     end
   end
 end

data/lib/administrate_exportable/version.rb

@@ -1,3 +1,3 @@
 module AdministrateExportable
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,72 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: administrate_exportable
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jônatas Rancan
 - Andrei Bondarev
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: administrate
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +91,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".tool-versions"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -166,8 +108,9 @@ files:
 homepage: https://github.com/SourceLabsLLC/administrate_exportable
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/SourceLabsLLC/administrate_exportable
+  bug_tracker_uri: https://github.com/SourceLabsLLC/administrate_exportable/issues
 rdoc_options: []
 require_paths:
 - lib
@@ -182,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Simple plugin to add CSV export feature to Administrate
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.0