ruby-progressbar 1.1.1 → 1.2.0

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+tags
 *.rbc
 .bundle
 .config
@@ -10,3 +11,4 @@ lib/bundler/man
 pkg
 spec/reports
 tmp
+tags

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+Changelog
+================================================================================
+
+v1.2.0
+--------------------------------------------------------------------------------
+* Finally removed deprecation warning and made folder structure consistent
+* Add #log which will properly handle the display of the bar when sending
+  a string of output to the screen.
+* Add unknown progress. See the README for more details.
+* Add proper output for non-TTY IO streams

data/README.md

@@ -102,6 +102,8 @@ The following are the list of options you can use:
 * `:length` - _(Defaults to full width if possible, otherwise `80`)_ The preferred width of the entire progress bar including any format options.
 * `:output` - _(Defaults to `STDOUT`)_ All output will be sent to this object.  Can be any object which responds to `.print`.
 * `:smoothing` - _(Defaults to `0.1`)_ See [**Smoothing Out Estimated Time Jitters**](#smoothing-out-estimated-time-jitters) below.
+* `:throttle_rate` - _(Defaults to `0.01`)_ See [**Throttling**](#throttling) below.
+* `:unknown_progress_animation_steps` - _(Defaults to `['=---', '-=--', '--=-', '---=']`)_ See [**Unknown Progress**](#unknown-progress) The graphical elements used to cycle when progress is changed but the total amount of items being processed is unknown.
 
 ### Changing Progress
 
@@ -110,6 +112,7 @@ The following are the list of options you can use:
 * `#progress +=`: Will allow you to increment by a relative amount.
 * `#progress -=`: Will allow you to decrement by a relative amount.
 * `#progress=`: Will allow you to jump the amount of progress directly to whatever value you would like. _Note: This will almost always mess up your estimated time if you're using it._
+* `#total=`: Will change the total number of items being processed by the bar. This can be anything (even nil) but cannot be less than the amount of progress already accumulated by the bar.
 
 ### Stopping
 
@@ -130,6 +133,64 @@ _Note: The bar will be finished automatically if the current value ever becomes
 
 * If you need to have the bar be redisplayed to give your users more of a "real-time" feel, you can call `#refresh` which will not affect the current position but will update the elapsed and estimated timers.
 
+### Unknown Progress
+
+Sometimes when processing work, you don't know at the beginning of the job exactly how many items you will be processing.  Maybe this might be because you're downloading a chunked file or processing a set of jobs that hasn't fully loaded yet.
+
+In times like these, you can set total to `nil` and continue to increment the bar as usual.  The bar will display an 'unknown' animation which will change every time you increment.  This will give the appearance (by default) that the bar is processing work even though there is no "progress".
+
+```ruby
+progressbar = ProgressBar.create(:starting_at => 20, :total => nil)
+```
+
+Will output:
+
+    Progress: |=---=---=---=---=---=---=---=---=---=---=---=---=---=---=---=---=---|
+
+Calling
+
+```ruby
+progressbar.increment
+```
+
+once more will output:
+
+    Progress: |-=---=---=---=---=---=---=---=---=---=---=---=---=---=---=---=---=--|
+
+ad infinitum.
+
+At whatever point you discover the total that you will be processing, you can call:
+
+```ruby
+progressbar.total = 100
+```
+
+And the bar will magically transform into its typical state:
+
+    Progress: |========                                                            |
+
+### Logging
+
+Many times while using the progress bar, you may wish to log some output for the user.  If you attempt to do this using a standard `puts` statement, you'll find that the text will overwrite that which makes up the bar.  For example if you were to `puts "hello"` after progress has already begun, you may get something like this:
+
+    helloess: |=======                                                             |
+    Progress: |========                                                            |
+
+The reason is that ruby-progressbar has to keep redrawing itself every time you change the progress.  It's a limitation of terminal output.  Using `puts` messes that up because `puts` adds a newline which moves the cursor to the next line, then when ruby-progressbar updates, it does so on the following line.
+
+To circumvent this, use `#log` instead.
+
+```ruby
+progressbar = ProgressBar.create
+progressbar.progress = 20
+progressbar.log 'hello'
+```
+
+    hello
+    Progress: |=============                                                       |
+
+`#log` will automatically clear the bar, print your desired text and then redraw the bar on the following line.  Notice that we did not get a bar **above** the logged output.  If you consistently use `#log`, you should only every see one bar on the screen at any time.
+
 Formatting
 --------------------------------
 
@@ -244,6 +305,22 @@ The above progress bar will output at most 10 times a second.
 
 The default throttling rate if none is specified is 100 times per second (or 0.01)
 
+### Custom Unknown Progress Animations
+
+Following up on [unknown progress](#unknown-progress), you may wish to update the unknown progress animation to suit your specific needs.  This can be easily done by passing in the `:unknown_progress_animation_steps` option.
+
+This item should be an array of strings representing each step of the animation. The specific step used for a given progress is determined by the current progress of the bar.  For example:
+
+```ruby
+progressbar = ProgressBar.create(:unknown_progress_animation_steps => ['==>', '>==', '=>='])
+```
+
+Would use element 0 ('==>') for a progress of 1, 4, 7, 10, etc.  It would use element 3 for a progress of 3, 6, 9, 12, etc.
+
+You can have an array of as many elements as you'd like and they will be used in the same manner.  For example if you have an array of 50 animation steps, element 0 would only be used for every 50th progress (eg: 1, 51, 101, etc).
+
+Whatever element is chosen is repeated along the entire 'incomplete' portion of the bar.
+
 Road Map
 --------------------------------
 We're planning on adding a bunch of really nice features to this gem over the next few weeks.  We want to keep the simple usage simple but allow for powerful features if they're needed.  Our `1.0` release is the first step in that direction.

data/lib/ruby-progressbar.rb

@@ -1,18 +1,11 @@
-require 'progress_bar/depreciable'
-require 'progress_bar/length_calculator'
-require 'progress_bar/running_average_calculator'
-require 'progress_bar/formatter'
-require 'progress_bar/components'
-require 'progress_bar/format'
-require 'progress_bar/base'
+require 'ruby-progressbar/length_calculator'
+require 'ruby-progressbar/running_average_calculator'
+require 'ruby-progressbar/formatter'
+require 'ruby-progressbar/components'
+require 'ruby-progressbar/format'
+require 'ruby-progressbar/base'
 
 class ProgressBar
-  def self.new(*args)
-    puts "DEPRECATION WARNING: Calling `ProgressBar.new` is deprecated and will be removed on or after #{ProgressBar::Depreciable::DEPRECATION_DATE}.  Please use `ProgressBar.create` instead."
-
-    create *args
-  end
-
   def self.create(*args)
     ProgressBar::Base.new *args
   end

data/lib/{progress_bar → ruby-progressbar}/base.rb

@@ -2,21 +2,18 @@ class ProgressBar
   class Base
     include ProgressBar::LengthCalculator
     include ProgressBar::Formatter
-    include ProgressBar::Depreciable
 
-    DEFAULT_OUTPUT_STREAM = STDOUT
+    DEFAULT_OUTPUT_STREAM = $stdout
 
-    def initialize(*args)
-      options             = args.empty? ? {} : backwards_compatible_args_to_options_conversion(args)
-
-      self.output         = options[:output]                || DEFAULT_OUTPUT_STREAM
+    def initialize(options = {})
+      self.output       = options[:output] || DEFAULT_OUTPUT_STREAM
 
       super(options)
 
-      @bar                = Components::Bar.new(options)
-      @estimated_time     = Components::EstimatedTimer.new(options)
-      @elapsed_time       = Components::ElapsedTimer.new
-      @throttle           = Components::Throttle.new(options)
+      @bar              = Components::Bar.new(options)
+      @estimated_time   = Components::EstimatedTimer.new(options)
+      @elapsed_time     = Components::ElapsedTimer.new
+      @throttle         = Components::Throttle.new(options)
 
       start :at => options[:starting_at]
     end
@@ -48,6 +45,10 @@ class ProgressBar
       with_update { with_progressables(:progress=, new_progress) }
     end
 
+    def total=(new_total)
+      with_update { with_progressables(:total=, new_total) }
+    end
+
     ###
     # Stopping The Bar
     #
@@ -75,7 +76,7 @@ class ProgressBar
     end
 
     def stopped?
-      @estimated_time.stopped? && @elapsed_time.stopped?
+      (@estimated_time.stopped? && @elapsed_time.stopped?) || finished?
     end
 
     alias :paused? :stopped?
@@ -99,13 +100,23 @@ class ProgressBar
     # Output
     #
     def clear
-      output.print clear_string
+      if output.tty?
+        output.print clear_string
+        output.print "\r"
+      end
     end
 
     def refresh
       update
     end
 
+    def log(string)
+      clear
+      output.puts string
+
+      update(:force => true) unless stopped?
+    end
+
     def to_s(format_string = nil)
       format_string ||= @format_string
 
@@ -113,34 +124,24 @@ class ProgressBar
     end
 
     def inspect
-      "#<ProgressBar:#{progress}/#{total}>"
+      "#<ProgressBar:#{progress}/#{total || 'unknown'}>"
     end
 
   private
     attr_accessor   :output
 
     def clear_string
-      "#{" " * length}\r"
+      "#{" " * length}"
     end
 
-    def with_progressables(action, *args)
-      if args.empty?
-        @bar.send(action)
-        @estimated_time.send(action)
-      else
-        @bar.send(action, *args)
-        @estimated_time.send(action, *args)
-      end
+    def with_progressables(*args)
+      @bar.send(*args)
+      @estimated_time.send(*args)
     end
 
-    def with_timers(action, *args)
-      if args.empty?
-        @estimated_time.send(action)
-        @elapsed_time.send(action)
-      else
-        @estimated_time.send(action, *args)
-        @elapsed_time.send(action, *args)
-      end
+    def with_timers(*args)
+      @estimated_time.send(*args)
+      @elapsed_time.send(*args)
     end
 
     def with_update
@@ -148,22 +149,24 @@ class ProgressBar
       update
     end
 
-    def update
-      with_timers(:stop) if finished?
+    def update(options = {})
+      if output.tty? || stopped?
+        with_timers(:stop) if finished?
 
-      @throttle.choke( finished? ) do
-        if length_changed?
-          clear
-          reset_length
-        end
+        @throttle.choke( stopped? || options[:force] ) do
+          if length_changed?
+            clear
+            reset_length
+          end
 
-        output.print self.to_s + eol
-        output.flush
+          output.print self.to_s + eol
+          output.flush
+        end
       end
     end
 
     def eol
-      finished? || stopped? ? "\n" : "\r"
+      stopped? ? "\n" : "\r"
     end
   end
 end

data/lib/ruby-progressbar/components.rb

@@ -0,0 +1,6 @@
+require 'ruby-progressbar/components/timer'
+require 'ruby-progressbar/components/progressable'
+require 'ruby-progressbar/components/bar'
+require 'ruby-progressbar/components/estimated_timer'
+require 'ruby-progressbar/components/elapsed_timer'
+require 'ruby-progressbar/components/throttle'

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

@@ -0,0 +1,57 @@
+class ProgressBar
+  module Components
+    class Bar
+      include Progressable
+
+      DEFAULT_PROGRESS_MARK                    = '='
+      DEFAULT_UNKNOWN_PROGRESS_ANIMATION_STEPS = ['=---', '-=--', '--=-', '---=']
+
+      attr_accessor :progress_mark
+      attr_accessor :length
+      attr_accessor :unknown_progress_animation_steps
+
+      def initialize(options = {})
+        super
+
+        self.unknown_progress_animation_steps = options[:unknown_progress_animation_steps] || DEFAULT_UNKNOWN_PROGRESS_ANIMATION_STEPS
+        self.progress_mark                    = options[:progress_mark]                    || DEFAULT_PROGRESS_MARK
+      end
+
+      def to_s(options = {:format => :standard})
+        completed_string = send(:"#{options[:format]}_complete_string")
+
+        "#{completed_string}#{empty_string}"
+      end
+
+      def integrated_percentage_complete_string
+        return standard_complete_string if completed_length < 5
+
+        " #{percentage_completed} ".to_s.center(completed_length, progress_mark)
+      end
+
+      def standard_complete_string
+        progress_mark * completed_length
+      end
+
+      def empty_string
+        incomplete_length = (length - completed_length)
+
+        if total.nil?
+          current_animation_step = progress % unknown_progress_animation_steps.size
+          animation_graphic      = unknown_progress_animation_steps[current_animation_step]
+
+          unknown_incomplete_string = animation_graphic * ((incomplete_length / unknown_progress_animation_steps.size) + 2)
+
+          unknown_incomplete_string[0, incomplete_length]
+        else
+          ' ' * incomplete_length
+        end
+      end
+
+    private
+      def completed_length
+        (length * percentage_completed / 100).floor
+      end
+    end
+  end
+end

data/lib/{progress_bar → ruby-progressbar}/components/progressable.rb

@@ -12,7 +12,7 @@ class ProgressBar
       attr_accessor             :smoothing
 
       def initialize(options = {})
-        self.total           = options[:total]     || DEFAULT_TOTAL
+        self.total           = options.fetch(:total, DEFAULT_TOTAL)
         self.smoothing       = options[:smoothing] || DEFAULT_SMOOTHING
 
         start :at => DEFAULT_BEGINNING_POSITION
@@ -60,6 +60,7 @@ class ProgressBar
 
       def percentage_completed
         return 100 if total == 0
+        return 0   if total.nil?
 
         # progress / total * 100
         #
@@ -75,7 +76,7 @@ class ProgressBar
 
     private
       def validate_total(new_total)
-        (progress.nil? || new_total >= progress) || raise("You can't set the item's total value to be less than the current progress.")
+        (progress.nil? || new_total.nil? || new_total >= progress) || raise("You can't set the item's total value to be less than the current progress.")
       end
 
       def validate_progress(new_progress)

data/lib/{progress_bar → ruby-progressbar}/components/timer.rb

@@ -1,4 +1,4 @@
-require 'progress_bar/time'
+require 'ruby-progressbar/time'
 
 class ProgressBar
   module Components

data/lib/ruby-progressbar/format.rb

@@ -0,0 +1,2 @@
+require 'ruby-progressbar/format/molecule'
+require 'ruby-progressbar/format/base'

data/lib/{progress_bar → ruby-progressbar}/format/base.rb

@@ -21,6 +21,7 @@ class ProgressBar
         processed_string.gsub! '%%', '%'
 
         leftover_bar_length = environment.send(:length) - processed_string.length + placeholder_length
+        leftover_bar_length = leftover_bar_length < 0 ? 0 : leftover_bar_length
 
         bar_molecules.each do |molecule|
           processed_string.gsub!("%#{molecule.key}", environment.send(molecule.method_name, leftover_bar_length).to_s)

data/lib/{progress_bar → ruby-progressbar}/version.rb

@@ -1,3 +1,3 @@
 class ProgressBar
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/ruby-progressbar.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "progress_bar/version"
+require "ruby-progressbar/version"
 
 Gem::Specification.new do |s|
   s.rubygems_version      = '1.3.5'

data/spec/fixtures/benchmark.rb

@@ -1,5 +1,11 @@
 # bundle exec ruby-prof --printer=graph_html --file=../results.html --require 'ruby-progressbar' --sort=total ./spec/fixtures/benchmark.rb
 
-bar = ProgressBar.create(:length => 80, :start => 0, :total => 100000)
+total  = 10
+# output = File.open('/Users/jfelchner/Downloads/benchmark.txt', 'w+')
+output = $stdout
+bar    = ProgressBar.create(:output => output, :length => 80, :start => 0, :total => total)
 
-100000.times { bar.increment }
+total.times do |i|
+  bar.log i
+  bar.increment
+end

data/spec/{progress_bar → lib/ruby-progressbar}/base_spec.rb

@@ -4,18 +4,68 @@ require 'stringio'
 describe ProgressBar::Base do
   before do
     @output = StringIO.new('', 'w+')
+    @output.stub(:tty?).and_return true
+
+    @non_tty_output = StringIO.new('', 'w+')
+    @non_tty_output.stub(:tty?).and_return false
+
     @progressbar = ProgressBar::Base.new(:output => @output, :length => 80, :throttle_rate => 0.0)
+    @output.rewind
   end
 
-  describe 'terminal width dropping below title length' do
-    it 'should not crash' do
-      @progressbar = ProgressBar::Base.new(:output => @output)
-      @progressbar.stub(:terminal_width).and_return(100)
-      @progressbar.title = 'a'*95
-      @progressbar.stub(:terminal_width).and_return(60)
-      expect {
-        @progressbar.title = 'a'*95
-      }.to_not raise_error
+  context 'when the terminal width is shorter than the string being output' do
+    it 'can properly handle outputting the bar when the length changes on the fly to less than the minimum width' do
+      IO.stub_chain(:console, :winsize).and_return [1, 30]
+      @progressbar = ProgressBar::Base.new(:output => @output, :title => 'a' * 25, :format => '%t%B', :throttle_rate => 0.0)
+
+      @progressbar.start
+
+      IO.stub_chain(:console, :winsize).and_return [1, 20]
+      @progressbar.increment
+
+      @output.rewind
+      @output.read.should match /\raaaaaaaaaaaaaaaaaaaaaaaaa     \r\s+\raaaaaaaaaaaaaaaaaaaaaaaaa\r\z/
+    end
+
+    context 'and the bar length is calculated' do
+      it 'returns the proper string' do
+        IO.stub_chain(:console, :winsize).and_return [1, 20]
+        @progressbar = ProgressBar::Base.new(:output => @output, :title => ('*' * 21), :starting_at => 5, :total => 10)
+
+        @progressbar.to_s('%t%w').should eql '*********************'
+      end
+    end
+
+    context 'and the incomplete bar length is calculated' do
+      it 'returns the proper string' do
+        IO.stub_chain(:console, :winsize).and_return [1, 20]
+        @progressbar = ProgressBar::Base.new(:output => @output, :title => ('*' * 21))
+
+        @progressbar.to_s('%t%i').should eql '*********************'
+      end
+
+      it 'returns the proper string' do
+        IO.stub_chain(:console, :winsize).and_return [1, 20]
+        @progressbar = ProgressBar::Base.new(:output => @output, :title => ('*' * 21), :starting_at => 5, :total => 10)
+
+        @progressbar.to_s('%t%i').should eql '*********************'
+      end
+    end
+
+    context 'and the full bar length is calculated (but lacks the space to output the entire bar)' do
+      it 'returns the proper string' do
+        IO.stub_chain(:console, :winsize).and_return [1, 20]
+        @progressbar = ProgressBar::Base.new(:output => @output, :title => ('*' * 19), :starting_at => 5, :total => 10)
+
+        @progressbar.to_s('%t%B').should eql '******************* '
+      end
+
+      it 'returns the proper string' do
+        IO.stub_chain(:console, :winsize).and_return [1, 20]
+        @progressbar = ProgressBar::Base.new(:output => @output, :title => ('*' * 19), :starting_at => 5, :total => 10)
+
+        @progressbar.to_s('%t%w%i').should eql '******************* '
+      end
     end
   end
 
@@ -131,6 +181,31 @@ describe ProgressBar::Base do
         end
       end
     end
+
+    context 'for a TTY enabled device' do
+      it 'can log messages' do
+        @progressbar = ProgressBar::Base.new(:output => @output, :length => 20, :starting_at => 3, :total => 6, :throttle_rate => 0.0)
+        @progressbar.increment
+        @progressbar.log 'We All Float'
+        @progressbar.increment
+
+        @output.rewind
+        @output.read.should include "Progress: |====    |\rProgress: |=====   |\r                    \rWe All Float\nProgress: |=====   |\rProgress: |======  |\r"
+      end
+    end
+
+    context 'for a non-TTY enabled device' do
+      it 'can log messages' do
+        @progressbar = ProgressBar::Base.new(:output => @non_tty_output, :length => 20, :starting_at => 4, :total => 6, :throttle_rate => 0.0)
+        @progressbar.increment
+        @progressbar.log 'We All Float'
+        @progressbar.increment
+        @progressbar.finish
+
+        @non_tty_output.rewind
+        @non_tty_output.read.should include "We All Float\nProgress: |========|\n"
+      end
+    end
   end
 
   context 'when a bar is about to be completed' do
@@ -152,6 +227,31 @@ describe ProgressBar::Base do
     end
   end
 
+  context 'when a bar has an unknown amount to completion' do
+    before do
+      @progressbar = ProgressBar::Base.new(:total => nil, :output => @output, :length => 80, :unknown_progress_animation_steps => ['=--', '-=-', '--='])
+    end
+
+    it 'is represented correctly' do
+      @progressbar.to_s('%i').should eql '=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=-'
+    end
+
+    it 'is represented after being incremented once' do
+      @progressbar.increment
+      @progressbar.to_s('%i').should eql '-=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--='
+    end
+
+    it 'is represented after being incremented twice' do
+      @progressbar.increment
+      @progressbar.increment
+      @progressbar.to_s('%i').should eql '--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--'
+    end
+
+    it 'displays the proper ETA' do
+      @progressbar.to_s('%i%e').should eql '=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=-- ETA: ??:??:??'
+    end
+  end
+
   context 'when a bar is started' do
     before do
       @progressbar = ProgressBar::Base.new(:starting_at => 0, :total => 100, :output => @output, :length => 80, :throttle_rate  => 0.0)

data/spec/{progress_bar → lib/ruby-progressbar}/components/estimated_timer_spec.rb

@@ -183,7 +183,7 @@ describe ProgressBar::Components::EstimatedTimer do
     #    Failure/Error: COUNT.times { bar.increment }
     #    NoMethodError:
     #      undefined method `+' for nil:NilClass
-    #    # ./lib/progress_bar/components/progressable.rb:33:in `increment'
+    #    # ./lib/ruby-progressbar/components/progressable.rb:33:in `increment'
     #
     it 'properly delegates' do
       @output = StringIO.new('', 'w+')

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/spec/'
+end
 
 require 'mathn'
 require 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progressbar
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -95,41 +95,40 @@ files:
 - .rspec
 - .ruby-version
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- lib/progress_bar/base.rb
-- lib/progress_bar/components.rb
-- lib/progress_bar/components/bar.rb
-- lib/progress_bar/components/elapsed_timer.rb
-- lib/progress_bar/components/estimated_timer.rb
-- lib/progress_bar/components/progressable.rb
-- lib/progress_bar/components/throttle.rb
-- lib/progress_bar/components/timer.rb
-- lib/progress_bar/depreciable.rb
-- lib/progress_bar/format.rb
-- lib/progress_bar/format/base.rb
-- lib/progress_bar/format/molecule.rb
-- lib/progress_bar/formatter.rb
-- lib/progress_bar/length_calculator.rb
-- lib/progress_bar/running_average_calculator.rb
-- lib/progress_bar/time.rb
-- lib/progress_bar/version.rb
-- lib/progressbar.rb
 - lib/ruby-progressbar.rb
+- lib/ruby-progressbar/base.rb
+- lib/ruby-progressbar/components.rb
+- lib/ruby-progressbar/components/bar.rb
+- lib/ruby-progressbar/components/elapsed_timer.rb
+- lib/ruby-progressbar/components/estimated_timer.rb
+- lib/ruby-progressbar/components/progressable.rb
+- lib/ruby-progressbar/components/throttle.rb
+- lib/ruby-progressbar/components/timer.rb
+- lib/ruby-progressbar/format.rb
+- lib/ruby-progressbar/format/base.rb
+- lib/ruby-progressbar/format/molecule.rb
+- lib/ruby-progressbar/formatter.rb
+- lib/ruby-progressbar/length_calculator.rb
+- lib/ruby-progressbar/running_average_calculator.rb
+- lib/ruby-progressbar/time.rb
+- lib/ruby-progressbar/version.rb
 - ruby-progressbar.gemspec
 - spec/fixtures/benchmark.rb
-- spec/progress_bar/base_spec.rb
-- spec/progress_bar/components/bar_spec.rb
-- spec/progress_bar/components/elapsed_timer_spec.rb
-- spec/progress_bar/components/estimated_timer_spec.rb
-- spec/progress_bar/components/progressable_spec.rb
-- spec/progress_bar/components/throttle_spec.rb
-- spec/progress_bar/format/molecule_spec.rb
-- spec/progress_bar/running_average_calculator_spec.rb
-- spec/progress_bar/time_spec.rb
+- spec/lib/ruby-progressbar/base_spec.rb
+- spec/lib/ruby-progressbar/components/bar_spec.rb
+- spec/lib/ruby-progressbar/components/elapsed_timer_spec.rb
+- spec/lib/ruby-progressbar/components/estimated_timer_spec.rb
+- spec/lib/ruby-progressbar/components/progressable_spec.rb
+- spec/lib/ruby-progressbar/components/throttle_spec.rb
+- spec/lib/ruby-progressbar/format/molecule_spec.rb
+- spec/lib/ruby-progressbar/running_average_calculator_spec.rb
+- spec/lib/ruby-progressbar/time_spec.rb
 - spec/spec_helper.rb
 - spec/support/time.rb
 homepage: https://github.com/jfelchner/ruby-progressbar
@@ -160,15 +159,15 @@ specification_version: 3
 summary: Ruby/ProgressBar is a flexible text progress bar library for Ruby.
 test_files:
 - spec/fixtures/benchmark.rb
-- spec/progress_bar/base_spec.rb
-- spec/progress_bar/components/bar_spec.rb
-- spec/progress_bar/components/elapsed_timer_spec.rb
-- spec/progress_bar/components/estimated_timer_spec.rb
-- spec/progress_bar/components/progressable_spec.rb
-- spec/progress_bar/components/throttle_spec.rb
-- spec/progress_bar/format/molecule_spec.rb
-- spec/progress_bar/running_average_calculator_spec.rb
-- spec/progress_bar/time_spec.rb
+- spec/lib/ruby-progressbar/base_spec.rb
+- spec/lib/ruby-progressbar/components/bar_spec.rb
+- spec/lib/ruby-progressbar/components/elapsed_timer_spec.rb
+- spec/lib/ruby-progressbar/components/estimated_timer_spec.rb
+- spec/lib/ruby-progressbar/components/progressable_spec.rb
+- spec/lib/ruby-progressbar/components/throttle_spec.rb
+- spec/lib/ruby-progressbar/format/molecule_spec.rb
+- spec/lib/ruby-progressbar/running_average_calculator_spec.rb
+- spec/lib/ruby-progressbar/time_spec.rb
 - spec/spec_helper.rb
 - spec/support/time.rb
 has_rdoc: 

data/lib/progress_bar/components.rb

@@ -1,6 +0,0 @@
-require 'progress_bar/components/timer'
-require 'progress_bar/components/progressable'
-require 'progress_bar/components/bar'
-require 'progress_bar/components/estimated_timer'
-require 'progress_bar/components/elapsed_timer'
-require 'progress_bar/components/throttle'

data/lib/progress_bar/components/bar.rb

@@ -1,42 +0,0 @@
-class ProgressBar
-  module Components
-    class Bar
-      include Progressable
-
-      DEFAULT_PROGRESS_MARK = '='
-
-      attr_accessor :progress_mark
-      attr_accessor :length
-
-      def initialize(options = {})
-        super
-
-        self.progress_mark   = options[:progress_mark] || DEFAULT_PROGRESS_MARK
-      end
-
-      def to_s(options = {:format => :standard})
-        completed_string = send(:"#{options[:format]}_complete_string")
-        completed_string.ljust(length, ' ')
-      end
-
-      def integrated_percentage_complete_string
-        return standard_complete_string if completed_length < 5
-
-        " #{percentage_completed} ".to_s.center(completed_length, progress_mark)
-      end
-
-      def standard_complete_string
-        progress_mark * completed_length
-      end
-
-      def empty_string
-        ' ' * (length - completed_length)
-      end
-
-    private
-      def completed_length
-        length * percentage_completed / 100
-      end
-    end
-  end
-end

data/lib/progress_bar/depreciable.rb

@@ -1,121 +0,0 @@
-class ProgressBar
-  module Depreciable
-    DEPRECATION_DATE = "June 30th, 2013"
-
-    def backwards_compatible_args_to_options_conversion(args)
-      options = {}
-
-      if args.size > 1
-        puts "DEPRECATION WARNING: Creating progress bars using ProgressBar.new(title, total, output_io) has been deprecated and will be removed on or after #{DEPRECATION_DATE}.  Please use ProgressBar.create(:title => title, :total => total, :output => output_io) instead. The full list of options can be found here: https://github.com/jfelchner/ruby-progressbar."
-        options[:title]  = args[0]
-        options[:total]  = args[1]
-        options[:output] = args[2]
-      else
-        options = args[0]
-      end
-
-      options
-    end
-
-    def inc(value = nil)
-      if value.nil?
-        method_deprecation_message 'inc', 'increment'
-
-        increment
-      else
-        method_removal_message 'inc', 'Rather than passing a step increment to the new #increment method, you can simply do `my_progress_bar.progress += step`.'
-
-        progress = progress + value.to_i
-      end
-    end
-
-    def set(new_value)
-      method_deprecation_message 'set', 'progress='
-
-      progress = new_value
-    end
-
-    def halt
-      method_deprecation_message 'halt', 'stop'
-
-      stop
-    end
-
-    def bar_mark=(mark)
-      method_deprecation_message 'bar_mark=', 'progress_mark='
-
-      progress_mark = mark
-    end
-
-    def title_width
-      method_removal_message 'title_width', 'The formatter is now smart enough to handle any title you use.  Set the format for the bar as described here: https://github.com/jfelchner/ruby-progressbar'
-    end
-
-    def title_width=(value)
-      method_removal_message 'title_width=', 'The formatter is now smart enough to handle any title you use.  Set the format for the bar as described here: https://github.com/jfelchner/ruby-progressbar'
-    end
-
-    def start_time
-      method_deprecation_message 'start_time'
-
-      @elapsed_time.instance_variable_get(:@started_at)
-    end
-
-    def start_time=(value)
-      method_removal_message 'start_time=', 'It is no longer appropriate to set the start time of the bar. Using #start, #stop, #pause and #resume all work as expected.'
-    end
-
-    def format=(value)
-      method_removal_message 'format=', 'The formatter has been completely rewriten for v1.0.  Please use `#format(format_string)`.  See https://github.com/jfelchner/ruby-progressbar for all the formatting options.'
-    end
-
-    def format_arguments=(value)
-      method_removal_message 'format_arguments=', 'The formatter has been completely rewriten for v1.0.  Please use `#format(format_string)`.  See https://github.com/jfelchner/ruby-progressbar for all the formatting options.'
-    end
-
-    def current
-      method_deprecation_message 'current', 'progress'
-
-      @bar.progress
-    end
-
-    def smoothing
-      method_removal_message 'smoothing'
-    end
-
-    def smoothing=(value)
-      method_removal_message 'smoothing=', 'This value can only be set via the options hash when creating a new progress bar like so: ProgressBar.create(:smoothing => 0.2)'
-    end
-
-    def file_transfer_mode
-      method_removal_message 'file_transfer_mode', 'We will be implementing a much better file transfer progress bar in the upcoming version however it has been removed for v1.0.  If you still require this functionality, you should remain at v0.11.0'
-    end
-
-  private
-
-    def method_deprecation_message(old_item, new_item = '')
-      message_has_not_been_shown?(old_item) do
-        replacement_message = new_item.empty? ? 'There will be no replacement.' : "Please use ##{new_item} instead."
-        puts "DEPRECATION WARNING: ##{old_item} will be removed on or after #{DEPRECATION_DATE}. #{replacement_message}"
-      end
-    end
-
-    def method_removal_message(old_item, message = '')
-      message_has_not_been_shown?(old_item) do
-        puts "REMOVAL WARNING: ##{old_item} has been removed. There is no replacement. #{message}"
-      end
-    end
-
-    def safe_string(item)
-      item.gsub('=', '_setter')
-    end
-
-    def message_has_not_been_shown?(item)
-      unless instance_variable_get(:"@#{safe_string item}_deprecation_warning")
-        instance_variable_set(:"@#{safe_string item}_deprecation_warning", true)
-
-        yield
-      end
-    end
-  end
-end

data/lib/progress_bar/format.rb

@@ -1,2 +0,0 @@
-require 'progress_bar/format/molecule'
-require 'progress_bar/format/base'

data/lib/progressbar.rb

@@ -1,10 +0,0 @@
-require 'progress_bar/depreciable'
-
-# This file is provided for standardization purposes only.
-#
-# This gem didn't follow standard Ruby naming conventions and therefore, both `ruby-progressbar.rb` and `progressbar.rb` are needed.
-# `ruby-progressbar.rb` because the gem name should match the filename under `lib` and `progressbar.rb` because this gem was copied
-# directly from another gem and wasn't properly modified.  There are other applications which require this file.
-#
-puts "DEPRECATION WARNING: Requiring ruby-progressbar using `require progressbar` or `gem progressbar` has been deprecated and will be disabled on or after #{ProgressBar::Depreciable::DEPRECATION_DATE}.  Please use `require ruby-progressbar` or `gem ruby-progressbar` instead"
-require File.join(File.dirname(__FILE__), 'ruby-progressbar')