tty 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e168e711989d7450e4ab6ab08d745b056228ef3d
-  data.tar.gz: 314f1c8e75411f3654306a22a5dde7ab1ab2e444
+  metadata.gz: aa562e7fbc18bbf508315687b7ff78d6fcc48065
+  data.tar.gz: 010a69a34e11b44425161db72f4faadf64e28a04
 SHA512:
-  metadata.gz: 914a13c08433506b4d726a844cf12187e4553c348ada2383b7aaf90deadad41c4f2aba071a60a17678a649634f65a27f2c5fba9ec2dc9e2529c3b112f898a196
-  data.tar.gz: f0fd1747bff7318467d15e423e21549715c51258192b7e0259e1c23cbdf8f2e745f38c77810ae3b8b9ae77029a65e7db6966a7baaf96e84909f2c96dfa3f873c
+  metadata.gz: d01e6e1e38b28bab95f362e574d9727c78d371385eb6ce9b828fee37f23219da45ec15dc765f6a6556a54a02d7d58588c7f3ed9da277bc46a7b0277e74944ecf
+  data.tar.gz: 5ba3bcaac12cd90c4a505452298e3c2d17a791581d6aa8eca8826437cfd1c838dfbb13ba11587a8532bcf5a9fad1a35c0a6dc0425a661097d34ae04752818854

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+0.3.0 (Nov 24, 2015)
+
+* Extract prompting for user input as dependency on tty-prompt
+* Extract terminal mode
+* Remove support utils
+* Update dependencies to latest
+* Change home directory implementation
+
+0.2.1 (Sept 20, 2015)
+
+* Update dependencies to latest versions
+
 0.2.0 (July 6, 2015)
 
 * Extract platform detection as dependency on tty-platform

data/README.md

