tty-progressbar 0.17.0 → 0.18.0

data/lib/tty/progressbar/timer.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module TTY
+  class ProgressBar
+    # Used to measure the elapsed time for multiple time intervals
+    #
+    # @api private
+    class Timer
+      attr_reader :start_time
+
+      # Create Timer
+      #
+      # @api private
+      def initialize
+        reset
+      end
+
+      # Reset the start time to nil and elapsed time to zero
+      #
+      # @api public
+      def reset
+        @running = false
+        @offset = 0
+        @start_time = nil
+      end
+
+      # Check whether or not the timer is running
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def running?
+        @running
+      end
+
+      # Total elapsed time
+      #
+      # @return [Float]
+      #   the elapsed time in seconds
+      #
+      # @api public
+      def elapsed_time
+        if running?
+          elapsed_until_now + @offset
+        else
+          @offset
+        end
+      end
+
+      # Measure current time interval
+      #
+      # @api public
+      def elapsed_until_now
+        time_so_far = Time.now - @start_time
+        # protect against negative time drifting
+        time_so_far > 0 ? time_so_far : 0
+      end
+
+      # Start measuring elapsed time for a new interval
+      #
+      # @return [Time]
+      #   return the start time
+      #
+      # @api public
+      def start
+        return @start_time if running?
+
+        @running = true
+        @start_time = Time.now
+      end
+
+      # Stop measuring elapsed time for the current interval
+      #
+      # @return [Float]
+      #   return elapsed time for the stopped interval
+      #
+      # @api public
+      def stop
+        return 0 unless running?
+
+        interval = elapsed_until_now
+        @offset += interval
+        @running = false
+        @start_time = nil
+        interval
+      end
+    end # Timer
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = '0.17.0'
+    VERSION = "0.18.0"
   end # ProgressBar
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-31 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strings-ansi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: tty-cursor
   requirement: !ruby/object:Gem::Requirement
@@ -44,54 +44,60 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
@@ -100,56 +106,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
   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
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A flexible progress bars drawing in terminal emulators.
+        version: '0.9'
+description: Display a single or multiple progress bars in the terminal. A progress
+  bar can show determinate or indeterminate progress that can be paused and resumed
+  at any time. A bar format supports many tokens for common information display like
+  elapsed time, estimated time to completion, mean rate and more.
 email:
-- me@piotrmurach.com
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- examples/color.rb
-- examples/failure.rb
-- examples/iterator.rb
-- examples/lazy.rb
-- examples/multi/main_bar.rb
-- examples/multi/simple.rb
-- examples/multi/width.rb
-- examples/simple.rb
-- examples/slow_process.rb
-- examples/speed.rb
-- examples/threaded.rb
-- examples/tokens.rb
-- examples/unicode.rb
 - lib/tty-progressbar.rb
 - lib/tty/progressbar.rb
 - lib/tty/progressbar/configuration.rb
 - lib/tty/progressbar/converter.rb
+- lib/tty/progressbar/formats.rb
 - lib/tty/progressbar/formatter.rb
 - lib/tty/progressbar/formatter/bar.rb
 - lib/tty/progressbar/formatter/byte_rate.rb
@@ -157,73 +142,29 @@ files:
 - lib/tty/progressbar/formatter/current_byte.rb
 - lib/tty/progressbar/formatter/elapsed.rb
 - lib/tty/progressbar/formatter/estimated.rb
+- lib/tty/progressbar/formatter/estimated_time.rb
 - lib/tty/progressbar/formatter/mean_byte.rb
 - lib/tty/progressbar/formatter/mean_rate.rb
 - lib/tty/progressbar/formatter/percent.rb
 - lib/tty/progressbar/formatter/rate.rb
 - lib/tty/progressbar/formatter/total.rb
 - lib/tty/progressbar/formatter/total_byte.rb
+- lib/tty/progressbar/formatters.rb
 - lib/tty/progressbar/meter.rb
 - lib/tty/progressbar/multi.rb
 - lib/tty/progressbar/pipeline.rb
+- lib/tty/progressbar/timer.rb
 - lib/tty/progressbar/version.rb
