ruby-progressbar 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de140a57b8eb2dcda78dcafc0c85ccbfb56cdd1c
-  data.tar.gz: 7e1533eea70a9646865439bf0b91008f7a12c7a8
+  metadata.gz: 83f5b88d860cde93acea2fb44eaa5586d877e76d
+  data.tar.gz: 8c9611657c7def30f8188d4aaaca150dd30e34b5
 SHA512:
-  metadata.gz: 6f431ea55b755057c1bcad31154ac4713171626da77fd4f004071af505f56bb913601c886bc3d86a985705bdfd90bba5d6e9a26a7ef1fd802c6cbf128deb9191
-  data.tar.gz: 722fc3894c31e2b8dcf84676e3c3dd9820eae76aa9e80e853428a4e989ba2aac780dcbf3ecd97cb29648ee6d24322234a63a5dcc695b8fc6dad0cd3f10a7962c
+  metadata.gz: d6b0ae26cfb96b3e9a2f5d3f691137a115ad44c1c88b30e578e1aecce96c7b2b268ddf957b16292aba43ae77d5b07ffb28df613e52a327e28d2388ed7e6b836d
+  data.tar.gz: 5e65be1a60e11c1e23b39f44532cbe39df09364316fd73122e15458949e3a6643732e2c9c3ed9976e1de4f7bbcf71268fe27b821bca34cb40e18d0e0866bdad8

data/README.md

@@ -132,7 +132,23 @@ The bar can be stopped in four ways:
 
 * See `#finish` above.
 
-_Note: The bar will be finished automatically if the current value ever becomes equal to the total._
+By default, the bar will be finished automatically if the current value ever
+becomes equal to the total.  If you do not want the bar to autofinish, pass
+`:autofinish => false` when creating your bar.
+
+```ruby
+progressbar = ProgressBar.create(:starting_at => 9, :total => 10)
+progressbar.increment
+
+progressbar.finished? # => true
+```
+
+```ruby
+progressbar = ProgressBar.create(:starting_at => 9, :total => 10, :autofinish => false)
+progressbar.increment
+
+progressbar.finished? # => false
+```
 
 ### Refreshing
 
@@ -210,6 +226,8 @@ The flags you can use in the format string are as follows:
 * `%f`: Force estimated time to be displayed even if it exceeds `99:00:00`
 * `%p`: Percentage complete represented as a whole number (eg: `82`)
 * `%P`: Percentage complete represented as a decimal number (eg: `82.33`)
+* `%j`: Percentage complete right-justified to 3 places (eg: ` 82`)
+* `%J`: Percentage complete right-justified to 6 places (eg: ` 82.33`)
 * `%c`: Number of items currently completed
 * `%C`: Total number of items to be completed
 * `%B`: The full progress bar including 'incomplete' space (eg: `==========    `)

data/lib/ruby-progressbar/base.rb

@@ -103,7 +103,9 @@ class ProgressBar
     end
 
     def title=(title)
-      with_update { super }
+      if output.tty?
+        with_update { super }
+      end
     end
 
     ###

data/lib/ruby-progressbar/components/progressable.rb

@@ -12,17 +12,20 @@ class ProgressBar
       attr_accessor             :starting_position
       attr_accessor             :running_average
       attr_accessor             :smoothing
+      attr_accessor             :autofinish
+      attr_accessor             :finished
 
       def initialize(options = {})
         self.total           = options.fetch(:total, DEFAULT_TOTAL)
         self.smoothing       = options[:smoothing] || DEFAULT_SMOOTHING
+        self.autofinish      = options.fetch(:autofinish, true)
 
         start :at => DEFAULT_BEGINNING_POSITION
       end
 
       def start(options = {})
+        self.finished          = false
         self.running_average   = 0
-
         self.progress          = \
         self.starting_position = options[:at] || self.progress
       end
@@ -32,7 +35,7 @@ class ProgressBar
       end
 
       def finished?
-        self.progress == self.total
+        finished || (autofinish && progress == total)
       end
 
       def increment
@@ -65,7 +68,8 @@ class ProgressBar
       end
 
       def finish
-        self.progress = self.total
+        self.finished = true
+        self.progress = total
       end
 
       def percentage_completed
@@ -81,6 +85,9 @@ class ProgressBar
       end
 
       def percentage_completed_with_precision
+        return 100.0  if total == 0
+        return 0.0    if total.nil?
+
         format('%5.2f', (progress.to_f * 100.0 / total * 100.0).floor / 100.0)
       end
 

data/lib/ruby-progressbar/format/molecule.rb

@@ -8,6 +8,8 @@ class ProgressBar
         :C => :total,
         :p => :percentage,
         :P => :percentage_with_precision,
+        :j => :justified_percentage,
+        :J => :justified_percentage_with_precision,
         :a => :elapsed_time,
         :e => :estimated_time_with_unknown_oob,
         :E => :estimated_time_with_friendly_oob,

data/lib/ruby-progressbar/formatter.rb

@@ -45,10 +45,18 @@ class ProgressBar
       @bar.percentage_completed
     end
 
+    def justified_percentage
+      @bar.percentage_completed.to_s.rjust(3)
+    end
+
     def percentage_with_precision
       @bar.percentage_completed_with_precision
     end
 
