cliutils 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0754feae910c80be0a06a3b11353926cc8c79c28
+  data.tar.gz: afbe8b57e41c27f8d37479305acfe9a8834803df
+SHA512:
+  metadata.gz: c948a61c5ee399c1b921e3fb825201dcce07ec45b4ba1923ec28cd4131acc718eedb3143395899d5c2cd1895aedac1db6eba42a4ae1c4061239983da88489f71
+  data.tar.gz: 1aa55f1a16bd3c6035b0a0c459d8f8158d0186e732adebba479da8cbc14e1666b1987f8b3cf517ab08eb1af44ecca06966651ba9290fb5dd68f7c0eaf78ded8f

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cliutils.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    cliutils (0.0.1)
+      methadone (~> 1.3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.4)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.5.1)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.12)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    json (1.8.1)
+    methadone (1.3.2)
+      bundler
+    multi_json (1.9.2)
+    multi_test (0.1.1)
+    rake (0.9.2.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec-expectations (3.0.0.beta2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (= 3.0.0.beta2)
+    rspec-support (3.0.0.beta2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.5)
+  cliutils!
+  rake (~> 0.9.2)
+  rdoc

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaron Bach
+
+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,288 @@
+CLIUtils
+====
+
+CLIUtils is a library of functionality designed to alleviate common tasks and headaches when developing command-line (CLI) apps in Ruby.
+
+# Why?
+
+It's fairly simple:
+
+1. I love developing Ruby-based CLI apps.
+2. I found myself copy/pasting common code from one to another.
+3. I decided to do something about it.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```bash
+$ gem 'cliutils'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself:
+
+```bash
+$ gem install cliutils
+```
+
+# Usage
+
+```ruby
+require 'cliutils'
+```
+
+If you want to mix in everything that CLIUtils has to offer:
+
+```Ruby
+include CLIUtils
+```
+
+Alternatively, as described below, mix in only the libraries that you want.
+
+Note that although this README.md is extensive, it may not cover all methods. Check out the [tests](https://github.com/bachya/cli-utils/tree/master/test) to see more examples.
+
+# Libraries
+
+CLIUtils offers:
+
+* [PrettyIO](https://github.com/bachya/cli-utils#prettyio): nicer-looking CLI messages
+* [Messenging](https://github.com/bachya/cli-utils#messenging): a full-featured Logger
+* [Configuration](https://github.com/bachya/cli-utils#configuration): a app configuration manager
+* [Prefs](https://github.com/bachya/cli-utils#prefs): a preferences prompter and manager
+
+## PrettyIO
+
+First stop on our journey is better client IO. To activate, simply mix into your project:
+
+```ruby
+include CLIUtils::PrettyIO
+```
+
+PrettyIO affords you colorized strings:
+
+```ruby
+puts 'A sample string'.red
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prettyio-red-text.png "Colored Text via PrettyIO")
+
+PrettyIO gives you utility methods for the common ANSI color codes:
+
+```ruby
+String.blue
+String.cyan
+String.green
+String.purple
+String.red
+String.white
+String.yellow
+```
+
+You also get the `colorize` method, which allows you to define more complex color combinations. For example, to get some nice purple text on a gnarly green background:
+
+```ruby
+puts 'A sample string'.colorize('35;42')
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prettyio-gnarly-text.png "Complex Colored Text via PrettyIO")
+
+Naturally, memorizing the ANSI color scheme is a pain, so PrettyIO gives you a convenient method to look up these color combinations:
+
+```ruby
+color_chart
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prettyio-color-chart.png "PrettyIO Color Chart")
+
+## Messenging
+
+Throughout the life of your application, you will most likely want to send several messages to your user (warnings, errors, info, etc.). Messenging makes this a snap. It, too, is a mixin:
+
+```ruby
+include CLIUtils::Messenging
+```
+
+Once mixed in, you get access to `messenger`, a type of Logger that uses PrettyIO to send nicely-formatted messages to your user. For example, if you'd like to warn your user:
+
+```ruby
+messenger.warn('Hey pal, you need to be careful.')
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/messenger-warn.png "A Warning from Messenger")
+
+### Messenging Methods
+
+`messenger` gives you access to several basic methods:
+
+* `messenger.error`: used to show a formatted-red error message.
+* `messenger.info`: used to show a formatted-blue infomational message.
+* `messenger.section`: used to show a formatted-purple sectional message.
+* `messenger.success`: used to show a formatted-green success message.
+* `messenger.yellow`: used to show a formatted-yellow warning message.
+
+Let's see an example that uses them all:
+
+```Ruby
+messenger.section('STARTING ATTACK RUN...')
+messenger.info('Beginning strafing run...')
+messenger.warn('WARNING: Tie Fighters approaching!')
+messenger.error('Porkins died :(')
+messenger.success('But Luke still blew up the Death Star!')
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/messenger-types-1.png "Basic Messenger Types")
+
+`messenger` also includes two "block" methods that allow you to wrap program execution in messages that are "longer-term".
+
+```Ruby
+messenger.info_block('Starting up...', 'Done!', multiline = false) { # do stuff here }
+```
+
+`messenger` outputs 'Starting up...', runs the code in `# do stuff here`, and once complete, outputs 'Done!' on the same line. Note that `section_block` is the same exact signature (except for the method name, of course!).
+
+### Message Wrapping
+
+PrettyIO also gives `messenger` the ability to wrap your messages so that they don't span off into infinity. You can even control what the wrap limit (in characters) is:
+
+```Ruby
+CLIUtils::PrettyIO::wrap_at(50)
+messenger.info('This is a really long message, okay? It should wrap at some point. Seriously. Wrapping is nice.')
+puts ''
+CLIUtils::PrettyIO::wrap_at(20)
+messenger.info('This is a really long message, okay? It should wrap at some point. Seriously. Wrapping is nice.')
+puts ''
+CLIUtils::PrettyIO::wrap(false)
+messenger.info('This is a really long message, okay? It should wrap at some point. Seriously. Wrapping is nice.')
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/wrapping.png "Text Wrapping")
+
+### Prompting
+
+`messenger` also carries a convenient method to prompt your users to give input (including an optional default). It makes use of `readline`, so you can do cool things like text expansion of paths.
+
+```Ruby
+p = messenger.prompt('Are you a fan of Battlestar Galactica?', default = 'Y')
+messenger.info("You answered: #{ p }")
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prompting.png "Prompting")
+
+### Logging
+
+Often, it's desirable to log messages as they appear to your user. `messenging` makes this a breeze by allowing you to attach and detach Logger instances at will.
+
+For instance, let's say you wanted to log a few messages to both your user's STDOUT and to `file.txt`:
+
+```Ruby
+file_logger = Logger.new('file.txt')
+
+messenger.info('This should only appear in STDOUT.')
+
+messenger.attach(file_logger)
+
+messenger.warn('This warning should appear in STDOUT and file.txt')
+messenger.error('This error should appear in STDOUT and file.txt')
+messenger.debug('This debug message should only appear in file.txt')
+
+messenger.detach(file_logger)
+
+messenger.section('This section message should appear only in STDOUT')
+```
+
+In STDOUT:
+
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/multi-logger.png "Multi-logging")
+
+...and in `file.txt`:
+
+```
+W, [2014-03-29T15:14:34.844406 #4497]  WARN -- : This warning should appear in STDOUT and file.txt
+E, [2014-03-29T15:14:34.844553 #4497] ERROR -- : This error should appear in STDOUT and file.txt
+D, [2014-03-29T15:14:34.844609 #4497] DEBUG -- : This debug message should only appear in file.txt
+```
+
+Since you can attach Logger objects, each can have it's own format and severity level. Cool!
+
+## Configuration
+
+CLIUtils offers two "things" -- a `Configurator` class and a `Configuration` module that provides access to a shared instance of `Configurator` -- that make managing a user's configuration parameters easy. Mix it in!
+
+```Ruby
+include CLIUtils::Configuration
+```
+
+### Loading a Configuration File
+
+```Ruby
+load_configuration('~/.my-app-config')
+```
+
+If there's data in there, it will be consumed into `configuration`'s `data` property.
+
+### Adding/Removing Sections
+
+Sections are top levels of the configuration file and are managed via the `configuration` object:
+
+```Ruby
+configuration.add_section(:user_data)
+configuration.add_section(:program_data)
+configuration.delete_section(:program_data)
+```
+
+### Adding Data to Sections
+
+There are two ways data can be managed in `configuration`: via its `@data` property or via some magic methods; your call:
+
+```Ruby
+configuration.data[:user_data].merge!(username: 'bob')
+# OR
+configuration.user_data.merge!(username: 'bob')
+```
+
+### Saving to a File
+
+When you're ready to save your configuration data to a YAML file:
+
+```Ruby
+configuration.save
+```
+
+Note that all your keys are converted to strings before saving (and, likewise, are converted to symbols, when loading). Assuming we used the commands above, we could expect this to be the contents of `~/.my-app-config`:
+
+```YAML
+---
+user_data:
+  username: bob
+```
+
+# Known Issues
+
+* LoggerDelegator doesn't currently know what to do with `messenger.prompt`, so you'll have to manually log a `debug` message if you want that information logged.
+
+# Bugs and Feature Requests
+
+To report bugs with or suggest features/changes for CLIUtils, please use the [Issues Page](http://github.com/bachya/cli-utils/issues).
+
+# Contributing
+
+Contributions are welcome and encouraged. To contribute:
+
+1. Fork it ( http://github.com/bachya/cliutils/fork )
+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
+
+# License
+
+(The MIT License)
+
+Copyright © 2014 Aaron Bach <bachya1208@gmail.com>
+
+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.rdoc

@@ -0,0 +1,19 @@
+= cliutils - DESCRIBE YOUR GEM
+
+Author::  YOUR NAME (YOUR EMAIL)
+Copyright:: Copyright (c) 2014 YOUR NAME
+
+
+DESCRIBE YOUR GEM HERE
+
+== Links
+
+* {Source on Github}[LINK TO GITHUB]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing
+

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md","lib/**/**/*.rb")
+  rd.title = 'CLIUtils'
+end
+
+spec = eval(File.read('cliutils.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test]

data/bin/cliutils

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'cliutils.rb'
+
+# include CLIUtils::PrettyIO
+# 
+# warn('test')
+
+include CLIUtils::Messenging
+# # 
+# file_logger = Logger.new('file.txt')
+# puts ''
+# messenger.info('This should only appear in STDOUT.')
+# messenger.attach(file_logger)
+# messenger.warn('This warning should appear in STDOUT and file.txt')
+# messenger.error('This error should appear in STDOUT and file.txt')
+# messenger.debug('This debug message should only appear in file.txt')
+# messenger.detach(file_logger)
+# messenger.section('This section message should appear only in STDOUT')
+# puts ''
+# 
+include CLIUtils::Configuration
+
+load_configuration('~/.test')
+configuration.add_section(:user_data)
+configuration.add_section(:program_data)
+configuration.delete_section(:program_data)
+configuration.user_data.merge!(username: 'bob')
+configuration.save
+# 
+# p = CLIUtils::Prefs.new(File.join(File.expand_path(File.dirname(__FILE__)),'..', 'test/test_files/prefstest.yaml'))
+# 
+# # arr = [{:prompt=>"What is the hostname of your DD-WRT router?", :default=>"192.168.1.1", :key=>"hostname", :section=>"ssh_info"}, {:prompt=>"What is the SSH username of your DD-WRT router?", :default=>"root", :key=>"username", :section=>"ssh_info"}, {:prompt=>"What SSH port does your DD-WRT router use?", :default=>22, :key=>"port", :section=>"ssh_info"}, {:prompt=>"How do you use password or key authentication?", :default=>"password", :key=>"auth_method", :section=>"ssh_info", :options=>["password", "key"]}, {:prompt=>"Where is your key located?", :default=>"~/.ssh", :key=>"key_location", :section=>"ssh_info", :requirements=>[{:key=>"auth_method", :value=>"key"}]}, {:prompt=>"What is your password?", :key=>"password", :section=>"ssh_info", :requirements=>[{:key=>"auth_method", :value=>"password"}]}]
+# # p = CLIUtils::Prefs.new(arr)
+# 
+# # p p.prompts
+# p.ask
+# configuration.ingest_prefs(p)
+# configuration.save

data/cliutils.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cliutils/version'
+
+Gem::Specification.new do |spec|
+  spec.name             = "cliutils"
+  spec.version          = CLIUtils::VERSION
+  spec.authors          = ["Aaron Bach"]
+  spec.email            = ["bachya1208@googlemail.com"]
+  spec.summary          = 'Sugary goodness for Ruby CLI apps.'
+  spec.description      = 'A library of functionality designed to alleviate common tasks and headaches when developing command-line (CLI) apps in Ruby.'
+  spec.homepage         = "https://github.com/bachya/cli-utils"
+  spec.license          = "MIT"
+                        
+  spec.files            = `git ls-files -z`.split("\x0")
+  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.has_rdoc         = true
+  spec.extra_rdoc_files = ['README.md']
+  spec.rdoc_options << '--title' << 'CLIUtils' << '--main' << 'README.md' << '-ri'
+
+  spec.add_development_dependency("bundler", "~> 1.5")
+  spec.add_development_dependency('rdoc', '~> 0')
+  spec.add_development_dependency('rake', '~> 0')
+end

data/features/cli_manager.feature

@@ -0,0 +1,13 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "cliutils"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+    And the banner should document that this app takes no arguments

data/features/step_definitions/cli_manager_steps.rb

@@ -0,0 +1 @@
+# Put your step definitions here

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end