-- spec/spec_helper.rb
-- spec/unit/advance_spec.rb
-- spec/unit/clear_spec.rb
-- spec/unit/complete_spec.rb
-- spec/unit/converter/to_bytes_spec.rb
-- spec/unit/converter/to_seconds_spec.rb
-- spec/unit/converter/to_time_spec.rb
-- spec/unit/custom_formatter_spec.rb
-- spec/unit/custom_token_spec.rb
-- spec/unit/events_spec.rb
-- spec/unit/finish_spec.rb
-- spec/unit/formatter/bar_spec.rb
-- spec/unit/formatter/byte_rate_spec.rb
-- spec/unit/formatter/current_byte_spec.rb
-- spec/unit/formatter/current_spec.rb
-- spec/unit/formatter/elapsed_spec.rb
-- spec/unit/formatter/estimated_spec.rb
-- spec/unit/formatter/mean_byte_spec.rb
-- spec/unit/formatter/mean_rate_spec.rb
-- spec/unit/formatter/percent_spec.rb
-- spec/unit/formatter/rate_spec.rb
-- spec/unit/formatter/total_byte_spec.rb
-- spec/unit/formatter/total_spec.rb
-- spec/unit/frequency_spec.rb
-- spec/unit/head_spec.rb
-- spec/unit/hide_cursor_spec.rb
-- spec/unit/inspect_spec.rb
-- spec/unit/iterate_spec.rb
-- spec/unit/log_spec.rb
-- spec/unit/meter_spec.rb
-- spec/unit/multi/advance_spec.rb
-- spec/unit/multi/events_spec.rb
-- spec/unit/multi/finish_spec.rb
-- spec/unit/multi/line_inset_spec.rb
-- spec/unit/multi/register_spec.rb
-- spec/unit/multi/reset_spec.rb
-- spec/unit/multi/stop_spec.rb
-- spec/unit/multi/width_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/pipeline_spec.rb
-- spec/unit/ratio_spec.rb
-- spec/unit/render_spec.rb
-- spec/unit/reset_spec.rb
-- spec/unit/resize_spec.rb
-- spec/unit/set_current_spec.rb
-- spec/unit/start_spec.rb
-- spec/unit/stop_spec.rb
-- spec/unit/update_spec.rb
-- spec/unit/width_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-progressbar.gemspec
-homepage: https://piotrmurach.github.io/tty/
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-progressbar/issues
+  changelog_uri: https://github.com/piotrmurach/tty-progressbar/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-progressbar
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-progressbar
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -239,8 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A flexible progress bars drawing in terminal emulators.
+summary: A flexible and extensible progress bar for terminal applications.
 test_files: []

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/examples/color.rb

@@ -1,18 +0,0 @@
-require 'pastel'
-
-require_relative '../lib/tty-progressbar'
-
-pastel = Pastel.new
-green = pastel.on_green(" ")
-red = pastel.on_red(" ")
-
-bar = TTY::ProgressBar.new("|:bar|",
-  total: 30,
-  complete: green,
-  incomplete: red
-)
-
-30.times do
-  sleep(0.1)
-  bar.advance
-end

data/examples/failure.rb

@@ -1,12 +0,0 @@
-require_relative '../lib/tty-progressbar'
-
-bar = TTY::ProgressBar.new("downloading [:bar] :percent", head: '>', total: 30)
-30.times do |i|
-  if i == 15
-    bar.update(head: 'x')
-    bar.stop
-    break
-  end
-  sleep(0.1)
-  bar.advance
-end

data/examples/iterator.rb

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

data/examples/lazy.rb

@@ -1,6 +0,0 @@
-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,13 +0,0 @@
-require_relative '../../lib/tty-progressbar'
-
-bars = TTY::ProgressBar::Multi.new("main [:bar] :percent")
-
-bar1 = bars.register "foo [:bar] :percent", total: 15
-bar2 = bars.register "bar [:bar] :percent", total: 15
-bar3 = bars.register "baz [:bar] :percent", total: 45
-
-th1 = Thread.new { 15.times { sleep(0.1); bar1.advance } }
-th2 = Thread.new { 15.times { sleep(0.1); bar2.advance } }
-th3 = Thread.new { 45.times { sleep(0.1); bar3.advance } }
-
-[th1, th2, th3].each(&:join)

data/examples/multi/simple.rb

@@ -1,13 +0,0 @@
-require_relative '../../lib/tty-progressbar'
-
-bars = TTY::ProgressBar::Multi.new
-
-bar1 = bars.register "foo [:bar] :percent", total: 20
-bar2 = bars.register "bar [:bar] :percent", total: 30
-bar3 = bars.register "baz [:bar] :percent", total: 10
-
-th1 = Thread.new { 20.times { sleep(0.2); bar1.advance } }
-th2 = Thread.new { 30.times { sleep(0.1); bar2.advance } }
-th3 = Thread.new { 10.times { sleep(0.3); bar3.advance } }
-
-[th1, th2, th3].each(&:join)