terminal_helpers 0.1.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/README.md

@@ -0,0 +1,95 @@
+# TerminalHelpers
+
+This is a collection of helper method for your console-based applications.
+
+It does not have any gem dependencies and could be easily plugged-in into your existing code.
+
+Was inspired by ```heroku``` CLI app.
+
+## Installation
+
+You can install it using rubygems:
+
+```
+gem install terminal_helpers
+```
+
+Or build it:
+
+```
+rake install
+```
+
+## Usage
+
+To start using terminal_helpers just include it into your app or class:
+
+```ruby
+require 'terminal_helpers'
+include TerminalHelpers
+
+# or if you have session or somethin
+class Session
+  include TerminalHelpers
+end
+```
+
+### Input helpers
+
+```ruby
+name     = ask('Your name')
+email    = ask('Email address', :required => true, :format => :email)
+zipcode  = ask('Zipcode', :format => :zipcode)
+domain   = ask('Domain', :format => :domain)
+password = ask_password(:confirm => true)
+sure     = ask_yesno('Are you sure about this?')
+```
+
+### Message helpers
+
+```ruby
+empty_line    # print just an empty line
+empty_line 50 # print 50 empty lines
+prompt        # print '>' and wait for user input
+```
+
+Various informative methods:
+
+```ruby
+info    'This is INFO message!'
+display 'This is another INFO message!'
+success 'This is SUCCESS message!'
+warning 'This is WARNING message!'
+error   'This is ERROR message', true # true means termination after printing
+```
+
+To enable disable colors support:
+
+```ruby
+TerminalHelpers.use_colors = false # colors are enabled by default
+```
+
+### Extras
+
+Execute a shell command:
+
+```ruby
+result = shell 'uptime'
+```
+
+Enable/disable terminal echo (helpful for password input):
+
+```ruby
+echo_on
+echo_off
+```
+
+## License
+
+Copyright © 2011 Dan Sosedoff.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,21 @@
+task :install do
+  gem_name = "terminal_helpers"
+  
+  require 'fileutils'
+  require File.expand_path("../lib/#{gem_name}/version", __FILE__)
+  
+  gem_file = "#{gem_name}-#{TerminalHelpers::VERSION}.gem"
+  
+  if File.exists?(gem_file)
+    FileUtils.rm_f(gem_file)
+  end
+  
+  puts "-> Uninstalling..."
+  puts `gem uninstall -x #{gem_name} --version=#{TerminalHelpers::VERSION}`
+  
+  puts "-> Building..."
+  puts `gem build #{gem_name}.gemspec`
+  
+  puts "-> Installing..."
+  puts `gem install #{gem_file}`
+end

data/lib/terminal_helpers/colors.rb

@@ -0,0 +1,18 @@
+module Colors
+  def red;          colorize(self, "\e[1m\e[31m"); end
+  def green;        colorize(self, "\e[1m\e[32m"); end
+  def dark_green;   colorize(self, "\e[32m");      end
+  def yellow;       colorize(self, "\e[1m\e[33m"); end
+  def blue;         colorize(self, "\e[1m\e[34m"); end
+  def dark_blue;    colorize(self, "\e[34m");      end
+  def purple;       colorize(self, "\e[1m\e[35m"); end
+  def magenta;      colorize(self, "\e[1m\e[36m"); end
+  
+  def colorize(text, color_code)
+    "#{color_code}#{text}\e[0m"
+  end
+end
+
+class String
+  include Colors
+end

data/lib/terminal_helpers/errors.rb

@@ -0,0 +1,6 @@
+module TerminalHelpers
+  class Error           < StandardError ; end
+  class InputError      < Error ; end
+  class FormatError     < Error ; end
+  class ValidationError < Error ; end
+end

data/lib/terminal_helpers/helpers.rb

