solidus_importer 0.1.0

data/app/jobs/solidus_importer/import_job.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SolidusImporter
+  class ImportJob < ActiveJob::Base
+    queue_as :default
+
+    retry_on ActiveRecord::Deadlocked
+
+    def perform(source, import_type = nil)
+      raise ArgumentError, 'Missing import source' unless source
+
+      if source.is_a?(Integer)
+        perform_import_from_model(source)
+      elsif source.is_a?(String) && import_type.present?
+        perform_import_from_filename(source, import_type)
+      else
+        raise ArgumentError, "#{source} should be a filename or an Import id"
+      end
+    end
+
+    def perform_import_from_model(id)
+      import = ::SolidusImporter::Import.find(id)
+      ::SolidusImporter::ProcessImport.new(import).process
+    end
+
+    def perform_import_from_filename(filename, import_type)
+      ::SolidusImporter::ProcessImport.import_from_file(filename, import_type)
+    end
+  end
+end

data/app/models/solidus_importer/import.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SolidusImporter
+  class Import < ApplicationRecord
+    self.table_name = 'solidus_importer_imports'
+
+    attr_accessor :importer
+
+    has_many :rows,
+      class_name: 'SolidusImporter::Row',
+      inverse_of: :import,
+      dependent: :destroy
+
+    enum state: {
+      created: 'created',
+      processing: 'processing',
+      failed: 'failed',
+      completed: 'completed'
+    }
+
+    has_attached_file :file
+
+    do_not_validate_attachment_file_type :file
+    validates_attachment_presence :file
+    validates :import_type, presence: true, allow_blank: false
+    validates :state, presence: true, allow_blank: false
+
+    def created_or_failed?
+      %w[created failed].include? state
+    end
+
+    def finished?
+      rows.failed_or_completed.size == rows.size
+    end
+
+    def import_file=(path)
+      raise SolidusImporter::Exception, 'Existing file required' if !path || !File.exist?(path)
+
+      self.file = File.open(path, 'r')
+    end
+
+    class << self
+      def available_types
+        SolidusImporter::Import.select(:import_type).order(:import_type).group(:import_type).pluck(:import_type)
+      end
+    end
+  end
+end

data/app/models/solidus_importer/row.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SolidusImporter
+  class Row < ApplicationRecord
+    self.table_name = 'solidus_importer_rows'
+
+    belongs_to :import,
+      class_name: 'SolidusImporter::Import',
+      inverse_of: :rows
+
+    serialize :data, JSON
+
+    enum state: {
+      created: 'created',
+      processing: 'processing',
+      failed: 'failed',
+      completed: 'completed'
+    }
+
+    scope :created_or_failed, -> { where(state: %i[created failed]) }
+    scope :failed_or_completed, -> { where(state: %i[failed completed]) }
+
+    validates :data, presence: true, allow_blank: false
+    validates :state, presence: true, allow_blank: false
+  end
+end

data/app/views/spree/admin/solidus_importer/import_rows/show.html.erb

@@ -0,0 +1,46 @@
+<%
+admin_layout('full-width')
+import_id = @import_row.import_id
+admin_breadcrumb(
+  t('spree.solidus_importer.title'),
+  link_to(t('spree.solidus_importer.imports'), admin_solidus_importer_imports_path),
+  link_to(import_id.to_s, admin_solidus_importer_import_path(id: import_id)),
+  t('spree.solidus_importer.import_rows'),
+  @import_row.id.to_s
+)
+%>
+
+<div data-hook="admin_solidus_importer_import_rows_show">
+  <dl>
+    <dt><%= t('spree.id') %></dt>
+    <dd><%= @import_row.id %></dd>
+    <dt><%= t('spree.state') %></dt>
+    <dd class="solidus_importer state-<%= @import_row.state %>"><%= @import_row.state %></dd>
+    <dt><%= t('spree.solidus_importer.created_at') %></dt>
+    <dd><%= @import_row.created_at %></dd>
+    <dt><%= t('spree.solidus_importer.updated_at') %></dt>
+    <dd><%= @import_row.updated_at %></dd>
+    <dt><%= t('spree.solidus_importer.messages') %></dt>
+    <dd><%= @import_row.messages.blank? ? '-' : @import_row.messages %></dd>
+    <% if @log_details %>
+      <dt><%= t('spree.solidus_importer.log_entry') %></dt>
+      <dd><%= @log_details %></dd>
+    <% end %>
+    <% if @target_entity %>
+      <dt><%= t('spree.solidus_importer.target_entity') %></dt>
+      <dd>
+        <%= link_to("#{@target_entity.class} ##{@target_entity.id}", url_for([:admin, @target_entity])) rescue '-' %>
+      </dd>
+    <% end %>
+    <dt><%= t('spree.solidus_importer.data') %></dt>
+  </dl>
+
+  <table class="table">
+    <% @import_row.data.each do |k, v| %>
+    <tr class="import_row_attribute">
+      <td class="key"><%= k %></td>
+      <td class="value"><%= v %></td>
+    </tr>
+    <% end %>
+  </table>
+</div>

