administrate_exportable 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0eeab3dbc1629f67561d23a235d685fdb9587ad09c3e4d64cc967b3e932d94a
-  data.tar.gz: e428424abb066e9d1b074d6d87ca9826d0bbf02f2dd6c01017489354f0483900
+  metadata.gz: 66d0a1d7b10a17a14ff7c4553f751d34c756b1f1138614c15f1144b807e9161f
+  data.tar.gz: e7669105bcb5d34ddfb92520a57f07eb9c28871510cc7aa28a7bbd21189818b3
 SHA512:
-  metadata.gz: 9334efb3cffad20ee050853d3eae9e512642f7674ba446ffa5a9eaf0942c6412328149eb06dffcccfa7ab7bf9806e07c0275c03521fb245f671d9ff56e6f791e
-  data.tar.gz: 54c004002db29996a158043fcdb1eb38d703c200e27e4fafe39e3cdf729d57e622739bcdbf92ba10567eb6e26b9efe89e9f1c1be37818e51b24f50303f6c3b77
+  metadata.gz: afd7af1c25b548fac0bea63635190d6ac3a98cc30622390db4f02535ea33b7b3494a4bf71d672845466ba6caa5bbbe92e21e2bc2e79a98d96a5ec83bfe745840
+  data.tar.gz: 82b748cbd381e7890a2ce35a6f05029a4cab127c676f2c344237398734a59b499472ef863c417d3a7d835840ed3592f2a1ae1200dcfc604a9117727690a4ba2a

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - main
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.1", "3.2", "3.3", "3.4"]
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: StandardRb check
+        run: bundle exec standardrb --format progress --format github --color
+
+      - name: Run tests
+        run: |
+          bundle exec rspec
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler: default
+          bundler-cache: true
+      - name: Build docs
+        run: bundle exec rake yard

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.2
+ruby 3.1.6

data/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 eval_gemfile File.join(File.dirname(__FILE__), "spec/dummy/Gemfile")

data/Gemfile.lock

@@ -1,91 +1,137 @@
 PATH
   remote: .
   specs:
-    administrate_exportable (0.6.2)
+    administrate_exportable (0.7.0)
       actionview (>= 5.2.2.1)
       administrate (>= 0.17.0)
+      csv (~> 3.0)
       rails (>= 4.2)
       railties (>= 5.2.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.8)
-      actionpack (= 5.2.8)
+    actioncable (7.1.6)
+      actionpack (= 7.1.6)
+      activesupport (= 7.1.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.8)
-      actionpack (= 5.2.8)
-      actionview (= 5.2.8)
-      activejob (= 5.2.8)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.6)
+      actionpack (= 7.1.6)
+      activejob (= 7.1.6)
+      activerecord (= 7.1.6)
+      activestorage (= 7.1.6)
+      activesupport (= 7.1.6)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.6)
+      actionpack (= 7.1.6)
+      actionview (= 7.1.6)
+      activejob (= 7.1.6)
+      activesupport (= 7.1.6)
       mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.2.8)
-      actionview (= 5.2.8)
-      activesupport (= 5.2.8)
-      rack (~> 2.0, >= 2.0.8)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.6)
+      actionview (= 7.1.6)
+      activesupport (= 7.1.6)
+      cgi
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.8)
-      activesupport (= 5.2.8)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.6)
+      actionpack (= 7.1.6)
+      activerecord (= 7.1.6)
+      activestorage (= 7.1.6)
+      activesupport (= 7.1.6)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.6)
+      activesupport (= 7.1.6)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.8)
-      activesupport (= 5.2.8)
+      cgi
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.6)
+      activesupport (= 7.1.6)
       globalid (>= 0.3.6)
-    activemodel (5.2.8)
-      activesupport (= 5.2.8)
-    activerecord (5.2.8)
-      activemodel (= 5.2.8)
-      activesupport (= 5.2.8)
-      arel (>= 9.0)
-    activestorage (5.2.8)
-      actionpack (= 5.2.8)
-      activerecord (= 5.2.8)
-      marcel (~> 1.0.0)
-    activesupport (5.2.8)
+    activemodel (7.1.6)
+      activesupport (= 7.1.6)
+    activerecord (7.1.6)
+      activemodel (= 7.1.6)
+      activesupport (= 7.1.6)
+      timeout (>= 0.4.0)
+    activestorage (7.1.6)
+      actionpack (= 7.1.6)
+      activejob (= 7.1.6)
+      activerecord (= 7.1.6)
+      activesupport (= 7.1.6)
+      marcel (~> 1.0)
+    activesupport (7.1.6)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    administrate (0.17.0)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      mutex_m
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0)
+    administrate (0.19.0)
       actionpack (>= 5.0)
       actionview (>= 5.0)
       activerecord (>= 5.0)
