tty-progressbar 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434eb41ca96e22fc08eec8d921a1e58926bcdc53
-  data.tar.gz: b7cc419624722fd02b25a6de8b2bb9ec781df647
+  metadata.gz: f04f4c768fd866bf975c789315865b20506ee916
+  data.tar.gz: c50d09a231f989552fb19baa5ea81bcb5cc49a5c
 SHA512:
-  metadata.gz: ae0c2edda8fc6eac3577a1a4c74a55b3e5cd01759e13a5978786a5777c4ebb4292bb89daa62da7e2043932d352cdb1af28eef579f0f4eae8025a5c433e5bd16c
-  data.tar.gz: 9b3bf8f4bae6156ff201ea8f1382c6097d2ba033cd8378832081018efe0c57d90913a77c6053b423460bc961b9f071a4f217990a8441a51e354553d01a36fecd
+  metadata.gz: 3aa6b1cbcb9d6310900ddadf151cc53147dafbba951d34cca60996c30319df9c3d73a1f9c1cac2547c5c64c921b45cc14137cb880dad69c8b473d55f46d0b957
+  data.tar.gz: bddfaf5c090ef9f0552c1e3162ddc150467496aeb4d93103aafa44b71376e633c96687749d6cce3a7bca4a0cafdf38a84af99fddd0b8f2dea673d48b7dba72c7

data/.travis.yml

@@ -16,9 +16,6 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: jruby-19mode
-    - rvm: jruby-20mode
-    - rvm: jruby-21mode
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+0.3.0 (December 21, 2014)
+
+* Catch INT signal and cleanly end progress
+* Add tty-screen dependency for terminal size detection
+* Add to_bytes converter
+* Add formatter for managing formats pipeline
+* Change to add matching condition to formatter
+* Add block configuration
+
 0.2.0 (November 9, 2014)
 
 * Add estimated time formatter.

data/README.md

@@ -9,14 +9,15 @@
 [codeclimate]: https://codeclimate.com/github/peter-murach/tty-progressbar
 [coverage]: https://coveralls.io/r/peter-murach/tty-progressbar
 
