datanorm 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f44ab02c4041e106b7e120a1eae889c7d3e1384c4dbaedd6adea4bc86a0d1895
-  data.tar.gz: 338c389dded4de592d34d9730080bbf800052c32359a2294fea1aaa45d25b99b
+  metadata.gz: f81183cf69ef2798729afff7dcb246230e46daf3d049c14b9f2d5d2e373f68a5
+  data.tar.gz: fb025bfbd9b8a5405098bf187e9f438bda2e6b82ac28e554d046e9ccfff4895e
 SHA512:
-  metadata.gz: 342576af02ba6ae033e97090908944045896e2bd2df1e496ec83e08835945e737051a62d139300dd10f1d9711ac1e88901e94715e0d060024390975ed2e10e39
-  data.tar.gz: 535491f2403475fb0227e6e4e81db3b4c43bb512b70640d04852a110359c74816d1ec3b02ab959a7d83a9fed62269a54a21401efb7db1a24025e629d3c7f271b
+  metadata.gz: bbc711307ec3c2783a98c31b8ba3ef364bf206d82910d7f5423bf93a4a953efbb1552139963824def5e3271a5518c3085c65a3c6814385f03c2df7b35ee9bf1d
+  data.tar.gz: d8235f4fd9be07113abc53ba29c9bd4cff955d1201f4549dc2793d8e732f08c20be94f238a00357fe4fab394d37583e686085a08a8ea1e5bcc260cf3bea4d935

data/README.md

@@ -94,7 +94,27 @@ I went for a parsing mechanism that works every time, with every file, at the ex
 
 If you have a `DATANORM.001` and also a `DATPREIS.001`, you must concatenate those two files into one file first (their versions need to be the same). The resulting, merged file is what you provide to this Rubygem.
 
-If you want one product at a time, without having to deal with the complexities of Datanorm, you can use this:
+### Quick Usage
+
+If you want one product at a time (without having to deal with the complexities of Datanorm), you can use this:
+
+```ruby
+document = Datanorm::Document.new(path: 'datanorm.001')
+
+puts document.header
+puts document.version
+
+document.each do |product|
+  puts product.title
+  puts product.to_json
+end
+```
+
+Notice that it can take a long time until the first product is yielded due to the preprocessing that takes place at first.
+
+### Usage with Progress
+
+ If you want to see the progress, you can use the following:
 
 ```ruby
 document = Datanorm::Document.new(path: 'datanorm.001')
@@ -102,7 +122,7 @@ document = Datanorm::Document.new(path: 'datanorm.001')
 puts document.header
 puts document.version
 
-document.each do |product, progress|
+document.each(yield_progress: true) do |product, progress|
   # Once pre-processing is complete, you'll start to get products here
   puts product # <- can be nil in the beginning
 
@@ -111,6 +131,8 @@ document.each do |product, progress|
 end
 ```
 
+### Bare Datanorm parsing
+
 In case you only want the raw Datanorm file one line at a time as Ruby Objects, you can use this:
 
 ```ruby

data/lib/datanorm/document.rb

@@ -28,13 +28,13 @@ module Datanorm
       file.version
     end
 
-    def each(&)
+    def each(yield_progress: false, &)
       unless @preprocessed
-        ::Datanorm::Documents::Preprocess.call(file:, workdir:, &)
+        ::Datanorm::Documents::Preprocess.call(file:, workdir:, yield_progress:, &)
         @preprocessed = true
       end
 
-      ::Datanorm::Documents::Assemble.call(workdir:, &)
+      ::Datanorm::Documents::Assemble.call(workdir:, yield_progress:, &)
     ensure
       # At this point all yields have gone through and we can clean up.
       workdir.rmtree unless ENV['DEBUG_DATANORM']

data/lib/datanorm/documents/assemble.rb

@@ -8,13 +8,19 @@ module Datanorm
       include ::Datanorm::Logging
 
       option :workdir
+      option :yield_progress, default: -> { false }
 
       def call
         return unless products_file.file?
 
         ::File.foreach(products_file) do |json|
           progress.increment!
-          yield ::Datanorm::Documents::Assembles::Product.new(json:, workdir:), progress
+
+          if yield_progress
+            yield ::Datanorm::Documents::Assembles::Product.new(json:, workdir:), progress
+          else
+            yield ::Datanorm::Documents::Assembles::Product.new(json:, workdir:)
+          end
         end
       end
 

data/lib/datanorm/documents/preprocess.rb

@@ -10,6 +10,7 @@ module Datanorm
 
       option :file
       option :workdir
+      option :yield_progress, default: -> { false }
 
       def call
         FileUtils.mkdir_p(workdir)
@@ -18,7 +19,9 @@ module Datanorm
           ::Datanorm::Documents::Preprocesses::Process.call(workdir:, record:)
 
           progress.increment!
-          yield nil, progress # No items to yield during preprocess.
+          if yield_progress
+            yield nil, progress # No items to yield during preprocess.
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datanorm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - halo