ixport 0.1.0 → 0.3.0

data/app/views/ixport/imports/index.html.erb

@@ -7,4 +7,21 @@
       <div data-import><%= link_to registration.title, new_import_path(key: registration.key) %></div>
     <% end %>
   <% end %>
+  <% if @imports.any? %>
+    <%= ui_section(title: "Your imports") do %>
+      <% @imports.each do |import| %>
+        <div data-past-import>
+          <%= link_to import_step_path(import), data: { step_link: true } do %><span data-import-title><%= import.title %></span><% end %>
+          <span data-file-name><%= import.file.filename.to_s %></span>
+          <span data-status><%= import.status.capitalize %></span>
+          <span data-made-on><%= import.created_at.strftime("%b %-d, %Y") %></span>
+          <% if import.finished? %>
+            <span>Added <span data-added><%= import.added_count %></span></span>
+            <span>Updated <span data-updated><%= import.updated_count %></span></span>
+            <span>Refused <span data-refused><%= import.refusals.size %></span></span>
+          <% end %>
+        </div>
+      <% end %>
+    <% end %>
+  <% end %>
 <% end %>

data/app/views/ixport/imports/show.html.erb

@@ -1,20 +1,35 @@
-<%= ui_show_page(title: "Import finished", back_url: root_path) %>
+<% heading = if @import.running?
+                "Import running"
+              elsif @import.failed?
+                "Import failed"
+              else
+                "Import finished"
+              end %>
+<%= ui_show_page(title: heading, back_url: root_path) %>
 <%= ui_page(max_width: :md) do %>
-  <%= ui_page_header(title: "Import finished") %>
-  <%= ui_grid(cols: { default: 1, sm: 2 }) do %>
-    <%= ui_stat_card(label: "Added", value: tag.span(@import.added_count, data: { result_count: "added" })) %>
-    <%= ui_stat_card(label: "Updated", value: tag.span(@import.updated_count, data: { result_count: "updated" })) %>
-  <% end %>
-  <% if @import.refusals.any? %>
-    <%= ui_section(title: "Refused") do %>
-      <ul>
-        <% @import.refusals.each do |refusal| %>
-          <%= tag.li(data: { refused_row: true }) do %>
-            Row <%= tag.span(refusal.row_number, data: { row_number: true }) %>
-            <%= tag.span(refusal.reason, data: { reason: true }) %>
+  <%= ui_page_header(title: heading) %>
+  <% if @import.running? %>
+    <%= ui_alert(type: :info, message: tag.span("This import is running.", data: { import_running: true })) %>
+  <% else %>
+    <% if @import.failed? %>
+      <%= ui_alert(type: :error, message: tag.span(@import.error_message, data: { import_error: true })) %>
+      <p>Rows saved before it stopped stay saved.</p>
+    <% end %>
+    <%= ui_grid(cols: { default: 1, sm: 2 }) do %>
+      <%= ui_stat_card(label: "Added", value: tag.span(@import.added_count, data: { result_count: "added" })) %>
+      <%= ui_stat_card(label: "Updated", value: tag.span(@import.updated_count, data: { result_count: "updated" })) %>
+    <% end %>
+    <% if @import.refusals.any? %>
+      <%= ui_section(title: "Refused") do %>
+        <ul>
+          <% @import.refusals.each do |refusal| %>
+            <%= tag.li(data: { refused_row: true }) do %>
+              Row <%= tag.span(refusal.row_number, data: { row_number: true }) %>
+              <%= tag.span(refusal.reason, data: { reason: true }) %>
+            <% end %>
           <% end %>
-        <% end %>
-      </ul>
+        </ul>
+      <% end %>
     <% end %>
   <% end %>
 <% end %>

data/config/routes.rb

@@ -1,5 +1,9 @@
 Ixport::Engine.routes.draw do
   root "imports#index"