-      datetime_picker_rails (~> 0.0.7)
       jquery-rails (>= 4.0)
       kaminari (>= 1.0)
-      momentjs-rails (~> 2.8)
       sassc-rails (~> 2.1)
       selectize-rails (~> 0.6)
-    administrate-field-enumerate (0.0.2)
-      administrate
-      enumerate_it
-      rails (>= 4.2, < 7.0)
-    arel (9.0.0)
-    builder (3.2.4)
-    byebug (11.1.3)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (4.0.1)
+    builder (3.3.0)
+    byebug (12.0.0)
+    cgi (0.5.1)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.3.6)
+    connection_pool (2.5.5)
     crass (1.0.6)
-    datetime_picker_rails (0.0.7)
-      momentjs-rails (>= 2.8.1)
-    diff-lcs (1.5.0)
-    enumerate_it (3.2.2)
-      activesupport (>= 5.0.7.2)
-    erubi (1.10.0)
-    ffi (1.15.5)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.10.0)
+    csv (3.3.5)
+    date (3.5.1)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (4.0.4)
+      cgi (>= 0.3.3)
+    erubi (1.13.1)
+    ffi (1.17.3)
+    ffi (1.17.3-arm64-darwin)
+    globalid (1.3.0)
+      activesupport (>= 6.1)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    jquery-rails (4.4.0)
+    io-console (0.8.2)
+    irb (1.16.0)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jquery-rails (4.6.1)
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
+    json (2.18.1)
     kaminari (1.2.2)
       activesupport (>= 4.1.0)
       kaminari-actionview (= 1.2.2)
@@ -98,75 +144,142 @@ GEM
       activerecord
       kaminari-core (= 1.2.2)
     kaminari-core (1.2.2)
-    loofah (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.25.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.9.0)
+      logger
       mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
-    minitest (5.15.0)
-    momentjs-rails (2.29.1.1)
-      railties (>= 3.1)
-    nio4r (2.5.8)
-    nokogiri (1.13.6)
-      mini_portile2 (~> 2.8.0)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.1.0)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.9)
+    minitest (5.27.0)
+    mutex_m (0.3.0)
+    net-imap (0.5.13)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.5)
+    nokogiri (1.18.10)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
       racc (~> 1.4)
-    pry (0.13.1)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (5.2.8)
-      actioncable (= 5.2.8)
-      actionmailer (= 5.2.8)
-      actionpack (= 5.2.8)
-      actionview (= 5.2.8)
-      activejob (= 5.2.8)
-      activemodel (= 5.2.8)
-      activerecord (= 5.2.8)
-      activestorage (= 5.2.8)
-      activesupport (= 5.2.8)
-      bundler (>= 1.3.0)
-      railties (= 5.2.8)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    pry-byebug (3.11.0)
+      byebug (~> 12.0)
+      pry (>= 0.13, < 0.16)
+    psych (5.3.1)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.2.4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.3.1)
+      rack (>= 3)
+    rails (7.1.6)
+      actioncable (= 7.1.6)
+      actionmailbox (= 7.1.6)
+      actionmailer (= 7.1.6)
+      actionpack (= 7.1.6)
+      actiontext (= 7.1.6)
+      actionview (= 7.1.6)
+      activejob (= 7.1.6)
+      activemodel (= 7.1.6)
+      activerecord (= 7.1.6)
+      activestorage (= 7.1.6)
+      activesupport (= 7.1.6)
+      bundler (>= 1.15.0)
+      railties (= 7.1.6)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (5.2.8)
-      actionpack (= 5.2.8)
-      activesupport (= 5.2.8)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (13.0.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (7.1.6)
+      actionpack (= 7.1.6)
+      activesupport (= 7.1.6)
+      cgi
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.3.1)
     rb-readline (0.5.5)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.4)