data/app/views/spree/admin/solidus_importer/imports/_form.html.erb

@@ -0,0 +1,14 @@
+<div class="row">
+  <div class="col-4">
+    <div class="field">
+      <%= f.label :import_type %><br>
+      <%= f.select :import_type, [nil] + @import_types %>
+    </div>
+  </div>
+  <div class="col-3">
+    <div class="field">
+      <%= f.label :file %><br>
+      <%= f.file_field :file %>
+    </div>
+  </div>
+</div>

data/app/views/spree/admin/solidus_importer/imports/index.html.erb

@@ -0,0 +1,80 @@
+<% admin_layout('full-width') %>
+<% admin_breadcrumb(t('spree.solidus_importer.title'), t('spree.solidus_importer.imports')) %>
+
+<% content_for :page_actions do %>
+  <li>
+    <%= link_to t('spree.admin.solidus_importer.new'), new_admin_solidus_importer_import_url, id: 'admin_new_order', class: 'btn btn-primary' %>
+  </li>
+<% end if can? :create, SolidusImporter::Import %>
+
+<% content_for :table_filter do %>
+  <%= search_form_for [:admin, @search], url: admin_solidus_importer_imports_path do |f| %>
+    <div class="row">
+      <div class="col-md-4">
+        <div class="form-group">
+          <%= label_tag :q_import_type_eq, t('spree.type') %>:
+          <%= f.select :import_type_eq, SolidusImporter::Import.available_types, { include_blank: true }, class: 'select2 js-filterable' %>
+        </div>
+      </div>
+      <div class="col-md-2">
+        <div class="form-group">
+          <%= label_tag :q_state_eq, t('spree.state') %>:
+          <%= f.select :state_eq, SolidusImporter::Import.states, { include_blank: true }, class: 'select2 js-filterable' %>
+        </div>
+      </div>
+      <div class="col-md-2">
+        <div class="input-group">
+          <%= f.text_field :created_at_gt, class: 'datepicker datepicker-from form-control', value: params.dig(:q, :created_at_gt), autocomplete: 'off', placeholder: t('spree.solidus_importer.updated_at_from') %> &nbsp;
+        </div>
+      </div>
+      <div class="col-md-2">
+        <div class="input-group">
+          <%= f.text_field :created_at_lt, class: 'datepicker datepicker-to form-control', value: params.dig(:q, :created_at_lt), autocomplete: 'off', placeholder: t('spree.solidus_importer.updated_at_to') %> &nbsp;
+        </div>
+      </div>
+      <div class="col-md-2 text-right">
+        <%= button_tag t('spree.filter_results') %>
+      </div>
+    </div>
+  <% end %>
+<% end %>
+
+<div data-hook="admin_solidus_importer_imports_index">
+  <%= paginate @imports, theme: 'solidus_admin' %>
+
+  <% if @imports.any? %>
+    <table class="table table-bordered table-striped">
+      <thead>
+        <tr>
+          <th><%= sort_link @search, :id, t('spree.id') %></th>
+          <th><%= sort_link @search, :import_type, t('spree.type') %></th>
+          <th><%= sort_link @search, :state, t('spree.state') %></th>
+          <th><%= t('spree.solidus_importer.import_rows') %></th>
+          <th><%= sort_link @search, :updated_at, t('spree.solidus_importer.updated_at') %></th>
+          <th class="actions"></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @imports.each do |import| %>
+          <% link_details = admin_solidus_importer_import_path(id: import.id) %>
+          <tr class='solidus_importer_import'>
+            <td><%= link_to import.id.to_s, link_details %></td>
+            <td><%= import.import_type %></td>
+            <td class="solidus_importer state-<%= import.state %>"><%= import.state %></td>
+            <th><%= import.rows.count %></th>
+            <td><%= l(import.updated_at) %></td>
+            <td><%= link_to 'Details', link_details, class: 'fa fa-eye icon_link', 'data-action': 'view' %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  <% else %>
+    <div class="no-objects-found">
+      <%= render 'spree/admin/shared/no_objects_found',
+                   resource: SolidusImporter::Import,
+                   new_resource_url: new_object_url %>
+    </div>
+  <% end %>
+
+  <%= paginate @imports, theme: 'solidus_admin' %>
+</div>

data/app/views/spree/admin/solidus_importer/imports/new.html.erb

