activeadmin_batched_export 0.1.0

data/lib/activeadmin/batched_export/install.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module BatchedExport
+    module Install
+      module_function
+
+      def call
+        ActiveAdmin.application.namespaces.each do |namespace|
+          namespace.resources.each do |config|
+            next if config.is_a?(ActiveAdmin::Page)
+            next unless config.batched_export_enabled?
+            next unless config.controller.action_methods.include?("index")
+
+            changed = false
+            unless config.collection_actions.any? { |action| action.name.to_sym == :batched_export }
+              config.collection_actions << ActiveAdmin::ControllerAction.new(:batched_export, method: :get)
+              changed = true
+            end
+
+            controller = config.controller
+            unless controller.included_modules.include?(ControllerMethods)
+              controller.include(ControllerMethods)
+              changed = true
+            end
+
+            controller.clear_action_methods! if changed
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin/batched_export/resource_extension.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module BatchedExport
+    module ResourceSettings
+      def batched_export_settings
+        @batched_export_settings ||= {}
+      end
+
+      def batched_export_settings=(value)
+        @batched_export_settings = value || {}
+      end
+
+      def batched_export_enabled?
+        settings = batched_export_settings
+        if settings.key?(:enabled) || settings.key?("enabled")
+          return settings[:enabled] != false && settings["enabled"] != false
+        end
+
+        BatchedExport.config.default_enabled
+      end
+
+      def batched_export_column_selection?
+        settings = batched_export_settings
+        if settings.key?(:column_selection) || settings.key?("column_selection")
+          return settings[:column_selection] != false && settings["column_selection"] != false
+        end
+
+        BatchedExport.config.default_column_selection
+      end
+
+      def batched_export_batch_size
+        batched_export_settings[:batch_size] ||
+          batched_export_settings["batch_size"] ||
+          BatchedExport.config.batch_size
+      end
+
+      def batched_export_effective_batch_size
+        requested = batched_export_batch_size
+        maximum = BatchedExport.config.max_batch_size
+        [requested, maximum].min
+      end
+
+      def batched_export_includes
+        settings = batched_export_settings
+        settings[:includes] || settings["includes"]
+      end
+
+      def batched_export_filename_proc
+        batched_export_settings[:filename] ||
+          batched_export_settings["filename"] ||
+          BatchedExport.config.filename_proc
+      end
+    end
+
+    module ResourceDSL
+      def batched_export(**options)
+        config.batched_export_settings = options
+      end
+    end
+  end
+end
+
+ActiveAdmin::Resource.include(ActiveAdmin::BatchedExport::ResourceSettings)
+ActiveAdmin::ResourceDSL.include(ActiveAdmin::BatchedExport::ResourceDSL)

data/lib/activeadmin/batched_export/styles.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module BatchedExport
+    class Styles
+      DEFAULTS = {
+        workspace: "mx-auto max-w-2xl space-y-6 py-8",
+        card: "space-y-2 rounded border border-gray-200 bg-white p-4 dark:border-gray-700 dark:bg-gray-900/40",
+        card_title: "text-base font-semibold text-gray-900 dark:text-gray-100",
+        table: "w-full border-collapse text-sm",
+        table_body: "align-top",
+        table_row: "border-b border-gray-100 dark:border-gray-800",
+        table_header: "w-44 py-2 pr-4 text-left font-medium text-gray-600 dark:text-gray-400",
+        table_cell: "py-2 text-gray-900 dark:text-gray-100",
+        table_cell_mono: "py-2 font-mono text-sm text-gray-900 dark:text-gray-100",
+        hint: "text-sm text-gray-600 dark:text-gray-400",
+        column_grid: "grid max-h-[min(70vh,48rem)] grid-cols-1 gap-2 overflow-y-auto sm:grid-cols-2",
+        column_label: "flex cursor-pointer items-start gap-2 text-sm text-gray-900 dark:text-gray-100",
+        column_checkbox: "mt-0.5",
+        heading: "text-lg font-semibold",
+        progress_wrap: "hidden space-y-3 rounded border border-gray-200 p-4 dark:border-gray-700",
+        progress_bar: "h-2 w-full",
+        progress_status_row: "flex justify-between text-sm",
+        error: "hidden text-sm text-red-600",
+        warning: "text-sm text-amber-800 dark:text-amber-300",
+        actions: "flex flex-wrap gap-3",
+        primary_button: "rounded bg-blue-600 px-4 py-2 text-sm font-medium text-white hover:bg-blue-700 disabled:opacity-50",
+        secondary_button: "hidden rounded border border-gray-300 px-4 py-2 text-sm font-medium hover:bg-gray-50 disabled:opacity-50 dark:border-gray-600 dark:hover:bg-gray-800",
+        back_link: "inline-flex items-center text-sm text-blue-600 hover:underline"
+      }.freeze
+
+      def initialize(overrides = {})
+        @classes = DEFAULTS.merge(overrides)
+      end
+
+      def [](key)
+        @classes.fetch(key)
+      end
+
+      def merge(overrides)
+        self.class.new(@classes.merge(overrides))
+      end
+    end
+  end
+end

