progress_bar 1.0.5 → 1.3.3

data/lib/progress_bar.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 
-require 'options'
-require 'highline'
+require "options"
+require "highline"
 
 class ProgressBar
   Error = Class.new(StandardError)
@@ -9,34 +10,41 @@ class ProgressBar
   attr_accessor :count, :max, :meters
 
   def initialize(*args)
-
     @count      = 0
     @max        = 100
     @meters     = [:bar, :counter, :percentage, :elapsed, :eta, :rate]
 
-    @max        = args.shift if args.first.is_a? Numeric
-    raise ArgumentError, "Max must be a positive integer" unless @max > 0
+    @max = args.shift if args.first.is_a? Numeric
+    raise ArgumentError, "Max must be a positive integer" unless @max >= 0
 
-    @meters     = args unless args.empty?
+    @meters = args unless args.empty?
 
     @last_write = ::Time.at(0)
     @start      = ::Time.now
 
-    @hl         = HighLine.new
+    @hl = HighLine.new
+    @terminal_width = 80
+    @last_width_adjustment = ::Time.at(0)
   end
 
   def increment!(count = 1)
-    self.count += count
+    @count += count
     now = ::Time.now
-    if (now - @last_write) > 0.2 || self.count >= max
+    if (now - @last_write) > 0.2 || @count >= max
       write
       @last_write = now
     end
   end
 
-  def write
+  def puts(text)
     clear!
-    print to_s
+    $stderr.write(text)
+    $stderr.puts
+    write
+  end
+
+  def write
+    print "\r" + to_s
   end
 
   def remaining
@@ -73,8 +81,8 @@ class ProgressBar
 
   def to_s
     self.count = max if count > max
-    meters.inject("") do |text, meter|
-      text << render(meter) + " "
+    meters.inject(String.new) do |text, meter|
+      text << "#{render(meter)} "
     end.strip
   end
 
@@ -85,7 +93,7 @@ class ProgressBar
   end
 
   def clear!
-    print "\r"
+    print "\r" + " " * terminal_width + "\r"
   end
 
   def render(meter)
@@ -97,13 +105,11 @@ class ProgressBar
   end
 
   def render_bar
-    return '' if bar_width < 2
+    return "" if bar_width < 2
+
     progress_width = (ratio * (bar_width - 2)).floor
     remainder_width = bar_width - 2 - progress_width
-    "[" +
-      "#" * progress_width +
-      " " * remainder_width +
-    "]"
+    "[#{'#' * progress_width}#{' ' * remainder_width}]"
   end
 
   def render_counter
@@ -124,20 +130,17 @@ class ProgressBar
   end
 
   def render_rate
-    "[%#{max_width+3}.2f/s]" % rate
+    "[%#{max_width + 3}.2f/s]" % rate
   end
 
   def terminal_width
     # HighLine check takes a long time, so only update width every second.
-    if @terminal_width.nil? || @last_width_adjustment.nil? ||
-                               ::Time.now - @last_width_adjustment > 1
-
-      @last_width_adjustment = ::Time.now
-      @terminal_width = @hl.output_cols.to_i
-      if @terminal_width < 1
-        @terminal_width = 80
-      end
-      @terminal_width
+    now = ::Time.now
+    if now - @last_width_adjustment > 1
+      @last_width_adjustment = now
+      new_width = @hl.output_cols.to_i
+      new_width = 80 if new_width < 1
+      @terminal_width = new_width
     else
       @terminal_width
     end
@@ -148,12 +151,12 @@ class ProgressBar
   end
 
   def non_bar_width
-    meters.reject { |m| m == :bar }.inject(0) do |width, meter|
+    meters.reject { |meter| meter == :bar }.inject(0) do |width, meter|
       width += width_of(meter) + 1
     end
   end
 
-  def counter_width   # [  1/100]
+  def counter_width # [  1/100]
     max_width * 2 + 3
   end
 
@@ -181,12 +184,15 @@ class ProgressBar
     max.to_s.length
   end
 
+  HOUR = 3600
+  MINUTE = 60
   def format_interval(interval)
-    if interval > 3600
-      "%02i:%02i:%02i" % [interval/3600, interval%3600/60, interval%60]
+    if interval > HOUR
+      "%02i:%02i:%02i" % [interval / HOUR, interval % HOUR / MINUTE, interval % MINUTE]
     else
-      "%02i:%02i" % [interval/60, interval%60]
+      "%02i:%02i" % [interval / MINUTE, interval % MINUTE]
     end
   end
-
 end
