tty-progressbar 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffbc5e8dbfe59fffa658892053d84d3f571ae501
-  data.tar.gz: 2605c62530355c6ddde735c12395f6a7a0d35cbf
+  metadata.gz: b9e021f67756883c39075abe088ad0861ef85582
+  data.tar.gz: 08b1cd0a9925899b0a7c6ace9dddeef1a1545953
 SHA512:
-  metadata.gz: fedfcab4a057cd7d1488f003b4ab300fb33197ac8d3ad8157057d82684d357057b825d9e06fed00186c075a5bca97e73779ec210b191002a57b07dee64d24690
-  data.tar.gz: c203b0789b771f1bb9aadd1a7a19a4e7933d0d31591d6f2a0e48043013115ed3762d557167d5299098d427d5e003fa0f4d7061ee7c32217c8d0a4fe051f86d12
+  metadata.gz: 7719a9ffa8814c51e301dd5e441a4516e87230ee7f66780ba40c3b29556bdd086f5dc18b6ee024b2b54b1344bb52996c51048837bafffcc560164c4b44165f0e
+  data.tar.gz: 98974cccbbad3174dcbf24dfd66957db87aca29f79ba94f4f287c6fff789251130a042c6e2ed8ae9831ea1be95380f433c3b14093a9ae01b282d4a4331f0ef97

data/.travis.yml

@@ -7,9 +7,9 @@ script: "bundle exec rake ci"
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.1
+  - 2.2.8
+  - 2.3.6
+  - 2.4.3
   - ruby-head
   - jruby-9.1.5.0
   - jruby-head

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## [v0.14.0] - 2017-01-17
+
+### Changed
+* Change to only output to a console and stop output to a file, pipe etc...
+* Change #iterate to accept enumerators as collection type by Victor Shepelev(@zverok)
+
+### Fixed
+* Fix #iterate to take into account progress value in total steps calculation
+
 ## [v0.13.0] - 2017-10-29
 
 ### Changed
@@ -151,6 +160,7 @@
 
 * Initial implementation and release
 
