progressbar 0.21.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b33b35967bde2d97d385a221d1967fe21fa57856
-  data.tar.gz: 776f253cb483eb64048ad53e83c3dcef3c15a037
+  metadata.gz: 961db6323b945f7b6373152fb44363bfd8a6ac51
+  data.tar.gz: 379bef4d424ce616f2f7b98e0de4881474d3c636
 SHA512:
-  metadata.gz: a3903d317334071b929b8b54bb1235e80a04a09ef1f18e7dcb889e085790f1dcdaf3f0cd209926d8212655a5aff2ab041a6f52a1cdbafbc31800271425dd4e42
-  data.tar.gz: 58b62e68e5d88d86638f0b30b7894240833e11dace0a423f561489ef6671b97f2dc6807c27b15ee3c86eccf2cb59b9cad61ecd79d3f397b91a5bebbe2f750b83
+  metadata.gz: 45799ecf9e67670603bb0cbeb959508fbe148a30681d07c5dff599b8fb3ee9aefa06d1ac24f42552977b463760340d83724b0d4193297ffa60dcf49654d10084
+  data.tar.gz: 60430265e9174a0fe0a1484986d956683b8dea789683fb78c7956852bf9c5759b569d6e476ad0c6871084f32ee27ff43fd274a598985722e0d1d870870c6c90d

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2016 The Kompanee, Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+Ruby/ProgressBar
+================================
+[![Gem Version](https://img.shields.io/gem/v/ruby-progressbar.svg)](https://rubygems.org/gems/ruby-progressbar) ![Rubygems Rank Overall](https://img.shields.io/gem/rt/ruby-progressbar.svg) ![Rubygems Rank Daily](https://img.shields.io/gem/rd/ruby-progressbar.svg) ![Rubygems Downloads](https://img.shields.io/gem/dv/ruby-progressbar/stable.svg) [![Build Status](https://img.shields.io/travis/jfelchner/ruby-progressbar/master.svg)](http://travis-ci.org/jfelchner/ruby-progressbar) [![Code Climate](https://codeclimate.com/github/jfelchner/ruby-progressbar.svg)](https://codeclimate.com/github/jfelchner/ruby-progressbar) [![Code Climate](https://codeclimate.com/github/jfelchner/ruby-progressbar/coverage.svg)](https://codeclimate.com/github/jfelchner/ruby-progressbar)
+
+<img src="https://www.dropbox.com/s/pe9o1yobxtubof8/ruby-progressbar-cage.png?dl=1" align="right" />
+
+The **ultimate** text progress bar library for Ruby!  It'll **SMASH YOU OVER THE HEAD** with a **PURE RUSH** of progress bar excitement!
+
+Don't miss out on what all the kids are talking about!  If you want everyone to know that your gem or app can survive _in the cage_ then YOU WANT **RUBY-PROGRESSBAR**!
+
+&nbsp;
+
+Full Reference
+--------------------------------
+
+There's gotten to be too much awesome to pack into one page.  Visit the [wiki](https://github.com/jfelchner/ruby-progressbar/wiki) for the full documentation.
+
+Here's a [quick link](https://github.com/jfelchner/ruby-progressbar/wiki/Basic-Usage) to the 'Basic Usage' section.
+
+Issues
+--------------------------------
+
+If you have problems, please create a [Github issue](https://github.com/jfelchner/ruby-progressbar/issues).
+
+Credits
+--------------------------------
+
+![The Kompanee](https://www.dropbox.com/s/86jfka1d6bhv8as/kompanee-text-black.png?dl=1)
+
+ruby-progressbar is maintained by [The Kompanee, Ltd.](http://www.thekompanee.com)
+
+The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
+
+License
+--------------------------------
+
+ruby-progressbar 1.0 is Copyright &copy; 2011-2016 The Kompanee. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+ruby-progressbar 0.9.0 is Copyright &copy; 2008 [Satoru Takabayashi](http://namazu.org/~satoru/)

data/Rakefile

@@ -1,14 +1,2 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-task :default => :test
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/test.rb'
-  test.verbose = true
-end
-
-require 'yard'
-YARD::Rake::YardocTask.new
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/lib/progressbar.rb

@@ -1,288 +1,18 @@
-#
-# Ruby/ProgressBar - a text progress bar library
-#
-# Copyright (C) 2001-2005 Satoru Takabayashi <satoru@namazu.org>
-#     All rights reserved.
-#     This is free software with ABSOLUTELY NO WARRANTY.
-#
-# You can redistribute it and/or modify it under the terms
-# of Ruby's license.
-#
+# frozen_string_literal: true
+require 'ruby-progressbar/output'
+require 'ruby-progressbar/outputs/tty'
+require 'ruby-progressbar/outputs/non_tty'
+require 'ruby-progressbar/timer'
+require 'ruby-progressbar/progress'
+require 'ruby-progressbar/throttle'
+require 'ruby-progressbar/calculators/length'
+require 'ruby-progressbar/calculators/running_average'
+require 'ruby-progressbar/components'
+require 'ruby-progressbar/format'
+require 'ruby-progressbar/base'
 
 class ProgressBar
-  VERSION = "0.21.0"
-
-  def initialize (title, total, out = STDERR)
-    @title = title
-    @total = total
-    @out = out
-    @terminal_width = 80
-    @bar_mark = "o"
-    @current = 0
-    @previous = 0
-    @finished_p = false
-    @start_time = Time.now
-    @previous_time = @start_time
-    @title_width = 14
-    @format = "%-#{@title_width}s %3d%% %s %s"
-    @format_arguments = [:title, :percentage, :bar, :stat]
-    clear
-    show
-    if block_given?
-      yield(self)
-      finish
-    end
-  end
-
-  attr_reader   :title
-  attr_reader   :current
-  attr_reader   :total
-  attr_accessor :start_time
-  attr_writer   :bar_mark
-
-private
-
-  def fmt_bar
-    bar_width = do_percentage * @terminal_width / 100
-    sprintf("|%s%s|",
-            @bar_mark * bar_width,
-            " " *  (@terminal_width - bar_width))
-  end
-
-  def fmt_percentage
-    do_percentage
-  end
-
-  def fmt_stat
-    if @finished_p then elapsed else eta end
-  end
-
-  def fmt_stat_for_long_run
-    if @finished_p then elapsed else eta_running_average end
-  end
-
-  def fmt_stat_for_file_transfer
-    if @finished_p then
-      sprintf("%s %s %s", bytes, transfer_rate, elapsed)
-    else
-      sprintf("%s %s %s", bytes, transfer_rate, eta)
-    end
-  end
-
-  def fmt_title
-    @title[0,(@title_width - 1)] + ":"
-  end
-
-  def convert_bytes (bytes)
-    if bytes < 1024
-      sprintf("%6dB", bytes)
-    elsif bytes < 1024 * 1000 # 1000kb
-      sprintf("%5.1fKB", bytes.to_f / 1024)
-    elsif bytes < 1024 * 1024 * 1000  # 1000mb
-      sprintf("%5.1fMB", bytes.to_f / 1024 / 1024)
-    else
-      sprintf("%5.1fGB", bytes.to_f / 1024 / 1024 / 1024)
-    end
-  end
-
-  def transfer_rate
-    bytes_per_second = @current.to_f / (Time.now - @start_time)
-    sprintf("%s/s", convert_bytes(bytes_per_second))
-  end
-
-  def bytes
-    convert_bytes(@current)
-  end
-
-  def format_time (t)
-    t = t.to_i
-    sec = t % 60
-    min  = (t / 60) % 60
-    hour = t / 3600
-    sprintf("% 3d:%02d:%02d", hour, min, sec);
-  end
-
-  # ETA stands for Estimated Time of Arrival.
-  def eta
-    if @current == 0
-      "ETA:  --:--:--"
-    else
-      elapsed = Time.now - @start_time
-      eta = elapsed * @total / @current - elapsed;
-      sprintf("ETA: %s", format_time(eta))
-    end
-  end
-
-  # Compute ETA with running average (better suited to long running tasks)
-  def eta_running_average
-    now = Time.now
-
-    # update throughput running average
-    if @total > 0 && @eta_previous && @eta_previous_time
-      current_elapsed = @current - @eta_previous
-      alpha = 0.9 ** current_elapsed
-      current_progress = 1.0 * current_elapsed
-      current_throughput = current_progress / (now - @eta_previous_time)
-      if @eta_throughput
-        @eta_throughput = @eta_throughput * alpha + current_throughput * (1-alpha)
-      else
-        @eta_throughput = current_throughput
-      end
-    end
-
-    @eta_previous = @current
-    @eta_previous_time = now
-
-    if @eta_throughput && @eta_throughput > 0
-      eta = (@total - @current) / @eta_throughput;
-      sprintf("ETA: %s", format_time(eta))
-    else
-      "ETA:  --:--:--"
-    end
-  end
-
-  def elapsed
-    elapsed = Time.now - @start_time
-    sprintf("Time: %s", format_time(elapsed))
-  end
-
-  def eol
-    if @finished_p then "\n" else "\r" end
-  end
-
-  def do_percentage
-    if @total.zero?
-      100
-    else
-      @current  * 100 / @total
-    end
-  end
-
-  DEFAULT_WIDTH = 80
-  def get_term_width
-    term_width = if ENV['COLUMNS'] =~ /^\d+$/
-      ENV['COLUMNS'].to_i
-    elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && shell_command_exists?('tput')
-      `tput cols`.to_i
-    elsif STDIN.tty? && shell_command_exists?('stty')
-      `stty size`.scan(/\d+/).map { |s| s.to_i }[1]
-    else
-      DEFAULT_WIDTH
-    end
-
-    if term_width > 0
-      term_width
-    else
-      DEFAULT_WIDTH
-    end
-  rescue
-    DEFAULT_WIDTH
-  end
-
-  def shell_command_exists?(command)
-    ENV['PATH'].split(File::PATH_SEPARATOR).any?{|d| File.exists? File.join(d, command) }
-  end
-
-  def show
-    arguments = @format_arguments.map {|method|
-      method = sprintf("fmt_%s", method)
-      send(method)
-    }
-    line = sprintf(@format, *arguments)
-
-    width = get_term_width
-    if line.length == width - 1
-      @out.print(line + eol)
-      @out.flush
-    elsif line.length >= width
-      @terminal_width = [@terminal_width - (line.length - width + 1), 0].max
-      if @terminal_width == 0 then @out.print(line + eol) else show end
-    else # line.length < width - 1
-      @terminal_width += width - line.length + 1
-      show
-    end
-    @previous_time = Time.now
-  end
-
-  def show_if_needed
-    if @total.zero?
-      cur_percentage = 100
-      prev_percentage = 0
-    else
-      cur_percentage  = (@current  * 100 / @total).to_i
-      prev_percentage = (@previous * 100 / @total).to_i
-    end
-
-    # Use "!=" instead of ">" to support negative changes
-    if cur_percentage != prev_percentage ||
-        Time.now - @previous_time >= 1 || @finished_p
-      show
-    end
-  end
-
-public
-
-  def clear
-    @out.print "\r"
-    @out.print(" " * (get_term_width - 1))
-    @out.print "\r"
-  end
-
-  def finish
-    @current = @total
-    @finished_p = true
-    show
-  end
-
-  def finished?
-    @finished_p
-  end
-
-  def file_transfer_mode
-    @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
-  end
-
-  def long_running
-    @format_arguments = [:title, :percentage, :bar, :stat_for_long_run]
-  end
-
-  def format= (format)
-    @format = format
-  end
-
-  def format_arguments= (arguments)
-    @format_arguments = arguments
-  end
-
-  def halt
-    @finished_p = true
-    show
-  end
-
-  def inc (step = 1)
-    @current += step
-    @current = @total if @current > @total
-    show_if_needed
-    @previous = @current
-  end
-
-  def set (count)
-    if count < 0 || count > @total
-      raise "invalid count: #{count} (total: #{@total})"
-    end
-    @current = count
-    show_if_needed
-    @previous = @current
-  end
-
-  def inspect
-    "#<ProgressBar:#{@current}/#{@total}>"
-  end
-
-end
-
-class ReversedProgressBar < ProgressBar
-  def do_percentage
-    100 - super
+  def self.create(*args)
+    ProgressBar::Base.new(*args)
   end
 end

data/lib/ruby-progressbar/base.rb

@@ -0,0 +1,161 @@
+require 'forwardable'
+
+class   ProgressBar
+class   Base
+  extend Forwardable
+
+  def_delegators :output,
+                 :clear,
+                 :log,
+                 :refresh
+
+  def_delegators :progressable,
+                 :progress,
+                 :total
+
+  def initialize(options = {})
+    self.autostart    = options.fetch(:autostart,  true)
+    self.autofinish   = options.fetch(:autofinish, true)
+    self.finished     = false
+
+    self.timer        = Timer.new(options)
+    self.progressable = Progress.new(options)
+
+    options           = options.merge(:timer    => timer,
+                                      :progress => progressable)
+
+    self.title_comp   = Components::Title.new(options)
+    self.bar          = Components::Bar.new(options)
+    self.percentage   = Components::Percentage.new(options)
+    self.rate         = Components::Rate.new(options)
+    self.time         = Components::Time.new(options)
+
+    self.output       = Output.detect(options.merge(:bar => self))
+    @format           = Format::String.new(output.resolve_format(options[:format]))
+
+    start :at => options[:starting_at] if autostart
+  end
+
+  def start(options = {})
+    clear
+
+    timer.start
+    update_progress(:start, options)
+  end
+
+  def finish
+    return if finished?
+
+    output.with_refresh do
+      self.finished = true
+      progressable.finish
+      timer.stop
+    end
+  end
+
+  def pause
+    output.with_refresh { timer.pause } unless paused?
+  end
+
+  def stop
+    output.with_refresh { timer.stop } unless stopped?
+  end
+
+  def resume
+    output.with_refresh { timer.resume } if stopped?
+  end
+
+  def reset
+    output.with_refresh do
+      self.finished = false
+      progressable.reset
+      timer.reset
+    end
+  end
+
+  def stopped?
+    timer.stopped? || finished?
+  end
+
+  alias paused? stopped?
+
+  def finished?
+    finished || (autofinish && progressable.finished?)
+  end
+
+  def started?
+    timer.started?
+  end
+
+  def decrement
+    update_progress(:decrement)
+  end
+
+  def increment
+    update_progress(:increment)
+  end
+
+  def progress=(new_progress)
+    update_progress(:progress=, new_progress)
+  end
+
+  def total=(new_total)
+    update_progress(:total=, new_total)
+  end
+
+  def progress_mark=(mark)
+    output.refresh_with_format_change { bar.progress_mark = mark }
+  end
+
+  def remainder_mark=(mark)
+    output.refresh_with_format_change { bar.remainder_mark = mark }
+  end
+
+  def title
+    title_comp.title
+  end
+
+  def title=(title)
+    output.refresh_with_format_change { title_comp.title = title }
+  end
+
+  def to_s(new_format = nil)
+    self.format = new_format if new_format
+
+    Format::Formatter.process(@format, output.length, self)
+  end
+
+  def inspect
+    "#<ProgressBar:#{progress}/#{total || 'unknown'}>"
+  end
+
+  def format=(other)
+    output.refresh_with_format_change do
+      @format = Format::String.new(other || output.default_format)
+    end
+  end
+
+  alias format format=
+
+  protected
+
+  attr_accessor :output,
+                :timer,
+                :progressable,
+                :title_comp,
+                :bar,
+                :percentage,
+                :rate,
+                :time,
+                :autostart,
+                :autofinish,
+                :finished
+
+  def update_progress(*args)
+    output.with_refresh do
+      progressable.__send__(*args)
+      timer.stop if finished?
+    end
+  end
+end
+end