importo 2.0.5 → 3.0.9

data/app/views/importo/imports/new.html.slim

@@ -1,24 +1,34 @@
-= sts.form_for(@import) do |f|
-  = f.input :kind, as: :hidden
-  = sts.card title: t('.title'), icon: 'fad fa-file-spreadsheet' do |card|
-    - card.action
-      = f.submit
+.grid.grid-cols-1.gap-4.sm:grid-cols-3.mt-4
+  .col-span-3.sm:col-span-3
+    = sts.form_for(@import) do |f|
+      = f.input :kind, as: :hidden
+      = sts.card :"importo_imports #{@import.kind}", title: t('.title'), icon: 'fad fa-file-spreadsheet' do |card|
+        - card.with_action
+          = f.submit
 
-    .grid.grid-cols-12.gap-4
-      .col-span-12
-        .prose
-          p= t('.explanation_html', name: @import.importer.class.friendly_name, sample_path: sample_import_path(kind: @import.kind))
-          - if @import.allow_export?
-            p= t('.export_html', export_path: export_path(kind: @import.kind))
+        .grid.grid-cols-12.gap-4
+          .col-span-12
+            .prose
+              p= t('.explanation_html', name: @import.importer.class.friendly_name, sample_path: sample_import_path(kind: @import.kind))
+              - if @import.allow_export?
+                p= t('.export_html', export_path: export_path(kind: @import.kind))
 
-      .col-span-12
-        - @import.importer.overridable_columns.each do |column|
-          = f.fields_for :column_overrides do |fff|
-            - if column.collection
-              = fff.input column.attribute, as: :select, label: column.name, collection: column.collection, include_blank: true, required: false
-            - else
-              =  fff.input column.attribute, label: column.name, required: false
+          .col-span-12
+            - @import.importer.overridable_columns.each do |column|
+              = f.fields_for :column_overrides do |fff|
+                - if column.collection
+                  = fff.input column.attribute, as: :select, label: column.name, collection: column.collection, include_blank: true, required: false
+                - else
+                  =  fff.input column.attribute, label: column.name, required: false
 
-      .col-span-12
-        = f.input :original, as: :file
+          .col-span-12
+            = f.input :original, as: :file
+
+.grid.grid-cols-1.gap-4.sm:grid-cols-3.mt-4
+  .col-span-3.sm:col-span-3
+    = sts.card :importo_imports, title: "#{@import.kind.humanize} imports", icon: 'fad fa-file-import', content_padding: false do |card|
+      - if defined? Mensa
+        = sts.mensa(:importo_mensa_imports, parameters: { kind: @import.kind })
+      - else
+        = card.with_table(:importo_imports, parameters: { kind: @import.kind }, custom_views: false)
 

data/config/locales/en.yml

@@ -1,8 +1,8 @@
 en:
   helpers:
-      submit:
-        importo/import:
-          create: "Import"
+    submit:
+      importo/import:
+        create: "Import"
   importo:
     sheet:
       results:
@@ -10,24 +10,36 @@ en:
       explanation:
         name: Explanation
         column: Column
-        explanation: Explanation
+        value: Value
+        explanation: Purpose
+        example: Example
     imports:
       index:
         title: Import results
+        card:
+          importo_imports:
+            title: Import results
+            tab:
+              Imports: Imports
       new:
-        submit: 'Import'
+        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
-        error_explanation: 'The following problems prohibited this import from completing:'
+        error_explanation: "The following problems prohibited this import from completing:"
         import: Import %{kind}
         import_button: Import
+        card:
+          importo_imports:
+            tab:
+              importo_imports: Imports
       create:
         flash:
           no_file: Import failed, please upload a file.
-          error: Import failed, there were problems.
-          success: 'Import scheduled with id %{id}, you will get an email with the results.'
+          error: Import failed, there were problems %{error}.
+          success: "Import scheduled with id %{id}, you will get an email with the results."
     errors:
