Initial release.

.gitignore

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

.rspec

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

.ruby-version

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

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

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.

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.

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 ]

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

lib/tty-progressbar.rb

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