progress_printer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d36d6773874ac74b24ec824a6b9255fb9a6015df
-  data.tar.gz: 83bca370e9059c05fb447ebe9999d4e4ab61996d
+SHA256:
+  metadata.gz: 66bac07a17f8eafa553b1384da0c1cfb8c353fac09720d5b6cbb20bc53504370
+  data.tar.gz: 9a510a4a9e62f3f6a81e5d1849df04d2838c1a13543cf9a6b544e105c995b22e
 SHA512:
-  metadata.gz: cd946f471c49b66bd5a591abf166cfe5636954bc6415ea3d0b811fb7a2a46b64cf623a95071dcbdb1f0e5a696bdf3895f8f2abdb461a7ba894cd84332fd06455
-  data.tar.gz: c9b07528d3ff8ea35809cfe7856a24b89f77bc9ae0d654495e07349f84c68a0265dd518dc388f7124f2d7c321a3b7aba8d1048f9dacdc28839b10a3b5dc536c2
+  metadata.gz: cddf35442374d0b86a579ca5411af75af86ce30f4e81f33fd26fd3e5ee13c14309567664c2bf1686c747bf78b2e80aa3b4f0289fecc4abf85cc86e8fa9ac9fc1
+  data.tar.gz: 6f3268e6e4d93141acf90cf8c33eeabc56030576957b00f11fa92310bb5496195337980e1a88e92cac6f714a03742a138cd4fdede7b5c4033c9a7bb256cd0a5c

data/.travis.yml

@@ -1,5 +1,13 @@
 sudo: false
+
 language: ruby
+
 rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.15.4
+  - 2.2
+  - 2.3
+  - 2.4
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.2.0
+
+* Print the total runtime on #finish [[PR 6](https://github.com/justincampbell/progress_printer/pull/6/files)]
+* Added .wrap/#wrap methods which take blocks [[PR 4](https://github.com/justincampbell/progress_printer/pull/4/files)]
+
+## 0.1.0
+
+* Initial release
+

data/README.md

@@ -1,43 +1,68 @@
-# ProgressPrinter
+# ProgressPrinter [![Gem Version](https://badge.fury.io/rb/progress_printer.svg)](https://badge.fury.io/rb/progress_printer) [![Build Status](https://travis-ci.org/justincampbell/progress_printer.svg?branch=master)](https://travis-ci.org/justincampbell/progress_printer)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/progress_printer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+> Logs the progress of an operation, with estimated completion time.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+When using [Bundler](https://bundler.io), add this to your project's `Gemfile`:
 
 ```ruby
 gem 'progress_printer'
 ```
 
-And then execute:
-
-    $ bundle
+Otherwise, install it with the `gem` command:
 
-Or install it yourself as:
 
-    $ gem install progress_printer
+```shell
+$ gem install progress_printer
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
 
-## Development
+A `ProgressPrinter` must be created, started, and finished. Use `#increment` within your operation to increment the progress.
 
-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.
+```rb
+require 'progress_printer'
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+printer = ProgressPrinter.new(name: "Counting", total: 250)
+printer.start
+250.times { sleep 0.05; printer.increment }
+printer.finish
+```
 
-## Contributing
+Output:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/justincampbell/progress_printer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+```
+Counting:   0/250   0% calculating...
+Counting: 100/250  40% ~8s
+Counting: 200/250  80% ~2s
+Counting: 250/250 100% 14s total
+```
 
-## License
+You can also achieve the same results by using `.wrap` or `#wrap`:
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+```rb
+ProgressPrinter.wrap(name: "Counting", total: 250) do |progress|
+  250.times { sleep 0.05; progress.increment }
+end
+```
+
+```rb
+printer = ProgressPrinter.new(name: "Counting", total: 250)
+printer.wrap do |progress|
+  250.times { sleep 0.05; progress.increment }
+end
+```
+
+### Arguments
 
-## Code of Conduct
+* `total` - The total number of iterations expected. If this is omitted, estimated completion time will not be shown.
+* `name` - A string to display next to each printed line. This helps identify the current operation, or the specific progress printer if using multiple.
+* `every` (Default: `100`) - How many iterations should pass in between printing a line.
+* `out` (Default: `$stdout`) - An object responding to `#puts` for printing the progress to.
 
-Everyone interacting in the ProgressPrinter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/justincampbell/progress_printer/blob/master/CODE_OF_CONDUCT.md).
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/justincampbell/progress_printer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/progress_printer.rb

@@ -12,12 +12,24 @@
 #
 #   Counting:   0/250   0% calculating...
 #   Counting: 100/250  40% ~1m30s
-#   Counting: 200/250  80% ~45s
-#   Counting: 250/250 100% ~0s
+#   Counting: 200/250  80% ~30s
+#   Counting: 250/250 100% 2m30s total
 #
 class ProgressPrinter
   DEFAULT_EVERY = 100
 
+  class << self
+    attr_accessor :silent
+
+    def silence
+      self.silent = true
+    end
+
+    def wrap(*args, &block)
+      new(*args).wrap(&block)
+    end
+  end
+
   attr_reader :total, :name, :every, :out
   attr_accessor :start_time
 
@@ -25,7 +37,19 @@ class ProgressPrinter
     @total = total
     @name = name
     @every = every
-    @out = out
+
+    if self.class.silent
+      @out = StringIO.new
+    else
+      @out = out
+    end
+  end
+
+  def wrap
+    start
+    yield(self)
+  ensure
+    finish
   end
 
   def start
@@ -40,11 +64,7 @@ class ProgressPrinter
   end
 
   def finish
-    if total
-      print_progress total
-    else
-      print_progress current unless at_milestone?
-    end
+    print_progress current, final: true
   end
 
   def percent_complete
@@ -75,8 +95,12 @@ class ProgressPrinter
     return if percent_remaining == 1.0
     return 0.0 if percent_remaining == 0.0
 
-    time_passed = now - start_time
-    time_passed / percent_complete * (1.0 - percent_complete)
+    time_passed(now) / percent_complete * (1.0 - percent_complete)
+  end
+
+  def time_passed(now = Time.now)
+    return unless start_time
+    now - start_time
   end
 
   def current
@@ -93,7 +117,7 @@ class ProgressPrinter
     @enum ||= (1..Float::INFINITY).enum_for
   end
 
-  def print_progress(n)
+  def print_progress(n, final: false)
     buffer = StringIO.new
 
     buffer.print "#{name}: " if name
@@ -102,11 +126,20 @@ class ProgressPrinter
       buffer.print left_pad(n, total_length)
       buffer.print "/#{total} "
       buffer.print left_pad(percent_complete_string, 4)
-      buffer.print " #{estimated_time_remaining}"
     else
       buffer.print n
     end
 
+    if final
+      if time_passed
+        buffer.print " #{self.class.format_duration(time_passed)} total"
+      end
+    else
+      if total
+        buffer.print " #{estimated_time_remaining}"
+      end
+    end
+
     out.puts buffer.string
   end
 

data/lib/progress_printer/version.rb

@@ -1,3 +1,3 @@
 class ProgressPrinter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progress_printer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Logs the progress of an operation, with estimated completion time.