-A flexible progress bars drawing in terminal emulators.
+> A flexible progress bars drawing in terminal emulators.
 
 **TTY::ProgressBar** provides independent progress bars component for [TTY](https://github.com/peter-murach/tty) toolkit.
 
 ## Features
 
-* Extremly flexible progress display formatting
-* Ability to define your custom format tokens
+* Fully [configurable](#2-configuration)
+* Extremly flexible progress display [formatting](#3-formatting)
+* Ability to define your custom format [tokens](#31-tokens)
 * Works on all ECMA-48 compatible terminals
 
 ## Installation
@@ -41,6 +42,7 @@ Or install it yourself as:
   * [1.1 advance](#11-advance)
   * [1.2 finish](#12-finish)
   * [1.3 complete?](#13-complete)
+  * [1.4 resize](#14-resize)
 * [2. Configuration](#2-configuration)
   * [2.1 Frequency](#21-frequency)
 * [3. Formatting](#3-formatting)
@@ -69,7 +71,7 @@ downloading [=======================       ]
 
 ### 1.1 advance
 
-Once you have **ProgressBar** instance, you can progress the display by calling `advance` method. By default it will increase by `1`  but you can pass any number of steps, for instance, when used to advance number of bytes of downloaded file.
+Once you have **TTY::ProgressBar** instance, you can progress the display by calling `advance` method. By default it will increase by `1` but you can pass any number of steps, for instance, when used to advance number of bytes of downloaded file.
 
 ```ruby
 bar.advance(1000)
@@ -99,6 +101,14 @@ During progresion you can check if bar is finished or not by calling `complete?`
 bar.complete? # => false
 ```
 
+### 1.4 resize
+
+If you wish for a progress bar to change it's current width, you can use `resize` by passing in a new desired length:
+
+```ruby
+bar.resize(50)  # => will resize bar proportionately from this point onwards
+```
+
 ## 2. Configuration
 
 There are number of configuration options that can be provided:
@@ -110,6 +120,17 @@ There are number of configuration options that can be provided:
 * `output` the output stream defaulting to `stderr`
 * `frequency` used to throttle the output, by default `0` (see [Frequency](#21-frequency))
 * `hide_cursor` to hide display cursor defaulting to `false`
+* `clear` to clear the finished bar defaulting to `false`
+
+All the above options can be passed in as hash options or block parameters:
+
+```ruby
+TTY::ProgressBar.new "[:bar]" do |config|
+  config.total = 30
+  config.frequency = 10
+  config.clear = true
+end
+```
 
 ### 2.1 Frequency
 
@@ -134,6 +155,7 @@ Every **TTY::ProgressBar** instance requires a format string, which apart from r
 These are the tokens that are currently supported:
 
 * `:bar` the progress bar
+* `:byte` the current progress in bytes
 * `:current` the current progress number
 * `:total` the total progress number
 * `:percent` the completion percentage
@@ -144,7 +166,7 @@ These are the tokens that are currently supported:
 
 If the provided tokens do not meet your needs, you can write your own formatter and instrument formatting pipeline to use a formatter you prefer.
 
-For example, begin by creating custom formatter called `TimeFormatter` that will dynamicly update `:time` token in format string as follows:
+For example, begin by creating custom formatter called `TimeFormatter` that will dynamicly update `:time` token in format string. The methods that you need to specify are `initialize`, `matches?` and `format` like follows:
 
 ```ruby
 class TimeFormatter
@@ -152,7 +174,11 @@ class TimeFormatter
     @progress = progress
   end
 
-  def format(value)
+  def matches?(value)  # specify condition to match for
+    value.to_s =~ /:time/
+  end
+
+  def format(value)  # specify how value is formatted
     transformed = transform(value)
     value.gsub(/:time/, transformed.to_s)   # => :time token
   end

data/lib/tty-progressbar.rb

@@ -1 +1,3 @@
+# coding: utf-8
+
 require 'tty/progressbar'

data/lib/tty/progressbar.rb

@@ -2,16 +2,21 @@
 
 require 'io/console'
 require 'forwardable'
+require 'tty-screen'
 
+require 'tty/progressbar/configuration'
 require 'tty/progressbar/converter'
 require 'tty/progressbar/version'
 require 'tty/progressbar/pipeline'
-require 'tty/progressbar/bar_formatter'
-require 'tty/progressbar/current_formatter'
-require 'tty/progressbar/elapsed_formatter'
-require 'tty/progressbar/estimated_formatter'
-require 'tty/progressbar/percent_formatter'
-require 'tty/progressbar/total_formatter'
+require 'tty/progressbar/formatter'
+
+require 'tty/progressbar/formatter/bar'
+require 'tty/progressbar/formatter/byte'
+require 'tty/progressbar/formatter/current'
+require 'tty/progressbar/formatter/elapsed'
+require 'tty/progressbar/formatter/estimated'
+require 'tty/progressbar/formatter/percent'
+require 'tty/progressbar/formatter/total'
 
 module TTY
   # Used for creating terminal progress bar
@@ -20,35 +25,26 @@ module TTY
   class ProgressBar
     extend Forwardable
 
-    ECMA_ESC = "\x1b"
-    ECMA_CSI = "\x1b["
-    ECMA_CHA = 'G'
+    ECMA_ESC = "\e".freeze
+    ECMA_CSI = "\e[".freeze
+    ECMA_CHA = 'G'.freeze
+    ECMA_CLR = 'K'.freeze
 
-    DEC_RST = 'l'
-    DEC_SET = 'h'
-    DEC_TCEM = '?25'
+    DEC_RST  = 'l'.freeze
+    DEC_SET  = 'h'.freeze
+    DEC_TCEM = '?25'.freeze
 
     attr_reader :format
 
-    attr_reader :total
-
-    attr_reader :width
-
-    attr_reader :no_width
-
     attr_reader :current
 
     attr_reader :start_at
 
-    attr_reader :complete
+    def_delegators :@configuration, :total, :width, :no_width,
+                   :complete, :incomplete, :hide_cursor, :clear,
+                   :output, :frequency
 
-    attr_reader :incomplete
-
-    attr_reader :hide_cursor
-
-    attr_reader :output
-
-    def_delegator :@pipeline, :use
+    def_delegator :@formatter, :use
 
     # Create progress bar
     #
@@ -74,28 +70,21 @@ module TTY
     #
     # @api public
     def initialize(format, options = {})
-      @format      = format
-      @total       = options.fetch(:total) { fail ArgumentError }
-      @width       = options.fetch(:width) { @total }
-      @no_width    = options.fetch(:no_width) { false }
-      @clear       = options.fetch(:clear) { false }
-      @incomplete  = options.fetch(:incomplete) { ' ' }
-      @complete    = options.fetch(:complete) { '=' }
-      @hide_cursor = options.fetch(:hide_cursor) { false }
-      @output      = options.fetch(:output) { $stderr }
-      @frequency   = options.fetch(:frequency) { 0 } # 0Hz
-
-      @width             = 0 if @no_width
-      @render_period     = @frequency == 0 ? 0 : 1.0 / @frequency
+      @format        = format
+      @configuration = Configuration.new(options)
+      yield @configuration if block_given?
+
+      @width             = 0 if no_width
+      @render_period     = frequency == 0 ? 0 : 1.0 / frequency
       @current           = 0
       @readings          = 0
       @last_render_time  = Time.now
       @last_render_width = 0
       @done              = false
       @start_at          = Time.now
-      @pipeline          = TTY::ProgressBar::Pipeline.new
+      @formatter         = TTY::ProgressBar::Formatter.new
 
-      default_pipeline
+      @formatter.load
       register_callbacks
     end
 
@@ -126,27 +115,20 @@ module TTY
     #
     # @api public
     def ratio
-      proportion = (@current.to_f / @total)
+      proportion = (@current.to_f / total)
       [[proportion, 0].max, 1].min
     end
 
-    # Determine terminal width
-    #
-    # @api public
-    def max_columns
-      IO.console.winsize.last
-    end
-
     # Render progress to the output
     #
     # @api private
     def render
       return if @done
-      if @hide_cursor && @last_render_width == 0 && !(@current >= total)
+      if hide_cursor && @last_render_width == 0 && !(@current >= total)
         write(ECMA_CSI + DEC_TCEM + DEC_RST)
       end
 
-      formatted = @pipeline.decorate(self, @format)
+      formatted = @formatter.decorate(self, @format)
       write(formatted, true)
 
       @last_render_time  = Time.now
@@ -159,9 +141,9 @@ module TTY
     #
     # @api private
     def write(data, clear_first = false)
-      @output.print(ECMA_CSI + '1' + ECMA_CHA) if clear_first
-      @output.print(data)
-      @output.flush
+      output.print(ECMA_CSI + '1' + ECMA_CHA) if clear_first
+      output.print(data)
+      output.flush
     end
 
     # Resize progress bar with new configuration
@@ -171,11 +153,11 @@ module TTY
       fail 'Cannot resize finished progress bar' if @done
 
       if new_width
-        @no_width = false
-        @width    = new_width
+        @configuration.no_width = false
+        @configuration.width    = new_width
       else
-        @no_width = true
-        @width    = 0
+        @configuration.no_width = true
+        @configuration.width    = 0
       end
 
       advance(0) # rerender with new configuration
@@ -186,16 +168,23 @@ module TTY
     # @api public
     def finish
       # reenable cursor if it is turned off
-      if @hide_cursor && @last_render_width != 0
+      if hide_cursor && @last_render_width != 0
         write(ECMA_CSI + DEC_TCEM + DEC_SET, false)
       end
       return if @done
-      @current = @width if @no_width
+      @current = width if no_width
       render
-      write("\n", false)
+      clear ? clear_line : write("\n", false)
       @done = true
     end
 
+    # Clear current line
+    #
+    # @api public
+    def clear_line
+      output.print(ECMA_CSI + '0m' + ECMA_CSI + '1000D' + ECMA_CSI + ECMA_CLR)
+    end
+
     # Check if progress is finised
     #
     # @return [Boolean]
@@ -224,6 +213,13 @@ module TTY
       render
     end
 
+    # Determine terminal width
+    #
+    # @api public
+    def max_columns
+      TTY::Screen.new.width
+    end
+
     private
 
     # Pad message out with spaces
@@ -237,26 +233,17 @@ module TTY
       message
     end
 
-    # Prepare default pipeline formatters
-    #
-    # @api private
-    def default_pipeline
-      @pipeline.use TTY::ProgressBar::CurrentFormatter
-      @pipeline.use TTY::ProgressBar::TotalFormatter
-      @pipeline.use TTY::ProgressBar::ElapsedFormatter
-      @pipeline.use TTY::ProgressBar::EstimatedFormatter
-      @pipeline.use TTY::ProgressBar::PercentFormatter
-      @pipeline.use TTY::ProgressBar::BarFormatter
-    end
-
     # Handle resize and kill signals
     #
     # @api private
     def register_callbacks
-      callback = proc { send(:resize, max_columns) }
-      Signal.trap('SIGWINCH', &callback)
+      callback = proc do
+        adjusted_width =  width < max_columns ? width : max_columns
+        send(:resize, adjusted_width)
+      end
+      Signal.trap('WINCH', &callback)
 
-      Signal.trap('KILL') { @finish }
+      Signal.trap('INT') { finish }
     end
   end # ProgressBar
 end # TTY

data/lib/tty/progressbar/configuration.rb

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    class Configuration
+
+      attr_accessor :total
+
+      attr_accessor :width
+
+      attr_accessor :no_width
+
+      attr_accessor :incomplete
+
+      attr_accessor :complete
+
+      attr_accessor :hide_cursor
+
+      attr_accessor :clear
+
+      attr_accessor :output
+
+      attr_accessor :frequency
+
+      def initialize(options)
+        self.total   = options[:total] if options[:total]
+        @width       = options.fetch(:width) { total }
+        @no_width    = options.fetch(:no_width) { false }
+        @incomplete  = options.fetch(:incomplete) { ' ' }
+        @complete    = options.fetch(:complete) { '=' }
+        @hide_cursor = options.fetch(:hide_cursor) { false }
+        @clear       = options.fetch(:clear) { false }
+        @output      = options.fetch(:output) { $stderr }
+        @frequency   = options.fetch(:frequency) { 0 } # 0Hz
+      end
+
+      def total=(value)
+        fail ArgumentError unless value
+        @total = value
+        @width = value unless width
+      end
+    end # Configuration
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/converter.rb

@@ -6,9 +6,17 @@ module TTY
     #
     # @api public
     class Converter
+      HOURSECONDS = 3600
+
+      # Convert seconds to time notation
+      #
+      # @param [Numeric] seconds
+      #   the seconds to convert to time
+      #
+      # @api public
       def to_time(seconds)
-        hours = (seconds / 3600.to_f).floor
-        seconds -= hours * 3600
+        hours = (seconds / HOURSECONDS.to_f).floor
+        seconds -= hours * HOURSECONDS
         minutes = (seconds / 60).floor
         seconds -= minutes * 60
 
@@ -22,6 +30,30 @@ module TTY
           sprintf('%2ds', seconds)
         end
       end
+
+      KILOBYTE = 1024
+      MEGABYTE = KILOBYTE * 1024
+      GIGABYTE = MEGABYTE * 1024
+
+      # Convert value to bytes
+      #
+      # @param [Numeric] value
+      #   the value to convert to bytes
+      #
+      # @return [String]
+      #
+      # @api public
+      def to_bytes(value)
+        if value >= GIGABYTE
+          sprintf('%.2f', value / GIGABYTE.to_f) + 'GB'
+        elsif value >= MEGABYTE
+          sprintf('%.2f', value / MEGABYTE.to_f) + 'MB'
+        elsif value >= KILOBYTE
+          sprintf('%.2f', value / KILOBYTE.to_f) + 'KB'
+        else
+          value.to_s + 'B'
+        end
+      end
     end # Converter
   end # ProgressBar
 end # TTY

data/lib/tty/progressbar/formatter.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    class Formatter
+      extend Forwardable
+
+      def_delegators :@pipeline, :decorate, :use
+
+      # @api private
+      def initialize(pipeline = nil)
+        @pipeline = TTY::ProgressBar::Pipeline.new
+      end
+
+      # Prepare default pipeline formatters
+      #
+      # @api private
+      def load
+        @pipeline.use TTY::ProgressBar::CurrentFormatter
+        @pipeline.use TTY::ProgressBar::TotalFormatter
+        @pipeline.use TTY::ProgressBar::ElapsedFormatter
+        @pipeline.use TTY::ProgressBar::EstimatedFormatter
+        @pipeline.use TTY::ProgressBar::PercentFormatter
+        @pipeline.use TTY::ProgressBar::ByteFormatter
+        @pipeline.use TTY::ProgressBar::BarFormatter
+      end
+    end # Formatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/{bar_formatter.rb → formatter/bar.rb}

@@ -6,10 +6,23 @@ module TTY
     #
     # @api private
     class BarFormatter
+      MATCHER = /:bar/.freeze
+
       def initialize(progress, *args, &block)
         @progress = progress
       end
 
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
       # Format :bar token
       #
       # @param [String] value
@@ -27,7 +40,7 @@ module TTY
         bar += complete.join
         bar += incomplete.join
 
-        value.gsub(/:bar/, bar)
+        value.gsub(MATCHER, bar)
       end
     end # BarFormatter
   end #  ProgressBar

data/lib/tty/progressbar/formatter/byte.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    class ByteFormatter
+      MATCHER = /:byte/.freeze
+      # Used by {Pipeline} to format :byte token
+      #
+      # @api private
+      def initialize(progress)
+        @progress = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      def format(value)
+        bytes = @converter.to_bytes(@progress.current)
+        value.gsub(MATCHER, bytes)
+      end
+    end # ByteFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/{current_formatter.rb → formatter/current.rb}

@@ -6,10 +6,23 @@ module TTY
     #
     # @api private
     class CurrentFormatter
+      MATCHER = /:current/
+
       def initialize(progress)
         @progress = progress
       end
 
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
       # Format :current token
       #
       # @param [String] value
@@ -17,7 +30,7 @@ module TTY
       #
       # @api public
       def format(value)
-        value.gsub(/:current/, @progress.current.to_s)
+        value.gsub(MATCHER, @progress.current.to_s)
       end
     end # CurrentFormatter
   end # ProgressBar

data/lib/tty/progressbar/formatter/elapsed.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format :elapsed token
+    #
+    # @api private
+    class ElapsedFormatter
+      MATCHER = /:elapsed/.freeze
+
+      def initialize(progress, *args, &block)
+        @progress  = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      def format(value)
+        elapsed = (Time.now - @progress.start_at)
+        value.gsub(MATCHER, @converter.to_time(elapsed))
+      end
+    end # ElapsedFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/{estimated_formatter.rb → formatter/estimated.rb}

@@ -6,16 +6,29 @@ module TTY
     #
     # @api private
     class EstimatedFormatter
+      MATCHER = /:eta/.freeze
+
       def initialize(progress)
-        @progress = progress
-        @converter = TTY::ProgressBar::Converter.new
+        @progress  = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
       end
 
       def format(value)
         elapsed   = Time.now - @progress.start_at
         estimated = (elapsed / @progress.ratio).to_f - elapsed
         estimated = (estimated.infinite? || estimated < 0) ? 0.0 : estimated
-        value.gsub(/:eta/, @converter.to_time(estimated))
+        value.gsub(MATCHER, @converter.to_time(estimated))
       end
     end # ElapsedFormatter
   end # ProgressBar

data/lib/tty/progressbar/{percent_formatter.rb → formatter/percent.rb}

@@ -6,13 +6,26 @@ module TTY
     #
     # @api private
     class PercentFormatter
+      MATCHER = /:percent/.freeze
+
       def initialize(progress, *args, &block)
         @progress = progress
       end
 
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
       def format(value)
         percent = @progress.width == 0 ? 100 : (@progress.ratio * 100).to_i
-        value.gsub(/:percent/, percent.to_s + '%')
+        value.gsub(MATCHER, percent.to_s + '%')
       end
     end # PercentFormatter
   end # ProgressBar

data/lib/tty/progressbar/formatter/total.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    class TotalFormatter
+      MATCHER = /:total/.freeze
+
+      def initialize(progress, *args, &block)
+        @progress = progress
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      def format(value)
+        value.gsub(MATCHER, @progress.total.to_s)
+      end
+    end # TotalFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/pipeline.rb

@@ -22,7 +22,12 @@ module TTY
       def decorate(progress, tokenized)
         base = tokenized.dup
         formatters.inject(base) do |formatted, formatter|
-          formatter.call(progress).format(formatted)
+          instance = formatter.call(progress)
+          if instance.respond_to?(:matches?) && instance.matches?(formatted)
+            instance.format(formatted)
+          else
+            formatted
+          end
         end
       end
 

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end # ProgressBar
 end # TTY

data/spec/unit/clear_spec.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'clear' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "clears progress bar when finished" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5,
+     clear: true)
+    5.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[=    ]",
+      "\e[1G[==   ]",
+      "\e[1G[===  ]",
+      "\e[1G[==== ]",
+      "\e[1G[=====]\e[0m\e[1000D\e[K"
+    ].join)
+  end
+end

data/spec/unit/converter/to_bytes_spec.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar::Converter, '.to_bytes' do
+  subject(:converter) { described_class.new }
+
+  it "converts 1000 to bytes" do
+    expect(converter.to_bytes(1000)).to eq('1000B')
+  end
+
+  it "converts 1024 to bytes" do
+    expect(converter.to_bytes(1024)).to eq('1.00KB')
+  end
+
+  it "converts 2000 to bytes" do
+    expect(converter.to_bytes(2000)).to eq('1.95KB')
+  end
+
+  it "converts 10_000_000 to bytes" do
+    expect(converter.to_bytes(10_000_000)).to eq('9.54MB')
+  end
+
+  it "convert 10_000_000_000 to bytes" do
+    expect(converter.to_bytes(10_000_000_000)).to eq('9.31GB')
+  end
+end

data/spec/unit/custom_formatter_spec.rb

@@ -13,6 +13,10 @@ RSpec.describe TTY::ProgressBar, 'custom' do
         @progress = progress
       end
 
+      def matches?(value)
+        value.to_s =~ /:hi/
+      end
+
       def format(value)
         value.gsub(/:hi/, "Hello")
       end

data/spec/unit/formatter/byte_spec.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, '.new' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "displays bytes processed" do
+    progress = described_class.new(":byte", output: output, total: 102_400)
+    5.times { progress.advance(20_480) }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G20.00KB",
+      "\e[1G40.00KB",
+      "\e[1G60.00KB",
+      "\e[1G80.00KB",
+      "\e[1G100.00KB\n"
+    ].join)
+  end
+end

data/spec/unit/{elapsed_formatter_spec.rb → formatter/elapsed_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe TTY::ProgressBar, '.new' do
+RSpec.describe TTY::ProgressBar, 'elapsed' do
   let(:output) { StringIO.new('', 'w+') }
 
   before { Timecop.safe_mode = false }

data/spec/unit/new_spec.rb

@@ -12,6 +12,18 @@ RSpec.describe TTY::ProgressBar, '.new' do
     expect(output.read).to eq("\e[1G[=         ]")
   end
 
+  it "yields configuration to block" do
+    progress = TTY::ProgressBar.new "[:bar]" do |config|
+      config.output = output
+      config.total  = 10
+      config.clear  = true
+    end
+    expect(progress.output).to eq(output)
+    expect(progress.total).to eq(10)
+    expect(progress.width).to eq(10)
+    expect(progress.clear).to eq(true)
+  end
+
   it "displays output where width > total" do
     progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5, width: 10)
     5.times { progress.advance }

data/spec/unit/resize_spec.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, '.resize' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "resizes output down by x2" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5, width: 10)
+    2.times { progress.advance }
+    progress.resize(5)
+    3.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[==        ]",
+      "\e[1G[====      ]",
+      "\e[1G[==   ]",
+      "\e[1G[===  ]",
+      "\e[1G[==== ]",
+      "\e[1G[=====]\n"
+    ].join)
+  end
+
+  it "resizes output up by x2" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5, width: 10)
+    2.times { progress.advance }
+    progress.resize(20)
+    3.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[==        ]",
+      "\e[1G[====      ]",
+      "\e[1G[========            ]",
+      "\e[1G[============        ]",
+      "\e[1G[================    ]",
+      "\e[1G[====================]\n"
+    ].join)
+  end
+end

data/spec/unit/width_spec.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'width' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "handles width exceeding terminal width" do
+    progress = TTY::ProgressBar.new "[:bar]" do |config|
+      config.output = output
+      config.total = 5
+      config.width = 1024
+    end
+    screen = double(:screen, width: 20)
+    allow(TTY::Screen).to receive(:new).and_return(screen)
+    5.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[====              ]",
+      "\e[1G[=======           ]",
+      "\e[1G[===========       ]",
+      "\e[1G[==============    ]",
+      "\e[1G[==================]\n"
+    ].join)
+  end
+end

data/tasks/console.rake

@@ -4,7 +4,7 @@ desc 'Load gem inside irb console'
 task :console do
   require 'irb'
   require 'irb/completion'
-  require File.join(__FILE__, '../../lib/tty-progresbar')
+  require File.join(__FILE__, '../../lib/tty-progressbar')
   ARGV.clear
   IRB.start
 end

data/tty-progressbar.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "tty-screen", '~> 0.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-09 00:00:00.000000000 Z
+date: 2014-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: 0.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.6'
 description: A flexible progress bars drawing in terminal emulators.
 email:
 - ''
@@ -58,30 +58,38 @@ files:
 - examples/simple.rb
 - lib/tty-progressbar.rb
 - lib/tty/progressbar.rb
-- lib/tty/progressbar/bar_formatter.rb
+- lib/tty/progressbar/configuration.rb
 - lib/tty/progressbar/converter.rb
-- lib/tty/progressbar/current_formatter.rb
-- lib/tty/progressbar/elapsed_formatter.rb
-- lib/tty/progressbar/estimated_formatter.rb
-- lib/tty/progressbar/percent_formatter.rb
+- lib/tty/progressbar/formatter.rb
+- lib/tty/progressbar/formatter/bar.rb
+- lib/tty/progressbar/formatter/byte.rb
+- lib/tty/progressbar/formatter/current.rb
+- lib/tty/progressbar/formatter/elapsed.rb
+- lib/tty/progressbar/formatter/estimated.rb
+- lib/tty/progressbar/formatter/percent.rb
+- lib/tty/progressbar/formatter/total.rb
 - lib/tty/progressbar/pipeline.rb
-- lib/tty/progressbar/total_formatter.rb
 - lib/tty/progressbar/version.rb
 - spec/spec_helper.rb
 - spec/unit/advance_spec.rb
-- spec/unit/bar_formatter_spec.rb
+- spec/unit/clear_spec.rb
 - spec/unit/complete_spec.rb
-- spec/unit/converter_spec.rb
-- spec/unit/current_formatter_spec.rb
+- spec/unit/converter/to_bytes_spec.rb
+- spec/unit/converter/to_time_spec.rb
 - spec/unit/custom_formatter_spec.rb
-- spec/unit/elapsed_formatter_spec.rb
-- spec/unit/estimated_formatter_spec.rb
+- spec/unit/formatter/bar_spec.rb
+- spec/unit/formatter/byte_spec.rb
+- spec/unit/formatter/current_spec.rb
+- spec/unit/formatter/elapsed_spec.rb
+- spec/unit/formatter/estimated_spec.rb
+- spec/unit/formatter/percent_spec.rb
 - spec/unit/frequency_spec.rb
 - spec/unit/hide_cursor_spec.rb
 - spec/unit/log_spec.rb
 - spec/unit/new_spec.rb
-- spec/unit/percent_formatter_spec.rb
 - spec/unit/pipeline_spec.rb
+- spec/unit/resize_spec.rb
+- spec/unit/width_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
@@ -113,17 +121,22 @@ summary: A flexible progress bars drawing in terminal emulators.
 test_files:
 - spec/spec_helper.rb
 - spec/unit/advance_spec.rb
-- spec/unit/bar_formatter_spec.rb
+- spec/unit/clear_spec.rb
 - spec/unit/complete_spec.rb
-- spec/unit/converter_spec.rb
-- spec/unit/current_formatter_spec.rb
+- spec/unit/converter/to_bytes_spec.rb
+- spec/unit/converter/to_time_spec.rb
 - spec/unit/custom_formatter_spec.rb
-- spec/unit/elapsed_formatter_spec.rb
-- spec/unit/estimated_formatter_spec.rb
+- spec/unit/formatter/bar_spec.rb
+- spec/unit/formatter/byte_spec.rb
+- spec/unit/formatter/current_spec.rb
+- spec/unit/formatter/elapsed_spec.rb
+- spec/unit/formatter/estimated_spec.rb
+- spec/unit/formatter/percent_spec.rb
 - spec/unit/frequency_spec.rb
 - spec/unit/hide_cursor_spec.rb
 - spec/unit/log_spec.rb
 - spec/unit/new_spec.rb
-- spec/unit/percent_formatter_spec.rb
 - spec/unit/pipeline_spec.rb
+- spec/unit/resize_spec.rb
+- spec/unit/width_spec.rb
 has_rdoc: 

data/lib/tty/progressbar/elapsed_formatter.rb

@@ -1,20 +0,0 @@
-# coding: utf-8
-
-module TTY
-  class ProgressBar
-    # Used by {Pipeline} to format :elapsed token
-    #
-    # @api private
-    class ElapsedFormatter
-      def initialize(progress, *args, &block)
-        @progress = progress
-        @converter = TTY::ProgressBar::Converter.new
-      end
-
-      def format(value)
-        elapsed = (Time.now - @progress.start_at)
-        value.gsub(/:elapsed/, @converter.to_time(elapsed))
-      end
-    end # ElapsedFormatter
-  end # ProgressBar
-end # TTY

data/lib/tty/progressbar/total_formatter.rb

@@ -1,15 +0,0 @@
-# coding: utf-8
-
-module TTY
-  class ProgressBar
-    class TotalFormatter
-      def initialize(progress, *args, &block)
-        @progress = progress
-      end
-
-      def format(value)
-        value.gsub(/:total/, @progress.total.to_s)
-      end
-    end # TotalFormatter
-  end # ProgressBar
-end # TTY