@@ -0,0 +1,136 @@
+require 'fileutils'
+
+module TerminalHelpers
+  # Ask for the user input
+  #
+  # title - Input prompt text
+  # options - Input options
+  #
+  # options[:default]  - Default value if input is blank
+  # options[:required] - Make input mandatory (default: false)
+  # options[:format]   - Validate input data using format
+  # options[:echo]     - Enable/disable echo (default: true)
+  #
+  def ask(title, options={})
+    title_str = title.dup
+    title_str += " [#{options[:default]}]" unless options[:default].to_s.empty?
+    title_str += ": "
+    
+    echo_off if options[:echo] == false
+    
+    print(title_str)
+    result = gets.strip
+    result = options[:default] if result.empty? && options.key?(:default)
+    #result = result.scan(/[a-z\d\_\-]{1,}/i) if options.key?(:array)
+    
+    if result.empty? && options[:required]
+      empty_line if options[:echo] == false
+      return ask(title, options)
+    end
+    
+    empty_line if options[:echo] == false
+    echo_on
+    
+    Validations.validate(result, options[:format], true) if options[:format]
+    result
+  end
+  
+  # Prompt for password
+  #
+  # options[:confirm] - Require a password confirmation (default: false)
+  #
+  def ask_password(options={})
+    password = ask('Password', :required => true, :echo => false)
+    if options[:confirm] == true
+      confirmation = ask('Confirm password', :required => true, :echo => false)
+      if confirmation != password
+        raise InputError, "Password confirmation should match."
+      end
+    end
+    password
+  end
+  
+  # Prompt for Y/N question
+  #
+  def ask_yesno(title, required='y', options={})
+    answer = ask("#{title} (y/n)", options).downcase
+    answer == required
+  end
+  
+  # Prints an empty line N times
+  #
+  def empty_line(num=1)
+    num.times { info("") }
+  end
+  
+  # Regular prompt with prefix
+  #
+  def prompt(prefix='> ')
+    print("#{prefix}")
+    gets.strip
+  end
+  
+  # Print an information message
+  #
+  # message - Information text
+  # color - Specify message color (default: none)
+  #
+  def info(message, color=nil)
+    if TerminalHelpers.use_colors
+      message = message.send(color) unless color.nil?
+    end
+    STDOUT.puts(message)
+    STDOUT.flush
+  end
+  
+  # Show success message
+  #
+  def success(message)
+    info(message, :green)
+  end
+  
+  # Show warning message
+  #
+  def warning(message)
+    info(message, :yellow)
+  end
+  
+  # Show error message
+  #
+  def error(message, exit_after=false)
+    if TerminalHelpers.use_colors
+      message = message.red
+    end
+    STDERR.puts(message)
+    exit(1) if exit_after
+  end
+  
+  # Print message
+  #
+  def display(message, newline=true)
+    if newline
+      STDOUT.puts(message)
+    else
+      STDOUT.print(message)
+      STDOUT.flush
+    end
+  end
+  
+  # Execure a shell command
+  #
+  def shell(cmd)
+    FileUtils.cd(Dir.pwd) {|d| return `#{cmd}`}
+  end
+  
+  # Disables terminal prompt
+  #
+  def echo_off
+    system("stty -echo")
+  end
+
+  # Enables terminal prompt
+  #
+  def echo_on
+    system("stty echo")
+  end
+end

data/lib/terminal_helpers/validations.rb

@@ -0,0 +1,30 @@
+module TerminalHelpers
+  module Validations
+    extend self
+    
+    FORMATS = {
+      :domain  => /^[a-z\d-]+(\.[a-z\d-]+)*\.(([\d]{1,3})|([a-z]{2,3})|(aero|coop|info|museum|name))$/i,
+      :email   => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i,
+      :zipcode => /^[\d]{5}$/,
+      :ipv4    => /^[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}$/
+    }
+    
+    # Validate data against provided format
+    #
+    def validate(value, format, raise_error=false)
+      unless FORMATS.key?(format)
+        raise FormatError, "Invalid data format: #{format}"
+      end
+      result = value =~ FORMATS[format] ? true : false
+      if raise_error && !result
+        raise ValidationError, "Invalid value \"#{value}\" for #{format}"
+      end
+      result
+    end
+    
+    def email(value)   ; validate(value, :email)   ; end
+    def domain(value)  ; validate(value, :domain)  ; end
+    def zipcode(value) ; validate(value, :zipcode) ; end
+    def ipv4(value)    ; validate(value, :ipv4)    ; end
+  end
+end

data/lib/terminal_helpers/version.rb

@@ -0,0 +1,3 @@
+module TerminalHelpers
+  VERSION = '0.1.0'
+end

data/lib/terminal_helpers.rb

@@ -0,0 +1,19 @@
+require 'terminal_helpers/version'
+require 'terminal_helpers/errors'
+require 'terminal_helpers/validations'
+require 'terminal_helpers/colors'
+require 'terminal_helpers/helpers'
+
+module TerminalHelpers
+  @@use_colors = true
+  
+  class << self
+    def use_colors
+      @@use_colors
+    end
+    
+    def use_colors=(value)
+      @@use_colors = value == true
+    end
+  end
+end

data/terminal_helpers.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path('../lib/terminal_helpers/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "terminal_helpers"
+  s.version     = TerminalHelpers::VERSION.dup
+  s.summary     = "Various helpers for console-based applications"
+  s.description = "Various helpers for console-based applications"
+  s.homepage    = "http://github.com/sosedoff/terminal_helpers"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = ["dan.sosedoff@gmail.com"]
+    
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths      = ["lib"]
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: terminal_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-05 00:00:00.000000000Z
+dependencies: []
+description: Various helpers for console-based applications
+email:
+- dan.sosedoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- Rakefile
+- lib/terminal_helpers.rb
+- lib/terminal_helpers/colors.rb
+- lib/terminal_helpers/errors.rb
+- lib/terminal_helpers/helpers.rb
+- lib/terminal_helpers/validations.rb
+- lib/terminal_helpers/version.rb
+- terminal_helpers.gemspec
+homepage: http://github.com/sosedoff/terminal_helpers
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Various helpers for console-based applications
+test_files: []