+  resources :exports, only: %i[index show] do
+    resources :templates, only: %i[new create], controller: "export_templates"
+  end
+  resources :export_templates, only: %i[show edit update destroy]
   resources :imports, only: %i[new create show] do
     resource :mapping, only: %i[show update]
     resource :preview, only: :show

data/lib/generators/ixport/install/install_generator.rb

@@ -15,6 +15,9 @@ module Ixport
       def copy_migrations
         migration_template "create_ixport_imports.rb.erb", "db/migrate/create_ixport_imports.rb"
         migration_template "create_ixport_import_refusals.rb.erb", "db/migrate/create_ixport_import_refusals.rb"
+        migration_template "create_ixport_export_templates.rb.erb", "db/migrate/create_ixport_export_templates.rb"
+        migration_template "add_wallflower_task_to_ixport_imports.rb.erb", "db/migrate/add_wallflower_task_to_ixport_imports.rb"
+        migration_template "add_error_message_to_ixport_imports.rb.erb", "db/migrate/add_error_message_to_ixport_imports.rb"
       end
     end
   end

data/lib/generators/ixport/install/templates/add_error_message_to_ixport_imports.rb.erb

@@ -0,0 +1,5 @@
+class AddErrorMessageToIxportImports < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :ixport_imports, :error_message, :text
+  end
+end

data/lib/generators/ixport/install/templates/add_wallflower_task_to_ixport_imports.rb.erb

@@ -0,0 +1,6 @@
+class AddWallflowerTaskToIxportImports < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :ixport_imports, :wallflower_task_id, :bigint
+    add_index :ixport_imports, :wallflower_task_id
+  end
+end

data/lib/generators/ixport/install/templates/create_ixport_export_templates.rb.erb

@@ -0,0 +1,12 @@
+class CreateIxportExportTemplates < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :ixport_export_templates do |t|
+      t.string :key, null: false
+      t.string :name, null: false
+      t.json :columns, null: false
+      t.references :person, polymorphic: true, null: false
+      t.references :account, polymorphic: true, null: true
+      t.timestamps
+    end
+  end
+end

data/lib/generators/ixport/update/update_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Ixport
+  module Generators
+    class UpdateGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("../install/templates", __dir__)
+
+      desc "Updates Ixport: copies the migrations added since it was installed."
+
+      def copy_export_templates_migration
+        migration_template "create_ixport_export_templates.rb.erb", "db/migrate/create_ixport_export_templates.rb"
+      end
+
+      def copy_wallflower_task_migration
+        migration_template "add_wallflower_task_to_ixport_imports.rb.erb", "db/migrate/add_wallflower_task_to_ixport_imports.rb"
+      end
+
+      def copy_error_message_migration
+        migration_template "add_error_message_to_ixport_imports.rb.erb", "db/migrate/add_error_message_to_ixport_imports.rb"
+      end
+    end
+  end
+end

data/lib/ixport/background_runner.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Ixport
+  class ImportFailed < StandardError; end
+
+  def self.background_runner
+    case configuration.background_runner
+    when nil then nil
+    when :wallflower then WallflowerRunner
+    else configuration.background_runner.to_s.constantize
+    end
+  end
+
+  def self.run_import(import, reporter: NullReporter.new)
+    import.run!(reporter: reporter)
+  end
+
+  def self.install_background_runner!
+    return unless configuration.background_runner == :wallflower
+
+    Wallflower.register_kind(:ixport_import, title: "Import", runner: "Ixport::WallflowerTaskRunner")
+  end
+end

data/lib/ixport/configuration.rb

@@ -2,7 +2,7 @@
 
 module Ixport
   class Configuration
-    attr_accessor :authentication_method, :current_person_method, :current_account_method, :layout, :inline_row_limit
+    attr_accessor :authentication_method, :current_person_method, :current_account_method, :layout, :inline_row_limit, :background_runner, :base_controller
 
     def initialize
       @authentication_method = :authenticate_user!