+
+require_relative "progress_bar/with_progress"

data/progress_bar.gemspec

@@ -1,6 +1,6 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "progress_bar/version"
+# frozen_string_literal: true
+
+require_relative "lib/progress_bar/version"
 
 Gem::Specification.new do |s|
   s.name        = "progress_bar"
@@ -9,16 +9,20 @@ Gem::Specification.new do |s|
   s.authors     = ["Paul Sadauskas"]
   s.email       = ["psadauskas@gmail.com"]
   s.homepage    = "http://github.com/paul/progress_bar"
-  s.summary     = %q{Simple Progress Bar for output to a terminal}
-  s.description = %q{Give people feedback about long-running tasks without overloading them with information: Use a progress bar, like Curl or Wget!}
+  s.license     = "WTFPL"
+  s.summary     = "Simple Progress Bar for output to a terminal"
+  s.description = "Give people feedback about long-running tasks without overloading them with information: Use a progress bar, like Curl or Wget!"
 
-  s.rubyforge_project = "progress_bar"
+  s.required_ruby_version = ">= 2.4.0"
 
-  s.add_dependency('options', '~> 2.3.0')
-  s.add_dependency('highline', '~> 1.6')
+  s.add_dependency("highline", [">= 1.6", "< 3"])
+  s.add_dependency("options", "~> 2.3.0")
 
   s.add_development_dependency("rake")
+  s.add_development_dependency("reek")
   s.add_development_dependency("rspec")
+  s.add_development_dependency("rubocop")
+  s.add_development_dependency("rubocop-rspec")
   s.add_development_dependency("timecop")
 
   s.files         = `git ls-files`.split("\n")

data/spec/arguments_spec.rb

@@ -1,40 +1,37 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+# frozen_string_literal: true
 
-describe 'ProgressBar arguments' do
-  before do
-    @default_max = 100
-    @default_meters = [:bar, :counter, :percentage, :elapsed, :eta, :rate]
-  end
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "ProgressBar arguments" do
+  let(:default_max) { 100 }
+  let(:default_meters) { [:bar, :counter, :percentage, :elapsed, :eta, :rate] }
 
   it "should set appropriate defaults without any arguments" do
     bar = ProgressBar.new
-    bar.max.should == @default_max
-    bar.meters.should == @default_meters
+    expect(bar.max).to eq default_max
+    expect(bar.meters).to eq default_meters
   end
 
   it "should allow a single argument specifying the max" do
     bar = ProgressBar.new(123)
-    bar.max.should == 123
-    bar.meters.should == @default_meters
+    expect(bar.max).to eq 123
+    expect(bar.meters).to eq default_meters
   end
 
   it "should allow specifying just the meters" do
     bar = ProgressBar.new(:bar, :eta)
-    bar.max.should == @default_max
-    bar.meters.should == [:bar, :eta]
+    expect(bar.max).to eq default_max
+    expect(bar.meters).to eq [:bar, :eta]
   end
 
   it "should allow specyfing the max and meters" do
     bar = ProgressBar.new(123, :bar, :eta)
-    bar.max.should == 123
-    bar.meters.should == [:bar, :eta]
+    expect(bar.max).to eq 123
+    expect(bar.meters).to eq [:bar, :eta]
   end
 
   it "should raise an error when initial max is nonsense" do
-    lambda {
-      bar = ProgressBar.new(0)
-    }.should raise_error(ProgressBar::ArgumentError)
+    expect { ProgressBar.new(-1) }
+      .to raise_error(ProgressBar::ArgumentError)
   end
-
 end
-

data/spec/bar_spec.rb

@@ -1,37 +1,39 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+# frozen_string_literal: true
 
-describe 'ProgressBar bar output' do
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "ProgressBar bar output" do
   let(:max) { 100 }
   let(:terminal_width) { 12 }
 
   let(:progress_bar) { ProgressBar.new(max, :bar) }
 
   before do
-    progress_bar.stub(:terminal_width) { terminal_width }
+    allow(progress_bar).to receive(:terminal_width).and_return(terminal_width)
     progress_bar.count = count
   end
 
   subject { progress_bar.to_s }
 
-  describe 'at count=0' do
+  describe "at count=0" do
     let(:count) { 0 }
 
     it { should == "[          ]" }
   end
 
-  describe 'at count=50' do
+  describe "at count=50" do
     let(:count) { 50 }
 
     it { should == "[#####     ]" }
   end
 
-  describe 'at count=100' do
+  describe "at count=100" do
     let(:count) { 100 }
 
     it { should == "[##########]" }
   end
 
