tty-progressbar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86f9a4188616553d3453e6f8d5e35d4d3b434e7f
+  data.tar.gz: 57c8b9d98eca275035f392fa58d4b30b16f5c34d
+SHA512:
+  metadata.gz: e04221654464e622d50a1dd349d65c4d557c957b8d7df1999bd6186eeb087f286221a6c0e13f0102e8af8c93fe5b7227a550e0cd790aff4c4b5d6a69d5111ea7
+  data.tar.gz: 4997afe3c9e855bcb433dc9209a8d41e6a9df9b560797cca911d5a066557ff5ad2fa542412a4e63c83197a9052bf26c8728275b3f59f4547897bde7088f62ee9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake',    '~> 10.3.2'
+  gem 'rspec',   '~> 3.1.0'
+  gem 'yard',    '~> 0.8.7'
+  gem 'timecop', '~> 0.7.1'
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.0'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Murach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+# TTY::Progressbar
+[![Gem Version](https://badge.fury.io/rb/tty-progressbar.png)][gem]
+[![Build Status](https://secure.travis-ci.org/peter-murach/tty-progressbar.png?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/peter-murach/tty-progressbar.png)][codeclimate]
+
+[gem]: http://badge.fury.io/rb/tty-progressbar
+[travis]: http://travis-ci.org/peter-murach/tty-progressbar
+[codeclimate]: https://codeclimate.com/github/peter-murach/tty-progressbar
+
+A flexible progress bars drawing in terminal emulators.
+
+## Features
+
+* Extremly flexible progress display formatting
+* Ability to define your custom format tokens
+* Works on all ECMA-48 compatible terminals
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-progressbar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-progressbar
+
+## Contents
+
+* [1. Usage](#1-usage)
+  * [1.1 advance](#11-advance)
+  * [1.1 finish](#12-finish)
+* [2. Configuration](#2-configuration)
+* [3. Formatting](#3-formatting)
+  * [3.1 Tokens](#31-tokens)
+  * [3.2 Custom Formatter](#31-custom-formatter)
+
+## 1. Usage
+
+**TTY::ProgressBar** requires only format string and total number of steps to completion. Once initialized, use `advance` method to indicated the progress like so:
+
+```ruby
+bar = TTY::ProgressBar.new("downloading [:bar]", total: 30)
+30.times do
+  sleep(0.1)
+  bar.advance(1)
+end
+```
+
+This would produce anmiation in your terminal:
+
+```ruby
+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.
+
+```ruby
+bar.advance(1000)
+```
+
+### 1.2 finish
+
+In order to immediately stop and finish the bar call `finish`. This will finish drawing the progress and return to new line.
+
+```ruby
+bar.finish
+```
+
+## 2. Configuration
+
+There are number of configuration options that can be provided:
+
+* `total` total number of steps to completion
+* `width` for the bars display including formatting options defaulting to total
+* `complete` completion character by default `=`
+* `incomplete` incomplete character by default single space
+* `output` the output stream defaulting to `stderr`
+* `frequency` used to throttle the output, by default `false`
+* `hide_cursor` to hide display cursor defaulting to `false`
+
+## 3. Formatting
+
+Every **TTY::ProgressBar** instance requires a format string, which apart from regular characters accepts special tokens to display dynamic information. For instance, a format to measure download progress could be:
+
+```ruby
+"downloading [:bar] :elapsed :percent"
+```
+
+### 3.1 Tokens
+
+These are the tokens that are currently supported:
+
+* `:bar` the progress bar
+* `:current` the current progress number
+* `:total` the total progress number
+* `:percent` the completion percentage
+* `:elapsed` the elapsed time in seconds
+
+### 3.2 Custom formatter
+
+If the provided tokens do not meet your needs, you can instrument formatting pipeline to use a custome formatter.
+
+For example, begin by creating custom formatter called `TimeFormatter` that will dynamicly update `:time` token in format string as follows:
+
+```
+class TimeFormatter
+  def initialize(progress)
+    @progress = progress
+  end
+
+  def format(value)
+    transformed = transform(value)
+    value.gsub(/:time/, transformed.to_s)   # => :time token
+  end
+
+  private
+
+  def transfrom
+    value * (Time.now - @progress.start_at).to_i
+  end
+end
+```
+
+Notice that you have access to all the configuration options inside the formatter by simply invoking them on the `@progress` instance.
+
+Create **TTY::ProgressBar** instance with new token:
+
+```ruby
+bar = TTY::ProgressBar.new(":time", total: 30)
+```
+
+Then add `TimeFormatter` to the pipeline like so:
+
+```ruby
+bar.use TimeFormatter
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/peter-murach/tty-progressbar/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright (c) 2014 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require "bundler/gem_tasks"
+
+FileList['tasks/**/*.rake'].each(&method(:import))
+
+desc 'Run all specs'
+task ci: %w[ spec ]

data/examples/simple.rb

@@ -0,0 +1,7 @@
+require'tty-progressbar'
+
+bar = TTY::ProgressBar.new("downloading [:bar] :elapsed :percent", total: 30)
+30.times do
+  sleep(0.1)
+  bar.advance
+end

data/lib/tty/progressbar/bar_formatter.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format bar
+    #
+    # @api private
+    class BarFormatter
+      def initialize(progress, *args, &block)
+        @progress = progress
+      end
+
+      # Format :bar token
+      #
+      # @param [String] value
+      #  the value being formatted
+      #
+      # @api public
+      def format(value)
+        available_space = [0, @progress.max_columns - value.gsub(/:bar/, '').length].max
+        width = [@progress.width, available_space].min
+        complete_length = (width * @progress.ratio).round
+        complete   = Array.new(complete_length, @progress.complete)
+        incomplete = Array.new(width - complete_length, @progress.incomplete)
+
+        bar = ''
+        bar += complete.join
+        bar += incomplete.join
+
+        value.gsub(/:bar/, bar)
+      end
+    end # BarFormatter
+  end #  ProgressBar
+end # TTY

data/lib/tty/progressbar/converter.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Responsible for converting values to different formats
+    #
+    # @api public
+    class Converter
+      def to_time(seconds)
+        hours = (seconds / 3600.to_f).floor
+        seconds -= hours * 3600
+        minutes = (seconds / 60).floor
+        seconds -= minutes * 60
+
+        if hours > 99
+          sprintf('%dh', hours)
+        elsif hours > 0
+          sprintf('%2dh%2dm', hours, minutes)
+        elsif minutes > 0
+          sprintf('%2dm%2ds', minutes, seconds)
+        else
+          sprintf('%2ds', seconds)
+        end
+      end
+    end # Converter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/current_formatter.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    class CurrentFormatter
+      def initialize(progress, *args, &block)
+        @progress = progress
+      end
+
+      # Format :current token
+      #
+      # @param [String] value
+      #  the value being formatted
+      #
+      # @api public
+      def format(value)
+        value.gsub(/:current/, @progress.current.to_s)
+      end
+    end # CurrentFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/elapsed_formatter.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    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/percent_formatter.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    class PercentFormatter
+      def initialize(progress, *args, &block)
+        @progress = progress
+      end
+
+      def format(value)
+        percent = @progress.width == 0 ? 100 : (@progress.ratio * 100).to_i
+        value.gsub(/:percent/, percent.to_s + '%')
+      end
+    end # PercentFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/pipeline.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {ProgressBar} to decorate format string
+    #
+    # @api private
+    class Pipeline
+      include Enumerable
+
+      def initialize(formatters = [])
+        @formatters = formatters
+      end
+
+      # Add new formatter
+      #
+      # @ api public
+      def use(formatter, *args, &block)
+        formatters << proc { |progress| formatter.new(progress, *args, &block) }
+      end
+
+      def decorate(progress, tokenized)
+        base = tokenized.dup
+        formatters.inject(base) do |formatted, formatter|
+          formatter.call(progress).format(formatted)
+        end
+      end
+
+      # Iterate over formatters
+      #
+      # @api public
+      def each(&block)
+        formatters.each(&block)
+      end
+
+      protected
+
+      attr_reader :formatters
+    end # Pipeline
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/total_formatter.rb

@@ -0,0 +1,15 @@
+# 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

data/lib/tty/progressbar/version.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    VERSION = "0.1.0"
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar.rb

@@ -0,0 +1,230 @@
+# coding: utf-8
+
+require 'io/console'
+require 'forwardable'
+
+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/percent_formatter'
+require 'tty/progressbar/total_formatter'
+
+module TTY
+  # Used for creating terminal progress bar
+  #
+  # @api public
+  class ProgressBar
+    extend Forwardable
+
+    ECMA_ESC = "\x1b"
+    ECMA_CSI = "\x1b["
+    ECMA_CHA = 'G'
+
+    DEC_RST = 'l'
+    DEC_SET = 'h'
+    DEC_TCEM = '?25'
+
+    attr_reader :format
+
+    attr_reader :total
+
+    attr_reader :width
+
+    attr_reader :no_width
+
+    attr_reader :current
+
+    attr_reader :start_at
+
+    attr_reader :complete
+
+    attr_reader :incomplete
+
+    attr_reader :hide_cursor
+
+    def_delegator :@pipeline, :use
+
+    # Create progress bar
+    #
+    # @param [String] format
+    #   the tokenized string that displays the output
+    #
+    # @param [Hash] options
+    # @option options [Numeric] :total
+    #   the total number of steps to completion
+    # @option options [Numeric] :width
+    #   the maximum width for the bars display including
+    #   all formatting options
+    # @option options [Boolean] :no_width
+    #   true when progression is unknown defaulting to false
+    # @option options [Boolean] :clear
+    #   whether or not to clear the progress line
+    # @option options [Boolean] :hide_cursor
+    #   display or hide cursor
+    # @option options [Object] :output
+    #   the object that responds to print call defaulting to stderr
+    # @option options [Number] :frequency
+    #   the frequency with which to display bars
+    #
+    # @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
+      @current           = 0
+      @readings          = 0
+      @last_render_time  = Time.now
+      @last_render_width = 0
+      @done              = false
+      @pipeline          = TTY::ProgressBar::Pipeline.new
+
+      default_pipeline
+      register_callbacks
+    end
+
+    # Advance the progress bar
+    #
+    # @param [Object|Number] progress
+    #
+    # @api public
+    def advance(progress = 1)
+      return if @done
+
+      @start_at = Time.now if @current.zero?
+      @readings += 1
+      @current  += progress
+
+      if !no_width && @current >= total
+        finish && return
+      end
+
+      now = Time.now
+      return if (now - @last_render_time) < @render_period
+      render
+    end
+
+    # Ratio of completed over total steps
+    #
+    # @return [Float]
+    #
+    # @api public
+    def ratio
+      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
+      now = Time.now
+
+      if @hide_cursor && @last_render_time == 0
+        write(ECMA_CSI + DEC_RST + DEC_TCEM)
+      end
+
+      # Setup formatting values
+      percent = width == 0 ? 100 : (ratio * 100).to_i
+      elapsed = (now - @start_at) * 1000.0
+      estimated = (percent == 100) ? 0 : elapsed * (total / @current - 1)
+
+      formatted = @pipeline.decorate(self, @format)
+      write(formatted, true)
+
+      @last_render_time = Time.now
+      @last_render_width = formatted.length
+    end
+
+    # Write out to the output
+    #
+    # @param [String] data
+    #
+    # @api private
+    def write(data, clear_first = false)
+      @output.print(ECMA_CSI + '1' + ECMA_CHA) if clear_first
+      @output.print(data)
+      @output.flush
+    end
+
+    # Resize progress bar with new configuration
+    #
+    # @api public
+    def resize(new_width)
+      fail 'Cannot resize finished progress bar' if @done
+
+      if new_width
+        @no_width = false
+        @width    = new_width
+      else
+        @no_width = true
+        @width    = 0
+      end
+
+      advance(0) # rerender with new configuration
+    end
+
+    # End the progress
+    #
+    # @api public
+    def finish
+      # reenable cursor if it is turned off
+      write(ECMA_CSI + DEC_RST + DEC_TCEM, false) if @hide_cursor
+      return if @done
+      @current = @width if @no_width
+      render
+      write("\n", false)
+      @done = true
+    end
+
+    # Terminates the progress bar
+    #
+    # @api public
+    def terminate
+      @done = true
+    end
+
+    private
+
+    # 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::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)
+
+      Signal.trap('KILL') { @terminate }
+    end
+  end # ProgressBar
+end # TTY

data/lib/tty-progressbar.rb

@@ -0,0 +1 @@
+require 'tty/progressbar'

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'timecop'
+require 'tty-progressbar'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/bar_formatter_spec.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'bar' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "animates bar" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
+    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/spec/unit/converter_spec.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar::Converter, '.to_time' do
+  subject(:converter) { described_class.new }
+
+  it "converts seconds to seconds" do
+    expect(converter.to_time(15)).to eq("15s")
+  end
+
+  it "converts seconds to minutes" do
+    expect(converter.to_time(100)).to eq(" 1m40s")
+  end
+
+  it "converts seconds to small hours" do
+    expect(converter.to_time(3600)).to eq(" 1h 0m")
+  end
+
+  it "converts secodns to hours" do
+    expect(converter.to_time(100 * 3600)).to eq("100h")
+  end
+end

data/spec/unit/current_formatter_spec.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'current' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "displays current value" do
+    progress = TTY::ProgressBar.new("|:current|", output: output, total: 10)
+    3.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G|1|",
+      "\e[1G|2|",
+      "\e[1G|3|"
+    ].join)
+  end
+end

data/spec/unit/custom_formatter_spec.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'custom' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "allows for custom tag" do
+    progress = TTY::ProgressBar.new(":hi", output: output, total: 10)
+
+    HiFormatter = Class.new do
+      def initialize(progress)
+        @progress = progress
+      end
+
+      def format(value)
+        value.gsub(/:hi/, "Hello")
+      end
+    end
+
+    progress.use(HiFormatter)
+    progress.advance
+    output.rewind
+    expect(output.read).to eq("\e[1GHello")
+  end
+end

data/spec/unit/elapsed_formatter_spec.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, '.new' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  before { Timecop.safe_mode = false }
+
+  it "displays elapsed time" do
+    time_now = Time.local(2014, 10, 5, 12, 0, 0)
+    Timecop.freeze(time_now)
+    progress = TTY::ProgressBar.new(":elapsed", output: output, total: 10)
+
+    5.times do |sec|
+      time_now = Time.local(2014, 10, 5, 12, 0, sec)
+      Timecop.freeze(time_now)
+      progress.advance
+    end
+
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G 0s",
+      "\e[1G 1s",
+      "\e[1G 2s",
+      "\e[1G 3s",
+      "\e[1G 4s"
+    ].join)
+    Timecop.return
+  end
+end

data/spec/unit/new_spec.rb

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, '.new' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "displays output where width == total" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.advance
+    output.rewind
+    expect(output.read).to eq("\e[1G[=         ]")
+  end
+
+  it "displays output where width > total" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5, width: 10)
+    5.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[==        ]",
+      "\e[1G[====      ]",
+      "\e[1G[======    ]",
+      "\e[1G[========  ]",
+      "\e[1G[==========]\n"
+    ].join)
+  end
+
+  it "displays output where width < total" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10, width: 5)
+    10.times { progress.advance }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[=    ]",
+      "\e[1G[=    ]",
+      "\e[1G[==   ]",
+      "\e[1G[==   ]",
+      "\e[1G[===  ]",
+      "\e[1G[===  ]",
+      "\e[1G[==== ]",
+      "\e[1G[==== ]",
+      "\e[1G[=====]",
+      "\e[1G[=====]\n"
+    ].join)
+  end
+
+  it "displays total value" do
+    progress = TTY::ProgressBar.new("|:total|", output: output, total: 10)
+    progress.advance(3)
+    output.rewind
+    expect(output.read).to eq("\e[1G|10|")
+  end
+end

data/spec/unit/percent_formatter_spec.rb

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

data/spec/unit/pipeline_spec.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar::Pipeline, '.decorate' do
+  subject(:pipeline) { described_class.new }
+
+  it "decorates tokenized string with pipeline formatters" do
+    pipeline.use TTY::ProgressBar::CurrentFormatter
+    pipeline.use TTY::ProgressBar::TotalFormatter
+    progress_bar = double(current: '3', total: '10')
+    tokenized = "[:current/:total]"
+    expect(pipeline.decorate(progress_bar, tokenized)).to eq("[3/10]")
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-progresbar')
+  ARGV.clear
+  IRB.start
+end

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-progressbar.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/progressbar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-progressbar"
+  spec.version       = TTY::ProgressBar::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+  spec.summary       = %q{A flexible progress bars drawing in terminal emulators.}
+  spec.description   = %q{A flexible progress bars drawing in terminal emulators.}
+  spec.homepage      = "https://github.com/peter-murach/tty-progressbar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: tty-progressbar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A flexible progress bars drawing in terminal emulators.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/simple.rb
+- lib/tty-progressbar.rb
+- lib/tty/progressbar.rb
+- lib/tty/progressbar/bar_formatter.rb
+- lib/tty/progressbar/converter.rb
+- lib/tty/progressbar/current_formatter.rb
+- lib/tty/progressbar/elapsed_formatter.rb
+- lib/tty/progressbar/percent_formatter.rb
+- lib/tty/progressbar/pipeline.rb
+- lib/tty/progressbar/total_formatter.rb
+- lib/tty/progressbar/version.rb
+- spec/spec_helper.rb
+- spec/unit/bar_formatter_spec.rb
+- spec/unit/converter_spec.rb
+- spec/unit/current_formatter_spec.rb
+- spec/unit/custom_formatter_spec.rb
+- spec/unit/elapsed_formatter_spec.rb
+- spec/unit/new_spec.rb
+- spec/unit/percent_formatter_spec.rb
+- spec/unit/pipeline_spec.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-progressbar.gemspec
+homepage: https://github.com/peter-murach/tty-progressbar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A flexible progress bars drawing in terminal emulators.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/bar_formatter_spec.rb
+- spec/unit/converter_spec.rb
+- spec/unit/current_formatter_spec.rb
+- spec/unit/custom_formatter_spec.rb
+- spec/unit/elapsed_formatter_spec.rb
+- spec/unit/new_spec.rb
+- spec/unit/percent_formatter_spec.rb
+- spec/unit/pipeline_spec.rb
+has_rdoc: