col_active_importer_starter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8640f42dbcfff94ba0d58115a6a78ec859fe2dc63e9d695e36dab8546871e9d4
-  data.tar.gz: 723b1c2c15c2b53d07e1891edc493c1f1156d541a0155db0ff550d98a60e3790
+  metadata.gz: cbc87cc0fb9f6774deb81aa67430a579307573abd5d76da037ae1c85ab066135
+  data.tar.gz: 33c5a66a2f5e70c00890be462dc79f885b055c2b8db3c10c94e425e5182f91f8
 SHA512:
-  metadata.gz: 7854b72e834966f362ca3acad0cf5a94ecc725b022d377e89b6842674b2aef46b40ed5156941cab9853eba776a76f07cf8a0200cb0ab21b82037e721b76b527c
-  data.tar.gz: 5ed2ae585209d7baec0e3096fb9371e89ca18af9b521c738814078757a75b8085583f1a150ce990b4652e60a603b620d430c8a20169ed02692526cd895d2874d
+  metadata.gz: 2783cf206f6e21215126258c2428b61e994e85456f85f335660fdd0b30a08a0ffc9c5fbd552c986d9518377ae5d067afd1d4d938f30f3b1dfedea035fbb15c80
+  data.tar.gz: d3433a4093a35ee77142a497239d3438c4c0c2a960edc02e8106da8258048cf733ebe41d0dd0262c651a764d4c72dd91a6cc3503754c65b887009f693b65de03

data/README.md