-  describe 'at count=25 (non-integer divide, should round down)' do
+  describe "at count=25 (non-integer divide, should round down)" do
     let(:count) { 25 }
 
     it { should == "[##        ]" }
@@ -50,6 +52,4 @@ describe 'ProgressBar bar output' do
       end
     end
   end
-
 end
-

data/spec/counter_spec.rb

@@ -1,50 +1,45 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+# frozen_string_literal: true
 
-describe 'ProgressBar counter output' do
-  before do
-    @progress_bar = ProgressBar.new(100, :counter)
-  end
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "ProgressBar counter output" do
+  let(:progress_bar) { ProgressBar.new(100, :counter) }
 
-  subject { @progress_bar.to_s }
+  subject { progress_bar.to_s }
 
-  describe 'at count=0' do
+  describe "at count=0" do
     before do
-      @progress_bar.count = 0
+      progress_bar.count = 0
     end
 
     it { should == "[  0/100]" }
   end
 
-  describe 'at count=50' do
+  describe "at count=50" do
     before do
-      @progress_bar.count = 50
+      progress_bar.count = 50
     end
 
     it { should == "[ 50/100]" }
   end
 
-  describe 'at count=100' do
+  describe "at count=100" do
     before do
-      @progress_bar.count = 100
+      progress_bar.count = 100
     end
 
     it { should == "[100/100]" }
   end
 
-  describe 'with a shorter max' do
-    before do
-      @progress_bar = ProgressBar.new(42, :counter)
-    end
+  describe "with a shorter max" do
+    let(:progress_bar) { ProgressBar.new(42, :counter) }
 
-    it { should == '[ 0/42]' }
+    it { should == "[ 0/42]" }
   end
 
-  describe 'with a longer max' do
-    before do
-      @progress_bar = ProgressBar.new(4242, :counter)
-    end
+  describe "with a longer max" do
+    let(:progress_bar) { ProgressBar.new(4242, :counter) }
 
-    it { should == '[   0/4242]' }
+    it { should == "[   0/4242]" }
   end
-
 end

data/spec/elapsed_spec.rb

@@ -1,48 +1,50 @@
+# frozen_string_literal: true
 
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "ProgressBar elapsed output" do
+  let(:progress_bar) { ProgressBar.new(100, :elapsed) }
 
-describe 'ProgressBar elapsed output' do
   before do
     Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-    @progress_bar = ProgressBar.new(100, :elapsed)
+    progress_bar
     Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
   end
 
-  subject { @progress_bar.to_s }
+  subject { progress_bar.to_s }
 
-  describe 'at count=0' do
+  describe "at count=0" do
     before do
-      @progress_bar.count = 0
+      progress_bar.count = 0
     end
 
     it { should == "[00:10]" }
   end
 
-  describe 'at count=50' do
+  describe "at count=50" do
     before do
-      @progress_bar.count = 50
+      progress_bar.count = 50
     end
 
     it { should == "[00:10]" }
   end
 
-  describe 'at count=100' do
+  describe "at count=100" do
     before do
-      @progress_bar.count = 100
+      progress_bar.count = 100
     end
 
     it { should == "[00:10]" }
   end
 
-  describe 'with times over 1 hour' do
+  describe "with times over 1 hour" do
+    let(:progress_bar) { ProgressBar.new(42, :elapsed) }
+
     before do
       Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-      @progress_bar = ProgressBar.new(42, :elapsed)
       Timecop.freeze Time.utc(2010, 3, 10, 2, 0, 0) # 2 hours later
     end
 
-    it { should == '[02:00:00]' }
+    it { should == "[02:00:00]" }
   end
-
 end
-

data/spec/eta_spec.rb

@@ -1,50 +1,51 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+# frozen_string_literal: true
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "ProgressBar eta output" do
+  let(:progress_bar) { ProgressBar.new(100, :eta) }
 
-describe 'ProgressBar eta output' do
   before do
     Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-    @progress_bar = ProgressBar.new(100, :eta)
+    progress_bar
     Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
   end
 
-  subject { @progress_bar.to_s }
+  subject { progress_bar.to_s }
 
-  describe 'at count=0' do
+  describe "at count=0" do
     before do
-      @progress_bar.count = 0
+      progress_bar.count = 0
     end
 
     it { should == "[00:00]" }
   end
 
-  describe 'at count=50' do
+  describe "at count=50" do
     before do
-      @progress_bar.count = 50
+      progress_bar.count = 50
     end
 
     it { should == "[00:10]" }
   end
 
-  describe 'at count=100' do
+  describe "at count=100" do
     before do
-      @progress_bar.count = 100
+      progress_bar.count = 100
     end
 
     it { should == "[00:00]" }
   end
 
-  describe 'with times over 1 hour' do
+  describe "with times over 1 hour" do
+    let(:progress_bar) { ProgressBar.new(42, :eta) }
+
     before do
       Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-      @progress_bar = ProgressBar.new(42, :eta)
-      @progress_bar.count = 21
+      progress_bar.count = 21
       Timecop.freeze Time.utc(2010, 3, 10, 2, 0, 0) # 2 hours later
     end
 
-    it { should == '[02:00:00]' }
+    it { should == "[02:00:00]" }
   end
-
 end
-
-
-

data/spec/percentage_spec.rb

@@ -1,44 +1,43 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+# frozen_string_literal: true
 
-describe 'ProgressBar percentage output' do
-  before do
-    @progress_bar = ProgressBar.new(100, :percentage)
-  end
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "ProgressBar percentage output" do
+  let(:progress_bar) { ProgressBar.new(100, :percentage) }
 
-  subject { @progress_bar.to_s }
+  subject { progress_bar.to_s }
 
-  describe 'at count=0' do
+  describe "at count=0" do
     before do
-      @progress_bar.count = 0
+      progress_bar.count = 0
     end
 
     it { should == "[  0%]" }
   end
 
-  describe 'at count=50' do
+  describe "at count=50" do
     before do
-      @progress_bar.count = 50
+      progress_bar.count = 50
     end
 
     it { should == "[ 50%]" }
   end
 
-  describe 'at count=100' do
+  describe "at count=100" do
     before do
-      @progress_bar.count = 100
+      progress_bar.count = 100
     end
 
     it { should == "[100%]" }
   end
 
-  describe 'with a max that is not 100' do
+  describe "with a max that is not 100" do
+    let(:progress_bar) { ProgressBar.new(42, :percentage) }
+
     before do
-      @progress_bar = ProgressBar.new(42, :percentage)
-      @progress_bar.count = 21
+      progress_bar.count = 21
     end
 
-    it { should == '[ 50.00%]' }
+    it { should == "[ 50.00%]" }
   end
-
 end
-

data/spec/print_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "ProgressBar print output" do
+  let(:progress_bar) { ProgressBar.new(:counter) }
+
+  before do
+    allow(progress_bar).to receive(:terminal_width).and_return(10)
+  end
+
+  it "should replace the current bar with the text, and continue the bar on the next line" do
+    expect {
+      progress_bar.increment!
+      progress_bar.puts("Hello, world!")
+    }.to output("\r[  1/100]" \
+                "\r#{' ' * 10}" \
+                "\rHello, world!\n" \
+                "\r[  1/100]").to_stderr
+  end
+end

data/spec/progress_bar_spec.rb

@@ -1,47 +1,47 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+# frozen_string_literal: true
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "ProgressBar bar output" do
+  let(:progress_bar) { ProgressBar.new(100) }
 
-describe 'ProgressBar bar output' do
   before do
     Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-    @progress_bar = ProgressBar.new(100)
-    @progress_bar.stub(:terminal_width) { 60 }
+    allow(progress_bar).to receive(:terminal_width).and_return(60)
     Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
   end
 
-  subject { @progress_bar.to_s }
+  subject { progress_bar.to_s }
 
-  describe 'at count=0' do
+  describe "at count=0" do
     before do
-      @progress_bar.count = 0
+      progress_bar.count = 0
     end
 
     it { should == "[              ] [  0/100] [  0%] [00:10] [00:00] [  0.00/s]" }
   end
 
-  describe 'at count=50' do
+  describe "at count=50" do
     before do
-      @progress_bar.count = 50
+      progress_bar.count = 50
     end
 
     it { should == "[#######       ] [ 50/100] [ 50%] [00:10] [00:10] [  5.00/s]" }
   end
 
-  describe 'at count=100' do
+  describe "at count=100" do
     before do
-      @progress_bar.count = 100
+      progress_bar.count = 100
     end
 
     it { should == "[##############] [100/100] [100%] [00:10] [00:00] [ 10.00/s]" }
   end
 
-  describe 'at count=105' do
+  describe "at count=105" do
     before do
-      @progress_bar.count = 105
+      progress_bar.count = 105
     end
 
     it { should == "[##############] [100/100] [100%] [00:10] [00:00] [ 10.00/s]" }
   end
-
 end
-
-