tty 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff8d55e968e3331ebf153894ccbf0a049298bc6
-  data.tar.gz: 5cfbe8e57e25a74cb855e1501ce3c18c0a7b16b2
+  metadata.gz: fa48f582822f503a5f6baabe338a3cde4fa5a75c
+  data.tar.gz: c65742283bfea4e4389b2b8efb311a149b106bd7
 SHA512:
-  metadata.gz: cb5e763c659e1b78d82e179e4a25df354b7ab9939d99effe637044d5e27e0b9400025bb2bae37eeb9e350ae1f176a6b2b4227224f467d8ba8a6236cb67a80bbc
-  data.tar.gz: 138c0a16a982220b62b0859bbf19bef558e3a14978cbd1dcd3a57d7b706541cbafed1ffc2d6867c8c36797de30dd273a468d270c55d9268ae25d2a4694abc176
+  metadata.gz: c2f866d26af71516c644c099d4cf799acf70bb86c1f8abaa4621b9c97257c8d0f4be3b53700a1ebfe43e58b32f80754101db4e5fb296766ee6d18393f829c23d
+  data.tar.gz: 7b02be106e54c2885b85a7731bdea9d143214f7eeb288db5285d30015d70fc9085c438a799de9339ceb4f8b46dfb01e8f92fa0a454ba725b46772409e3211699

data/.travis.yml

@@ -6,20 +6,18 @@ rvm:
   - 2.0.0
   - 2.1.0
   - ruby-head
+  - rbx-2
 matrix:
   include:
     - rvm: jruby-19mode
     - rvm: jruby-20mode
     - rvm: jruby-21mode
     - rvm: jruby-head
-    - rvm: rbx-2
   allow_failures:
     - rvm: jruby-20mode
     - rvm: jruby-21mode
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx
-    - rvm: rbx-2
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.1.1 (November 23, 2014)
+
+* Add TTY::ProgressBar
+* Add TTY::Spinner
+* Remove TTY::Terminal::Color and replace with Pastel
+* Change to depend on Equatable library
+* Change to depend on TTY::Screen library for screen size detection
+
 0.1.0 (21 September, 2014)
 
 * Simplify development dependency mangement

data/README.md

@@ -4,13 +4,14 @@
 [![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)
 
 [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
 
-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.
+> 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.
 
 ## Motivation
 
@@ -22,19 +23,20 @@ Even more so, any command line application needs a clear way of communicating it
 
 Jump-start development of your command line app:
 
-* Table rendering with an easy-to-use API. [status: ✔ ]
+* Terminal ASCII and Unicode tables.       [status: ✔ ]
 * Terminal output colorization.            [status: ✔ ]
 * Terminal output paging.                  [status: ✔ ]
-* System & command detection utilities.    [status: ✔ ]
+* System detection utilities.              [status: ✔ ]
+* Command detection utilities.             [status: ✔ ]
 * Text manipulation(wrapping/truncation)   [status: ✔ ]
-* Shell user interface.                    [status: In Progress]
+* Terminal progress bars drawing.          [status: ✔ ]
+* Terminal spinners.                       [status: ✔ ]
+* Prompt user interface.                   [status: In Progress]
 * File diffs.                              [status: TODO]
-* Progress bar.                            [status: TODO]
 * Configuration file management.           [status: TODO]
 * Logging                                  [status: In Progress]
 * Plugin ecosystem                         [status: TODO]
 * Fully tested with major ruby interpreters.
-* No dependencies to allow for easy gem vendoring.
 
 ## Installation
 
@@ -60,15 +62,49 @@ Or install it yourself as:
   * [1.5 Padding](#15-padding)
   * [1.6 Filter](#16-filter)
   * [1.7 Width](#17-width)
-* [2. Terminal](#2-terminal)
-  * [2.1 Color](#21-color)
-  * [2.2 Pager](#22-pager)
-* [3. Shell](#3-shell)
-* [4. System](#4-system)
+* [2. Color](#2-color)
+* [3. ProgressBar](#3-progressbar)
+* [4. Spinner](#4-spinner)
+* [5. Screen](#5-screen)
+* [6. Terminal](#6-terminal)
+  * [6.1 Pager](#61-pager)
+* [7. Shell](#7-shell)
+* [8. System](#8-system)
 
 ## Usage
 
-### 1 Table
+**TTY** provides you with many tools to get the job done in terminal.
+
+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
+```
+
+To colorize your strings use `Pastel`:
+
+```ruby
+pastel = Pastel.new
+pastel.green.on_red.bold('Piotr')
+```
+
+To create a progress bar use `TTY::ProgressBar`:
+
+```ruby
+bar = TTY::ProgressBar.new("downloading [:bar]", total: 30)
+30.times { bar.advance }
+```
+
+To create a spinner use `TTY::Spinner`:
+
+```ruby
+spinner = TTY::Spinner.new('Loading ... ', format: :spin_2)
+30.times { spinner.spin }
+```
+
+## 1 Table
 
 To instantiate table pass 2-dimensional array:
 
@@ -293,7 +329,7 @@ end
 By default padding is not applied. You can add `padding` to table fields like so
 
 ```ruby
-heaer = ['Field', 'Type', 'Null', 'Key', 'Default', 'Extra']
+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] }
@@ -377,45 +413,41 @@ table.render width: 80, resize: true
   +---------+-------+------------+
 ```
 
-### 2 Terminal
+## 2 Color
 
-To read general terminal properties you can use on of the helpers
+To colorize your output you can use **Pastel** like so:
 
 ```ruby
-term = TTY::Terminal.new
-term.width              # => 140
-term.height             # =>  60
-term.color?             # => true or false
-term.echo(false) { }    # switch off echo for the block
-term.page               # page terminal output, on non unix systems falls back to ruby implementation
+pastel = Pastel.new
+pastel.red.on_green.bold 'text...'  # => red bold text on green background
 ```
 
-#### 2.1 Color
+Please refer to [documentation](https://github.com/peter-murach/pastel) for complete API.
 
-To colorize your output do
+## 3. ProgressBar
 
-```ruby
-term.color.set 'text...', :bold, :red, :on_green    # => red bold text on green background
-term.color.remove 'text...'       # strips off ansi escape sequences
-term.color.code :red              # ansi escape code for the supplied color
-```
+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
 
-Available colors are:
+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
 
 ```ruby
-black
-red
-green
-yellow
-blue
-magenta
-cyan
-white
+term = TTY::Terminal.new
+term.echo(false) { }    # switch off echo for the block
+term.page               # page terminal output, on non unix systems falls back to ruby implementation
 ```
 
-To supply background color simply prefix it with `on_`. For example a green background would be `on_green`.
-
-#### 2.2 Pager
+### 6.1 Pager
 
 To page your output do
 
@@ -423,7 +455,7 @@ To page your output do
 term.page 'long text...'
 ```
 
-### 3 Shell
+## 7 Shell
 
 Main responsibility is to interact with the prompt and provide convenience methods.
 
@@ -522,7 +554,7 @@ shell.suggest('sta', ['stage', 'stash', 'commit', 'branch'])
           stash
 ```
 
-### 4 System
+## 8 System
 
 ```ruby
 TTY::System.unix?        # check if unix platform

data/lib/tty.rb

@@ -1,12 +1,17 @@
 # encoding: utf-8
 
+require 'equatable'
+require 'pastel'
+require 'tty-screen'
+require 'tty-spinner'
+require 'tty-progressbar'
+
 require 'tty/version'
 
+require 'tty/conversion'
 require 'tty/support/utils'
 require 'tty/support/delegatable'
-require 'tty/support/conversion'
 require 'tty/support/coercion'
-require 'tty/support/equatable'
 require 'tty/support/unicode'
 
 require 'tty/terminal'
@@ -15,17 +20,11 @@ require 'tty/table'
 require 'tty/text'
 require 'tty/vector'
 require 'tty/shell'
-require 'tty/coercer'
 require 'tty/logger'
 require 'tty/plugins'
 
 require 'tty/plugins/plugin'
 
-require 'tty/coercer/range'
-require 'tty/coercer/integer'
-require 'tty/coercer/float'
-require 'tty/coercer/boolean'
-
 require 'tty/shell/response_delegation'
 require 'tty/shell/question'
 require 'tty/shell/question/validation'
@@ -35,7 +34,6 @@ require 'tty/shell/suggestion'
 require 'tty/shell/reader'
 require 'tty/shell/response'
 
-require 'tty/terminal/color'
 require 'tty/terminal/echo'
 require 'tty/terminal/home'
 require 'tty/terminal/pager'

data/lib/tty/conversion.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module TTY
+  module Conversion
+    TypeError = Class.new(StandardError)
+
+    # Raised when cannot conver to a given type
+    NoTypeConversionAvailable = Class.new(StandardError)
+  end
+end
+
+require 'tty/conversion/converter/array'
+require 'tty/conversion/converter/boolean'
+require 'tty/conversion/converter/float'
+require 'tty/conversion/converter/integer'
+require 'tty/conversion/converter/range'

data/lib/tty/conversion/converter/array.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module TTY
+  module Conversion
+    class ArrayConverter
+
+      attr_reader :target
+
+      attr_reader :source
+
+      def initialize(source = String)
+        @source = source
+        @target = Array
+      end
+
+      # @api public
+      def convert(value, copy = false)
+        case value
+        when Array
+          copy ? value.dup : value
+        when Hash
+          Array(value)
+        else
+          begin
+            converted = value.to_ary
+          rescue Exception => e
+            raise TTY::TypeError,
+                  "Cannot convert #{value.class} into an Array (#{e.message})"
+          end
+          converted
+        end
+      end
+    end # ArrayConverter
+  end # Conversion
+end # TTY

data/lib/tty/{coercer → conversion/converter}/boolean.rb

@@ -1,10 +1,23 @@
 # encoding: utf-8
 
 module TTY
-  class Coercer
-    # A class responsible for boolean type coercion
-    class Boolean
-      # Coerce value to boolean type including range of strings such as
+  module Conversion
+    class BooleanConverter
+
+      attr_reader :target
+
+      attr_reader :source
+
+      def initialize(source = String)
+        @source = source
+        @target = [TrueClass, FalseClass]
+      end
+
+      def boolean?(value)
+        target.any? { |klass| value.is_a?(klass) }
+      end
+
+      # Convert value to boolean type including range of strings such as
       #
       # @param [Object] value
       #
@@ -21,7 +34,7 @@ module TTY
       #    0, f, F, FALSE, false, False, n, N, No,  no,  No
       #
       # @api public
-      def self.coerce(value)
+      def convert(value)
         case value.to_s
         when /^(yes|y|t(rue)?|1)$/i
           return true
@@ -31,6 +44,6 @@ module TTY
           fail TypeError, "Expected boolean type, got #{value}"
         end
       end
-    end # Boolean
-  end # Coercer
+    end # BooleanConverter
+  end # Conversion
 end # TTY

data/lib/tty/conversion/converter/float.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module TTY
+  module Conversion
+    class FloatConverter
+
+      attr_reader :target
+
+      attr_reader :source
+
+      def initialize(source = String)
+        @source = source
+        @target = Float
+      end
+
+      # @api public
+      def convert(value, strict = false)
+        Kernel.send(target.name.to_sym, value.to_s)
+      rescue
+        if strict
+          raise InvalidArgument, "#{value} could not be coerced into #{target.name}"
+        else
+          value.to_f
+        end
+      end
+    end # IntegerConverter
+  end # Conversion
+end # TTY

data/lib/tty/conversion/converter/integer.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module TTY
+  module Conversion
+    class IntegerConverter
+
+      attr_reader :target
+
+      attr_reader :source
+
+      def initialize(source = String)
+        @source = source
+        @target = Integer
+      end
+
+      # @api public
+      def convert(value, strict = false)
+        Kernel.send(target.name.to_sym, value.to_s)
+      rescue
+        if strict
+          raise InvalidArgument, "#{value} could not be coerced into #{target.name}"
+        else
+          value.to_i
+        end
+      end
+    end # IntegerConverter
+  end # Conversion
+end # TTY

data/lib/tty/{coercer → conversion/converter}/range.rb

@@ -1,10 +1,19 @@
 # encoding: utf-8
 
 module TTY
-  class Coercer
-    # A class responsible for range type coercion
-    class Range
-      # Coerce value to Range type with possible ranges
+  module Conversion
+    class RangeConverter
+
+      attr_reader :target
+
+      attr_reader :source
+
+      def initialize(source = String)
+        @source = source
+        @target = Range
+      end
+
+      # Convert value to Range type with possible ranges
       #
       # @param [Object] value
       #
@@ -15,7 +24,7 @@ module TTY
       #   coerce('0-9')  # => (0..9)
       #
       # @api public
-      def self.coerce(value)
+      def convert(value)
         case value.to_s
         when /\A(\-?\d+)\Z/
           ::Range.new($1.to_i, $1.to_i)
@@ -27,6 +36,6 @@ module TTY
           fail InvalidArgument, "#{value} could not be coerced into Range type"
         end
       end
-    end # Range
-  end # Coercer
+    end # RangeConverter
+  end # Conversion
 end # TTY