@@ -0,0 +1,13 @@
+<% admin_breadcrumb t('spree.solidus_importer.title'), link_to(t('spree.solidus_importer.imports'), admin_solidus_importer_imports_path) %>
+
+<%= form_for [:admin, @import], method: :post, html: { multipart: true } do |f| %>
+  <fieldset class="no-border-top">
+    <%= render partial: 'spree/shared/error_messages', locals: { target: @import } %>
+    <%= render partial: 'form', locals: { f: f } %>
+
+    <div class="form-buttons filter-actions actions" data-hook="buttons">
+      <%= f.submit t('spree.actions.create'), class: 'btn btn-primary' %>
+    </div>
+  </fieldset>
+<% end %>
+

data/app/views/spree/admin/solidus_importer/imports/show.html.erb

@@ -0,0 +1,87 @@
+<%
+admin_layout('full-width')
+admin_breadcrumb(
+  t('spree.solidus_importer.title'),
+  link_to(t('spree.solidus_importer.imports'), admin_solidus_importer_imports_path),
+  @import.id.to_s
+)
+%>
+
+<div data-hook="admin_solidus_importer_imports_show">
+  <dl>
+    <dt><%= t('spree.id') %></dt>
+    <dd><%= @import.id %></dd>
+    <dt><%= t('spree.type') %></dt>
+    <dd><%= @import.import_type %></dd>
+    <dt><%= t('spree.state') %></dt>
+    <dd class="solidus_importer state-<%= @import.state %>"><%= @import.state %></dd>
+    <dt><%= t('spree.solidus_importer.import') %></dt>
+    <dd><%= link_to @import.file_file_name, @import.file.url %></dd>
+    <dt><%= t('spree.solidus_importer.import_rows') %></dt>
+    <dd><%= @import.rows.count %></dd>
+    <dt><%= t('spree.solidus_importer.created_at') %></dt>
+    <dd><%= @import.created_at %></dd>
+    <dt><%= t('spree.solidus_importer.updated_at') %></dt>
+    <dd><%= @import.updated_at %></dd>
+    <dt><%= t('spree.solidus_importer.messages') %></dt>
+    <dd><%= @import.messages.blank? ? '-' : @import.messages %></dd>
+  </dl>
+
+  <hr/>
+
+  <%= search_form_for [:admin, @search], url: admin_solidus_importer_import_path(@import) do |f| %>
+    <div class="row">
+      <div class="col-md-3">
+        <div class="form-group">
+          <%= label_tag :q_state_eq, t('spree.state') %>:
+          <%= f.select :state_eq, SolidusImporter::Import.states, { include_blank: true }, class: 'select2 js-filterable' %>
+        </div>
+      </div>
+      <div class="col-md-3">
+        <div class="input-group">
+          <%= f.text_field :created_at_gt, class: 'datepicker datepicker-from form-control', value: params.dig(:q, :created_at_gt), autocomplete: 'off', placeholder: t('spree.solidus_importer.updated_at_from') %> &nbsp;
+        </div>
+      </div>
+      <div class="col-md-3">
+        <div class="input-group">
+          <%= f.text_field :created_at_lt, class: 'datepicker datepicker-to form-control', value: params.dig(:q, :created_at_lt), autocomplete: 'off', placeholder: t('spree.solidus_importer.updated_at_to') %> &nbsp;
+        </div>
+      </div>
+      <div class="col-md-3 text-right">
+        <%= button_tag t('spree.filter_results') %>
+      </div>
+    </div>
+  <% end %>
+
+  <%= paginate @import_rows, theme: 'solidus_admin' %>
+
+  <% if @import_rows.any? %>
+    <table class="table table-bordered table-striped">
+      <thead>
+        <tr>
+          <th><%= sort_link @search, :id, t('spree.id') %></th>
+          <th><%= sort_link @search, :state, t('spree.state') %></th>
+          <th><%= sort_link @search, :updated_at, t('spree.solidus_importer.updated_at') %></th>
+          <th class="actions"></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @import_rows.each do |import_row| %>
+          <% link_details = admin_solidus_importer_import_import_row_path(import_id: @import.id, id: import_row.id) %>
+          <tr class='solidus_importer_import_row'>
+            <td><%= link_to import_row.id.to_s, link_details %></td>
+            <td class="solidus_importer state-<%= import_row.state %>"><%= import_row.state %></td>
+            <td><%= l(import_row.updated_at) %></td>
+            <td><%= link_to 'Details', link_details, class: 'fa fa-eye icon_link', 'data-action': 'view' %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  <% else %>
+    <div class="no-objects-found">
+      <%= render 'spree/admin/shared/no_objects_found', resource: SolidusImporter::Row %>
+    </div>
+  <% end %>
+
+  <%= paginate @import_rows, theme: 'solidus_admin' %>
+</div>

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_importer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_importer/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_importer"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=false \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."