progressor 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54e39588afa295d9501f32e4a183834d030b536cb902fbc133be2e61d2b97745
-  data.tar.gz: 5732a7f82cd05f0ced057785595d2d4724264ddef570c69fca086823b76318fd
+  metadata.gz: e8b8a4cb127259a4f539935a5c3d33dde51918c5f06e2a6c0bfba817b13a44ab
+  data.tar.gz: 489755d94b178dfc2c98d75b12ee7839a652d47948b09c39fc1e4a8476b9897b
 SHA512:
-  metadata.gz: e9339fc8632bdd3b0d1c0ab47d5c95d987e6db3f5383f59541511341735c105ebce68a6544eed20a0614f8ee12974d91f9fc65dfe58f4d5e662d96a02746092a
-  data.tar.gz: 5b58b596f4596bccccb352ec2c8ec6949573ad898677b228fcd43073e8b141d561c397b428d5f16dfe53dd7134e2fdb430f2be51c1a0013a1537e95f98d724ae
+  metadata.gz: e074b0f2820dbc2a898258f7f89a36fc9a2f1867b13fd134b02cfe432589cb30beb6355facf0d80b0cb36a6deb562c7a36409382a1ab61bcee6aaaa6ec2306de
+  data.tar.gz: c8ebbad12c98156313ef2a16c55ff148f27f54bc1f8a3fa76371e714d4346847db7756e406db07e0a1c9d3acd4a1eb60e5bf8e3bbb090dfead4be93f59884bee

data/README.md

@@ -100,6 +100,26 @@ The format is:
 <current>, t: <time from start>, t/i: <time per iteration>
 ```
 
+## Simpler iteration
+
+For `ActiveRecord` and other iterable collections, it's possible to skip some boilerplate. For example, you might start from this:
+
+``` ruby
+Record.not_processed.find_each do |record|
+  record.process
+end
+```
+
+In order to add measurements, you could instantiate a `Progressor` etc like in the above example, or you could do this:
+
+``` ruby
+Progressor::Iteration.find_each(Record.not_processed) do |record|
+  record.process
+end
+```
+
+And it'll add some default print statements. Check the API documentation or the code for details.
+
 ## Configuration
 
 Apart from `total_count`, which is optional and affects the kind of sequence that will be stored, you can provide `min_samples` and `max_samples`. You can also provide a custom formatter:

data/lib/progressor/iteration.rb

@@ -0,0 +1,54 @@
+module Progressor::Iteration
+  # Iterate the given collection, assuming it responds to:
+  #
+  # - The given `method` with a block that yields a single item
+  # - optionally, `count` that returns the number of results
+  #
+  # It yields two items -- the item from the collection and a numeric index. It
+  # prints the progress automatically for each loop.
+  #
+  # This is meant to be used as a convenience method for ActiveRecord
+  # collections with `find_each` or `each`, but it could really be used for
+  # anything that works with this interface.
+  #
+  # Inputs:
+  #
+  # - method:     the method name to invoke on `collection`
+  # - collection: the iterable object
+  # - format:     the method to use for printing each individual record. Defaults to `:to_s`
+  # - options:    passed along to `Progressor::new`
+  #
+  def self.iterate(method, collection, format: :to_s, **options, &block)
+    if !collection.respond_to?(method)
+      raise Progressor::Error.new("Given collection doesn't respond to ##{method}")
+    end
+
+    if collection.respond_to?(:count)
+      progressor = Progressor.new(total_count: collection.count, **options)
+    else
+      progressor = Progressor.new(**options)
+    end
+
+    index = 0
+
+    collection.public_send(method) do |item|
+      progressor.run do |progress|
+        Kernel.puts "[#{progress}] Working on #{item.public_send(format)}"
+        block.call(item, index)
+        index += 1
+      end
+    end
+  end
+
+  # Iterates using `.iterate` and the `#find_each` method
+  #
+  def self.find_each(collection, **options, &block)
+    iterate(:find_each, collection, **options, &block)
+  end
+
+  # Iterates using `.iterate` and the `#each` method
+  #
+  def self.each(collection, **options, &block)
+    iterate(:each, collection, **options, &block)
+  end
+end

data/lib/progressor/version.rb

@@ -1,3 +1,3 @@
 class Progressor
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/progressor.rb

@@ -3,6 +3,7 @@ require 'progressor/error'
 require 'progressor/formatting'
 require 'progressor/limited_sequence'
 require 'progressor/unlimited_sequence'
+require 'progressor/iteration'
 
 require 'benchmark'
 
@@ -99,4 +100,12 @@ class Progressor
   def skip(n)
     @sequence.skip(n)
   end
+
+  # Returns the time since the sequence was started, formatted like all the
+  # other durations. Useful for a final message to compare initial estimation
+  # to actual elapsed time.
+  #
+  def elapsed_time
+    @sequence.elapsed_time
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progressor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Radev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-03 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -67,6 +67,7 @@ files:
 - lib/progressor.rb
 - lib/progressor/error.rb
 - lib/progressor/formatting.rb
+- lib/progressor/iteration.rb
 - lib/progressor/limited_sequence.rb
 - lib/progressor/unlimited_sequence.rb
 - lib/progressor/version.rb