+    rdoc (7.1.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (3.9.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.7)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    ruby-progressbar (1.13.0)
     sassc (2.4.0)
       ffi (~> 1.9)
     sassc-rails (2.1.2)
@@ -175,40 +288,63 @@ GEM
       sprockets (> 3.0)
       sprockets-rails
       tilt
+    securerandom (0.4.1)
     selectize-rails (0.12.6)
-    sprockets (4.0.3)
+    sprockets (4.2.2)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.4.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
+      logger
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.5.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
       sprockets (>= 3.0.0)
-    sqlite3 (1.4.2)
-    thor (1.2.1)
-    thread_safe (0.3.6)
-    tilt (2.0.10)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.5)
+    sqlite3 (2.8.1)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (2.8.1-arm64-darwin)
+    standard (1.53.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.82.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    stringio (3.2.0)
+    thor (1.5.0)
+    tilt (2.7.0)
+    timeout (0.6.0)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    websocket-driver (0.8.0)
+      base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
+    yard (0.9.38)
+    zeitwerk (2.6.18)
 
 PLATFORMS
+  arm64-darwin
   ruby
 
 DEPENDENCIES
-  administrate (~> 0.17.0)
-  administrate-field-enumerate
+  administrate (~> 0.19.0)
   administrate_exportable!
   byebug
   pry-byebug
-  rails (~> 5.2.3)
+  rails (~> 7.1.0)
   rb-readline
-  rspec-rails (~> 3.8)
+  rspec-rails (~> 6.0)
   sqlite3
-
-RUBY VERSION
-   ruby 2.7.2p137
+  standard
+  yard
 
 BUNDLED WITH
-   2.2.17
+   2.5.11

data/README.md

@@ -17,15 +17,19 @@ Or install it yourself as:
 ## Usage
 
 For each resource you want to be exportable, add the following line to the their respective Administrate controller.
+
 ```ruby
 include AdministrateExportable::Exporter
 ```
+
 and the following line in the `config/routes.rb` file, correctly nested on resources
+
 ```ruby
 get :export, on: :collection
 ```
 
 Example:
+
 ```ruby
 namespace :admin do
   resources :organizations do
@@ -37,6 +41,7 @@ namespace :admin do
 By default all the attributes from `ATTRIBUTE_TYPES` will be exported. If you want to exclude an attribute, you can use the option: `export: false`.
 
 Example:
+
 ```ruby
 class BusinessDashboard < Administrate::BaseDashboard
   ATTRIBUTE_TYPES = {
@@ -49,14 +54,16 @@ class BusinessDashboard < Administrate::BaseDashboard
 For the default field types from Administrate, we export the values you got from the partial `views/fields/index`. And if it is a custom field, we just run `field.to_s`.
 But if you want to specify the value to be exported, you can use the option `transform_on_export`, to pass a `Proc` that receives the `field`.
 Example:
+
 ```ruby
 ATTRIBUTE_TYPES = {
  created_at: Field::DateTime.with_options(transform_on_export: -> (field) { field.data.strftime("%F") })
 ```
 
-By default the gem adds the Export button to the view `views/admin/application/index.html.erb`. But if you have your own Administrate `index` views, you can add the link manually:
+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 valid_action?(:export)
+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)
 ```
 
 Example:
@@ -71,17 +78,41 @@ Example:
       ),
       [:new, namespace.to_sym, page.resource_path.to_sym],
       class: "button",
-    ) if valid_action?(:new) && show_action?(:new, new_resource) %>
+    ) if existing_action?(resource_class, :new) && authorized_action?(new_resource, :new) %>
 
     <%= 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 valid_action?(:export) %>    
+    ) if existing_action?(resource_class, :export) %>
   </div>
 ....
 ```
 
+### 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.
+
+To fix this issue you need to add the `export` action to the policy and define the logic for who can export the resource.
+
+Example:
+
+```ruby
+module Admin
+  class OrganizationPolicy < ApplicationPolicy
+    # ... other methods ...
+
+    def export?
+      # Define the logic for who can export organizations
+      # For example, allow only admins to export:
+      user.admin?
+    end
+
+    # ... other methods ...
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
+YARD::Rake::YardocTask.new
 
-task :default => :spec
+task default: :spec

data/administrate_exportable.gemspec

@@ -1,17 +1,16 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "administrate_exportable/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "administrate_exportable"
-  spec.version       = AdministrateExportable::VERSION
-  spec.authors       = ["Jônatas Rancan", "Andrei Bondarev"]
-  spec.email         = ["hello@sourcelabs.io"]
-  spec.homepage      = 'https://github.com/SourceLabsLLC/administrate_exportable'
-  spec.summary       = "Simple plugin to add CSV export feature to Administrate"
-  spec.description   = spec.summary
-  spec.license       = "MIT"
+  spec.name = "administrate_exportable"
+  spec.version = AdministrateExportable::VERSION
+  spec.authors = ["Jônatas Rancan", "Andrei Bondarev"]
+  spec.email = ["hello@sourcelabs.io"]
+  spec.homepage = "https://github.com/SourceLabsLLC/administrate_exportable"
+  spec.summary = "Simple plugin to add CSV export feature to Administrate"
+  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.
@@ -22,19 +21,20 @@ Gem::Specification.new do |spec|
   #     "public gem pushes."
   # end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  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'
-  spec.add_dependency 'railties', '>= 5.2.2.1'
+  spec.add_dependency "administrate", ">= 0.17.0"
+  spec.add_dependency "rails", ">= 4.2"
+  spec.add_dependency "actionview", ">= 5.2.2.1"
+  spec.add_dependency "railties", ">= 5.2.2.1"
+  spec.add_dependency "csv", "~> 3.0"
 end

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

@@ -0,0 +1,35 @@
+<% content_for(:title) do %>
+  <%= display_resource_name(page.resource_name) %>
+<% end %>
+
+<header class="main-content__header">
+  <h1 class="main-content__page-title" id="page-title">
+    <%= content_for(:title) %>
+  </h1>
+
+  <% if show_search_bar %>
+    <%= render(
+      "search",
+      search_term: search_term,
+      resource_name: display_resource_name(page.resource_name)
+    ) %>
+  <% end %>
+
+  <div>
+    <%= link_to(
+      t(
+        "administrate.actions.new_resource",
+        name: display_resource_name(page.resource_name, singular: true).downcase
+      ),
+      [:new, namespace, page.resource_path.to_sym],
+      class: "button",
+    ) if accessible_action?(new_resource, :new) %>
+
+    <%= link_to(
+      'Export',
+      [:export, namespace, page.resource_name.to_s.pluralize.to_sym, sanitized_order_params(page, :id).to_h.merge(format: :csv)],
+      class: 'button',
+      target: '_blank'
+    ) if existing_action?(resource_class, :export) && authorized_action?(resource_name, :export) %>
+  </div>
+</header>

data/lib/administrate_exportable/exporter.rb

@@ -11,8 +11,8 @@ module AdministrateExportable
         define_method(:export) do
           search_term = params[:search].to_s.strip
           resources = Administrate::Search.new(scoped_resource,
-                                               dashboard,
-                                               search_term).run
+            dashboard,
+            search_term).run
           resources = apply_collection_includes(resources)
           resources = order.apply(resources)
 

data/lib/administrate_exportable/exporter_service.rb

@@ -1,4 +1,4 @@
-require 'csv'
+require "csv"
 
 module AdministrateExportable
   class ExporterService
@@ -14,7 +14,6 @@ module AdministrateExportable
 
     def csv
       CSV.generate(headers: true) do |csv|
-
         csv << headers
 
         collection.find_each do |record|
@@ -30,7 +29,7 @@ module AdministrateExportable
     attr_reader :dashboard, :resource_class, :resources, :sanitizer
 
     def record_attribute(record, attribute_key, attribute_type)
-      field = attribute_type.new(attribute_key, record.send(attribute_key), 'index', resource: record)
+      field = attribute_type.new(attribute_key, record.send(attribute_key), "index", resource: record)
       transform_on_export = attribute_type.respond_to?(:options) && attribute_type.options[:transform_on_export]
 
       if transform_on_export.is_a? Proc
@@ -41,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 if field.data
+        field.data&.count
       when Administrate::Field::DateTime.to_s
         field.datetime if field.data
       when Administrate::Field::Date.to_s
@@ -61,24 +60,22 @@ module AdministrateExportable
       attributes_to_export.map do |attribute_key, _|
         attr_key = attribute_key.to_s
 
-        if attr_key.include?('_id')
+        if attr_key.include?("_id")
           attr_key
         else
-	  I18n.t(
+          I18n.t(
             "helpers.label.#{resource_class.name.downcase}.#{attr_key}",
-            default: attr_key,
+            default: attr_key
           ).titleize
         end
       end
     end
 
     def attributes_to_export
-      @attributes_to_export ||= begin
-        dashboard.class::ATTRIBUTE_TYPES.select do |attribute_key, attribute_type|
-          attribute_options = attribute_type.try(:options)
+      @attributes_to_export ||= dashboard.class::ATTRIBUTE_TYPES.select do |attribute_key, attribute_type|
+        attribute_options = attribute_type.try(:options)
 
-          !attribute_options || attribute_options[:export] != false
-        end
+        !attribute_options || attribute_options[:export] != false
       end
     end
 

data/lib/administrate_exportable/version.rb

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

data/lib/administrate_exportable.rb

@@ -4,7 +4,7 @@ require "administrate_exportable/exporter"
 require "administrate/version"
 
 module AdministrateExportable
-  PAGE_PARAM = Gem::Version.create(Administrate::VERSION) >= Gem::Version.create('0.15.0') ? '_page' : 'page'
+  PAGE_PARAM = (Gem::Version.create(Administrate::VERSION) >= Gem::Version.create("0.15.0")) ? "_page" : "page"
 
   class Engine < ::Rails::Engine
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: administrate_exportable
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Jônatas Rancan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2026-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.2.1
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Simple plugin to add CSV export feature to Administrate
 email:
 - hello@sourcelabs.io
@@ -130,6 +144,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".tool-versions"
@@ -140,8 +155,8 @@ files:
 - README.md
 - Rakefile
 - administrate_exportable.gemspec
+- app/views/admin/application/_index_header.html.erb
 - app/views/admin/application/_pagination.html.erb
-- app/views/admin/application/index.html.erb
 - bin/console
 - bin/setup
 - lib/administrate_exportable.rb
@@ -167,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Simple plugin to add CSV export feature to Administrate

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

@@ -1,68 +0,0 @@
-<%#
-# Index
-This view is the template for the index page.
-It is responsible for rendering the search bar, header and pagination.
-It renders the `_table` partial to display details about the resources.
-## Local variables:
-- `page`:
-  An instance of [Administrate::Page::Collection][1].
-  Contains helper methods to help display a table,
-  and knows which attributes should be displayed in the resource's table.
-- `resources`:
-  An instance of `ActiveRecord::Relation` containing the resources
-  that match the user's search criteria.
-  By default, these resources are passed to the table partial to be displayed.
-- `search_term`:
-  A string containing the term the user has searched for, if any.
-- `show_search_bar`:
-  A boolean that determines if the search bar should be shown.
-[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Collection
-%>
-
-<% content_for(:title) do %>
-  <%= display_resource_name(page.resource_name) %>
-<% end %>
-
-<header class="main-content__header" role="banner">
-  <h1 class="main-content__page-title" id="page-title">
-    <%= content_for(:title) %>
-  </h1>
-
-  <% if show_search_bar %>
-    <%= render(
-      "search",
-      search_term: search_term,
-      resource_name: display_resource_name(page.resource_name)
-    ) %>
-  <% end %>
-
-  <div>
-    <%= link_to(
-      t(
-        "administrate.actions.new_resource",
-        name: page.resource_name.titleize.downcase
-      ),
-      [:new, namespace, page.resource_path.to_sym],
-      class: "button",
-    ) if valid_action?(:new) && show_action?(:new, new_resource) %>
-    <%= link_to(
-      'Export',
-      [:export, namespace, page.resource_name.to_s.pluralize.to_sym, sanitized_order_params(page, :id).to_h.merge(format: :csv)],
-      class: 'button',
-      target: '_blank'
-    ) if valid_action?(:export) && show_action?(:export, resource_name) %>
-  </div>
-</header>
-
-<section class="main-content__body main-content__body--flush">
-  <%= render(
-    "collection",
-    collection_presenter: page,
-    collection_field_name: resource_name,
-    page: page,
-    resources: resources,
-    table_title: "page-title"
-  ) %>
-
-  <%= render("pagination", resources: resources) %>
-</section>