-      structure_invalid: 'The structure is invalid, these are the invalid headers: %{invalid_headers}'
+      parse_error: "We encountered a parse error: %{error}"
+      structure_invalid: "The structure is invalid, these are the invalid headers: %{invalid_headers}"
     importers:
       result_message: "Successfully imported %{nr} of %{of} rows"

data/config/locales/nl.yml

@@ -6,23 +6,29 @@ nl:
       explanation:
         name: Uitleg
         column: Kolom
-        explanation: Uitleg
+        value: Waarde
+        explanation: Doeleinde
+        example: Voorbeeld
     imports:
       index:
         title: Import resultaten
+        card:
+          importo_imports:
+            title: Imports
       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.
-          error_explanation: 'De import is mislukt door de volgende problemen:'
+          error_explanation: "De import is mislukt door de volgende problemen:"
           import: Import %{kind}
           import_button: Importeer
       create:
         flash:
           no_file: Import mislukt, upload een bestand.
           error: Import mislukt, er waren problemen, voor details zie hieronder.
-          success: 'Import geplanned met id %{id}, je krijgt een email met de resultaten.'
+          success: "Import geplanned met id %{id}, je krijgt een email met de resultaten."
     errors:
-      structure_invalid: 'The structuur is ongeldig, dit zijn de ongeldige headers: %{invalid_headers}'
+      parse_error: "We ondervonden een parse error: %{error}"
+      structure_invalid: "The structuur is ongeldig, dit zijn de ongeldige headers: %{invalid_headers}"
     importers:
       result_message: "%{nr} van %{of} rijen succesvol geimporteerd"

data/config/routes.rb

@@ -6,8 +6,8 @@ Importo::Engine.routes.draw do
       post :undo
     end
   end
-  get ':kind/new', to: 'imports#new', as: :new_import
-  get ':kind/sample', to: 'imports#sample', as: :sample_import
-  get ':kind/export', to: 'imports#export', as: :export
-  root to: 'imports#index'
+  get ":kind/new", to: "imports#new", as: :new_import
+  get ":kind/sample", to: "imports#sample", as: :sample_import
+  get ":kind/export", to: "imports#export", as: :export
+  root to: "imports#index"
 end

data/db/migrate/20180409151031_create_importo_import.rb

@@ -1,19 +1,19 @@
 class CreateImportoImport < ActiveRecord::Migration[5.1]
   def change
-    enable_extension 'uuid-ossp'
-    enable_extension 'pgcrypto'
+    enable_extension "uuid-ossp"
+    enable_extension "pgcrypto"
 
     return if table_exists?(:importo_imports)
 
     create_table :importo_imports, id: :uuid do |t|
-      t.string  :importo_ownable_type, null: false
-      t.uuid    :importo_ownable_id, null: false
+      t.string :importo_ownable_type, null: false
+      t.uuid :importo_ownable_id, null: false
 
-      t.string  :kind
-      t.string  :state
-      t.string  :file_name
-      t.string  :result_message
-      t.jsonb   :results
+      t.string :kind
+      t.string :state
+      t.string :file_name
+      t.string :result_message
+      t.jsonb :results
 
       t.timestamps
     end

data/db/migrate/20180628175535_add_locale_importo_import.rb

@@ -2,6 +2,6 @@ class AddLocaleImportoImport < ActiveRecord::Migration[5.1]
   def change
     return if column_exists?(:importo_imports, :locale)
 
-    add_column :importo_imports, :locale, :string, default: 'en'
+    add_column :importo_imports, :locale, :string, default: "en"
   end
 end

data/db/migrate/20230510051447_remove_result_from_imports.rb

@@ -0,0 +1,5 @@
+class RemoveResultFromImports < ActiveRecord::Migration[7.0]
+  def change
+    remove_column :importo_imports, :results, :jsonb
+  end
+end

data/db/migrate/20230510083043_create_importo_results.rb

@@ -0,0 +1,11 @@
+class CreateImportoResults < ActiveRecord::Migration[7.0]
+  def change
+    create_table :importo_results, id: :uuid do |t|
+      t.integer :row_index
+      t.references :import, type: :uuid, null: false, foreign_key: {to_table: :importo_imports}
+      t.jsonb :details, default: {}
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/importo/importer_generator.rb

