csvbuilder-importer 0.1.4 → 0.1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cdbeae4314f705e797a216730c276ccc68f57140f3c06ae86109fa9a9b6902
-  data.tar.gz: 45c9d16608cc0e86e920333bf9e08db34f98f9ca2fa17354c95323132e8afb43
+  metadata.gz: 4b7ef3908dc9244684d9332fba0f25089b39abc5ac9757c6754431597162166d
+  data.tar.gz: de8ae2d006614ee45e139a077ffdc5458472afa702a5d1c7a9048cf8bb55f889
 SHA512:
-  metadata.gz: ae94d692fbfa627cdd37952a47b7db183414095e206d1bbd908d01a2e3e4ff0e719673a7f0fc8a1545bc2316bcce7d17d542ddcbe9b565f0f0d68137f5c25f23
-  data.tar.gz: a7c914fff4abb75256af5f3f996a13116db6408ff64290bf22430c75ab45503c85561bd1b959657dba6b95a6fb5975b76988a2f749d2a2ddb51ab52012de187e
+  metadata.gz: 40530fa7d450630ecfaef9892ee13119d03042d12e61fb86922bbd7bb02cfe91476d417fcb420aa8f7462506fcb5f107adc1877567b989765623c6e86d6a1f35
+  data.tar.gz: 365319e0776682a6ff9d2317a0ee73f0a084ea99289d14465346fb58cb8e0bdf29d3c212a9dabd55a2801a115b39df30532c663e397a700738b4f62e1c07f75a

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [Released]
+
+## [0.1.5.1] - 2023-07-26
+
+- Revert: Using Less Memory And Quicker Line Counter https://github.com/joel/csvbuilder-importer/pull/11
+
+## [0.1.5] - 2023-07-26
+
+- Add a way to abort at the importer level, handy to handle wrong headers check https://github.com/joel/csvbuilder-importer/pull/12
+- Using Less Memory And Quicker Line Counter https://github.com/joel/csvbuilder-importer/pull/11
+
 ## [0.1.4] - 2023-04-21
 
 - Potential Security Fix

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csvbuilder-importer (0.1.4)
+    csvbuilder-importer (0.1.5.1)
       activemodel (>= 5.2)
       activesupport (>= 5.2)
       csvbuilder-core

data/README.md

@@ -40,13 +40,14 @@ The import takes the CSV file and the Import class.
 
 ```ruby
 rows = Csvbuilder::Import::File.new(file.path, UserCsvImportModel).each
-row = rows.next
+row_enumerator = rows.each # It's essential to go through the Enumerator to benefit from the callbacks. See References[^1]
+row_model_instance = row_enumerator.next
 ```
 
 `Csvbuilder::Import` implement two essential methods:
 
 1. skip?
-2. abort?
+2. abort? # NOTE: abort can be trigger at the importer level too.
 
 You have to provide your implementation of the method `abort?`. If the method `abort?` returns true, the iteration will stop.
 
@@ -183,6 +184,42 @@ Thanks to the callback mechanism, the opportunities to interact with the import
 
 For long imports, you can show a progress bar to help customers cope with the import time; as you know, if errors have occurred, you can change the colour of the progress bar accordingly and offer the possibility to stop the import earlier.
 
+## Aborting an import
+
+There is a design challenge to handling an import line-by-line. If it makes the code more efficient and decoupled, we might have cases when we want to check something shared with all lines. The obvious ones are the headers. Let's say we want to check them and abort all imports if something wrong is detected. We probably don't want to add the abort conditioning on every line (Csvbuilder::Model or, more precisely, its extension Csvbuilder::Import). We would rather have it in the Importer itself. In that case, we can stop the Importer from invoking "abort!". Let's consider the following example:
+
+```ruby
+class Importer < Csvbuilder::Import::File
+
+  after_next do
+    if HeaderChecker.new(current_row_model).invalid?
+      abort!
+      next true # Keep going into #each and hit the callbacks
+    end
+  end
+
+end
+```
+
+```ruby
+context "with incorrect headers" do
+
+  should "not import data" do
+    importer = Importer.new(@file.path, @importer_class, @context)
+
+    row_enumerator = importer.each
+
+    assert_raises StopIteration do
+      row_enumerator.next
+    end
+  end
+end
+```
+
+## References
+
+- [^1] Csvbuilder::Import::File#each https://github.com/joel/csvbuilder-importer/blob/e8e6633a03dda4ae0e5d6775ec9d395dec553fbe/lib/csvbuilder/importer/public/import/file.rb#L66-L68
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/csvbuilder/importer/public/import/file.rb

@@ -9,7 +9,7 @@ module Csvbuilder
       extend ActiveModel::Callbacks
       include ActiveModel::Validations
 
-      attr_reader :csv, :row_model_class, :index, :current_row_model, :previous_row_model, :context # -1 = start of file, 0 to infinity = index of row_model, nil = end of file, no row_model
+      attr_reader :interrupt, :csv, :row_model_class, :index, :current_row_model, :previous_row_model, :context # -1 = start of file, 0 to infinity = index of row_model, nil = end of file, no row_model
 
       delegate :size, :end_of_file?, :line_number, to: :csv
 
@@ -26,6 +26,7 @@ module Csvbuilder
         @csv             = ::Csvbuilder::Import::Csv.new(file_path) # Full namespace provided to avoid confusion with Ruby CSV class.
         @row_model_class = row_model_class
         @context         = context.to_h.symbolize_keys
+        @interrupt = false
         reset
       end
 
@@ -39,6 +40,7 @@ module Csvbuilder
         csv.reset
         @index = -1
         @current_row_model = nil
+        @interrupt = false
       end
 
       # Gets the next row model based on the context
@@ -74,7 +76,13 @@ module Csvbuilder
 
       # @return [Boolean] returns true, if the file should abort reading
       def abort?
-        !valid? || !!current_row_model.try(:abort?)
+        interrupt || !valid? || !!current_row_model.try(:abort?)
+      end
+
+      def abort!
+        @interrupt = true
+
+        nil
       end
 
       # @return [Boolean] returns true, if the file should skip `current_row_model`

data/lib/csvbuilder/importer/version.rb

@@ -2,6 +2,6 @@
 
 module Csvbuilder
   module Importer
-    VERSION = "0.1.4"
+    VERSION = "0.1.5.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csvbuilder-importer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5.1
 platform: ruby
 authors:
 - Joel Azemar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Csvbuilder Importer contain the components to handle CSV importing