@@ -10,6 +10,8 @@ module Ixport
       @current_account_method = :current_account
       @layout = "application"
       @inline_row_limit = 1_000
+      @background_runner = nil
+      @base_controller = "::ApplicationController"
     end
   end
 

data/lib/ixport/engine.rb

@@ -4,6 +4,9 @@ module Ixport
   class Engine < ::Rails::Engine
     isolate_namespace Ixport
 
-    config.after_initialize { Ixport.check_registrations! }
+    config.after_initialize do
+      Ixport.check_registrations!
+      Ixport.install_background_runner!
+    end
   end
 end

data/lib/ixport/exporter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Ixport
+  class Exporter
+    Column = Struct.new(:key, :label, :through, keyword_init: true)
+
+    attr_reader :person, :account
+
+    def initialize(person:, account:)
+      @person = person
+      @account = account
+    end
+
+    def self.column(key, label:, through: nil)
+      columns << Column.new(key: key.to_sym, label: label, through: through)
+    end
+
+    def self.columns
+      @columns ||= []
+    end
+
+    def value(record, column)
+      source = column.through ? record.public_send(column.through) : record
+      source&.public_send(column.key)
+    end
+  end
+end

data/lib/ixport/importer.rb

@@ -19,12 +19,16 @@ module Ixport
       @fields ||= []
     end
 
-    def self.match_on(key)
-      @match_field = key.to_sym
+    def self.match_on(*keys)
+      @match_fields = keys.map(&:to_sym)
+    end
+
+    def self.match_fields
+      @match_fields || []
     end
 
     def self.match_field
-      @match_field
+      match_fields.first
     end
   end
 end

data/lib/ixport/registrations.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 module Ixport
-  Registration = Struct.new(:key, :title, :importer, keyword_init: true)
+  module AccessRule
+    def allows?(person, account)
+      allow.nil? || allow.call(person, account)
+    end
+  end
+
+  Registration = Struct.new(:key, :title, :importer, :allow, keyword_init: true) { include AccessRule }
+  ExportRegistration = Struct.new(:key, :title, :exporter, :chosen, :allow, keyword_init: true) { include AccessRule }
 
   class MissingImporter < StandardError; end
+  class MissingExporter < StandardError; end
 
-  def self.register_import(key, title:, importer:)
-    registrations[key.to_sym] = Registration.new(key: key.to_sym, title: title, importer: importer.to_s)
+  def self.register_import(key, title:, importer:, allow: nil)
+    registrations[key.to_sym] = Registration.new(key: key.to_sym, title: title, importer: importer.to_s, allow: allow)
   end
 
   def self.registration(key)
@@ -23,9 +31,27 @@ module Ixport
 
       raise MissingImporter, "Ixport import #{registration.key} names the importer #{registration.importer}, which does not exist."
     end
+    export_registrations.each_value do |registration|
+      next if registration.exporter.safe_constantize
+
+      raise MissingExporter, "Ixport export #{registration.key} names the exporter #{registration.exporter}, which does not exist."
+    end
+  end
+
+  def self.register_export(key, title:, exporter:, chosen: false, allow: nil)
+    export_registrations[key.to_sym] = ExportRegistration.new(key: key.to_sym, title: title, exporter: exporter.to_s, chosen: chosen, allow: allow)
+  end
+
+  def self.export_registration(key)
+    export_registrations.fetch(key.to_sym)
+  end
+
+  def self.export_registrations
+    @export_registrations ||= {}
   end
 
   def self.reset_registrations!
     @registrations = {}
+    @export_registrations = {}
   end
 end

data/lib/ixport/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ixport
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/ixport.rb

@@ -3,6 +3,8 @@ require "ixport/version"
 require "ixport/configuration"
 require "ixport/registrations"
 require "ixport/importer"
+require "ixport/exporter"
+require "ixport/background_runner"
 require "ixport/engine"
 
 module Ixport