@@ -1,6 +1,6 @@
 module Importo
   class ImporterGenerator < Rails::Generators::NamedBase
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path("templates", __dir__)
 
     def copy_initializer_file
       template "application_importer.rb", "app/importers/application_importer.rb"

data/lib/generators/importo/install_generator.rb

@@ -1,26 +1,25 @@
 # frozen_string_literal: true
 
-require 'rails/generators/base'
+require "rails/generators/base"
 
 module Importo
   module Generators
-
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __dir__)
+      source_root File.expand_path("../templates", __dir__)
 
-      desc 'Creates a Importo initializer and copy locale files to your application.'
+      desc "Creates a Importo initializer and copy locale files to your application."
 
       def copy_initializer
-        template 'importo.rb', 'config/initializers/importo.rb'
+        template "importo.rb", "config/initializers/importo.rb"
       end
 
       def copy_locale
-        copy_file '../../../config/locales/en.yml', 'config/locales/importo.en.yml'
-        copy_file '../../../config/locales/nl.yml', 'config/locales/importo.nl.yml'
+        copy_file "../../../config/locales/en.yml", "config/locales/importo.en.yml"
+        copy_file "../../../config/locales/nl.yml", "config/locales/importo.nl.yml"
       end
 
       def show_readme
-        readme 'README' if behavior == :invoke
+        readme "README" if behavior == :invoke
       end
     end
   end

data/lib/generators/importo/templates/importo.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Importo.setup do |config|
+  config.base_controller = "::ApplicationController"
+  config.admin_authentication_module = "Authenticated"
+
+  # Current import owner
+  config.current_import_owner = -> { Current.user }
+
+  config.queue_name = :import
+end

data/lib/generators/satis/install_generator.rb

@@ -0,0 +1,22 @@
+module Satis
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer_file
+      template "config/initializers/satis.rb"
+    end
+
+    def add_route
+      return if Rails.application.routes.routes.detect { |route| route.app.app == Satis::Engine }
+      route %(mount Satis::Engine => "/satis")
+    end
+
+    def copy_migrations
+      rake "satis:install:migrations"
+    end
+
+    def tailwindcss_config
+      rake "satis:tailwindcss:config"
+    end
+  end
+end

data/lib/generators/satis/tailwind_config_generator.rb

@@ -0,0 +1,24 @@
+require "rails/generators/base"
+
+module Satis
+  module Generators
+    class TailwindConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __dir__)
+      desc "Configures tailwind.config.js and application.tailwindcss.css"
+
+      def add_content_to_tailwind_config
+        inject_into_file "config/tailwind.config.js", before: "],\n  theme: {" do
+          "  // Satis content\n" +
+            %w[/app/views/**/* /app/helpers/**/* /app/controllers/**/* /app/components/**/* /app/javascript/**/*.js /app/assets/**/*.css].map { |path| "    \"#{Satis::Engine.root}#{path}\"" }.join(",\n") +
+            ",\n  "
+        end
+      end
+
+      def add_content_application_tailwind_css
+        inject_into_file "app/assets/stylesheets/application.tailwind.css", before: "@tailwind base;" do
+          "@import '#{Satis::Engine.root}/app/assets/stylesheets/satis/application.css';\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/satis/templates/config/initializers/satis.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Satis.setup do |config|
+  config.submit_on_enter = false
+
+  config.logger = Rails.logger
+  config.confirm_before_leave = false
+  config.current_user = -> { Current.user }
+
+  config.default_help_text = lambda do |template, object, key, additional_scope|
+    I18n.t((["help"] + [key.to_s]).join("."), default: nil)
+  end
+end

data/lib/importo/acts_as_import_owner.rb

@@ -5,7 +5,7 @@ module Importo
     extend ActiveSupport::Concern
 
     included do
