tty 0.0.11 → 0.1.0

checksums.yaml

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

data/.rspec

@@ -1,3 +1,4 @@
 --color
 --format progress
 --order random
+--warnings

data/.ruby-gemset

@@ -0,0 +1 @@
+tty

data/.ruby-version

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

data/.travis.yml

@@ -1,16 +1,25 @@
 language: ruby
-before_install:
-  - gem install bundler
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci"
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - ruby-head
-  - jruby-19mode
-  - rbx-19mode
-  - jruby-head
-  - rbx-head
 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-head
+    - rvm: rbx
+    - rvm: rbx-2
+  fast_finish: true
+branches:
+  only: master

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+0.1.0 (21 September, 2014)
+
+* Simplify development dependency mangement
+* Update test suite to the latest RSpec
+* Improve method documentation across library
+* Semantic changes across library to improve code readability

data/Gemfile

@@ -1,4 +1,21 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in tty.gemspec
 gemspec
+
+group :development do
+  gem 'rake',    '~> 10.1.0'
+  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'
+  gem 'reek',      '~> 1.3.7'
+end
+
+group :benchmarks do
+  gem 'benchmark_suite', '~> 1.0.0'
+end

data/README.md

@@ -1,4 +1,5 @@
-# TTY
+# [![Application icon](https://github.com/peter-murach/tty/raw/master/images/tty.png)][icon]
+[icon]: http://peter-murach.github.io/tty/
 [![Gem Version](https://badge.fury.io/rb/tty.png)][gem]
 [![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]
@@ -9,17 +10,23 @@
 [codeclimate]: https://codeclimate.com/github/peter-murach/tty
 [coveralls]: https://coveralls.io/r/peter-murach/tty
 
-Toolbox for developing CLI clients in Ruby. This library provides a fluid interface for working with terminals.
+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
+
+All too often libraries that interact with command line create their own interface logic that gathers input from users and displays information back. Many times utility files are created that contain methods for reading system or terminal properties. Shouldn't we focus our energy on building the actual client?
+
+Even more so, any command line application needs a clear way of communicating its results back to terminal whether in tabular form, column form or colorfully indented text. Our time and energy should be spent in creating the tools not the foundation.
 
 ## Features
 
 Jump-start development of your command line app:
 
-* Table rendering with an easy-to-use API. [status: In Progress]
+* Table rendering with an easy-to-use API. [status: ✔ ]
 * Terminal output colorization.            [status: ✔ ]
 * Terminal output paging.                  [status: ✔ ]
-* System & command detection utilities.    [status: In Progress]
-* Text manipulation(wrapping/truncation)   [status: In Progress]
+* System & command detection utilities.    [status: ✔ ]
+* Text manipulation(wrapping/truncation)   [status: ✔ ]
 * Shell user interface.                    [status: In Progress]
 * File diffs.                              [status: TODO]
 * Progress bar.                            [status: TODO]
@@ -43,9 +50,25 @@ Or install it yourself as:
 
     $ gem install tty
 
+## 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. Terminal](#2-terminal)
+  * [2.1 Color](#21-color)
+  * [2.2 Pager](#22-pager)
+* [3. Shell](#3-shell)
+* [4. System](#4-system)
+
 ## Usage
 
-### Table
+### 1 Table
 
 To instantiate table pass 2-dimensional array:
 
@@ -91,9 +114,9 @@ table = TTY::Table.new  do |t|
 end
 ```
 
-#### Rendering
+#### 1.1 Rendering
 
-Once you have an instance of `TTY::Table` you can print it out to the stdout by doing:
+Once you have an instance of `TTY::Table` you can print it out to the stdout like so:
 
 ```ruby
 table.to_s
@@ -124,7 +147,7 @@ width          # constrain the table total width, otherwise dynamically
                # calculated from content and terminal size
 ```
 
-#### Multiline
+#### 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.
 
@@ -154,7 +177,7 @@ table.render :ascii, multiline: false
   +------------------+-+
 ```
 
-#### Border
+#### 1.3 Border
 
 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:
 
@@ -239,7 +262,7 @@ table.render do |renderer|
 end
 ```
 
-#### Alignment
+#### 1.4 Alignment
 
 All columns are left aligned by default. You can enforce per column alignment by passing `column_aligns` option like so
 
@@ -265,7 +288,7 @@ table = TTY::Table.new do |t|
 end
 ```
 
-#### Padding
+#### 1.5 Padding
 
 By default padding is not applied. You can add `padding` to table fields like so
 
@@ -299,7 +322,7 @@ table.render { |renderer|
   +-----+-------+----+---+-------+-----+
 ```
 
-#### Filter
+#### 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
 
@@ -334,7 +357,7 @@ table.render do |renderer|
 end
 ```
 
-#### Width
+#### 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.
 
@@ -354,7 +377,7 @@ table.render width: 80, resize: true
   +---------+-------+------------+
 ```
 
-### Terminal
+### 2 Terminal
 
 To read general terminal properties you can use on of the helpers
 
@@ -367,6 +390,8 @@ term.echo(false) { }    # switch off echo for the block
 term.page               # page terminal output, on non unix systems falls back to ruby implementation
 ```
 
+#### 2.1 Color
+
 To colorize your output do
 
 ```ruby
@@ -390,13 +415,15 @@ white
 
 To supply background color simply prefix it with `on_`. For example a green background would be `on_green`.
 
+#### 2.2 Pager
+
 To page your output do
 
 ```ruby
 term.page 'long text...'
 ```
 
-### Shell
+### 3 Shell
 
 Main responsibility is to interact with the prompt and provide convenience methods.
 
@@ -424,16 +451,16 @@ answer = shell.ask("What is your name?").read_string
 The library provides small DSL to help with parsing and asking precise questions
 
 ```ruby
-argument    # :required or :optional
-character   # turn character based input, otherwise line (default: false)
-clean       # reset question
-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'
-validate    # regex against which stdin input is checked
-valid       # a list of expected valid options
+argument   # :required or :optional
+char       # turn character based input, otherwise line (default: false)
+clean      # reset question
+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'
+validate   # regex against which stdin input is checked
+valid      # a list of expected valid options
 ```
 
 You can chain question methods or configure them inside a block
@@ -495,7 +522,7 @@ shell.suggest('sta', ['stage', 'stash', 'commit', 'branch'])
           stash
 ```
 
-### System
+### 4 System
 
 ```ruby
 TTY::System.unix?        # check if unix platform
@@ -527,4 +554,4 @@ TTY::System.editor.open('file path...')
 
 ## Copyright
 
-Copyright (c) 2012-2013 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2012-2014 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -1,12 +1,8 @@
-# -*- encoding: utf-8 -*-
-$:.unshift File.expand_path('../lib', __FILE__)
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# encoding: utf-8
 
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
+require "bundler/gem_tasks"
 
-FileList['tasks/**/*.rake'].each { |task| import task }
+FileList['tasks/**/*.rake'].each(&method(:import))
 
-task :default => [:spec]
+desc 'Run all specs'
+task ci: %w[ spec ]

data/lib/tty.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'tty/version'
 
@@ -115,7 +115,12 @@ module TTY
   EMPTY_ARRAY = Array.new.freeze
 
   class << self
+    def included(base)
+      base.send :extend, ClassMethods
+    end
+  end
 
+  module ClassMethods
     # Return shared terminal instance
     #
     # @return [TTY::Terminal]
@@ -153,4 +158,5 @@ module TTY
     end
   end
 
+  extend ClassMethods
 end # TTY

data/lib/tty/coercer/boolean.rb

@@ -1,11 +1,9 @@
-# -*- encoding: utf-8 -*-
+# 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
       #
       # @param [Object] value
@@ -16,7 +14,8 @@ module TTY
       #   other values coerced to true are:
       #     1, t, T, TRUE,  true,  True,  y, Y, YES, yes, Yes
       #
-      #  coerce("False") # => false
+      # @example
+      #   coerce("False") # => false
       #
       #  other values coerced to false are:
       #    0, f, F, FALSE, false, False, n, N, No,  no,  No
@@ -24,16 +23,14 @@ module TTY
       # @api public
       def self.coerce(value)
         case value.to_s
-        when %r/^(yes|y|t(rue)?|1)$/i
+        when /^(yes|y|t(rue)?|1)$/i
           return true
-        when %r/^(no|n|f(alse)?|0)$/i
+        when /^(no|n|f(alse)?|0)$/i
           return false
         else
-          raise TypeError, "Expected boolean type, got #{value}"
+          fail TypeError, "Expected boolean type, got #{value}"
         end
       end
-
     end # Boolean
-
   end # Coercer
 end # TTY

data/lib/tty/coercer/float.rb

@@ -1,23 +1,20 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Coercer
-
-      class Float
-
-        def self.coerce(value, strict=true)
-          begin
-            Kernel.send(:Float, value.to_s)
-          rescue
-            if strict
-              raise InvalidArgument, "#{value} could not be coerced into Float"
-            else
-              value.to_f
-            end
-          end
+    # Coerce values into float number
+    #
+    # @api public
+    class Float
+      def self.coerce(value, strict = true)
+        Kernel.send(:Float, value.to_s)
+      rescue
+        if strict
+          raise InvalidArgument, "#{value} could not be coerced into Float"
+        else
+          value.to_f
         end
-
-      end # Float
-
+      end
+    end # Float
   end # Coercer
 end # TTY

data/lib/tty/coercer/integer.rb

@@ -1,23 +1,20 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Coercer
-
-      class Integer
-
-        def self.coerce(value, strict=true)
-          begin
-            Kernel.send(:Integer, value.to_s)
-          rescue
-            if strict
-              raise InvalidArgument, "#{value} could not be coerced into Integer"
-            else
-              value.to_i
-            end
-          end
+    # Coerce value into integer number
+    #
+    # @api public
+    class Integer
+      def self.coerce(value, strict = true)
+        Kernel.send(:Integer, value.to_s)
+      rescue
+        if strict
+          raise InvalidArgument, "#{value} could not be coerced into Integer"
+        else
+          value.to_i
         end
-
-      end # Integer
-
+      end
+    end # Integer
   end # Coercer
 end # TTY