importo 3.0.26 → 3.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6b9f5a7602b4cff37fb084cf00b657358637ceec299afe88895d8b06961cf6
-  data.tar.gz: edf96c419ecb1504ce5fcd4588ee9f5cd2d121e254c4a39fa283c44edfebb1e8
+  metadata.gz: 013fc113e0d5a9cd16cd888462a9d5437ee21d329cbe680ed5a905b6fd53dd23
+  data.tar.gz: 2d7b1fadf7a61b4527d02bfc3a206096f0acaa413b26a3cf61ebb43f15a45ef5
 SHA512:
-  metadata.gz: 156626804a208b63f94db287102c7c24b24e52022df51a9d339e6f40adea95aee44ade306d2622691a823604ad6cc46d3da9fccb9a5a541be44ac4ab0969d238
-  data.tar.gz: d34945cd95e615c507670298da6d8bcc2aa5cf92f63bdb69c14d94992d6d89d7e9d8006e3b1a213500580dd13df4efb2b50059b878303d7954b863f0c22d9b4c
+  metadata.gz: 967c9f7fc07adadaab9707cd6e6b87098a9672026871992b86d985d73e270bb5269cbd2ae244e0c30e85d89f8bbae4e28bc469e07c8bf3013f0820d8a11f6060
+  data.tar.gz: 2c6f5a588b252208692070db52fb65e3a5aa74a42040f9e30acdb8d085725672db888e143b76e28a02ba7b3de3ba8f1b20c33c45af15a52c4b4ea15884ac62a0

data/app/controllers/importo/imports_controller.rb

@@ -86,15 +86,13 @@ module Importo
     end
 
     def sample
-      import = Import.new(kind: params[:kind], locale: I18n.locale)
-      send_data import.importer.sample_file.read,
-        type: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", filename: import.importer.file_name("sample")
+      create_export(:sample)
+      redirect_back(fallback_location: importo.new_import_path(params[:kind]))
     end
 
     def export
-      import = Import.new(kind: params[:kind], locale: I18n.locale)
-      send_data import.importer.export_file.read,
-        type: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", filename: import.importer.file_name("export")
+      create_export(:export)
+      redirect_back(fallback_location: importo.new_import_path(params[:kind]))
     end
 
     def index
@@ -103,6 +101,13 @@ module Importo
 
     private
 
+    def create_export(kind)
+      import = Import.new(kind: params[:kind], locale: I18n.locale,
+        importo_ownable: Importo.config.current_import_owner.call)
+      import.save!(validate: false)
+      ExportJob.perform_later(import.id, kind)
+    end
+
     def import_params
       params.require(:import).permit(:original, :kind, :column_overrides,
         column_overrides: params.dig(:import, :column_overrides)&.keys)

data/app/importers/importo/base_importer.rb

@@ -28,11 +28,6 @@ module Importo
       I18n.locale = import.locale if import&.locale # Should we do this?? here??
     end
 
-    def state_changed(_import, transition)
-      run_callbacks(transition.to_name) do
-      end
-    end
-
     class << self
       def t(key, options = {})
         if I18n.exists? :"importers.#{name.underscore}#{key}"

data/app/importers/importo/import_job_callback.rb

@@ -10,23 +10,29 @@ module Importo
     end
 
     def complete_import(import)