+[v0.14.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.13.0...v0.14.0
 [v0.13.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.12.2...v0.13.0
 [v0.12.2]: https://github.com/peter-murach/tty-progressbar/compare/v0.12.1...v0.12.2
 [v0.12.1]: https://github.com/peter-murach/tty-progressbar/compare/v0.12.0...v0.12.1

data/Gemfile

@@ -3,13 +3,12 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'timecop', '~> 0.8.1'
-  gem 'pastel',  '~> 0.7.0'
+  gem 'pastel',  '~> 0.7.2'
   gem 'coveralls', '~> 0.8.13'
   gem 'simplecov', '~> 0.11.2'
 end
 
 group :metrics do
-  gem 'yard',      '~> 0.8.7'
+  gem 'yard',      '~> 0.9.12'
   gem 'yardstick', '~> 0.9.9'
 end

data/README.md

@@ -1,8 +1,9 @@
 # TTY::ProgressBar [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
 [![Gem Version](https://badge.fury.io/rb/tty-progressbar.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/tty-progressbar.svg?branch=master)][travis]
 [![Build status](https://ci.appveyor.com/api/projects/status/w3jafjeatt1ulufa?svg=true)][appveyor]
-[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-progressbar/badges/gpa.svg)][codeclimate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/e85416137d2057169575/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-progressbar/badge.svg)][coverage]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/tty-progressbar.svg?branch=master)][inchpages]
 
@@ -10,7 +11,7 @@
 [gem]: http://badge.fury.io/rb/tty-progressbar
 [travis]: http://travis-ci.org/piotrmurach/tty-progressbar
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-progressbar
-[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-progressbar
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-progressbar/maintainability
 [coverage]: https://coveralls.io/github/piotrmurach/tty-progressbar
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-progressbar
 
@@ -62,8 +63,9 @@ Or install it yourself as:
   * [2.13 on](#213-on)
 * [3. Configuration](#3-configuration)
   * [3.1 :head](#31-head)
-  * [3.2 :frequency](#32-interval)
-  * [3.3 :interval](#33-interval)
+  * [3.2 :output](#32-output)
+  * [3.3 :frequency](#33-frequency)
+  * [3.4 :interval](#34-interval)
 * [4. Formatting](#4-formatting)
   * [4.1 Tokens](#41-tokens)
   * [4.2 Custom Formatters](#42-custom-formatters)
@@ -150,7 +152,7 @@ To simplify progressing over an enumerable you can use `iterate` which as a firs
 First, create a progress bar without a total which will be dynamically handled for you:
 
 ```ruby
-bar = TTY::ProgressBar.new
+bar = TTY::ProgressBar.new("[:bar]")
 ```
 
 Then, either directly iterate over a collection by yielding values to a block:
@@ -159,7 +161,7 @@ Then, either directly iterate over a collection by yielding values to a block:
 bar.iterate(30.times) { |v| ... }
 ```
 
-or return an 'Enumerator':
+or return an `Enumerator`:
 
 ```ruby
 progress = bar.iterate(30.times)
@@ -172,6 +174,33 @@ By default, progress bar is advanced by `1` but you can change it by passing sec
 bar.iterate(30.times, 5)
 ```
 
+One particularly useful application of `iterate` are Ruby infamous [lazy enumerators](http://ruby-doc.org/core-2.5.0/Enumerator/Lazy.html), or slowly advancing enumerations, representing complex processes.
+
+For example, an `Enumerator` that downloads content from a remote server chunk at a time:
+
+```ruby
+downloader = Enumerator.new do |y|
+  start = 0
+  loop do
+    yield(download_from_server(start, CHUNK_SIZE))
+    raise StopIteration if download_finished?
+    start += CHUNK_SIZE
+  end
+end
+```
+
+would be used with progress bar with the total size matching the content size like so:
+
+```ruby
+bar = TTY::ProgressBar.new("[:bar]", total: content_size)
+# you need to provide the total for the iterate to avoid calling enumerator.count
+response = bar.iterate(downloader, CHUNK_SIZE).to_a.join
+```
+
+This would result in progress bar advancing after each chunk up until all content has been downloaded, returning the result of the download in `response` variable.
+
+Please run [slow_process example](examples/slow_process.rb) to see this in action.
+
 ### 2.3 current=
 
 **TTY::ProgressBar** allows you to set progress to a given value by calling `current=` method.
@@ -299,10 +328,10 @@ There are number of configuration options that can be provided:
 * `:width` of the bars display in terminal columns excluding formatting options. Defaults to total steps
 * `:complete` completion character by default `=`
 * `:incomplete` incomplete character by default single space
-* [:head](#21-head) the head character by default `=`
-* `:output` the output stream defaulting to `stderr`
-* [:frequency](#22-frequency) used to throttle the output, by default `0`
-* [:interval](#23-interval) used to measure the speed, by default `1 sec`
+* [:head](#31-head) the head character by default `=`
+* [:output](#32-output) the output stream defaulting to `stderr`
+* [:frequency](#33-frequency) used to throttle the output, by default `0`
+* [:interval](#34-interval) used to measure the speed, by default `1 sec`
 * `:hide_cursor` to hide display cursor defaulting to `false`
 * `:clear` to clear the finished bar defaulting to `false`
 
@@ -326,7 +355,19 @@ bar = TTY::ProressBar.new("[:bar]", head: '>')
 # [=======>      ]
 ```
 
-### 3.2 :frequency
+### 3.2 :output
+
+The progress bar only outputs to a console and when output is redirected to a file or a pipe it does nothing. This is so, for example, your error logs do not overflow with progress bars output.
+
+You can change where console output is streamed with `:output` option:
+
+```ruby
+bar = TTY::ProgressBar.new(output: $stdout)
+```
+
+The output stream defaults to `stderr`.
+
+### 3.3 :frequency
 
 Each time the `advance` is called it causes the progress bar to repaint. In cases when there is a huge number of updates per second, you may need to limit the rendering process by using the `frequency` option.
 
@@ -336,7 +377,7 @@ The `frequency` option accepts `integer` representing number of `Hz` units, for
 TTY::ProgressBar.new("[:bar]", total: 30, frequency: 10) # 10 Hz
 ```
 
-### 3.3 :interval
+### 3.4 :interval
 
 For every call of `advance` method the **ProgressBar** takes a sample for speed measurement. By default the samples are grouped per second but you can change that by passing the `interval` option.
 
@@ -633,4 +674,4 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 
 ## Copyright
 
-Copyright (c) 2014-2017 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014-2018 Piotr Murach. See LICENSE for further details.

data/examples/color.rb

@@ -1,8 +1,7 @@
-# coding: utf-8
-
-require 'tty-progressbar'
 require 'pastel'
 
+require_relative '../lib/tty-progressbar'
+
 pastel = Pastel.new
 green = pastel.on_green(" ")
 red = pastel.on_red(" ")

data/examples/failure.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'tty-progressbar'
+require_relative '../lib/tty-progressbar'
 
 bar = TTY::ProgressBar.new("downloading [:bar] :percent", head: '>', total: 30)
 30.times do |i|

data/examples/iterator.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
+require_relative '../lib/tty-progressbar'
 
-require 'tty-progressbar'
-
-bar = TTY::ProgressBar.new("[:bar]")
+bar = TTY::ProgressBar.new("[:bar]", total: 30)
 
 bar.iterate(30.times) { sleep(0.1) }

data/examples/lazy.rb

@@ -0,0 +1,6 @@
+require_relative '../lib/tty-progressbar'
+
+bar = TTY::ProgressBar.new("[:bar] :current", total: 10, width: 20)
+
+range = 1..Float::INFINITY
+bar.iterate(range.lazy.take(10)) { sleep(0.1) }

data/examples/multi/main_bar.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'tty-progressbar'
+require_relative '../../lib/tty-progressbar'
 
 bars = TTY::ProgressBar::Multi.new("main [:bar] :percent")
 

data/examples/multi/simple.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'tty-progressbar'
+require_relative '../../lib/tty-progressbar'
 
 bars = TTY::ProgressBar::Multi.new
 

data/examples/simple.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-require 'tty-progressbar'
+require_relative '../lib/tty-progressbar'
 
 bar = TTY::ProgressBar.new("downloading [:bar] :elapsed :percent", total: 30)
 30.times do

data/examples/slow_process.rb

@@ -0,0 +1,29 @@
+require_relative '../lib/tty-progressbar'
+
+CONTENT_SIZE = 2048
+CHUNK_SIZE = 255
+
+# Dummy "long responding server"
+def download_from_server(offset, limit)
+  sleep(0.1)
+  "<chunk #{offset}..#{offset + limit}>"
+end
+
+def download_finished?(position)
+  position >= CONTENT_SIZE
+end
+
+downloader = Enumerator.new do |y|
+  start = 0
+  loop do
+    y.yield(download_from_server(start, CHUNK_SIZE))
+    start += CHUNK_SIZE
+    raise StopIteration if download_finished?(start)
+  end
+end
+
+bar = TTY::ProgressBar.new("[:bar] :current_byte/:total_byte", total: CONTENT_SIZE)
+
+response = bar.iterate(downloader, CHUNK_SIZE).to_a.join
+
+puts response

data/examples/speed.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-require 'tty-progressbar'
+require_relative '../lib/tty-progressbar'
 
 bar = TTY::ProgressBar.new "downloading [:bar] :rate/s :mean_rate/s" do |conf|
   conf.total = 100

data/examples/threaded.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'tty-progressbar'
+require_relative '../lib/tty-progressbar'
 
 threads = []
 

data/examples/tokens.rb

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-require 'tty-progressbar'
+require_relative '../lib/tty-progressbar'
 
 files = [
   'file1.txt', 'file2.txt', 'file3.txt', 'file4.txt', 'file5.txt',

data/lib/tty/progressbar.rb

@@ -155,7 +155,19 @@ module TTY
     end
 
     # Iterate over collection either yielding computation to block
-    # or provided Enumerator.
+    # or provided Enumerator. If the bar's `total` was not set,
+    # it would be taken from `collection.count`, otherwise previously
+    # set `total` would be used. This allows using the progressbar
+    # with infinite, lazy, or slowly-calculated enumerators.
+    #
+    # @note
+    #   If `total` is set, iteration will NOT stop after this number of
+    #   iterations, only when provided Enumerable is finished. It may
+    #   be convenient in "unsure number of iterations" situations
+    #   (like downloading in chunks, when server may eventually send
+    #   more chunks than predicted), but be careful to not pass infinite
+    #   enumerators without previosly doing `.take(some_finite_number)`
+    #   on them.
     #
     # @example
     #   bar.iterate(30.times) { ... }
@@ -170,14 +182,14 @@ module TTY
     #
     # @api public
     def iterate(collection, progress = 1, &block)
-      update(total: collection.count)
-      prog = Enumerator.new do |iter|
+      update(total: collection.count * progress) unless total
+      progress_enum = Enumerator.new do |iter|
         collection.each do |elem|
           advance(progress)
           iter.yield(elem)
         end
       end
-      block_given? ? prog.each(&block) : prog
+      block_given? ? progress_enum.each(&block) : progress_enum
     end
 
     # Update configuration options for this bar
@@ -279,6 +291,8 @@ module TTY
     #
     # @api private
     def write(data, clear_first = false)
+      return unless tty? # write only to terminal
+
       move_to_row do
         output.print(TTY::Cursor.column(1)) if clear_first
         characters_in = @multibar.line_inset(self) if @multibar
@@ -465,5 +479,14 @@ module TTY
         callback.call(*args)
       end
     end
+
+    # Check if IO is attached to a terminal
+    #
+    # return [Boolean]
+    #
+    # @api public
+    def tty?
+      output.respond_to?(:tty?) && output.tty?
+    end
   end # ProgressBar
 end # TTY

data/lib/tty/progressbar/version.rb

@@ -1,5 +1,5 @@
 module TTY
   class ProgressBar
-    VERSION = '0.13.0'
+    VERSION = '0.14.0'.freeze
   end # ProgressBar
 end # TTY

data/spec/spec_helper.rb

@@ -16,6 +16,12 @@ end
 require 'timecop'
 require 'tty-progressbar'
 
+class StringIO
+  def tty?
+    true
+  end
+end
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

data/spec/unit/iterate_spec.rb

@@ -20,7 +20,8 @@ RSpec.describe TTY::ProgressBar, '#iterate' do
 
   it "iterates over a collection with a step" do
     bar = TTY::ProgressBar.new("[:bar]", output: output)
-    bar.iterate(20.times, 5) {  }
+    values = []
+    bar.iterate(4.times, 5) { |val| values << val }
 
     expect(bar.complete?).to eq(true)
     output.rewind
@@ -30,6 +31,7 @@ RSpec.describe TTY::ProgressBar, '#iterate' do
       "\e[1G[===============     ]",
       "\e[1G[====================]\n"
     ].join)
+    expect(values).to eq([0, 1, 2, 3])
   end
 
   it "iterates over a collection and returns enumerable" do
@@ -43,4 +45,35 @@ RSpec.describe TTY::ProgressBar, '#iterate' do
 
     expect(values).to eq([0,1,2,3,4])
   end
+
+  it "does not uses collection's count if total is provided" do
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
+    iterable = 5.times
+    expect(iterable).not_to receive(:count)
+    progress = bar.iterate(iterable)
+    values = []
+
+    progress.each { |v| values << v }
+
+    expect(values).to eq([0,1,2,3,4])
+  end
+
+  it "iterates over an infinite enumerator and renders bar correctly" do
+    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
+    infinite_iter = (1..Float::INFINITY).lazy
+
+    progress = bar.iterate(infinite_iter)
+
+    10.times { progress.next }
+
+    expect(bar.complete?).to eq(true)
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[=    ]",
+      "\e[1G[==   ]",
+      "\e[1G[===  ]",
+      "\e[1G[==== ]",
+      "\e[1G[=====]\n"
+    ].join)
+  end
 end

data/tty-progressbar.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency "tty-cursor", '~> 0.5.0'
-  spec.add_dependency "tty-screen", '~> 0.6.0'
+  spec.add_dependency "tty-screen", '~> 0.6.4'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
   spec.add_development_dependency 'rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-29 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-cursor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,9 +121,11 @@ files:
 - examples/color.rb
 - examples/failure.rb
 - examples/iterator.rb
+- examples/lazy.rb
 - examples/multi/main_bar.rb
 - examples/multi/simple.rb
 - examples/simple.rb
+- examples/slow_process.rb
 - examples/speed.rb
 - examples/threaded.rb
 - examples/tokens.rb
@@ -255,4 +271,3 @@ test_files:
 - spec/unit/stop_spec.rb
 - spec/unit/update_spec.rb
 - spec/unit/width_spec.rb
-has_rdoc: