cli_tools 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97ca4006c9d4aad3f468fee6c21a6e7f7ed92939
+  data.tar.gz: bd7c470b4d297335eb7bc463dd87448f4f2ac34e
+SHA512:
+  metadata.gz: ed93a838a7f58d8313baa67d84bb430c0202f23b353b2fbce7238e5475cdd0bb326b1fcffe069a38dd57a6c33794dc4059564ea88d3da15a0c523e30566a2a43
+  data.tar.gz: 058bc0e697e24561a7d9228021e4dd564e0768d88f628ce2a7777e9d371a6d07e7c8d8b0c7ed4b592713c8431b92b398461859a7a7674cf5883259f53af9775e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cli_tools.gemspec
+gemspec
+
+gem "rake", :group => [:development, :test]
+
+group :test do
+
+  gem "rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Kukushkin
+
+MIT License
+
+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/README.md

@@ -0,0 +1,42 @@
+# Tools for CLI application
+
+A collection of helper methods for ruby CLI application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cli_tools'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cli_tools
+
+## Usage
+
+```ruby
+require 'cli_tools'
+include CliTools
+
+puts esc_green("Hello")+' world!' # outputs 'Hello world!' where 'Hello' is painted green
+```
+
+OR: all the methods automatically included into Kernel:
+
+```ruby
+require 'cli_tools/include'
+
+puts esc_green("Hello")+' world!'
+```
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')

data/cli_tools.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli_tools"
+  spec.version       = CliTools::VERSION
+  spec.authors       = ["Alex Kukushkin"]
+  spec.email         = ["alex@kukushk.in"]
+  spec.description   = %q{A collection of helper methods for ruby CLI applications}
+  spec.summary       = %q{CLI application helper methods}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/cli_tools/console.rb

@@ -0,0 +1,106 @@
+module CliTools
+
+# Replaces current line in the output with a new one.
+#
+def putr( str = '' )
+  # move cursor to beginning of line
+  cr = "\r"
+
+  # ANSI escape code to clear line from cursor to end of line
+  # cf. http://en.wikipedia.org/wiki/ANSI_escape_code
+  clear = "\e[0K"
+
+  # reset lines
+  reset = cr + clear
+
+  print "#{reset}#{str}"
+  $stdout.flush
+end
+
+# Puts a 'beep' ANSI code.
+#
+def put_beep
+  print "\a"
+  $stdout.flush
+end
+
+# Clears console screen and puts cursor in 0,0.
+#
+def put_cls
+  cls = `clear`
+  putr cls
+end
+
+# Returns ANSI escaped string.
+#
+def esc_string( esc, text )
+  esc+text.to_s+"\e[0m"
+end
+
+# Returns ANSI escaped string for the red colored text.
+#
+def esc_red( text )
+  esc_string "\e[31m", text
+end
+
+# Returns ANSI escaped string for the green colored text.
+#
+def esc_green( text )
+  esc_string "\e[32m", text
+end
+
+# Returns ANSI escaped string for the yellow colored text.
+#
+def esc_yellow( text )
+  esc_string "\e[33m", text
+end
+
+# Returns ANSI escaped string for the blue colored text.
+#
+def esc_blue( text )
+  esc_string "\e[34m", text
+end
+
+# Returns ANSI escaped string for the bold text.
+#
+def esc_bold( text )
+  esc_string "\e[01;37m", text
+end
+
+
+# Returns pressed key or +nil+ if there is no keyboard input.
+#
+def kb_getkey
+  kb_raw_no_echo_mode
+
+  begin
+    return $stdin.read_nonblock(1)
+  rescue
+    return nil
+  ensure
+    kb_restore_mode
+  end
+end
+
+# Switches the input mode to raw and disables echo.
+#
+# *WARNING*:  This method requires the external "stty" program!
+#
+# Pasted from +HighLine+ gem.
+#
+def kb_raw_no_echo_mode
+  @tty_state = `stty -g`
+  system "stty raw -echo cbreak isig"
+end
+
+# Restores a previously saved input mode.
+#
+# *WARNING*:  This method requires the external "stty" program!
+#
+# Pasted from +HighLine+ gem.
+#
+def kb_restore_mode
+  system "stty #{@tty_state}"
+end
+
+end # module CliTools

data/lib/cli_tools/include.rb

@@ -0,0 +1,7 @@
+# Include all cli_tools at the main object level (and it's not a Kernel).
+# Usage:
+#   require 'cli_tools/include'
+#   putr 'hello?'
+#
+require 'cli_tools'
+include CliTools

data/lib/cli_tools/system.rb