@@ -7,9 +7,10 @@ col_active_importer_starter is a starter(or wrapper) to [active_importer - https
 `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:
+  - [Custom parameters · continuum/active_importer Wiki - https://github.com/continuum/active_importer/wiki/Custom-parameters](https://github.com/continuum/active_importer/wiki/Custom-parameters)
   - [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
+- Use rubyXL to write out a file with the original data and more information for result
 
 ## Installation
 
@@ -37,7 +38,7 @@ Suppose there is a ActiveRecord model `Article`:
 
 ```ruby
 class Article < ApplicationRecord
-  
+
 end
 ```
 and tabular data file `data/Articles.xlsx`
@@ -54,38 +55,38 @@ and tabular data file `data/Articles.xlsx`
 
 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 = {
@@ -95,7 +96,7 @@ class ArticleImporter < ColActiveImporterStarter::BaseImporter
     }
     import(file, params: params)
   end
-  
+
   private
 end
 ```
@@ -103,7 +104,12 @@ end
 2. Import data from a file.
 
 ```ruby
-ArticleImporter.execute("#{Rails.root}/data/Articles.1.xlsx")
+ArticleImporter.import("#{Rails.root}/data/Articles.1.xlsx")
+
+# Or use ArticleImporter instance.
+# importer = ArticleImporter.new(file, {params: params(file)})
+# importer.import
+# puts importer.row_count
 ```
 
 Or specify more arguments.
@@ -112,12 +118,19 @@ Or specify more arguments.
 params = {
   cache: {},
   file: "#{Rails.root}/data/Articles.1.xlsx",
-  result_index: 10,
+  result_index: 3,
 }
 
-ArticleImporter.import(file, params: params)
+ArticleImporter.import(file, {params: params})
+
+# Or use ArticleImporter instance.
+# importer = ArticleImporter.new(file, {params: params(file)})
+# importer.import
+# puts importer.row_count
 ```
 
+For more examples to see [./test/dummy/test/importers/article_importer_test.rb](./test/dummy/test/importers/article_importer_test.rb).
+
 3. Then, check `tmp/importers` directory to find the result file.
 
 | Title           | Body            |   | Result ID | Result Message  |
@@ -125,6 +138,14 @@ ArticleImporter.import(file, params: params)
 | Article.1.title | Article.1.body  |   | 1         | success         |
 | Article.2.title | Article.2.body  |   | 2         | success         |
 
+## Testing
+
+Run `rails test` to execute all test cases in `test/dummy/test` directory.
+
+```shell
+rails test test/dummy/test
+```
+
 ## Inspire
 
 Inspire by [active_importer - https://github.com/continuum/active_importer](https://github.com/continuum/active_importer).
@@ -146,4 +167,15 @@ The gem is available as open source under the terms of the [MIT License - https:
 
 ## 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)
+[1] [CloudoLife-Rails/col_active_importer_starter: col_active_importer_starter is a starter(or wrapper) to [active_importer. - https://github.com/CloudoLife-Rails/col_active_importer_starter](https://github.com/CloudoLife-Rails/col_active_importer_starter)
+
+[2] [col_active_importer_starter | RubyGems.org | your community gem host - https://rubygems.org/gems/col_active_importer_starter](https://rubygems.org/gems/col_active_importer_starter)
+
+[3] [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)
+
+[4] [weshatheleopard/rubyXL: Ruby lib for reading/writing/modifying .xlsx and .xlsm files - https://github.com/weshatheleopard/rubyXL](https://github.com/weshatheleopard/rubyXL)
+
+[5] [rubyXL | RubyGems.org | your community gem host - https://rubygems.org/gems/rubyXL/](https://rubygems.org/gems/rubyXL/)
+
+[6] [RubyGems.org | your community gem host - https://rubygems.org/](https://rubygems.org/)
+

data/lib/col_active_importer_starter/lib.rb

@@ -41,16 +41,25 @@ module ColActiveImporterStarter
 
   class BaseImporter < ActiveImporter::Base
 
+    attr_reader :start_at, :end_at, :time_consuming
+
     def get_result_id_column_index
+      return -1 if params.blank?
+
       params[ResultIndex::ID]
     end
 
     def initialize_result_exporter
+      return if params.blank?
+
       exporter = RubyXL::Parser.parse(params[:file])
       exporter_sheet1 = exporter[0]
 
       header_index = @header_index - 1
       column_index = get_result_id_column_index
+
+      return if invalid_column_index?(column_index)
+
       exporter_sheet1.add_cell(header_index, (column_index += 1), ResultColumnName::ID)
       exporter_sheet1.add_cell(header_index, (column_index += 1), ResultColumnName::Message)
 
@@ -59,30 +68,39 @@ module ColActiveImporterStarter
     end
 
     def initialize_model_cache
+      return if params.blank?
+
       model_cache = params.try(:[], :model_cache) || {}
 
       @model_cache = model_cache
     end
 
     on :import_started do
+      # initialize_count
+
       initialize_result_exporter
       initialize_model_cache
+
+      start_time_consuming
     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
+    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
+
+      return if invalid_column_index?(column_index)
+
       column_index += 1
       exporter_sheet1.add_cell(row_index, (column_index += 1), ResultValue::Success)
     end
@@ -96,6 +114,9 @@ module ColActiveImporterStarter
 
       row_index = @row_index - @header_index
       column_index = get_result_id_column_index
+
+      return if invalid_column_index?(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)
@@ -110,6 +131,9 @@ module ColActiveImporterStarter
 
       row_index = @row_index - @header_index
       column_index = get_result_id_column_index
+
+      return if invalid_column_index?(column_index)
+
       exporter_sheet1.add_cell(row_index, (column_index += 1), model&.id)
     end
 
@@ -117,10 +141,11 @@ module ColActiveImporterStarter
       handle_row_processed
     end
 
-
     def handle_import_finished
       exporter = @exporter
 
+      return if params.blank?
+
       file = params[:file]
 
       extname = '.xlsx'
@@ -136,6 +161,36 @@ module ColActiveImporterStarter
 
     on :import_finished do
       handle_import_finished
+
+      end_start_time_consuming
+    end
+
+    def info
+      {
+        start_at: start_at,
+        end_at: end_at,
+        time_consuming: time_consuming,
+
+        row_count: row_count,
+        row_processed_count: row_processed_count,
+        row_success_count: row_success_count,
+        row_error_count: row_error_count,
+      }
+    end
+
+    private
+
+    def invalid_column_index?(column_index)
+      column_index == -1
+    end
+
+    def start_time_consuming
+      @start_at = Time.now
+    end
+
+    def end_start_time_consuming
+      @end_at = Time.now
+      @time_consuming = @end_at - @start_at
     end
   end
-end
+end

data/lib/col_active_importer_starter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: col_active_importer_starter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Benjamin CloudoLife
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-07 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,13 +76,13 @@ files:
 - 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
+homepage: https://github.com/CloudoLife-Rails/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
+  homepage_uri: https://github.com/CloudoLife-Rails/col_active_importer_starter
+  source_code_uri: https://github.com/CloudoLife-Rails/col_active_importer_starter
+  changelog_uri: https://github.com/CloudoLife-Rails/col_active_importer_starter
 post_install_message:
 rdoc_options: []
 require_paths: