progress_bar 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba9ff51571d8c5a4420d524d098f474ab3434bad617ceef86d67de8450832553
-  data.tar.gz: dd6e5b12b7fba8db09fc775b05d1e70baa5b2a4c72fbcce578a3c5b65743eb01
+  metadata.gz: 93deaf290ed6e467982f59e116823785ec82927e7c490b46fa4379dc08b23777
+  data.tar.gz: c7888385f8bdb280e39fb63d212bcdc75ee5f20a04aaccff753e35d110151e6d
 SHA512:
-  metadata.gz: 663bd5538ea023b5153f24829f9ef009fd05c2e1a3d9034bb1e0887e8202c0f62bccb6e9e8898a11bf09e5cc153e21e1f52c46097a1a013df33308aea725ef48
-  data.tar.gz: 67bc5eef3c976f9533e0ca4d29edc8c0f298dd4869ec6f4d2978a1ad3f963c526c5e65536550253d6a4f9e746a1bfb94863c4934e2be8dc547743cfa8aaf8112
+  metadata.gz: 1f384ee668213ae7b49b5b3d7b22c3ee8ccaabe1303b46f34f7f5f7db4713aeeff03480acd8ca515084cdfaad64f849c4078272a3b5ad43c79ae78ea78f149ec
+  data.tar.gz: 353313ddaec29915b98efcaa0f60d470b08094b729b6b8b8afb33c38c6cad0ee17f26f6ea9d5fb532fc5649fd4cb7b18382e86087b6a80e42aa648d4bee82d43

data/.github/workflows/pronto.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/checkout@v1.0.0
       - uses: actions/setup-ruby@v1
         with:
-          ruby-version: '2.6'
+          ruby-version: '2.7'
       - name: Install dependencies
         run: |
           sudo apt-get update -qq

data/.github/workflows/rspec.yml

@@ -8,11 +8,12 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 2.4
-          - 2.5
-          - 2.6
+          - 2.4.x
+          - 2.5.x
+          - 2.6.x
+          - 2.7.x
     steps:
-      - uses: actions/checkout@v1.0.0
+      - uses: actions/checkout@v1
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.rubocop.yml

@@ -5,12 +5,10 @@ inherit_from:
 require:
   - rubocop-rspec
 
-Rails:
-  Enabled: true
-
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
+  NewCops: enable
   TargetRubyVersion: 2.6
 
   Exclude:
@@ -20,7 +18,7 @@ AllCops:
     - "script/**/*"
     - "tmp/**/*"
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
 Lint/AmbiguousBlockAssociation:
@@ -53,7 +51,7 @@ Metrics/BlockLength:
     - shared_context
     - feature
     - define_type
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: true
   Max: 120
 Metrics/ClassLength:
@@ -63,7 +61,7 @@ Naming/RescuedExceptionsVariableName:
   PreferredName: ex
 Naming/FileName:
   Enabled: false
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Enabled: false
 Style/EmptyLiteral:
   Enabled: false
@@ -76,6 +74,8 @@ Style/HashSyntax:
     - lib/tasks/**/*.rake
 Style/NumericLiterals:
   Enabled: false
+Style/StringConcatenation:
+  Enabled: false
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Changelog.mkd

@@ -1,3 +1,11 @@
+# 1.3.2
+
+ * Added `ProgressBar#puts`, to be able to print text to the output without
+   interfering with the rendering of the bar output.
+   [#56](https://github.com/paul/progress_bar/pull/56) Thanks to
+   [TRex22](https://github.com/TRex22) for the suggestion in
+   [#44](https://github.com/paul/progress_bar/pull/44).
+
 # 1.3.1
 
  * Added support for passing bar options to `Enumerable#with_progress`

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Gemfile
 source "https://rubygems.org"
 

data/README.mkd

@@ -20,14 +20,16 @@ lots of progress bar alternatives, and we thank you for using ProgressBar!
 
 ## The Easy Way
 
+```ruby
+require 'progress_bar'
 
-    require 'progress_bar'
-    bar = ProgressBar.new
+bar = ProgressBar.new
 
-    100.times do
-      sleep 0.1
-      bar.increment!
-    end
+100.times do
+  sleep 0.1
+  bar.increment!
+end
+```
 
 Produces output like:
 
@@ -42,15 +44,43 @@ it.*
 Usually, the defaults should be fine, the only thing you'll need to
 tweak is the max.
 
-    bar = ProgressBar.new(1000)
+```ruby
+bar = ProgressBar.new(1000)
+```
 
 ## Larger Steps
 
 If you want to process several things, and update less often, you can
 pass a number to `#increment!`
 
+```ruby
     bar.increment! 42
+```
+
+## Printing additional output
+
+Sometimes you want to print some additional messages in the output, but since the ProgressBar uses terminal control characters to replace the text on the same line on every update, the output looks funny:
+
+    [#######################################                           ] [ 59.00%] [00:06]
+    Hello!
+    [#########################################                         ] [ 60.00%] [00:05]
 
+To prevent this, you can use `ProgressBar#puts` so ProgressBar knows you want to print something, and it'll clear the bar before printing, then resume printing on the next line:
+
+```ruby
+100.times do |i|
+  sleep 0.1
+  bar.puts "Halfway there!" if i == 50
+  bar.increment!
+end
+```
+
+Produces output like:
+
+    Halfway there!
+    [##################################] [100/100] [100%] [00:10] [00:00] [  9.98/s]
+
+Try it out in `examples/printing_messages.rb` to see how it looks.
 
 ## Picking the meters
 
@@ -58,7 +88,9 @@ By default, ProgressBar will use all available meters (this will
 probably change). To select which meters you want, and in which order,
 pass them to the constructor:
 
-    bar = ProgressBar.new(100, :bar, :rate, :eta)
+```ruby
+bar = ProgressBar.new(100, :bar, :rate, :eta)
+```
 
 
 ### Available Meters

data/Rakefile

@@ -1,6 +1,8 @@
-require 'bundler'
+# frozen_string_literal: true
+
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/examples/enumerable.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar/enumerable'))
+require_relative "../lib/progress_bar/core_ext/enumerable_with_progress"
 
-p (20...34).with_progress.select{|i| sleep 0.1; (i % 2).zero?}
+(20...34).with_progress.select{ |i| sleep 0.1; (i % 2).zero? }

data/examples/printing_messages.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../lib/progress_bar"
+
+bar = ProgressBar.new
+
+100.times do |i|
+  sleep 0.1
+  bar.puts("Some long text\nthat contains newlines") if i == 10
+  bar.puts("Halfway there!") if i == 50
+  bar.puts("Almost done!") if i == 90
+  bar.increment!
+end
+
+__END__
+
+$ ruby examples/printing_messages.rb
+Some long text
+that contains newlines
+Halfway there!
+Almost done!
+[##################################] [100/100] [100%] [00:10] [00:00] [  9.98/s]

data/examples/simple.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar'))
+require_relative "../lib/progress_bar"
 
 bar = ProgressBar.new
 

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
+    @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,14 +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'
+require_relative "progress_bar/with_progress"

data/lib/progress_bar/core_ext/enumerable_with_progress.rb

@@ -1,4 +1,6 @@
-require_relative '../../progress_bar'
+# frozen_string_literal: true
+
+require_relative "../../progress_bar"
 
 ObjectSpace.each_object(Module) do |mod|
   if mod <= Enumerable

data/lib/progress_bar/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ProgressBar
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/lib/progress_bar/with_progress.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 class ProgressBar
   module WithProgress
     def each_with_progress(*args, &block)
       bar = ProgressBar.new(count, *args)
       if block
-        each{|obj| yield(obj).tap{bar.increment!}}
+        each{ |obj| yield(obj).tap{ bar.increment! } }
       else
-        Enumerator.new{|yielder|
-          self.each do |obj|
-            (yielder << obj).tap{bar.increment!}
+        Enumerator.new{ |yielder|
+          each do |obj|
+            (yielder << obj).tap{ bar.increment! }
           end
         }
       end

data/progress_bar.gemspec

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-$:.push File.expand_path("lib", __dir__)
-require "progress_bar/version"
+require_relative "lib/progress_bar/version"
 
 Gem::Specification.new do |s|
   s.name        = "progress_bar"
@@ -14,7 +13,7 @@ Gem::Specification.new do |s|
   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("highline", [">= 1.6", "< 3"])
   s.add_dependency("options", "~> 2.3.0")

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(-1)
-    }.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
-
-

data/spec/rate_spec.rb

@@ -1,63 +1,63 @@
-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 rate output" do
+  let(:progress_bar) { ProgressBar.new(100, :rate) }
 
-describe 'ProgressBar rate output' do
   before do
     Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-    @progress_bar = ProgressBar.new(100, :rate)
+    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 == "[  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 == "[  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 == "[ 10.00/s]" }
   end
 
-  describe 'with a shorter max' do
+  describe "with a shorter max" do
+    let(:progress_bar) { ProgressBar.new(42, :rate) }
+
     before do
       Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-      @progress_bar = ProgressBar.new(42, :rate)
-      @progress_bar.count = 21
+      progress_bar.count = 21
       Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
     end
 
-    it { should == '[ 2.10/s]' }
+    it { should == "[ 2.10/s]" }
   end
 
-  describe 'with a longer max' do
+  describe "with a longer max" do
+    let(:progress_bar) { ProgressBar.new(4242, :rate) }
+
     before do
       Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 0)
-      @progress_bar = ProgressBar.new(4242, :rate)
-      @progress_bar.count = 21
+      progress_bar.count = 21
       Timecop.freeze Time.utc(2010, 3, 10, 0, 0, 10) # 10 seconds later
     end
 
-    it { should == '[   2.10/s]' }
+    it { should == "[   2.10/s]" }
   end
-
 end
-
-
-
-
-

data/spec/spec_helper.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
 
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar'))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib/progress_bar"))
 
-require 'rspec'
-require 'timecop'
+require "rspec"
+require "timecop"
 
 RSpec.configure do |cfg|
   cfg.after do
     Timecop.return
   end
 end
-

data/spec/with_progress_spec.rb

@@ -1,13 +1,17 @@
-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::WithProgress do
-  context 'with block' do
-    let!(:bar){ProgressBar.new}
+  context "with block" do
+    let!(:bar){ ProgressBar.new }
+
     before{
-      Range.send(:include, ProgressBar::WithProgress)
-      allow(ProgressBar).to receive(:new){|max| bar.max = max; bar}
+      Range.include ProgressBar::WithProgress
+      allow(ProgressBar).to receive(:new){ |max| bar.max = max; bar }
     }
-    it 'should set max and increment on each iteration' do
+
+    it "should set max and increment on each iteration" do
       (1..20).each_with_progress do |i|
         break if i > 10
       end
@@ -16,19 +20,21 @@ describe ProgressBar::WithProgress do
     end
   end
 
-  context 'without block' do
-    let!(:bar){ProgressBar.new}
+  context "without block" do
+    let!(:bar){ ProgressBar.new }
+
     before{
-      Range.send(:include, ProgressBar::WithProgress)
-      allow(ProgressBar).to receive(:new){|max| bar.max = max; bar}
+      Range.include ProgressBar::WithProgress
+      allow(ProgressBar).to receive(:new){ |max| bar.max = max; bar }
     }
-    it 'should give Enumerator' do
+
+    it "should give Enumerator" do
       enum = (1..20).each_with_progress
       expect(enum).to be_kind_of(Enumerator)
       expect(bar.max).to eq 20
       expect(bar.count).to eq 0
 
-      res = enum.map{|i| i + 1}
+      res = enum.map{ |i| i + 1 }
       expect(res).to eq (2..21).to_a
       expect(bar.count).to eq 20
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progress_bar
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Paul Sadauskas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -150,6 +150,7 @@ files:
 - README.mkd
 - Rakefile
 - examples/enumerable.rb
+- examples/printing_messages.rb
 - examples/simple.rb
 - lib/progress_bar.rb
 - lib/progress_bar/core_ext/enumerable_with_progress.rb
@@ -166,6 +167,7 @@ files:
 - spec/elapsed_spec.rb
 - spec/eta_spec.rb
 - spec/percentage_spec.rb
+- spec/print_spec.rb
 - spec/progress_bar_spec.rb
 - spec/rate_spec.rb
 - spec/spec_helper.rb
@@ -182,14 +184,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple Progress Bar for output to a terminal
@@ -200,6 +202,7 @@ test_files:
 - spec/elapsed_spec.rb
 - spec/eta_spec.rb
 - spec/percentage_spec.rb
+- spec/print_spec.rb
 - spec/progress_bar_spec.rb
 - spec/rate_spec.rb
 - spec/spec_helper.rb