-      has_many :import, as: :importo_ownable, class_name: 'Importo::Import'
+      has_many :import, as: :importo_ownable, class_name: "Importo::Import"
     end
   end
 end

data/lib/importo/configuration.rb

@@ -1,68 +1,71 @@
 # frozen_string_literal: true
 
 module Importo
-  class Configuration
-    attr_accessor :admin_authentication_module
-    attr_accessor :base_controller
-    attr_accessor :base_service
-    attr_accessor :base_service_context
-    attr_accessor :queue_name
-
-    attr_writer :logger
-    attr_writer :current_import_owner
-    attr_writer :import_callbacks
-    attr_writer :admin_visible_imports
-    attr_writer :admin_can_destroy
-    attr_writer :admin_extra_links
-
-    def initialize
-      @logger               = Logger.new(STDOUT)
-      @logger.level         = Logger::INFO
-      @base_controller      = '::ApplicationController'
-      @base_service         = '::ApplicationService'
-      @base_service_context = '::ApplicationContext'
-      @current_import_owner = -> {}
-      @import_callbacks     = {
-        importing: lambda do |_import|
-        end,
-        completed: lambda do |_import|
-        end,
-        failed:    lambda do |_import|
-        end
-      }
-      @queue_name = :import
+  module Options
+    module ClassMethods
+      def option(name, default: nil)
+        attr_accessor(name)
+        schema[name] = default
+      end
 
-      @admin_visible_imports = -> { Importo::Import.where(importo_ownable: current_import_owner) }
-      @admin_can_destroy = ->(_import) { false }
-
-      # Extra links relevant for this import: { link_name: { icon: 'far fa-..', url: '...' } }
-      @admin_extra_links = ->(_import) { }
+      def schema
+        @schema ||= {}
+      end
     end
 
-    # Config: logger [Object].
-    def logger
-      @logger.is_a?(Proc) ? instance_exec(&@logger) : @logger
+    def set_defaults!
+      self.class.schema.each do |name, default|
+        instance_variable_set(:"@#{name}", default)
+      end
     end
 
-    def current_import_owner
-      raise 'current_import_owner should be a Proc' unless @current_import_owner.is_a? Proc
-      instance_exec(&@current_import_owner)
+    def self.included(cls)
+      cls.extend(ClassMethods)
     end
+  end
+
+  class Configuration
+    include Options
+
+    option :logger, default: Rails.logger
+    option :admin_authentication_module
+    option :base_controller, default: "::ApplicationController"
+    option :base_service, default: "::ApplicationService"
+    option :base_service_context, default: "::ApplicationContext"
+    option :current_import_owner, default: lambda {}
+    option :queue_name, default: :import
+
+    option :admin_visible_imports, default: lambda { Importo::Import.where(importo_ownable: Importo.config.current_import_owner) }
+    option(:admin_can_destroy,
+      default: lambda do |import|
+        false
+      end)
+
+    # Extra links relevant for this import: { link_name: { icon: 'far fa-..', url: '...' } }
+    option(:admin_extra_links,
+      default: lambda do |import|
+        []
+      end)
 
-    def import_callback(import, state)
-      instance_exec(import, &@import_callbacks[state]) if @import_callbacks[state]
+    def initialize
+      set_defaults!
     end
+  end
+
+  module Configurable
+    attr_writer :config
 
-    def admin_visible_imports
-      instance_exec(&@admin_visible_imports) if @admin_visible_imports
+    def config
+      @config ||= Configuration.new
     end
 
-    def admin_can_destroy(import)
-      instance_exec(import, &@admin_can_destroy) if @admin_can_destroy
+    def configure
+      yield(config)
     end
+    alias_method :setup, :configure
 
-    def admin_extra_links(import)
-      instance_exec(import, &@admin_extra_links) if @admin_extra_links
+    def reset_config!
+      @config = Configuration.new
     end
   end
 end

data/lib/importo/engine.rb

@@ -1,23 +1,25 @@
 # frozen_string_literal: true
 