data/lib/activeadmin/batched_export/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module BatchedExport
+    VERSION = "0.1.0"
+  end
+end

data/lib/activeadmin/batched_export.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module BatchedExport
+    class << self
+      def config
+        require "activeadmin/batched_export/configuration"
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      def styles
+        config.styles
+      end
+
+      def install!
+        require "activeadmin/batched_export/install"
+        Install.call
+      end
+    end
+  end
+end

data/lib/activeadmin_batched_export.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "activeadmin/batched_export/version"
+require "activeadmin/batched_export"
+require "activeadmin/batched_export/engine"

data/sig/activeadmin/batched_export.rbs

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module BatchedExport
+    VERSION: String
+  end
+end

metadata

@@ -0,0 +1,377 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin_batched_export
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Makarov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta13
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta13
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: polyrun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: prosopite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.34'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.52'
+- !ruby/object:Gem::Dependency
+  name: standard-custom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: standard-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: standard-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: standard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Replaces long-lived ActiveAdmin index downloads with a batched export
+  workspace, customizable views, and export column macros.
+email:
+- contact@kiskolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- GOVERNANCE.md
+- LICENSE.md
+- README.md
+- SECURITY.md
+- activeadmin_batched_export.gemspec
+- app/assets/controllers/activeadmin_batched_export/batched_export_controller.js
+- app/views/active_admin/batched_export/_actions.html.erb
+- app/views/active_admin/batched_export/_columns.html.erb
+- app/views/active_admin/batched_export/_filters.html.erb
+- app/views/active_admin/batched_export/_progress.html.erb
+- app/views/active_admin/batched_export/_summary.html.erb
+- app/views/active_admin/batched_export/workspace.html.erb
+- app/views/active_admin/shared/_download_format_links.html.erb
+- config/locales/activeadmin_batched_export.en.yml
+- config/polyrun_coverage.yml
+- lib/activeadmin/batched_export.rb
+- lib/activeadmin/batched_export/configuration.rb
+- lib/activeadmin/batched_export/controller_methods.rb
+- lib/activeadmin/batched_export/engine.rb
+- lib/activeadmin/batched_export/export_macro_catalog.rb
+- lib/activeadmin/batched_export/export_macro_resolver.rb
+- lib/activeadmin/batched_export/install.rb
+- lib/activeadmin/batched_export/resource_extension.rb
+- lib/activeadmin/batched_export/styles.rb
+- lib/activeadmin/batched_export/version.rb
+- lib/activeadmin_batched_export.rb
+- sig/activeadmin/batched_export.rbs
+homepage: https://github.com/amkisko/activeadmin_batched_export.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amkisko/activeadmin_batched_export.rb
+  source_code_uri: https://github.com/amkisko/activeadmin_batched_export.rb/tree/main
+  changelog_uri: https://github.com/amkisko/activeadmin_batched_export.rb/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/amkisko/activeadmin_batched_export.rb/issues
+  documentation_uri: https://github.com/amkisko/activeadmin_batched_export.rb#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Batched CSV, JSON, and XML export workspace for ActiveAdmin 4
+test_files: []