@@ -0,0 +1,165 @@
+require 'open3'
+
+module CliTools
+
+# Execs cmd in a shell and returns true if command executed successfully,
+# or throws an exception if command failed.
+#
+SH_STORED_OUTPUT_LIMIT = 2048
+SH_STORED_OUTPUT_LINES = 8
+def sh( cmd, echo = true, capture_output = nil, &block )
+  if _sh_captured_output.size == 0 && capture_output.nil? && block.nil?
+    # simple form
+    puts cmd if echo
+    system cmd or raise ShellExecutionError.new("Failed to execute: '#{cmd}' (#{$?})", $?, '')
+    return true
+  end
+
+  # ok, it's a bit more complex
+  exit_status = nil
+  current_output = ''
+  if echo
+    _sh_captured_output.each do |output_channel|
+      _sh_capture_concat output_channel, cmd+"\n"
+    end
+    if capture_output
+      _sh_capture_concat capture_output, cmd+"\n"
+    else
+      puts cmd
+    end
+  end
+  i = STDIN
+  Open3.popen2e( cmd ) do |i, oe, t|
+    i = STDIN
+    oe.sync = true
+    while oe_char = oe.getc do
+      # puts "sh: block tick"
+      _sh_captured_output.each do |output_channel|
+        _sh_capture_concat output_channel, oe_char
+      end
+      if capture_output
+        _sh_capture_concat capture_output, oe_char
+      else
+        putc oe_char
+      end
+      current_output += oe_char
+      if current_output.size > SH_STORED_OUTPUT_LIMIT
+        # squeeze cached output
+        current_output = current_output.split("\n").last(SH_STORED_OUTPUT_LINES).join("\n")
+      end
+      yield(oe_char) if block
+    end
+    exit_status = t.value
+  end
+  if exit_status != 0
+    raise ShellExecutionError.new("Failed to execute: '#{cmd}' (#{exit_status})", exit_status, current_output)
+  end
+  true
+end
+
+
+# Captures all outputs of all the #sh executed inside the block into +output+.
+#
+def sh_capture_output( output, &block )
+  _sh_captured_output << output
+  yield
+ensure
+  _sh_captured_output.delete output
+end
+
+# Prints message and captures it if capture output is enabled.
+#
+def sh_capture_echo( message )
+  _sh_captured_output.each do |output_channel|
+    _sh_capture_concat output_channel, message+"\n"
+  end
+end
+
+# Concatenates output buffer and text.
+# If output buffer object is a String, the content is #replace-d,
+# otherwise object must provide #text property-accessor.
+#
+def _sh_capture_concat( output_buffer, text )
+  if output_buffer.is_a? String
+    output_buffer.replace( output_buffer + text )
+  else
+    output_buffer.text += text
+  end
+end
+
+# Returns list of capture channels.
+# This list is local to the current thread.
+#
+def _sh_captured_output
+  Thread.current[:sh_captured_output] ||= []
+  Thread.current[:sh_captured_output]
+end
+
+# Exception class which holds command execution status and current output
+# for exceptions raised from '#sh' method call.
+#
+class ShellExecutionError < StandardError
+  attr_reader :status, :output
+  def initialize( msg = "Failed to execute 'sh'", status, output )
+    super msg
+    @status = status
+    @output = output
+  end
+end
+
+# Copy file if newer.
+#
+def copy_if_newer( from, to, echo = true )
+  # if Mac OS X:
+  os = os_name()
+  if os == 'macosx'
+    sh "cp -nf #{from} #{to}", echo
+  else
+    # update, force, preserve attrs
+    sh "cp -ufp #{from} #{to}", echo
+  end
+end
+
+# Returns the amount in bytes of free disk space in the specified folder.
+#
+def fs_disk_free( path )
+  result = `df -P -k #{path}`.split("\n")[1]
+  device, d_size, d_usage, d_free = result.split(" ")[0..3]
+
+  d_free.to_i*1024 # in bytes
+end
+
+# Returns the amount in bytes of used disk space in the specified folder.
+#
+def fs_disk_used( path )
+  # First, dereference path
+  if File.symlink? path
+    p = File.readlink( path )
+  else
+    p = path
+  end
+  result = `du -ks #{p} 2>/dev/null`
+  size = 0
+  result.split("\n").each do |line|
+    if m = /(\d+)\s+.*/.match(line)
+      size += m[1].to_i*1024
+    end
+  end
+  size
+end
+
+# Returns a host OS name in lowercase.
+#
+def os_name
+  name = `uname` rescue '' # Windows?
+  name.chomp!
+
+  case name
+  when 'Darwin' then 'macosx'
+  when 'Linux' then 'linux'
+  else
+    "unknown(#{name})"
+  end
+end
+
+end # module CliTools

data/lib/cli_tools/version.rb

@@ -0,0 +1,3 @@
+module CliTools
+  VERSION = "0.0.1"
+end

data/lib/cli_tools.rb

@@ -0,0 +1,11 @@
+require "cli_tools/version"
+require "cli_tools/console"
+require "cli_tools/system"
+
+module CliTools
+
+  # Include all instance methods as module methods
+  class << self
+    include CliTools
+  end
+end

data/spec/cli_tools_included_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'cli_tools/include'
+
+describe "when included, main object" do
+  it { should respond_to(:putr) }
+  it { should respond_to(:sh) }
+end

data/spec/cli_tools_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe CliTools do
+
+  it "should provide VERSION" do
+    CliTools.should be_const_defined(:VERSION)
+    CliTools::VERSION.should be_a( String )
+  end
+
+  it { should respond_to(:putr) }
+  it { should respond_to(:sh) }
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rubygems'
+require 'bundler/setup'
+require 'cli_tools'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: cli_tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Kukushkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A collection of helper methods for ruby CLI applications
+email:
+- alex@kukushk.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cli_tools.gemspec
+- lib/cli_tools.rb
+- lib/cli_tools/console.rb
+- lib/cli_tools/include.rb
+- lib/cli_tools/system.rb
+- lib/cli_tools/version.rb
+- spec/cli_tools_included_spec.rb
+- spec/cli_tools_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: CLI application helper methods
+test_files:
+- spec/cli_tools_included_spec.rb
+- spec/cli_tools_spec.rb
+- spec/spec_helper.rb