importo 2.0.4

data/config/locales/en.yml

@@ -0,0 +1,33 @@
+en:
+  helpers:
+      submit:
+        importo/import:
+          create: "Import"
+  importo:
+    sheet:
+      results:
+        name: Results
+      explanation:
+        name: Explanation
+        column: Column
+        explanation: Explanation
+    imports:
+      index:
+        title: Import results
+      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
+        error_explanation: 'The following problems prohibited this import from completing:'
+        import: Import %{kind}
+        import_button: Import
+      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.'
+    errors:
+      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

@@ -0,0 +1,28 @@
+nl:
+  importo:
+    sheet:
+      results:
+        name: Resultaten
+      explanation:
+        name: Uitleg
+        column: Kolom
+        explanation: Uitleg
+    imports:
+      index:
+        title: Import resultaten
+      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:'
+          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.'
+    errors:
+      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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Importo::Engine.routes.draw do
+  resources :imports, except: %i[new] do
+    member 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'
+end

data/db/migrate/20180409151031_create_importo_import.rb

@@ -0,0 +1,21 @@
+class CreateImportoImport < ActiveRecord::Migration[5.1]
+  def change
+    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  :kind
+      t.string  :state
+      t.string  :file_name
+      t.string  :result_message
+      t.jsonb   :results
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180628175535_add_locale_importo_import.rb

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

data/db/migrate/20190827093548_add_selected_fields_to_import.rb

@@ -0,0 +1,5 @@
+class AddSelectedFieldsToImport < ActiveRecord::Migration[5.2]
+  def change
+    add_column :importo_imports, :column_overrides, :jsonb, default: {}, null: false
+  end
+end

data/lib/generators/importo/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate importer Thing
+
+    This will create:
+        app/importers/thing_importer.rb

data/lib/generators/importo/importer_generator.rb

@@ -0,0 +1,10 @@
+module Importo
+  class ImporterGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_initializer_file
+      template "application_importer.rb", "app/importers/application_importer.rb"
+      template "importer.rb", "app/importers/#{file_name}_importer.rb"
+    end
+  end
+end

data/lib/generators/importo/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Importo
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates a Importo initializer and copy locale files to your application.'
+
+      def copy_initializer
+        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'
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,14 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Check the initializer (in config/initializers/importo.rb) for additional
+     configuration options. Take not of coupon and provider sections.
+
+  2.
+
+  3.
+
+  4.
+
+===============================================================================

data/lib/generators/templates/application_importer.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationImporter < Importo::BaseImporter
+end

data/lib/generators/templates/importer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class <%=name%>Importer < ApplicationImporter
+  # Whether the excel sheet should contain a header
+  includes_header true
+  # Whether to allow importing of duplicates
+  allow_duplicates false
+  # Whether to ignore the given header and use our internal mapping
+  ignore_header false
+
+  field 'id', 'record ID of the <%=name%> (only if you want to update)'
+  field 'name', 'name of the <%=name%>'
+
+  # Here you will build the record based on the row
+  def build(row)
+    record = <%=name%>.find_or_initialize_by(id: row['id'])
+    record.name = row['name']
+    record
+  end
+
+  # Uncomment if you need to do something before saving the record
+  # def before_save(record, _row)
+  # end
+end

data/lib/generators/templates/importo.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Importo.setup do |config|
+  config.base_controller = '::ApplicationController'
+  config.admin_authentication_module = 'Authenticated'
+
+  # Current import owner
+  config.current_import_owner = -> { User.current }
+
+  # Set callbacks for the import states. You can configure callbacks to work with different states
+  config.import_callbacks = {
+      importing: lambda do |import|
+      end,
+      completed: lambda do |import|
+      end,
+      failed: lambda do |import|
+      end
+  }
+
+  config.queue_name = :import
+end

data/lib/importo/acts_as_import_owner.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Importo
+  module ActsAsImportOwner
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :import, as: :importo_ownable, class_name: 'Importo::Import'
+    end
+  end
+end

data/lib/importo/configuration.rb

@@ -0,0 +1,68 @@
+# 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
+
+      @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) { }
+    end
+
+    # Config: logger [Object].
+    def logger
+      @logger.is_a?(Proc) ? instance_exec(&@logger) : @logger
+    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)
+    end
+
+    def import_callback(import, state)
+      instance_exec(import, &@import_callbacks[state]) if @import_callbacks[state]
+    end
+
+    def admin_visible_imports
+      instance_exec(&@admin_visible_imports) if @admin_visible_imports
+    end
+
+    def admin_can_destroy(import)
+      instance_exec(import, &@admin_can_destroy) if @admin_can_destroy
+    end
+
+    def admin_extra_links(import)
+      instance_exec(import, &@admin_extra_links) if @admin_extra_links
+    end
+  end
+end

data/lib/importo/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Importo
+  class Engine < ::Rails::Engine
+    isolate_namespace Importo
+
+    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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Importo
+  class ImportColumn
+    attr_accessor :proc, :options
+    attr_writer :name, :hint, :explanation
+
+    def initialize(name, hint, explanation, options, &block)
+      @name = name
+      @hint = hint
+      @explanation = explanation
+      @options = options || {}
+      @proc = block
+    end
+
+    def attribute
+      options[:attribute] || @name
+    end
+
+    def name
+      name = options[:attribute] || @name
+      I18n.t(".column.#{name}", scope: [:importers, options[:scope]], default: name)
+    end
+
+    def allowed_names
+      return @allowed_names if @allowed_names.present?
+
+      name = options[:attribute] || @name
+
+      @allowed_names = I18n.available_locales.map do |locale|
+        I18n.t(".column.#{name}", scope: [:importers, options[:scope]], locale: locale, default: name)
+      end.compact.uniq
+    end
+
+    def hint
+      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]
+    end
+
+    ##
+    # If set this allows the user to set a value during upload that overrides the uploaded values.
+    def overridable?
+      options[:overridable]
+    end
+
+    ##
+    # Collection of values (name, id) that are valid for this field, if a name is entered it will be replaced by the id during pre-processing
+    def collection
+      options[:collection]
+    end
+  end
+end

data/lib/importo/import_helpers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Importo::ImportHelpers
+  extend ActiveSupport::Concern
+
+  included do
+    has_one_attached :original
+    has_one_attached :result
+  end
+end

data/lib/importo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Importo
+  VERSION = '2.0.4'
+end

data/lib/importo.rb

@@ -0,0 +1,29 @@
+# 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'
+
+module Importo
+  class Error < StandardError; end
+
+  class DuplicateRowError < Error; end
+
+  class << self
+    attr_reader :config
+
+    def setup
+      @config = Configuration.new
+      yield config
+    end
+  end
+end