@@ -1,5 +1,7 @@
-# [![Application icon](https://github.com/peter-murach/tty/raw/master/images/tty.png)][icon]
-[icon]: http://peter-murach.github.io/tty/
+<div align="center">
+  <a href="http://peter-murach.github.io/tty"><img width="130" src="https://cdn.rawgit.com/peter-murach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+<br/>
 [![Gem Version](https://badge.fury.io/rb/tty.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/peter-murach/tty.svg?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/peter-murach/tty/badges/gpa.svg)][codeclimate]
@@ -34,7 +36,7 @@ Fully modular, choose out of many components to suite your needs and jump-start
 * Text manipulation(wrapping/truncation)   [status: ✔ ]
 * Terminal progress bars drawing.          [status: ✔ ]
 * Terminal spinners.                       [status: ✔ ]
-* Prompt user interface.                   [status: In Progress]
+* Interactive prompt for user input.       [status: ✔ ]
 * File diffs.                              [status: TODO]
 * Configuration file management.           [status: TODO]
 * Logging                                  [status: In Progress]
@@ -61,12 +63,13 @@ Or install it yourself as:
 * [2. Drawing tables](#2-drawing-tables)
 * [3. Drawing progress bars](#3-drawing-progress-bars)
 * [4. Drawing spinners](#4-drawing-spinners)
-* [5. Output coloring](#5-output-coloring)
-* [6. Output paging](#6-output-paging)
-* [7. Detecting screen properties](#7-detecting-screen-properties)
-* [8. Detecting platform](#8-detecting-platform)
-* [9. Searching executables](#9-searching-executables)
-* [10. Prompting for input](#10-prompting-for-input)
+* [5. Prompting for input](#5-prompting-for-input)
+* [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. Searching executables](#10-searching-executables)
+* [11. Setting editor](#11-setting-editor)
 
 ## 1. Overview
 
@@ -111,6 +114,22 @@ screen.width    # => 280
 screen.height   # => 51
 ```
 
+To ask for user input use `TTY::Prompt`:
+
+```ruby
+prompt = TTY::Prompt.new
+prompt.ask('Do you like Ruby?', type: :bool) # => true
+
+# or ask to select from list
+
+prompt.select("Choose your destiny?", %w(Scorpion Kano Jax))
+# =>
+# Choose your destiny? (Use arrow keys, press Enter to select)
+# ‣ Scorpion
+#   Kano
+#   Jax
+```
+
 ## 2. Drawing tables
 
 **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:
@@ -153,7 +172,18 @@ spinner = TTY::Spinner.new('Loading ... ', format: :spin_2)
 
 Please refer to [documentation](https://github.com/peter-murach/tty-spinner) for complete API.
 
-## 5. Output coloring
+## 5. Prompting for input
+
+**TTY** relies on [tty-prompt](https://github.com/peter-murach/tty-prompt#ttyprompt) component for processing user input.
+
+```ruby
+prompt = TTY::Prompt.new
+prompt.ask('Do you like Ruby?').read_bool # => true
+```
+
+Please refer to [documentation](https://github.com/peter-murach/tty-prompt#ttyprompt) for complete API.
+
+## 6. Output coloring
 
 In order to colorize your output **TTY** uses the [pastel](https://github.com/peter-murach/pastel) component like so:
 
@@ -164,7 +194,7 @@ pastel.red.on_green.bold 'text...'  # => red bold text on green background
 
 Please refer to [documentation](https://github.com/peter-murach/pastel) for complete API.
 
-## 6. Output paging
+## 7. Output paging
 
 To page terminal output **TTY** relies on [tty-pager](https://github.com/peter-murach/tty-pager) component.
 
@@ -177,7 +207,7 @@ pager.page('Very long text...')
 
 Please refer to [documentation](https://github.com/peter-murach/tty-pager) for complete API.
 
-## 7. Detecting screen properties
+## 8. Detecting screen properties
 
 **TTY** uses the [tty-screen](https://github.com/peter-murach/tty-screen) component to measure the screen properties.
 
@@ -192,7 +222,7 @@ screen.height   # => 51
 
 Please refer to [documentation](https://github.com/peter-murach/tty-screen) for complete API.
 
-## 8. Detecting platform
+## 9. Detecting platform
 
 To check for platform properties **TTY** uses [tty-platform](https://github.com/peter-murach/tty-platform) component.
 
@@ -212,7 +242,7 @@ TTY::Platform.windows? # => false
 
 Please refer to [documentation](https://github.com/peter-murach/tty-platform) for complete API.
 
-## 9. Searching executables
+## 10. Searching executables
 
 To find executable path **TTY** uses [tty-which](https://github.com/peter-murach/tty-which#ttywhich) component.
 
@@ -224,108 +254,8 @@ TTY::Which.which('less')  # => '/usr/bin/less'
 
 Please refer to [documentation](https://github.com/peter-murach/tty-which) for complete API.
 
-## 10. Prompting for input
-
-Main responsibility is to interact with the prompt and provide convenience methods.
-
-Available methods are
-
-```ruby
-shell = TTY::Shell.new
-shell.ask          # print question
-shell.read         # read from stdin
-shell.say          # print message to stdout
-shell.confirm      # print message(s) in green
-shell.warn         # print message(s) in yellow
-shell.error        # print message(s) in red
-shell.suggest      # print suggestion message based on possible matches
-shell.print_table  # print table to stdout
-```
-
-In order to ask question and parse answers:
-
-```ruby
-shell  = TTY::Shell.new
-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
-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..
-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
-```
-
-You can chain question methods or configure them inside a block
-
-```ruby
-shell.ask("What is your name?").argument(:required).default('Piotr').validate(/\w+\s\w+/).read_string
-
-shell.ask "What is your name?" do
-  argument :required
-  default  'Piotr'
-  validate /\w+\s\w+/
-  valid    ['Piotr', 'Piotrek']
-  modify   :capitalize
-end.read_string
-```
-
-Reading answers and converting them into required types can be done with custom readers
-
-```ruby
-read_bool       # return true or false for strings such as "Yes", "No"
-read_char       # return first character
-read_date       # return date type
-read_datetime   # return datetime type
-read_email      # validate answer against email regex
-read_file       # return a File object
-read_float      # return decimal or error if cannot convert
-read_int        # return integer or error if cannot convert
-read_multiple   # return multiple line string
-read_password   # return string with echo turned off
-read_range      # return range type
-read_regex      # return regex expression
-read_string     # return string
-read_symbol     # return symbol
-read_text       # return multiline string
-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").in('0-9') do
-  on_error :retry
-end.read_int
-```
-
-on the other hand, if we are interested in range answer then
-
-```ruby
-ask("Provide range of numbers?").read_range
-```
-
-To suggest possible matches for the user input use `suggest` method like so
-
-```ruby
-shell.suggest('sta', ['stage', 'stash', 'commit', 'branch'])
-# =>
-  Did you mean one of these?
-          stage
-          stash
-```
+## 11. Setting editor
 
-TTY::System.which(cmd)   # full path to executable if found, nil otherwise
-TTY::System.exists?(cmd) # check if command is available
-TTY::System.editor       # provides access to system editor
 To set preferred editor you can either use shell environment variables such as `EDITOR` and `VISUAL` or set the command(s) manually like so
 
 ```ruby

data/lib/tty.rb

@@ -12,35 +12,16 @@ require 'tty-table'
 require 'tty-which'
 
 require 'tty/version'
-
-require 'tty/support/utils'
 require 'tty/support/delegatable'
 require 'tty/support/coercion'
 require 'tty/support/unicode'
-
 require 'tty/terminal'
 require 'tty/system'
 require 'tty/vector'
-require 'tty/shell'
 require 'tty/logger'
 require 'tty/plugins'
-
 require 'tty/plugins/plugin'
-
-require 'tty/shell/distance'
-require 'tty/shell/response_delegation'
-require 'tty/shell/question'
-require 'tty/shell/question/validation'
-require 'tty/shell/question/modifier'
-require 'tty/shell/statement'
-require 'tty/shell/suggestion'
-require 'tty/shell/reader'
-require 'tty/shell/response'
-
-require 'tty/terminal/echo'
-require 'tty/terminal/raw'
 require 'tty/terminal/home'
-
 require 'tty/system/editor'
 
 module TTY
@@ -51,15 +32,6 @@ module TTY
   # Raised when the operation is not implemented
   class NoImplementationError < NotImplementedError; end
 
-  # Raised when the required argument is not supplied
-  class ArgumentRequired < ArgumentError; end
-
-  # Raised when the argument validation fails
-  class ArgumentValidation < ArgumentError; end
-
-  # Raised when the argument is not expected
-  class InvalidArgument < ArgumentError; end
-
   # Raised when the passed in validation argument is of wrong type
   class ValidationCoercion < TypeError; end
 
@@ -93,9 +65,9 @@ module TTY
     # @return [TTY::Shell]
     #
     # @api public
-    def shell(input=$stdin, output=$stdout)
-      @shell ||= Shell.new(input, output)
-    end
+    # def shell(input=$stdin, output=$stdout)
+    #   @shell ||= Shell.new(input, output)
+    # end
 
     # Return shared system object
     #

data/lib/tty/plugins/plugin.rb

@@ -43,9 +43,9 @@ module TTY
       begin
         require gem_name unless enabled?
       rescue LoadError => error
-        TTY.shell.error("Unable to load plugin #{gem_name} due to #{error}.")
+        puts("Unable to load plugin #{gem_name} due to #{error}.")
       rescue => error
-        TTY.shell.error("require '#{gem_name}' failed with #{error}")
+        puts("require '#{gem_name}' failed with #{error}")
       end
       @enabled = true
     end

data/lib/tty/terminal.rb

@@ -2,67 +2,11 @@
 
 module TTY
   class Terminal
-    # Return access to color terminal
-    #
-    # @return [TTY::Terminal::Color]
-    #
-    # @api public
-    attr_reader :color
-
     # Initialize a Terminal
     #
     # @api public
     def initialize(options = {})
-      @color = Pastel.new
-      @echo  = TTY::Terminal::Echo.new
-      @raw   = TTY::Terminal::Raw.new
-      @home  = Home.new
-    end
-
-    # Switch echo on
-    #
-    # @api public
-    def echo_on
-      @echo.on
-    end
-
-    # Switch echo off
-    #
-    # @api public
-    def echo_off
-      @echo.off
-    end
-
-    # Echo given block
-    #
-    # @param [Boolean] is_on
-    #
-    # @api public
-    def echo(is_on = true, &block)
-      @echo.echo(is_on, &block)
-    end
-
-    # Switch raw mode on
-    #
-    # @api public
-    def raw_on
-      @raw.on
-    end
-
-    # Switch raw mode off
-    #
-    # @api public
-    def raw_off
-      @raw.off
-    end
-
-    # Use raw mode in the given block
-    #
-    # @param [Boolean] is_on
-    #
-    # @api public
-    def raw(is_on = true, &block)
-      @raw.raw(is_on, &block)
+      @home = Home.new
     end
 
     # Find user home directory
@@ -71,7 +15,7 @@ module TTY
     #
     # @api public
     def home
-      @home.home
+      @home.find_home
     end
   end # Terminal
 end # TTY

data/lib/tty/terminal/home.rb

@@ -4,19 +4,37 @@ module TTY
   class Terminal
     # A class responsible for locating user home
     class Home
+      # @api public
+      def initialize(platform = nil)
+        @platform = platform || TTY::Platform
+      end
+
       # Find user home
       #
       # @api public
-      def home
-        if (env_home = ENV['HOME'])
-          env_home
+      def find_home
+        path = @platform.windows? ? windows_home : unix_home
+        File.expand_path(path)
+      end
+
+      def unix_home
+        require 'etc'
+        "~#{Etc.getlogin}"
+      rescue
+        ENV['HOME']
+      end
+
+      def windows_home
+        if (home = ENV['HOME'])
+          home.tr('\\', '/')
+        elsif ENV['HOMEDRIVE'] && ENV['HOMEPATH']
+          File.join(ENV['HOMEDRIVE'], ENV['HOMEPATH'])
+        elsif ENV['USERPROFILE']
+          ENV['USERPROFILE']
+        elsif ENV['HOMEDRIVE'] || ENV['SystemDrive']
+          File.join(ENV['HOMEDRIVE'] || ENV['SystemDrive'], '/')
         else
-          begin
-            require 'etc'
-            File.expand_path("~#{Etc.getlogin}")
-          rescue
-            TTY::System.windows? ?  'C:/' : '/'
-          end
+          'C:/'
         end
       end
     end # Home