-      if import.present?
-        results_file = import.importer.results_file
-        results_file = results_file.is_a?(StringIO) ? results_file : File.open(results_file)
-
-        import.result.attach(io: results_file, filename: import.importer.file_name("results"),
-          content_type: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
-
-        ActiveRecord::Base.uncached do
-          import.result_message = I18n.t("importo.importers.result_message",
-            nr: import.results.where("details @> ?", {state: "success"}.to_json).count, of: import.importer.send(:row_count))
-        end
-
-        if import.can_complete?
-          import.complete!
-        else
-          import.save!
-        end
+      return if import.blank?
+
+      # Sidekiq's batch :complete event can fire as soon as every row has been
+      # attempted once, even though some rows failed and are still awaiting a
+      # retry. Bail out here so we don't finalize (and report a wrong count)
+      # before every row has actually finished processing.
+      return unless import.results.count == import.importer.send(:row_count)
+
+      results_file = import.importer.results_file
+      results_file = results_file.is_a?(StringIO) ? results_file : File.open(results_file)
+
+      import.result.attach(io: results_file, filename: import.importer.file_name("results"),
+        content_type: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
+
+      ActiveRecord::Base.uncached do
+        import.result_message = I18n.t("importo.importers.result_message",
+          nr: import.results.where("details @> ?", {state: "success"}.to_json).count, of: import.importer.send(:row_count))
+      end
+
+      if import.can_complete?
+        import.complete!
+      else
+        import.save!
       end
     end
 
@@ -36,5 +42,9 @@ module Importo
       import = Import.find(options["import_id"])
       complete_import(import)
     end
+
+    # Sidekiq's batch :success event only fires once every job (including
+    # retries) has truly succeeded, so it is the reliable place to finalize.
+    alias_method :on_success, :on_complete
   end
 end

data/app/jobs/importo/export_job.rb

@@ -0,0 +1,22 @@
+module Importo
+  class ExportJob < ApplicationJob
+    CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+
+    def perform(import_id, kind)
+      import = Import.find(import_id)
+      import.start_export!
+
+      importer = import.importer
+      file_kind = kind.to_sym
+      file = importer.public_send(:"#{file_kind}_file")
+
+      filename = importer.file_name(file_kind)
+      import.result.attach(io: file, filename: filename, content_type: CONTENT_TYPE)
+      import.update!(result_message: filename)
+      import.complete_export!
+    rescue => error
+      import&.update!(result_message: "Exception: #{error.message}")
+      import&.failure!
+    end
+  end
+end

data/app/jobs/importo/import_job.rb

@@ -16,13 +16,13 @@ module Importo
       # - Sidekiq calls on_complete callback when all jobs ran at least once.
       # - GoodJob calls on_complete callback when all jobs are done (including retries).
       # i.e. this logic is only needed for sidekiq
-      return unless Importo.sidekiq?
+      # return unless Importo.sidekiq?
 
-      batch = Importo::SidekiqBatchAdapter.find(bid)
+      # batch = Importo::SidekiqBatchAdapter.find(bid)
 
-      if !import.completed? && import.can_complete? && batch.finished?
-        ImportJobCallback.perform_now(batch, import.id)
-      end
+      # if !import.completed? && import.can_complete? && batch.finished?
+      #   ImportJobCallback.perform_now(batch, import.id)
+      # end
     end
   end
 end

data/app/models/importo/import.rb

@@ -10,7 +10,7 @@ module Importo
     has_many :results, class_name: "Importo::Result", dependent: :delete_all
 
     validates :kind, presence: true
-    validates :original, presence: true
+    validates :original, presence: true, unless: :export_state?
     validate :content_validator
 
     has_one_attached :original
@@ -23,10 +23,11 @@ module Importo
       state :completed
       state :failed
       state :reverted
+      state :exporting
+      state :exported
+      state :reverting
 
-      after_transition any => any do |imprt, transition|
-        imprt.importer.state_changed(imprt, transition)
-      end
+      around_transition :run_transition_callbacks
 
       after_transition any => :scheduled, :do => :schedule_import
       after_transition any => :reverting, :do => :schedule_revert
@@ -53,6 +54,14 @@ module Importo
         transition any => :failed
       end
 
+      event :start_export do
+        transition concept: :exporting
+      end
+
+      event :complete_export do
+        transition exporting: :exported
+      end
+
       event :revert do
         transition completed: :reverting
       end
@@ -71,6 +80,8 @@ module Importo
     end
 
     def content_validator
+      return if export_state?
+
       unless importer.structure_valid?
         errors.add(:original,
           I18n.t("importo.errors.structure_invalid",
@@ -109,6 +120,16 @@ module Importo
       results.where("details @> ?", '{"state":"processing"}').none?
     end
 
+    def export_state?
+      %w[exporting exported failed].include?(state) && original.blank?
+    end
+
+    def run_transition_callbacks(transition)
+      importer.run_callbacks(transition.to_name) do
+        yield
+      end
+    end
+
     private
 
     def schedule_import

data/app/tables/importo/imports_table.rb

@@ -30,7 +30,7 @@ if defined? ActionTable
     private
 
     def scope
-      @scope = Importo.config.admin_visible_imports.call
+      @scope = Importo.config.admin_visible_imports.call.where.not(state: %w[exporting exported])
       @scope
     end
   end

data/app/tables/importo/mensa_imports_table.rb

@@ -44,7 +44,7 @@ if defined? Mensa
     private
 
     def scope
-      @scope = Importo.config.admin_visible_imports.call
+      @scope = Importo.config.admin_visible_imports.call.where.not(state: %w[exporting exported])
       @scope = @scope.joins("LEFT JOIN users on importo_imports.importo_ownable_type = 'User' and importo_imports.importo_ownable_id = users.id ")
     end
 

data/config/locales/en.yml

@@ -27,8 +27,8 @@ en:
       new:
         submit: "Import"
         title: Import
-        explanation_html: A CSV or Excel file can be used to import records. The first row should be the column names.<br>If an <b>id</b> is supplied it will update the matching record instead of creating a new one.<br>Download a <a href='%{sample_path}' target='_blank'>sample template</a> with all supported column names and their explanation.
-        export_html: You can download the currently stored records.<br>Download the <a href='%{export_path}' target='_blank'>current data</a> with all supported columns
+        explanation_html: A CSV or Excel file can be used to import records. The first row should be the column names.<br>If an <b>id</b> is supplied it will update the matching record instead of creating a new one.<br>Download a <a href='%{sample_path}'>sample template</a> with all supported column names and their explanation.
+        export_html: You can download the currently stored records.<br>Download the <a href='%{export_path}'>current data</a> with all supported columns
         error_explanation: "The following problems prohibited this import from completing:"
         import: Import %{kind}
         import_button: Import

data/config/locales/nl.yml

@@ -18,7 +18,7 @@ nl:
       new:
         import:
           title: Importeer
-          explanation_html: Een CSV of Excel bestand kan gebruikt worden om records te importeren. De eerste rij moet de kolom namen bevatten.<br>Als een <b>id</b> is ingevuld, zal het bestaande record worden geupdate in plaats van een nieuwe aan te maken.<br>Download een <a href='%{sample_path}' target='_blank'>voorbeeld file</a> met alle ondersteunde kolomnamen en de bijbehorende uitleg.
+          explanation_html: Een CSV of Excel bestand kan gebruikt worden om records te importeren. De eerste rij moet de kolom namen bevatten.<br>Als een <b>id</b> is ingevuld, zal het bestaande record worden geupdate in plaats van een nieuwe aan te maken.<br>Download een <a href='%{sample_path}'>voorbeeld file</a> met alle ondersteunde kolomnamen en de bijbehorende uitleg.
           error_explanation: "De import is mislukt door de volgende problemen:"
           import: Import %{kind}
           import_button: Importeer

data/lib/importo/adapters/sidekiq_batch_adapter.rb

@@ -21,7 +21,12 @@ module Importo
     end
 
     def on_success(job)
+      # Register for both events: :complete can fire prematurely while rows are
+      # still awaiting a Sidekiq retry, :success only fires once every row has
+      # truly succeeded. ImportJobCallback itself guards against finalizing
+      # before every row has actually finished processing.
       @instance.on(:complete, job.constantize, properties)
+      @instance.on(:success, job.constantize, properties)
     end
 
     def add

data/lib/importo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Importo
-  VERSION = "3.0.26"
+  VERSION = "3.0.28"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: importo
 version: !ruby/object:Gem::Version
-  version: 3.0.26
+  version: 3.0.28
 platform: ruby
 authors:
 - Andre Meij
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-12 00:00:00.000000000 Z
+date: 2026-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx
@@ -318,6 +318,7 @@ files:
 - app/importers/importo/base_importer.rb
 - app/importers/importo/import_job_callback.rb
 - app/jobs/importo/application_job.rb
+- app/jobs/importo/export_job.rb
 - app/jobs/importo/import_job.rb
 - app/jobs/importo/import_revert_job.rb
 - app/jobs/importo/import_schedule_job.rb