tty 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e81389b3c20540a552a4677e80c55307fb8964c
-  data.tar.gz: 10b70aa565b3bd550cbb7177826e3075ff47b9f8
+  metadata.gz: ad0efdc965bc3c933d7cb71d0bf75a5be2c3bf45
+  data.tar.gz: f4e7b12fbe37bce6cc467730a472112ca673ae36
 SHA512:
-  metadata.gz: 07691cae6416ce1edee73949c2088ce1be07ab2f764b8ca1c59af6e5d2c98a03efaad09a64171a87eba9152c507277bdc01ba91a024edfd28cecfad92f68aa7d
-  data.tar.gz: 4be98f8a15d2cf8a363b56c27d101c901a8f4091c24fe470a17350ec952d2b0ce1b2b143d2e887392f83d290a6ddfd6e2b5437e87307012a5f59e951d1a61601
+  metadata.gz: 0045cfb5de1675a6485681b047f6cf5e785e1758b6fca908bf84a943d199f8ed2e77ba8cb0239f8dc810f07cea551ae565b485849c395e1e9fa7ed1de62bcb79
+  data.tar.gz: 103f2d9010887f3b658f97f901df315deebe80f54248950818322477d0aea36f779a2ab93ce633c504f96491649feec324bce45d946402ebed729c81eabdd561

data/.travis.yml

@@ -2,9 +2,10 @@ language: ruby
 bundler_args: --without yard guard benchmarks
 script: "bundle exec rake ci"
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
   - ruby-head
   - rbx-2
   - jruby-19mode

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.1.3 (April 3, 2015)
+
+* Add table rendering as dependency on tty-table
+* Update tty-progressbar dependency
+
 0.1.2 (December 14, 2014)
 
 * Add Necromancer for type conversions

data/README.md

