tty 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e76e7f5fabce92373a5d30470030bb32c3e385a2
-  data.tar.gz: e22d3ee873af12433ad048780519cdc7a25eccd6
+  metadata.gz: 07e4420225b26d591c5808c75a22345b74829df6
+  data.tar.gz: a409678307999ca35df8470451c18ee823de4899
 SHA512:
-  metadata.gz: 92d6818d1d61b3e1dc4c66b6e62f39e85e43c2c295a312487ac77b468723ede92a917a5fb421bb67975b04d2e416dbf19f913668854da736add9ad966796014f
-  data.tar.gz: cfed541bea516a36e8568b9bce380dd3667bc107ea56f37553f9cd0bad27094a4569f3a358b4b34242919b224e63c92c3bf7d09a8326d9f893cf9fead22fa0f4
+  metadata.gz: b2d142aa5bac867c62e8f3c21173a7855b3d4a18cc0c356d8939944871f87de6fa4fa0aa32770eaa20f0044ca380ee1a5f2097afd4479c80b61e153e32d37d37
+  data.tar.gz: 059ea6e8da18de39646be9da9cc3cc115b0fc89a2354bf3251e3ce6846a55beb7010863a82f92372a954af9d6a34a7c7bd2ba4c242f91a95956391e8461003a8

data/.travis.yml

@@ -5,20 +5,20 @@ cache: bundler
 bundler_args: --without yard guard benchmarks
 script: "bundle exec rake ci"
 rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.0
+  - 2.0.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
   - ruby-head
-  - rbx-2
-  - jruby-19mode
+  - jruby-9000
+  - jruby-head
+  - rbx-3
 matrix:
-  include:
-    - rvm: jruby-head
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: rbx-3
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log
 
+## [v0.6.0] - 2017-01-28
+
+### Added
+* Add tty-editor dependency
+* Add tty-file dependency
+
+### Changed
+* Change to use plugin system to load all tty dependencies
+* Remove coercion, delegatable & unicode support
+* Remove error types from TTY module namespace
+* Remove System::Editor
+* Remove Vector
+* Remove Logger
+* Remove Terminal & Terminal:Home
+
 ## [v0.5.0] - 2016-05-30
 
 ### Added
@@ -88,13 +103,15 @@
 * Improve method documentation across library
 * Semantic changes across library to improve code readability
 
-[v0.4.0]: https://github.com/peter-murach/tty/compare/v0.3.2...v0.4.0
-[v0.3.2]: https://github.com/peter-murach/tty/compare/v0.3.1...v0.3.2
-[v0.3.1]: https://github.com/peter-murach/tty/compare/v0.3.0...v0.3.1
-[v0.3.0]: https://github.com/peter-murach/tty/compare/v0.2.1...v0.3.0
-[v0.2.1]: https://github.com/peter-murach/tty/compare/v0.2.0...v0.2.1
-[v0.2.0]: https://github.com/peter-murach/tty/compare/v0.1.3...v0.2.0
-[v0.1.3]: https://github.com/peter-murach/tty/compare/v0.1.2...v0.1.3
-[v0.1.2]: https://github.com/peter-murach/tty/compare/v0.1.1...v0.1.2
-[v0.1.1]: https://github.com/peter-murach/tty/compare/v0.1.0...v0.1.1
-[v0.1.0]: https://github.com/peter-murach/tty/compare/v0.0.9...v0.1.0
+[v0.6.0]: https://github.com/piotrmurach/tty/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/piotrmurach/tty/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/tty/compare/v0.3.2...v0.4.0
+[v0.3.2]: https://github.com/piotrmurach/tty/compare/v0.3.1...v0.3.2
+[v0.3.1]: https://github.com/piotrmurach/tty/compare/v0.3.0...v0.3.1
+[v0.3.0]: https://github.com/piotrmurach/tty/compare/v0.2.1...v0.3.0
+[v0.2.1]: https://github.com/piotrmurach/tty/compare/v0.2.0...v0.2.1
+[v0.2.0]: https://github.com/piotrmurach/tty/compare/v0.1.3...v0.2.0
+[v0.1.3]: https://github.com/piotrmurach/tty/compare/v0.1.2...v0.1.3
+[v0.1.2]: https://github.com/piotrmurach/tty/compare/v0.1.1...v0.1.2
+[v0.1.1]: https://github.com/piotrmurach/tty/compare/v0.1.0...v0.1.1
+[v0.1.0]: https://github.com/piotrmurach/tty/compare/v0.0.9...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [email]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rspec',   '~> 3.4.0'
+  gem 'rspec',   '~> 3.5.0'
   gem 'yard',    '~> 0.8.7'
   gem 'timecop', '~> 0.7.1'
 end
@@ -12,7 +12,7 @@ group :metrics do
   gem 'coveralls', '~> 0.8.1'
   gem 'simplecov', '~> 0.10.0'
   gem 'yardstick', '~> 0.9.9'
-  gem 'reek',      '~> 1.3.7'
+  gem 'term-ansicolor', '=1.3.2'
 end
 
 group :benchmarks do

data/README.md

@@ -4,6 +4,7 @@
 <br/>
 [![Gem Version](https://badge.fury.io/rb/tty.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/tty.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/0a85w6yr40lmuo3o?svg=true)][appveyor]
 [![Code Climate](https://codeclimate.com/github/piotrmurach/tty/badges/gpa.svg)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/piotrmurach/tty/badge.svg?branch=master)][coveralls]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/tty.svg?branch=master)][inchpages]
@@ -11,6 +12,7 @@
 
 [gem]: http://badge.fury.io/rb/tty
 [travis]: http://travis-ci.org/piotrmurach/tty
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty
 [codeclimate]: https://codeclimate.com/github/piotrmurach/tty
 [coveralls]: https://coveralls.io/r/piotrmurach/tty
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty
@@ -26,29 +28,21 @@ Even more so, any command line application needs a clear way of communicating it
 
 ## Features
 
-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: ✔ ]
-* Terminal output paging.                  [status: ✔ ]
-* System detection utilities.              [status: ✔ ]
-* Command detection utilities.             [status: ✔ ]
-* Text manipulation(wrapping/truncation)   [status: ✔ ]
-* Terminal progress bars drawing.          [status: ✔ ]
-* Terminal spinners.                       [status: ✔ ]
-* Interactive prompt for user input.       [status: ✔ ]
-* File diffs.                              [status: TODO]
-* Configuration file management.           [status: TODO]
-* Logging                                  [status: In Progress]
-* Plugin ecosystem                         [status: TODO]
+* Jump-start development of your command line app the Unix way.
+* Fully modular, choose out of many [components](#2-components) to suite your needs.
+* All tty components are small packages that do one thing well.
 * Fully tested with major ruby interpreters.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile to install all components:
 
     gem 'tty'
 
+or install a particular component:
+
+    gem 'tty-*'
+
 And then execute:
 
     $ bundle
@@ -60,18 +54,7 @@ Or install it yourself as:
 ## Contents
 
 * [1. Overview](#1-overview)
-* [2. Prompting for input](#2-prompting-for-input)
-* [3. Drawing tables](#3-drawing-tables)
-* [4. Drawing progress bars](#4-drawing-progress-bars)
-* [5. Drawing spinners](#5-drawing-spinners)
-* [6. Output coloring](#6-output-coloring)
-* [7. Output paging](#7-output-paging)
-* [8. Detecting screen properties](#8-detecting-screen-properties)
-* [9. Detecting platform](#9-detecting-platform)
-* [10. Detecting color capabilities](#10-detecting-color-capabilities)
-* [11. Searching executables](#11-searching-executables)
-* [12. Moving cursor](#12-moving-cursor)
-* [13. Setting editor](#13-setting-editor)
+* [2. Components](#2-components)
 
 ## 1. Overview
 
@@ -131,112 +114,14 @@ pager = TTY::Pager.new
 pager.page('Very long text...')
 ```
 
-To measure screen size use `TTY::Screen`:
-
-```ruby
-screen = TTY::Screen.new
-screen.size     # => [51, 280]
-screen.width    # => 280
-screen.height   # => 51
-```
-
-`TTY::Color` allows you to check if terminal supports color:
-
-```ruby
-TTY::Color.supports?  # => true
-TTY::Color.mode # => 64
-```
-
-To move cursor around the terminal use `TTY::Cursor`:
-
-```ruby
-cursor = TTY::Cursor
-print cursor.up(5) + cursor.forward(2)
-```
-
-## 2. Prompting for input
-
-**TTY** relies on [tty-prompt](https://github.com/piotrmurach/tty-prompt#ttyprompt) component for processing user input.
+To run external commands with output logging, capturing stdout and stderr use `TTY::Command`:
 
 ```ruby
-prompt.ask('What is your name?', default: ENV['USER'])
-# => What is your name? (piotr)
+cmd = TTY::Command.new
+out, err = cmd.run('cat ~/.bashrc | grep alias')
 ```
 
-Please refer to [documentation](https://github.com/piotrmurach/tty-prompt#contents) for complete API.
-
-## 3. Drawing tables
-
-**TTY** uses the [tty-table](https://github.com/piotrmurach/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(:ascii)
-# =>
-  +-------+-------+
-  |header1|header2|
-  +-------+-------+
-  |a1     |a2     |
-  |b1     |b2     |
-  +-------+-------+
-```
-
-Please refer to [documentation](https://github.com/piotrmurach/tty-table) for complete API.
-
-## 4. Drawing progress bars
-
-In order to draw progress bars in terminal, **TTY** uses the [tty-progressbar](https://github.com/piotrmurach/tty-progressbar) component.
-
-For example, to render basic download bar do:
-
-```ruby
-bar = TTY::ProgressBar.new("downloading [:bar]", total: 30)
-30.times { bar.advance }
-```
-
-Please refer to [documentation](https://github.com/piotrmurach/tty-progressbar) for complete API.
-
-## 5. Drawing spinners
-
-**TTY** uses the [tty-spinner](https://github.com/piotrmurach/tty-spinner) component to handle terminal spinning animation. For instance, to create a simple spinner do:
-
-```ruby
-spinner = TTY::Spinner.new("[:spinner] Loading ...", format: :pulse_2)
-30.times { spinner.spin }
-spinner.stop('Done!')
-```
-
-Please refer to [documentation](https://github.com/piotrmurach/tty-spinner) for complete API.
-
-## 6. Output coloring
-
-In order to colorize strings, **TTY** uses the [pastel](https://github.com/piotrmurach/pastel) component:
-
-```ruby
-pastel = Pastel.new
-pastel.red.on_green.bold 'text...'  # => red bold text on green background
-```
-
-Please refer to [documentation](https://github.com/piotrmurach/pastel#contents) for complete API.
-
-## 7. Output paging
-
-To page terminal output **TTY** relies on [tty-pager](https://github.com/piotrmurach/tty-pager) component.
-
-For example to page terminal output do (on non unix systems falls back to ruby implementation):
-
-```ruby
-pager = TTY::Pager.new
-pager.page('Very long text...')
-```
-
-Please refer to [documentation](https://github.com/piotrmurach/tty-pager) for complete API.
-
-## 8. Detecting screen properties
-
-**TTY** uses the [tty-screen](https://github.com/piotrmurach/tty-screen) component to measure the screen properties.
-
-For example to get screen size do:
+To measure screen size use `TTY::Screen`:
 
 ```ruby
 screen = TTY::Screen.new
@@ -245,84 +130,57 @@ screen.width    # => 280
 screen.height   # => 51
 ```
 
-Please refer to [documentation](https://github.com/piotrmurach/tty-screen) for complete API.
-
-## 9. Detecting platform
-
-To check for platform properties **TTY** uses [tty-platform](https://github.com/piotrmurach/tty-platform) component.
-
-```ruby
-platform = TTY::Platform.new
-platform.cpu     # => 'x86_64'
-platform.os      # => 'darwin'
-platform.version # => '10.6.1'
-```
-
-In addition, there are more generic utilities to check for type of operating system:
-
-```
-TTY::Platform.unix?    # => true
-TTY::Platform.windows? # => false
-```
-
-Please refer to [documentation](https://github.com/piotrmurach/tty-platform) for complete API.
-
-## 10. Detecting color capabilities
-
-[tty-color](https://github.com/piotrmurach/tty-color) component allows **TTY** detect color support and mode in terminal emulator:
+`TTY::Color` allows you to check if terminal supports color and the color mode:
 
 ```ruby
 TTY::Color.supports?  # => true
 TTY::Color.mode # => 64
 ```
 
-Please refer to [documentation](https://github.com/piotrmurach/tty-color) for complete API.
-
-## 11. Searching executables
-
-To find executable path **TTY** uses [tty-which](https://github.com/piotrmurach/tty-which#ttywhich) component.
-
 For instance, to find out if `less` utility is actually supported by the system do:
 
 ```ruby
 TTY::Which.which('less')  # => '/usr/bin/less'
 ```
 
-Please refer to [documentation](https://github.com/piotrmurach/tty-which#ttywhich) for complete API.
-
-## 12. Moving cursor
-
-To perform terminal cursor movements use [tty-cursor](https://github.com/piotrmurach/tty-cursor#ttycursor) component.
-
-For example, to move cursor up by 5 rows and forward by 2 columns:
+To move cursor around the terminal use `TTY::Cursor`:
 
 ```ruby
 cursor = TTY::Cursor
 print cursor.up(5) + cursor.forward(2)
 ```
 
-Please refer to [documentation](https://github.com/piotrmurach/tty-cursor#contents) for complete API.
-
-## 13. Setting editor
-
-```ruby
-TTY::System.editor.command('vim')
-```
-
-To open a file in your editor of choice do
-
-```ruby
-TTY::System.editor.open('file path...')
-```
+## 2. Components
+
+|  Component   | Description | API docs |
+| ------------ | ----------- | -------- |
+| [pastel](https://github.com/piotrmurach/pastel) | Terminal strings styling with intuitive and clean API. | [docs](http://www.rubydoc.info/gems/pastel) |
+| [tty-color](https://github.com/piotrmurach/tty-color) | Terminal color capabilities detection. | [docs](http://www.rubydoc.info/gems/tty-color) |
+| [tty-command](https://github.com/piotrmurach/tty-command) | Execute shell commands with pretty logging and capture stdout, stderr and exit status. | [docs](http://www.rubydoc.info/gems/tty-command) |
+| [tty-cursor](https://github.com/piotrmurach/tty-cursor) | Move terminal cursor around. | [docs](http://www.rubydoc.info/gems/tty-cursor) |
+| [tty-editor](https://github.com/piotrmurach/tty-editor) | Open a file or text in the user preferred editor. | [docs](http://www.rubydoc.info/gems/tty-editor) |
+| [tty-file](https://github.com/piotrmurach/tty-file) | File manipulation utility methods. | [docs](http://www.rubydoc.info/gems/tty-file) |
+| [tty-pager](https://github.com/piotrmurach/tty-pager) | Terminal output paging in a cross-platform way. | [docs](http://www.rubydoc.info/gems/tty-pager) |
+| [tty-platform](https://github.com/piotrmurach/tty-platform) | Detecting different operating systems. | [docs](http://www.rubydoc.info/gems/tty-platform) |
+| [tty-progressbar](https://github.com/piotrmurach/tty-progressbar) | A flexible progress bars drawing in terminal emulators. | [docs](http://www.rubydoc.info/gems/tty-progressbar) |
+| [tty-prompt](https://github.com/piotrmurach/tty-prompt) | A beautiful and powerful interactive command line prompt. | [docs](http://www.rubydoc.info/gems/tty-prompt) |
+| [tty-screen](https://github.com/piotrmurach/tty-screen) | Terminal screen properties detection. | [docs](http://www.rubydoc.info/gems/tty-screen)
+| [tty-spinner](https://github.com/piotrmurach/tty-spinner) | A terminal spinner for tasks with non-deterministic time.| [docs](http://www.rubydoc.info/gems/tty-spinner) |
+| [tty-table](https://github.com/piotrmurach/tty-table) | A flexible and intuitive table output generator. | [docs](http://www.rubydoc.info/gems/tty-table) |
+| [tty-which](https://github.com/piotrmurach/tty-which) | Platform independent implementation of Unix which command. | [docs](http://www.rubydoc.info/gems/tty-which) |
 
 ## Contributing
 
+You can contribute by posting `feature requests`, evaluating the APIs or simply by hacking on TTY components:
+
 1. Fork it
 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 new Pull Request
 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
 ## Copyright
 
-Copyright (c) 2012-2016 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2012-2017 Piotr Murach. See LICENSE for further details.