col_active_importer_starter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8640f42dbcfff94ba0d58115a6a78ec859fe2dc63e9d695e36dab8546871e9d4
+  data.tar.gz: 723b1c2c15c2b53d07e1891edc493c1f1156d541a0155db0ff550d98a60e3790
+SHA512:
+  metadata.gz: 7854b72e834966f362ca3acad0cf5a94ecc725b022d377e89b6842674b2aef46b40ed5156941cab9853eba776a76f07cf8a0200cb0ab21b82037e721b76b527c
+  data.tar.gz: 5ed2ae585209d7baec0e3096fb9371e89ca18af9b521c738814078757a75b8085583f1a150ce990b4652e60a603b620d430c8a20169ed02692526cd895d2874d

data/README.md

@@ -0,0 +1,149 @@
+# col_active_importer_starter
+
+col_active_importer_starter is a starter(or wrapper) to [active_importer - https://github.com/continuum/active_importer](https://github.com/continuum/active_importer) gem.
+
+## Features
+
+`col_active_importer_starter` makes full use of `active_importer` gem to import tabular data from spreadsheets or similar sources into Active Record models.
+
+- The best practices of `active_importer`, such as:
+  - [Events and callbacks - https://github.com/continuum/active_importer/wiki/Callbacks](https://github.com/continuum/active_importer/wiki/Callbacks).
+- Introduce a optional cache to retain data in the memory
+- Write out a file with the original data and more information for result
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'col_active_importer_starter'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install col_active_importer_starter
+```
+
+## Usages
+
+Suppose there is a ActiveRecord model `Article`:
+
+```ruby
+class Article < ApplicationRecord
+  
+end
+```
+and tabular data file `data/Articles.xlsx`
+
+| Title           | Body            |
+|-----------------|-----------------|
+| Article.1.title | Article.1.body  |
+| Article.2.title | Article.2.body  |
+
+1. Create a `ArticleImporter` extend `ColActiveImporterStarter::BaseImporter`
+
+```ruby
+# app/importers/article_import.rb
+
+class ArticleImporter < ColActiveImporterStarter::BaseImporter
+  imports Article
+  
+  transactional
+  module ColumnName
+    Title = "Title"
+    Body = "Body"
+  end
+  
+  column ColumnName::Title, :title
+  column ColumnName::Body, :body
+  
+  def handle_fetch_model
+    params = {
+      title: row[ColumnName::Title],
+    }
+  
+    model = Article.find_or_initialize_by(params)
+  
+    model
+  end
+  
+  fetch_model do
+    handle_fetch_model
+  end
+  
+  def handle_skip_rows_if?
+    row[ColumnName::Title].blank?
+  end
+  
+  skip_rows_if do
+    handle_skip_rows_if?
+  end
+  
+  # ArticleImporter.execute
+  def self.execute(file = "#{Rails.root}/data/Articles.1.xlsx")
+    params = {
+      cache: {},
+      file: file,
+      result_index: 10,
+    }
+    import(file, params: params)
+  end
+  
+  private
+end
+```
+
+2. Import data from a file.
+
+```ruby
+ArticleImporter.execute("#{Rails.root}/data/Articles.1.xlsx")
+```
+
+Or specify more arguments.
+
+```ruby
+params = {
+  cache: {},
+  file: "#{Rails.root}/data/Articles.1.xlsx",
+  result_index: 10,
+}
+
+ArticleImporter.import(file, params: params)
+```
+
+3. Then, check `tmp/importers` directory to find the result file.
+
+| Title           | Body            |   | Result ID | Result Message  |
+|-----------------|-----------------|---|-----------|-----------------|
+| Article.1.title | Article.1.body  |   | 1         | success         |
+| Article.2.title | Article.2.body  |   | 2         | success         |
+
+## Inspire
+
+Inspire by [active_importer - https://github.com/continuum/active_importer](https://github.com/continuum/active_importer).
+
+## Contributing
+
+Contributions are welcome! Take a look at our contributions guide for details.
+The basic workflow for contributing is the following:
+
+- [Fork it - https://github.com/CloudoLife/col_active_importer_starter/fork](https://github.com/CloudoLife/col_active_importer_starter/fork)
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License - https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT).
+
+## References
+
+[1] [continuum/active_importer: Define importers that load tabular data from spreadsheets or CSV files into any ActiveRecord-like ORM. - https://github.com/continuum/active_importer](https://github.com/continuum/active_importer)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/col_active_importer_starter_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/col_active_importer_starter .css

data/app/assets/stylesheets/col_active_importer_starter/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/col_active_importer_starter/application_controller.rb

@@ -0,0 +1,4 @@
+module ColActiveImporterStarter
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/col_active_importer_starter/application_helper.rb

@@ -0,0 +1,4 @@
+module ColActiveImporterStarter
+  module ApplicationHelper
+  end
+end

data/app/jobs/col_active_importer_starter/application_job.rb

@@ -0,0 +1,4 @@
+module ColActiveImporterStarter
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/col_active_importer_starter/application_mailer.rb

@@ -0,0 +1,6 @@
+module ColActiveImporterStarter
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/col_active_importer_starter/application_record.rb

@@ -0,0 +1,5 @@
+module ColActiveImporterStarter
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/col_active_importer_starter/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Col active importer starter</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "col_active_importer_starter/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ColActiveImporterStarter::Engine.routes.draw do
+end

data/lib/col_active_importer_starter/engine.rb

@@ -0,0 +1,5 @@
+module ColActiveImporterStarter
+  class Engine < ::Rails::Engine
+    isolate_namespace ColActiveImporterStarter
+  end
+end

data/lib/col_active_importer_starter/lib.rb

@@ -0,0 +1,141 @@
+
+# continuum/active_importer: Define importers that load tabular data from spreadsheets or CSV files into any ActiveRecord-like ORM.
+# https://github.com/continuum/active_importer
+module ColActiveImporterStarter
+  module ColumnName
+    Code = "Code"
+
+    Name = "Name"
+    Seq = 'Seq'
+
+    ParentCode = "Parent Code"
+  end
+
+  module ResultIndex
+    ID = :result_index
+  end
+
+  module ResultColumnName
+    ID = 'Result ID'
+    Message = 'Result Message'
+    Error = 'Result Error'
+  end
+
+  module ResultValue
+    Success = 'success'
+    Fail = 'fail'
+    Skip = 'skip'
+  end
+
+  def self.handle_model_cache!(cache, key)
+    model = cache[key]
+    return model if model.present?
+
+    Rails.logger.info("Cache not found: #{key}")
+    model = yield(key) if block_given?
+
+    cache[key] = model
+
+    model
+  end
+
+  class BaseImporter < ActiveImporter::Base
+
+    def get_result_id_column_index
+      params[ResultIndex::ID]
+    end
+
+    def initialize_result_exporter
+      exporter = RubyXL::Parser.parse(params[:file])
+      exporter_sheet1 = exporter[0]
+
+      header_index = @header_index - 1
+      column_index = get_result_id_column_index
+      exporter_sheet1.add_cell(header_index, (column_index += 1), ResultColumnName::ID)
+      exporter_sheet1.add_cell(header_index, (column_index += 1), ResultColumnName::Message)
+
+      @exporter = exporter
+      @exporter_sheet1 = exporter_sheet1
+    end
+
+    def initialize_model_cache
+      model_cache = params.try(:[], :model_cache) || {}
+
+      @model_cache = model_cache
+    end
+
+    on :import_started do
+      initialize_result_exporter
+      initialize_model_cache
+    end
+
+    # on :row_skipped do
+    #   sheet1 = @sheet1
+    #
+    #   row_index = @row_index - @header_index
+    #   column_index = ColumnIndex::Imported
+    #   column_index += 1
+    #   sheet1[row_index, (column_index += 1)] = ResultColumnName::Skip
+    # end
+
+    def handle_row_success
+      exporter_sheet1 = @exporter_sheet1
+
+      row_index = @row_index - @header_index
+      column_index = get_result_id_column_index
+      column_index += 1
+      exporter_sheet1.add_cell(row_index, (column_index += 1), ResultValue::Success)
+    end
+
+    on :row_success do
+      handle_row_success
+    end
+
+    def handle_row_error(e)
+      exporter_sheet1 = @exporter_sheet1
+
+      row_index = @row_index - @header_index
+      column_index = get_result_id_column_index
+      column_index += 1
+      exporter_sheet1.add_cell(row_index, (column_index += 1), ResultValue::Fail)
+      exporter_sheet1.add_cell(row_index, (column_index += 1), e.message)
+    end
+
+    on :row_error do |e|
+      handle_row_error(e)
+    end
+
+    def handle_row_processed
+      exporter_sheet1 = @exporter_sheet1
+
+      row_index = @row_index - @header_index
+      column_index = get_result_id_column_index
+      exporter_sheet1.add_cell(row_index, (column_index += 1), model&.id)
+    end
+
+    on :row_processed do
+      handle_row_processed
+    end
+
+
+    def handle_import_finished
+      exporter = @exporter
+
+      file = params[:file]
+
+      extname = '.xlsx'
+      if file.present?
+        extname = File.extname(file)
+        basename = File.basename(file, extname)
+      end
+
+      result_file = "tmp/Result-#{Time.now.strftime('%Y%m%d%H%M%S')}-#{basename}#{extname}"
+
+      exporter.write result_file
+    end
+
+    on :import_finished do
+      handle_import_finished
+    end
+  end
+end

data/lib/col_active_importer_starter/version.rb

@@ -0,0 +1,3 @@
+module ColActiveImporterStarter
+  VERSION = "0.1.0"
+end

data/lib/col_active_importer_starter.rb

@@ -0,0 +1,11 @@
+require "col_active_importer_starter/version"
+require "col_active_importer_starter/engine"
+
+require 'active_importer'
+require 'rubyXL'
+
+require "col_active_importer_starter/lib"
+
+module ColActiveImporterStarter
+  # Your code goes here...
+end

data/lib/tasks/col_active_importer_starter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :col_active_importer_starter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: col_active_importer_starter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benjamin CloudoLife
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_importer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: col_active_importer_starter makes full use of active_importer gem to
+  import tabular data from spreadsheets or similar sources into Active Record models.
+email:
+- benjamin@cloudolife.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/col_active_importer_starter_manifest.js
+- app/assets/stylesheets/col_active_importer_starter/application.css
+- app/controllers/col_active_importer_starter/application_controller.rb
+- app/helpers/col_active_importer_starter/application_helper.rb
+- app/jobs/col_active_importer_starter/application_job.rb
+- app/mailers/col_active_importer_starter/application_mailer.rb
+- app/models/col_active_importer_starter/application_record.rb
+- app/views/layouts/col_active_importer_starter/application.html.erb
+- config/routes.rb
+- lib/col_active_importer_starter.rb
+- lib/col_active_importer_starter/engine.rb
+- lib/col_active_importer_starter/lib.rb
+- lib/col_active_importer_starter/version.rb
+- lib/tasks/col_active_importer_starter_tasks.rake
+homepage: https://github.com/CloudoLife-RoR/col_active_importer_starter
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/CloudoLife-RoR/col_active_importer_starter
+  source_code_uri: https://github.com/CloudoLife-RoR/col_active_importer_starter
+  changelog_uri: https://github.com/CloudoLife-RoR/col_active_importer_starter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.3
+signing_key:
+specification_version: 4
+summary: col_active_importer_starter is a starter(or wrapper) to [active_importer.
+test_files: []