progressor 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67733b5ccdcf4efdbe628a511246b38238f5bd368e320ae9251ec34dc1be7cc5
-  data.tar.gz: 2c84c065e48fdfab6e9ab4079c7c595be60cbfe16f7378970a451cebe36af326
+  metadata.gz: e8b8a4cb127259a4f539935a5c3d33dde51918c5f06e2a6c0bfba817b13a44ab
+  data.tar.gz: 489755d94b178dfc2c98d75b12ee7839a652d47948b09c39fc1e4a8476b9897b
 SHA512:
-  metadata.gz: 4735274940fcb4bd4b54089dce074bbbb6fe42cc530db202f3a3f4738c396624685d3d6740e8707882d8cfa9c0f4e2053851f5ed1c987c3d0a88c1fb665b2f28
-  data.tar.gz: 375e03f4109ea4a74de4483b55aa889611d7d2d0ec8901950363b2e5196f8652fb8995d20bcddb8d8118e842e6ead21d71bb47dec00cd071795962361f505371
+  metadata.gz: e074b0f2820dbc2a898258f7f89a36fc9a2f1867b13fd134b02cfe432589cb30beb6355facf0d80b0cb36a6deb562c7a36409382a1ab61bcee6aaaa6ec2306de
+  data.tar.gz: c8ebbad12c98156313ef2a16c55ff148f27f54bc1f8a3fa76371e714d4346847db7756e406db07e0a1c9d3acd4a1eb60e5bf8e3bbb090dfead4be93f59884bee

data/README.md

@@ -1,3 +1,6 @@
+[![Build Status](https://travis-ci.org/AndrewRadev/progressor.svg?branch=master)](https://travis-ci.org/AndrewRadev/progressor)
+[![Gem Version](https://badge.fury.io/rb/progressor.svg)](https://badge.fury.io/rb/progressor)
+
 Full documentation for the latest released version can be found at: https://www.rubydoc.info/gems/progressor
 
 ## Basic example
@@ -97,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/limited_sequence.rb

@@ -61,7 +61,7 @@ class Progressor
     end
 
     # Outputs a textual representation of the current state of the
-    # UnlimitedSequence. Shows:
+    # LimitedSequence. Shows:
     #
     # - the current number of iterations and the total count
     # - completion level in percentage
@@ -117,6 +117,14 @@ class Progressor
       remaining_time.round(2)
     end
 
+    # Returns the time since the object was instantiated, formatted like all
+    # the other durations. Useful for a final message to compare initial
+    # estimation to actual elapsed time.
+    #
+    def elapsed_time
+      format_time(Time.now - @start_time)
+    end
+
     private
 
     def average(collection)

data/lib/progressor/unlimited_sequence.rb

@@ -71,7 +71,7 @@ class Progressor
 
       [
         "#{@current + 1}",
-        "t: #{format_time(Time.now - @start_time)}",
+        "t: #{elapsed_time}",
         "t/i: #{format_time(per_iteration)}",
       ].join(', ')
     end
@@ -95,6 +95,13 @@ class Progressor
       # No estimation possible
     end
 
+    # Returns the time since the object was instantiated, formatted like all
+    # the other durations.
+    #
+    def elapsed_time
+      format_time(Time.now - @start_time)
+    end
+
     private
 
     def average(collection)

data/lib/progressor/version.rb

@@ -1,3 +1,3 @@
 class Progressor
-  VERSION = '0.1.0'
+  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'
 
@@ -34,7 +35,7 @@ require 'benchmark'
 #   ...
 #
 class Progressor
-  include Formatting
+  extend Formatting
 
   # Utility method to print a message with the time it took to run the contents
   # of the block.
@@ -48,8 +49,10 @@ class Progressor
   #
   def self.puts(message, &block)
     Kernel.puts "#{message}..."
-    measurement = Benchmark.measure { block.call }
+    result = nil
+    measurement = Benchmark.measure { result = block.call }
     Kernel.puts "#{message} DONE: #{format_time(measurement.real)}"
+    result
   end
 
   # Set up a new Progressor instance. Optional parameters:
@@ -97,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,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: progressor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Radev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,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
@@ -88,7 +75,7 @@ homepage: https://github.com/AndrewRadev/progressor
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Measure iterations in a long-running task
 test_files: []