@@ -4,12 +4,15 @@
 [![Build Status](https://secure.travis-ci.org/peter-murach/tty.png?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/peter-murach/tty.png)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/peter-murach/tty/badge.png?branch=master)][coveralls]
-[![Inline docs](http://inch-ci.org/github/peter-murach/tty.png?branch=master)](http://inch-ci.org/github/peter-murach/tty)
+[![Inline docs](http://inch-ci.org/github/peter-murach/tty.png?branch=master)][inchpages]
+[![Gitter](https://badges.gitter.im/Join Chat.svg)][gitter]
 
 [gem]: http://badge.fury.io/rb/tty
 [travis]: http://travis-ci.org/peter-murach/tty
 [codeclimate]: https://codeclimate.com/github/peter-murach/tty
 [coveralls]: https://coveralls.io/r/peter-murach/tty
+[inchpages]: http://inch-ci.org/github/peter-murach/tty
+[gitter]: https://gitter.im/peter-murach/tty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
 
 > TTY is a toolbox for developing beautiful command line clients in Ruby. It provides a fluid interface for gathering input from the user, querying system and terminal and displaying information back. It is not another command line options parser, rather a plumbing library that helps in common tasks.
 
@@ -21,7 +24,7 @@ Even more so, any command line application needs a clear way of communicating it
 
 ## Features
 
-Jump-start development of your command line app:
+Fully modular, choose out of many components to suite your needs and jump-start development of your command line app:
 
 * Terminal ASCII and Unicode tables.       [status: ✔ ]
 * Terminal output colorization.            [status: ✔ ]
@@ -55,13 +58,6 @@ Or install it yourself as:
 ## Contents
 
 * [1. Table](#1-table)
-  * [1.1 Rendering](#11-rendering)
-  * [1.2 Multiline](#12-multiline)
-  * [1.3 Border](#13-border)
-  * [1.4 Alignment](#14-alignment)
-  * [1.5 Padding](#15-padding)
-  * [1.6 Filter](#16-filter)
-  * [1.7 Width](#17-width)
 * [2. Color](#2-color)
 * [3. ProgressBar](#3-progressbar)
 * [4. Spinner](#4-spinner)
@@ -79,8 +75,9 @@ To print tabular output use `TTY::Table`:
 
 ```ruby
 table = TTY::Table[['a1', 'a2', 'a3'], ['b1', 'b2', 'b3']]
-table.to_s   # => a1  a2  a3
-                  b1  b2  b3
+table.to_s
+# => a1  a2  a3
+     b1  b2  b3
 ```
 
 To colorize your strings use `Pastel`:
@@ -104,339 +101,79 @@ spinner = TTY::Spinner.new('Loading ... ', format: :spin_2)
 30.times { spinner.spin }
 ```
 
-## 1 Table
-
-To instantiate table pass 2-dimensional array:
-
-```ruby
-table = TTY::Table[['a1', 'a2'], ['b1', 'b2']]
-table = TTY::Table.new [['a1', 'a2'], ['b1', 'b2']]
-table = TTY::Table.new rows: [['a1', 'a2'], ['b1', 'b2']]
-table = TTY::Table.new ['h1', 'h2'], [['a1', 'a2'], ['b1', 'b2']]
-table = TTY::Table.new header: ['h1', 'h2'], rows: [['a1', 'a2'], ['b1', 'b2']]
-```
-
-or cross header with rows inside a hash like so
-
-```ruby
-table = TTY::Table.new [{'h1' => ['a1', 'a2'], 'h2' => ['b1', 'b2']}]
-```
-
-Table behaves like an Array so `<<`, `each` and familiar methods can be used
-
-```ruby
-table << ['a1', 'a2', 'a3']
-table << ['b1', 'b2', 'b3']
-table << ['a1', 'a2'] << ['b1', 'b2']  # chain rows assignment
-
-table.each { |row| ... }  # iterate over rows
-table.each_with_index     # iterate over each element with row and column index
-table[i, j]               # return element at row(i) and column(j)
-table.row(i) { ... }      # return array for row(i)
-table.column(j) { ... }   # return array for column(j)
-table.column(name)        # return array for column(name), name of header
-table.row_size            # return row size
-table.column_size         # return column size
-table.size                # return an array of [row_size, column_size]
-table.border              # specify border properties
-```
-
-or pass your rows in a block
-
-```ruby
-table = TTY::Table.new  do |t|
-  t << ['a1', 'a2', 'a3']
-  t << ['b1', 'b2', 'b3']
-end
-```
-
-#### 1.1 Rendering
-
-Once you have an instance of `TTY::Table` you can print it out to the stdout like so:
-
-```ruby
-table.to_s
-
-a1  a2  a3
-b1  b2  b3
-```
-
-This will use so called `basic` renderer with default options.
-
-However, you can include other customization options such as
-
-```ruby
-border         # hash of border properties out of :characters, :style, :separator keys
-border_class   # a type of border to use
-column_widths  # array of maximum columns widths
-column_aligns  # array of cell alignments out of :left, :center and :right, default :left
-filter         # a proc object that is applied to every field in a row
-indent         # indentation applied to rendered table
-multiline      # if true will wrap text at new line or column width,
-               # when false will escape special characters
-orientation    # either :horizontal or :vertical
-padding        # array of integers to set table fields padding
-renderer       # enforce display type out of :basic, :color, :unicode, :ascii
-resize         # if true will expand/shrink table column sizes to match the width,
-               # otherwise if false rotate table vertically
-width          # constrain the table total width, otherwise dynamically
-               # calculated from content and terminal size
-```
-
-#### 1.2 Multiline
-
-Renderer options may include `multiline` parameter. The `true` value will cause the table fields wrap at their natural line breaks or in case when the column widths are set the content will wrap.
-
-```ruby
-table = TTY::Table.new [ ["First", '1'], ["Multi\nLine\nContent", '2'], ["Third", '3']]
-table.render :ascii, multiline: true
-# =>
-  +-------+-+
-  |First  |1|
-  |Multi  |2|
-  |Line   | |
-  |Content| |
-  |Third  |3|
-  +-------+-+
-```
-
-When the `false` option is specified all the special characters will be escaped and if the column widths are set the content will be truncated like so
+To measure screen size use `TTY::Screen`:
 
 ```ruby
-table = TTY::Table.new [ ["First", '1'], ["Multiline\nContent", '2'], ["Third", '3']]
-table.render :ascii, multiline: false
-# =>
-  +------------------+-+
-  |First             |1|
-  |Multiline\nContent|2|
-  |Third             |3|
-  +------------------+-+
+screen = TTY::Screen.new
+screen.size     # => [51, 280]
+screen.width    # => 280
+screen.height   # => 51
 ```
 
-#### 1.3 Border
+## 1. Table
 
-To print border around data table you need to specify `renderer` type out of `basic`, `ascii`, `unicode`. By default `basic` is used. For instance, to output unicode border:
+**TTY** uses the [tty-table](https://github.com/peter-murach/tty-table) component in order to convert data into table and render as string output in tabular form. For example, to render data with ASCII border:
 
 ```ruby
-table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2']
-table.render :unicode
-# =>
-  ┌───────┬───────┐
-  │header1│header2│
-  ├───────┼───────┤
-  │a1     │a2     │
-  │b1     │b2     │
-  └───────┴───────┘
-```
-
-You can also create your own custom border by subclassing `TTY::Table::Border` and implementing the `def_border` method using internal DSL methods like so:
-
-```ruby
-class MyBorder < TTY::Table::Border
-  def_border do
-    left         '$'
-    center       '$'
-    right        '$'
-    bottom       ' '
-    bottom_mid   '*'
-    bottom_left  '*'
-    bottom_right '*'
-  end
-end
-```
-
-Next pass the border class to your table instance `render_with` method
-
-```ruby
-table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2']
-table.render_with MyBorder
-# =>
-  $header1$header2$
-  $a1     $a2     $
-  *       *       *
-```
-
-Finally, if you want to introduce slight modifications to the predefined border types, you can use table `border` helper like so
-
-```ruby
-table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2']
-table.render do |renderer|
-  renderer.border do
-    mid          '='
-    mid_mid      ' '
-  end
-end
-# =>
-  header1 header2
-  ======= =======
-  a1      a2
-  b1      b2
-```
-
-In addition to specifying border characters you can force table to render separator line on each row like:
-
-```ruby
-table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2']]
-table.render do |renderer|
-  renderer.border.separator = :each_row
-end
+table = TTY::Table.new ['header1','header2'], [['a1','a2'], ['b1','b2']]
+table.render(:ascii)
 # =>
   +-------+-------+
   |header1|header2|
   +-------+-------+
   |a1     |a2     |
-  +-------+-------+
   |b1     |b2     |
   +-------+-------+
 ```
 
-Also to change the display color of your border do:
+Please refer to [documentation](https://github.com/peter-murach/tty-table) for complete API.
 
-```ruby
-table.render do |renderer|
-  renderer.border.style = :red
-end
-```
-
-#### 1.4 Alignment
-
-All columns are left aligned by default. You can enforce per column alignment by passing `column_aligns` option like so
-
-```ruby
-rows = [['a1', 'a2'], ['b1', 'b2']
-table = TTY::Table.new rows: rows
-table.render column_aligns: [:center, :right]
-```
+## 2. Color
 
-To align a single column do
+In order to colorize your output **TTY** uses the [pastel](https://github.com/peter-murach/pastel) component like so:
 
 ```ruby
-table.align_column(1, :right)
-```
-
-If you require a more granular alignment you can align individual fields in a row by passing `align` option
-
-```ruby
-table = TTY::Table.new do |t|
-  t << ['a1', 'a2', 'a3']
-  t << ['b1', {:value => 'b2', :align => :right}, 'b3']
-  t << ['c1', 'c2', {:value => 'c3', :align => :center}]
-end
+pastel = Pastel.new
+pastel.red.on_green.bold 'text...'  # => red bold text on green background
 ```
 
-#### 1.5 Padding
-
-By default padding is not applied. You can add `padding` to table fields like so
+Please refer to [documentation](https://github.com/peter-murach/pastel) for complete API.
 
-```ruby
-header = ['Field', 'Type', 'Null', 'Key', 'Default', 'Extra']
-rows  = [['id', 'int(11)', 'YES', 'nil', 'NULL', '']]
-table = TTY::Table.new(header, rows)
-table.render { |renderer| renderer.padding= [0,1,0,1] }
-# =>
-  +-------+---------+------+-----+---------+-------+
-  | Field | Type    | Null | Key | Default | Extra |
-  +-------+---------+------+-----+---------+-------+
-  | id    | int(11) | YES  | nil | NULL    |       |
-  +-------+---------+------+-----+---------+-------+
-```
+## 3. ProgressBar
 
-or you can set specific padding using `right`, `left`, `top`, `bottom` helpers. However, when adding top or bottom padding a `multiline` option needs to be set to `true` to allow for rows to span multiple lines. For example
+In order to draw progress bar **TTY** uses the [tty-progressbar](https://github.com/peter-murach/tty-progressbar) component. For example, to render basic download bar do:
 
 ```ruby
-table.render { |renderer|
-  renderer.multiline = true
-  renderer.padding.top = 1
-}
-# =>
-  +-----+-------+----+---+-------+-----+
-  |     |       |    |   |       |     |
-  |Field|Type   |Null|Key|Default|Extra|
-  +-----+-------+----+---+-------+-----+
-  |     |       |    |   |       |     |
-  |id   |int(11)|YES |nil|NULL   |     |
-  +-----+-------+----+---+-------+-----+
+bar = TTY::ProgressBar.new("downloading [:bar]", total: 30)
+30.times { bar.advance }
 ```
 
-#### 1.6 Filter
-
-You can define filters that will modify individual table fields value before they are rendered. A filter can be a callable such as proc. Here's an example that formats
+Please refer to [documentation](https://github.com/peter-murach/tty-progressbar) for complete API.
 
-```ruby
-table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2']
-table.render do |renderer|
-  renderer.filter = Proc.new do |val, row_index, col_index|
-    if col_index == 1 and !(row_index == 0)
-      val.capitalize
-    else
-      val
-    end
-  end
-end
-# =>
-  +-------+-------+
-  |header1|header2|
-  +-------+-------+
-  |a1     |A2     |
-  +-------+-------+
-  |b1     |B2     |
-  +-------+-------+
-```
+## 4. Spinner
 
-To color even fields red on green background add filter like so
+**TTY** uses the [tty-spinner](https://github.com/peter-murach/tty-spinner) component to handle terminal spinning animation. For instance, to create a simple spinner do:
 
 ```ruby
-table.render do |renderer|
-  renderer.filter = proc do |val, row_index, col_index|
-    col_index % 2 == 1 ? TTY.color.set(val, :red, :on_green) : val
-  end
-end
+spinner = TTY::Spinner.new('Loading ... ', format: :spin_2)
+30.times { spinner.spin }
 ```
 
-#### 1.7 Width
-
-To control table's column sizes pass `width`, `resize` options. By default table's natural column widths are calculated from the content. If the total table width does not fit in terminal window then the table is rotated vertically to preserve content.
-
-The `resize` property will force the table to expand/shrink to match the terminal width or custom `width`. On its own the `width` property will not resize table but only enforce table vertical rotation if content overspills.
-
-```ruby
-header = ['h1', 'h2', 'h3']
-rows   = [['aaa1', 'aa2', 'aaaaaaa3'], ['b1', 'b2', 'b3']]
-table = TTY::Table.new header, rows
-table.render width: 80, resize: true
-# =>
-  +---------+-------+------------+
-  |h1       |h2     |h3          |
-  +---------+-------+------------+
-  |aaa1     |aa2    |aaaaaaa3    |
-  |b1       |b2     |b3          |
-  +---------+-------+------------+
-```
+Please refer to [documentation](https://github.com/peter-murach/tty-spinner) for complete API.
 
-## 2 Color
+## 5. Screen
 
-To colorize your output you can use **Pastel** like so:
+**TTY** uses the [tty-screen](https://github.com/peter-murach/tty-screen) component to measure the screen properties. For example to get screen size do:
 
 ```ruby
-pastel = Pastel.new
-pastel.red.on_green.bold 'text...'  # => red bold text on green background
+screen = TTY::Screen.new
+screen.size     # => [51, 280]
+screen.width    # => 280
+screen.height   # => 51
 ```
 
-Please refer to [documentation](https://github.com/peter-murach/pastel) for complete API.
-
-## 3. ProgressBar
-
-Please refer to [documentation](https://github.com/peter-murach/tty-progressbar) for complete API.
-
-## 4. Spinner
-
-Please refer to [documentation](https://github.com/peter-murach/tty-spinner) for complete API.
-
-## 5. Screen
-
 Please refer to [documentation](https://github.com/peter-murach/tty-screen) for complete API.
 
-
 ## 6 Terminal
 
 To read general terminal properties you can use on of the helpers
@@ -490,7 +227,7 @@ default    # default value used if none is provided
 echo       # turn echo on and off (default: true)
 mask       # mask characters i.e '****' (default: false)
 modify     # apply answer modification :upcase, :downcase, :trim, :chomp etc..
-range      # specify range '0-9', '0..9', '0...9' or negative '-1..-9'
+in         # specify range '0-9', '0..9', '0...9' or negative '-1..-9'
 validate   # regex against which stdin input is checked
 valid      # a list of expected valid options
 ```
@@ -533,8 +270,7 @@ read_keypress   # return the key pressed
 For example, if we wanted to ask a user for a single digit in given range
 
 ```ruby
-ask("Provide number in range: 0-9") do
-  range '0-9'
+ask("Provide number in range: 0-9").in('0-9') do
   on_error :retry
 end.read_int
 ```
@@ -587,4 +323,4 @@ TTY::System.editor.open('file path...')
 
 ## Copyright
 
-Copyright (c) 2012-2014 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2012-2015 Piotr Murach. See LICENSE for further details.

data/lib/tty/{text → shell}/distance.rb

@@ -1,38 +1,16 @@
 # encoding: utf-8
 
 module TTY
-  class Text
+  class Shell
     # A class responsible for string comparison
     class Distance
-      include Unicode
-
-      attr_reader :first
-
-      attr_reader :second
-
-      # Initalize a Distance
-      #
-      # @param [String] first
-      #   the first string for comparision
-      #
-      # @param [String] second
-      #  the second string for comparison
-      #
-      # @api private
-      def initialize(first, second, *args)
-        options = Utils.extract_options!(args)
-        @first  = first.to_s
-        @second = second.to_s
-        # TODO: add option to ignore case
-      end
-
       # Calculate the optimal string alignment distance
       #
-      # @api private
-      def distance
+      # @api public
+      def distance(first, second)
         distances = []
-        rows      = first.length
-        cols      = second.length
+        rows      = first.to_s.length
+        cols      = second.to_s.length
 
         0.upto(rows) do |index|
           distances << [index] + [0] * cols

data/lib/tty/shell/suggestion.rb

@@ -5,9 +5,11 @@ module TTY
   class Shell
     # A class representing a suggestion
     class Suggestion
-      # @api private
-      attr_reader :shell
-      private :shell
+      DEFAULT_INDENT = 8
+
+      SINGLE_TEXT    = 'Did you mean this?'
+
+      PLURAL_TEXT    = 'Did you mean one of these?'
 
       # Number of spaces
       #
@@ -24,17 +26,6 @@ module TTY
       # @api public
       attr_reader :plural_text
 
-      # Possible suggestions
-      #
-      # @api public
-      attr_reader :suggestions
-
-      DEFAULT_INDENT = 8
-
-      SINGLE_TEXT    = 'Did you mean this?'
-
-      PLURAL_TEXT    = 'Did you mean one of these?'
-
       # Initialize a Suggestion
       #
       # @api public
@@ -43,6 +34,7 @@ module TTY
         @single_text = options.fetch(:single_text) { SINGLE_TEXT }
         @plural_text = options.fetch(:plural_text) { PLURAL_TEXT }
         @suggestions = []
+        @comparator  = Distance.new
       end
 
       # Suggest matches out of possibile strings
@@ -63,6 +55,8 @@ module TTY
         evaluate
       end
 
+      private
+
       # Measure distances between messag and possibilities
       #
       # @param [String] message
@@ -76,7 +70,7 @@ module TTY
         distances = Hash.new { |hash, key| hash[key] = [] }
 
         possibilities.each do |possibility|
-          distances[Text.distance(message, possibility)] << possibility
+          distances[comparator.distance(message, possibility)] << possibility
         end
         distances
       end
@@ -90,17 +84,43 @@ module TTY
       # @api private
       def evaluate
         return suggestions if suggestions.empty?
-        suggestion = ''
         if suggestions.one?
-          suggestion << single_text + "\n"
-          suggestion << (' ' * indent + @suggestions.first)
+          build_single_suggestion
         else
-          suggestion << plural_text + "\n"
-          suggestion << suggestions.map do |sugest|
-            ' ' * indent + sugest
-          end.join("\n")
+          build_multiple_suggestions
         end
       end
+
+      # @api private
+      def build_single_suggestion
+        suggestion = ''
+        suggestion << single_text + "\n"
+        suggestion << (' ' * indent + suggestions.first)
+      end
+
+      # @api private
+      def build_multiple_suggestions
+        suggestion = ''
+        suggestion << plural_text + "\n"
+        suggestion << suggestions.map do |sugest|
+          ' ' * indent + sugest
+        end.join("\n")
+      end
+
+      # Distance comparator
+      #
+      # @api private
+      attr_reader :comparator
+
+      # Reference to the current shell
+      #
+      # @api private
+      attr_reader :shell
+
+      # Possible suggestions
+      #
+      # @api private
+      attr_reader :suggestions
     end # Suggestion
   end # Shell
 end # TTY

data/lib/tty/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module TTY
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end # TTY