+require "axlsx"
+require "roo"
+require "roo-xls"
+require "slim"
+require "state_machines-activerecord"
+require "signum"
+require "turbo-rails"
+require "view_component"
+require "with_advisory_lock"
+
 module Importo
   class Engine < ::Rails::Engine
     isolate_namespace Importo
 
-    initializer 'importo.active_storage.attached' do
+    initializer "importo.active_storage.attached" do
       config.after_initialize do
         ActiveSupport.on_load(:active_record) do
           Importo::Import.include(ImportHelpers)
         end
       end
     end
-
-    initializer 'importo.append_migrations' do |app|
-      unless app.root.to_s.match?(root.to_s)
-        config.paths['db/migrate'].expanded.each do |expanded_path|
-          app.config.paths['db/migrate'] << expanded_path
-        end
-      end
-    end
   end
 end

data/lib/importo/import_column.rb

@@ -3,12 +3,12 @@
 module Importo
   class ImportColumn
     attr_accessor :proc, :options
-    attr_writer :name, :hint, :explanation
+    attr_writer :name, :hint, :explanation, :value, :example
 
-    def initialize(name, hint, explanation, options, &block)
+    def initialize(name: nil, **options, &block)
       @name = name
-      @hint = hint
-      @explanation = explanation
+      @hint = options[:hint]
+      @explanation = options[:explanation]
       @options = options || {}
       @proc = block
     end
@@ -33,11 +33,19 @@ module Importo
     end
 
     def hint
-      I18n.t(".hint.#{options[:attribute]}", scope: [:importers, options[:scope]], default: '') if options[:attribute]
+      I18n.t(".hint.#{options[:attribute]}", scope: [:importers, options[:scope]], default: "") if options[:attribute]
     end
 
     def explanation
-      I18n.t(".explanation.#{options[:attribute]}", scope: [:importers, options[:scope]], default: '') if options[:attribute]
+      I18n.t(".explanation.#{options[:attribute]}", scope: [:importers, options[:scope]], default: "") if options[:attribute]
+    end
+
+    def value
+      I18n.t(".value.#{options[:attribute]}", scope: [:importers, options[:scope]], default: "") if options[:attribute]
+    end
+
+    def example
+      I18n.t(".example.#{options[:attribute]}", scope: [:importers, options[:scope]], default: "") if options[:attribute]
     end
 
     ##
@@ -51,5 +59,9 @@ module Importo
     def collection
       options[:collection]
     end
+
+    def delay
+      options[:delay]
+    end
   end
 end

data/lib/importo/test_helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "axlsx"
+
+module Importo
+  module TestHelpers
+    def simple_sheet(an_array, sheet_name: "Import")
+      xls = Axlsx::Package.new
+      workbook = xls.workbook
+      sheet = workbook.add_worksheet(name: sheet_name)
+
+      an_array.each do |a|
+        sheet.add_row a
+      end
+
+      xls.to_stream
+    end
+  end
+end

data/lib/importo/version.rb

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

data/lib/importo.rb

@@ -1,29 +1,24 @@
 # frozen_string_literal: true
 
-require 'axlsx'
-require 'roo'
-require 'roo-xls'
-require 'slim'
-require 'state_machines-activerecord'
-# require 'active_storage/downloading'
-
-require_relative 'importo/engine'
-require_relative 'importo/acts_as_import_owner'
-require_relative 'importo/import_column'
-require_relative 'importo/import_helpers'
-require_relative 'importo/configuration'
+require_relative "importo/engine"
+require_relative "importo/acts_as_import_owner"
+require_relative "importo/import_column"
+require_relative "importo/import_helpers"
+require_relative "importo/configuration"
 
 module Importo
+  extend Configurable
+
   class Error < StandardError; end
 
   class DuplicateRowError < Error; end
 
-  class << self
-    attr_reader :config
+  class RetryError < StandardError
+    attr_reader :delay
 
-    def setup
-      @config = Configuration.new
-      yield config
+    def initialize(msg, delay)
+      super(msg)
+      @delay = delay
     end
   end
 end