+    def justified_percentage_with_precision
+      @bar.percentage_completed_with_precision.to_s.rjust(6)
+    end
+
     def elapsed_time
       @elapsed_time
     end

data/lib/ruby-progressbar/version.rb

@@ -1,3 +1,3 @@
 class ProgressBar
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'
 end

data/spec/lib/ruby-progressbar/base_spec.rb

@@ -294,6 +294,31 @@ describe ProgressBar::Base do
         non_tty_output.rewind
         expect(non_tty_output.read).to eql "\n\nProgress: |====\n"
       end
+
+      it 'ignores changes to the title due to the fact that the bar length cannot change' do
+        progressbar = ProgressBar::Base.new(:output => non_tty_output, :length => 20, :starting_at => 0, :total => 6, :throttle_rate => 0.0)
+
+        3.times { progressbar.increment }
+
+        progressbar.title = "Testing"
+        progressbar.stop
+
+        non_tty_output.rewind
+
+        expect(non_tty_output.read).to eql "\n\nProgress: |====\n"
+      end
+
+      it 'allows the title to be customized when the bar is created' do
+        progressbar = ProgressBar::Base.new(:output => non_tty_output, :title => 'Custom', :length => 20, :starting_at => 0, :total => 6, :throttle_rate => 0.0)
+
+        3.times { progressbar.increment }
+
+        progressbar.stop
+
+        non_tty_output.rewind
+
+        expect(non_tty_output.read).to eql "\n\nCustom: |=====\n"
+      end
     end
   end
 
@@ -321,6 +346,50 @@ describe ProgressBar::Base do
     end
   end
 
+  context 'when a bar with autofinish=false is about to be completed' do
+    let(:progressbar) { ProgressBar::Base.new(:autofinish => false, :starting_at => 5, :total => 6, :output => output, :length => 20) }
+
+    context 'and it is incremented' do
+      before { progressbar.increment }
+
+      it 'does not automatically finish' do
+        expect(progressbar).not_to be_finished
+      end
+
+      it 'does not prints a new line' do
+        output.rewind
+
+        expect(output.read.end_with?("\n")).to eql false
+      end
+
+      it 'allows reset' do
+        progressbar.finish
+        expect(progressbar).to be_finished
+
+        progressbar.reset
+
+        expect(progressbar).not_to be_finished
+      end
+
+      it 'does prints a new line when manually finished' do
+        progressbar.finish
+        expect(progressbar).to be_finished
+
+        output.rewind
+
+        expect(output.read.end_with?("\n")).to eql true
+      end
+
+      it 'does not continue to print bars if finish is subsequently called' do
+        progressbar.finish
+
+        output.rewind
+
+        expect(output.read).to end_with "                    \rProgress: |======  |\rProgress: |========|\n"
+      end
+    end
+  end
+
   context 'when a bar has an unknown amount to completion' do
     let(:progressbar) { ProgressBar::Base.new(:total => nil, :output => output, :length => 80, :unknown_progress_animation_steps => ['=--', '-=-', '--=']) }
 
@@ -700,6 +769,20 @@ describe ProgressBar::Base do
         expect(progressbar.to_s('%w%i')).to match /^= 5 =\s{95}\z/
       end
 
+      it 'can display a percentage, even if the total is unknown' do
+        progressbar = ProgressBar::Base.new(:output => output, :length => 100, :total => nil, :starting_at => 0)
+
+        expect(progressbar.to_s('%p')).to match /\A0\z/
+        expect(progressbar.to_s('%P')).to match /\A0\.0\z/
+      end
+
+      it 'can display a percentage, even if the total is zero' do
+        progressbar = ProgressBar::Base.new(:output => output, :length => 100, :total => 0, :starting_at => 0)
+
+        expect(progressbar.to_s('%p')).to match /\A100\z/
+        expect(progressbar.to_s('%P')).to match /\A100\.0\z/
+      end
+
       it 'displays the current capacity when passed the "%c" format flag' do
         progressbar = ProgressBar::Base.new(:output => output, :starting_at => 0)
 
@@ -722,12 +805,24 @@ describe ProgressBar::Base do
         expect(progressbar.to_s('%p')).to match /^16\z/
       end
 
+      it 'displays the justified percentage complete when passed the "%j" format flag' do
+        progressbar = ProgressBar::Base.new(:starting_at => 33, :total => 200)
+
+        expect(progressbar.to_s('%j')).to match /^ 16\z/
+      end
+
       it 'displays the percentage complete when passed the "%P" format flag' do
         progressbar = ProgressBar::Base.new(:starting_at => 33, :total => 200)
 
         expect(progressbar.to_s('%P')).to match /^16.50\z/
       end
 
+      it 'displays the justified percentage complete when passed the "%J" format flag' do
+        progressbar = ProgressBar::Base.new(:starting_at => 33, :total => 200)
+
+        expect(progressbar.to_s('%J')).to match /^ 16.50\z/
+      end
+
       it 'displays only up to 2 decimal places when using the "%P" flag' do
         progressbar = ProgressBar::Base.new(:starting_at => 66, :total => 99)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progressbar
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - thekompanee
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -162,3 +162,4 @@ test_files:
 - spec/lib/ruby-progressbar/running_average_calculator_spec.rb
 - spec/lib/ruby-progressbar/time_spec.rb
 - spec/support/time.rb
+has_rdoc: