cliutils 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed57d1bb3f3c3248b082ff1ea8a5159a2e68052b
-  data.tar.gz: 9fb6dc3532170cdcf2ef15239d99c199fb1ef04f
+  metadata.gz: e7d9fdba4ade5e475660b1e5403ba10c27b11d49
+  data.tar.gz: c433c12ec3c28b525a2ac4dd889592753c58473a
 SHA512:
-  metadata.gz: da2909f0c9d6de3f3e75698b09414ea999e364894435dc7843334351568b89f5fa6292215ff7e67546b5b5918afa80083885f3b735ef303a202fc94492faf9f8
-  data.tar.gz: efd71929d34adea0cadecd3cc6865f48a5b3cff101de2060084994369d56f50b37d57e4a1921fb49aa9c04d16d737c3bfd38307f99580f18f2e0105af9c461bc
+  metadata.gz: cd0495d72585e2e6176e58312bbfa9390443bbfb3e4c3906c2aa12096b735d92e058bbc853bb1410990b2b0323a922985d43e44c0a8d391e12d2ad1f78022579
+  data.tar.gz: a88ae22aa1b2e936ff8986714e545e9a8f3e3b9dfaabd68e1999d31ea96df64caa228c7106bd663a3e459bf5e73f6a29231e8320375d818b21d04b2c071a94b9

data/.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 doc
 pkg
+.yardoc
+bin

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cliutils (1.0.3)
+    cliutils (1.0.4)
 
 GEM
   remote: https://rubygems.org/

data/HISTORY.md

@@ -0,0 +1,11 @@
+# 1.0.4 (2014-03-29)
+
+* Fixed several bugs
+* Fixed backwards compatibility with Ruby 1.9.2
+* Added more YARDdoc
+* Cleaned out old directories
+* Updated gemspec to reflect new gem versions
+
+# 1.0.3 (2014-03-29)
+
+* Initial release of CLIUtils

data/README.md

@@ -1,5 +1,7 @@
 CLIUtils
 ====
+[![Build Status](https://travis-ci.org/bachya/cliutils.png?branch=master)](https://travis-ci.org/bachya/cliutils)
+[![Gem Version](https://badge.fury.io/rb/cliutils.png)](http://badge.fury.io/rb/cliutils)
 
 CLIUtils is a library of functionality designed to alleviate common tasks and headaches when developing command-line (CLI) apps in Ruby.
 
@@ -51,10 +53,10 @@ Note that although this README.md is extensive, it may not cover all methods. Ch
 
 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](#prettyio): nicer-looking CLI messages
+* [Messenging](#messenging): a full-featured Logger
+* [Configuration](#configuration): a app configuration manager
+* [Prefs](#prefs): a preferences prompter and manager
 
 ## PrettyIO
 
@@ -146,13 +148,13 @@ messenger.info_block('Starting up...', 'Done!', multiline = false) { # do stuff
 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)
+CLIUtils::PrettyIO.wrap_char_limit = 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)
+CLIUtils::PrettyIO.wrap_char_limit = 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)
+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")
@@ -255,6 +257,79 @@ user_data:
   username: bob
 ```
 
+## Prefs
+
+Many times, CLI apps need to ask their users some questions, collect the feedback, validate it, and store it. CLIUtils makes this a breeze via the `Prefs` class.
+
+`Prefs` can load preferences information from either a YAML file (via a filepath) or from an array of preferences. In either case, the schema is the same; each prompt includes the following:
+
+* prompt (**required**): the string to prompt your user with
+* default (*optional*): an optional default to offer
+* key (**required**): the key that refers to this preference
+* section (**required**): the Configuration section that this preference applies to
+* options (*optional*): an optional array of values; the user's choice must be in this array
+* requirements (*optional*): an optional list of key/value pairs that must exist for this preference to be displayed
+
+Here's an example YAML preferences file.
+
+```YAML
+prompts:
+  - 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: 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
+```
+
+Assuming the above, `Prefs` is instantiated like so:
+
+```Ruby
+prefs = CLIUtils::Prefs.new('path/to/yaml/file')
+```
+
+With valid preferences loaded, simply use `ask` to begin prompting your user:
+
+```Ruby
+prefs.ask
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prefs-ask.png "Prefs.ask")
+
+Once the user has answered all the preference prompts, you can fold those answers back into a Configurator using the `ingest` method:
+
+```Ruby
+configuration.ingest(prefs)
+configuration.save
+```
+
+### Why a Prefs Class?
+
+I've written apps that need to request user input at various times for multiple different things; as such, I thought it'd be easier to have those scenarios chunked up. You can always wrap `Prefs` into a module singleton if you wish.
+
 # 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.

data/cliutils.gemspec

@@ -10,17 +10,13 @@ Gem::Specification.new do |spec|
   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.homepage         = "http://www.bachyaproductions.com/cliutils-ruby-library-cli-apps/"
   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', 'doc']
-  spec.rdoc_options << '--title' << 'CLIUtils' << '--main' << 'README.md' << '-ri'
 
   spec.add_development_dependency('bundler', '~> 1.5')
   spec.add_development_dependency('pry', '~> 0.9')

data/lib/cliutils/ext/Hash+Extensions.rb

@@ -86,7 +86,7 @@ class Hash
 
   # Same as _deep_transform_keys_in_object, but
   # destructively alters the original Object.
-  # @param [Object] The object to examine
+  # @param [Object] object The object to examine
   # @yield &block
   # @return [Object]
   def _deep_transform_keys_in_object!(object, &block)

data/lib/cliutils/messenging.rb

@@ -1,8 +1,10 @@
+require 'cliutils/pretty-io'
+
 module CLIUtils
   #  CLIMessenger Module
   #  Outputs coordinated messages to a variety of targets.
   module Messenging
-    include CLIUtils::PrettyIO
+    include PrettyIO
 
     # Hook that triggers when this module is included.
     # @param [Object] k The includer object

data/lib/cliutils/prefs.rb

@@ -1,3 +1,5 @@
+require 'cliutils/pretty-io'
+
 module CLIUtils
   # Engine to derive preferences from a YAML file, deliver
   # those to a user via a prompt, and collect the results.
@@ -6,7 +8,7 @@ module CLIUtils
     attr_reader :answers, :config_path, :prompts
 
     # Reads prompt data from and stores it.
-    # @param [<String, Array>] data Either a filepath or an array
+    # @param [<String, Hash, Array>] data Filepath to YAML, Hash, or Array
     # @return [void]
     def initialize(data)
       @answers = []
@@ -22,6 +24,11 @@ module CLIUtils
         else
           fail "Invalid configuration file: #{ yaml_path }"
         end
+      when Hash
+        @config_path = nil
+        
+        data = {:prompts => data} unless data.keys[0] == :prompts
+        @prompts.deep_merge!(data).deep_symbolize_keys!
       when Array
         @config_path = nil
 

data/lib/cliutils/pretty-io.rb

@@ -10,8 +10,14 @@ module CLIUtils
   # CLIMessenger Module
   # Outputs color-coordinated messages to a CLI
   module PrettyIO
-    @@wrap = true
-    @@wrap_char_limit = 40
+
+    class << self
+      attr_accessor :wrap
+      attr_accessor :wrap_char_limit
+    end
+    
+    self.wrap = true
+    self.wrap_char_limit = 40
 
     # Hook that triggers when this module is included.
     # @param [Object] k The includer object
@@ -148,26 +154,6 @@ module CLIUtils
       puts _word_wrap(m, '# ').yellow
     end
 
-    # Toggles wrapping on or off
-    # @param [<True, False>] on
-    # @return [void]
-    def self.wrap(on)
-      @@wrap = on
-    end
-
-    # Returns the current character wrap amount
-    # @return [Integer]
-    def self.wrap_limit
-      @@wrap_char_limit
-    end
-
-    # Sets the number of characters at which to wrap
-    # @param [Integer] chars The number of chars to output before wrapping
-    # @return [void]
-    def self.wrap_at(chars)
-      @@wrap_char_limit = chars
-    end
-    
     private
 
     # Outputs a wrapped string (where each line is limited
@@ -176,9 +162,9 @@ module CLIUtils
     # @param [String] prefix_str The prefix for each line
     # @return [String]
     def _word_wrap(text, prefix_str) 
-      if @@wrap
-        return text if @@wrap_char_limit <= 0
-        text.gsub(/\n/, ' ').gsub(/(.{1,#{@@wrap_char_limit - prefix_str.length}})(\s+|$)/, "#{ prefix_str }\\1\n").strip
+      if PrettyIO.wrap
+        return text if PrettyIO.wrap_char_limit <= 0
+        text.gsub(/\n/, ' ').gsub(/(.{1,#{PrettyIO.wrap_char_limit - prefix_str.length}})(\s+|$)/, "#{ prefix_str }\\1\n").strip
       else
         text
       end

data/lib/cliutils/version.rb

@@ -1,4 +1,4 @@
 module CLIUtils
   # The current version of the gem
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/cliutils.rb

@@ -13,5 +13,5 @@ require 'cliutils/version'
 # The CLIUtils module, which wraps everything
 # in this gem.
 module CLIUtils
-
+  
 end

data/test/messenging_test.rb

@@ -1,4 +1,3 @@
-require 'fileutils'
 require 'logger'
 require 'test/unit'
 
@@ -27,10 +26,10 @@ class TestMessenging < Test::Unit::TestCase
   end
   
   def test_wrapping
-    CLIUtils::PrettyIO.wrap_at(35)
+    CLIUtils::PrettyIO.wrap_char_limit = 35
     
     long_str = 'This is a really long string that should wrap itself at some point, okay?'
-    expected_str = long_str.gsub(/\n/, ' ').gsub(/(.{1,#{CLIUtils::PrettyIO.wrap_limit - 2}})(\s+|$)/, "# \\1\n").strip
+    expected_str = long_str.gsub(/\n/, ' ').gsub(/(.{1,#{CLIUtils::PrettyIO.wrap_char_limit - 2}})(\s+|$)/, "# \\1\n").strip
     assert_output(expected_str.blue + "\n") { messenger.send(:info, long_str) }
   end
 
@@ -47,7 +46,7 @@ class TestMessenging < Test::Unit::TestCase
     messenger.send(:warn, 'Warn test')
     
     File.open(@file1path, 'r') do |f|
-      assert_output("INFO: Info test\nERROR: Error test\n") { puts f.read.lines[1..-1].join }
+      assert_output("INFO: Info test\nERROR: Error test\n") { puts f.read.lines.to_a[1..-1].join }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Aaron Bach
@@ -72,23 +72,17 @@ email:
 - bachya1208@googlemail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".yardoc/checksums"
-- ".yardoc/object_types"
-- ".yardoc/objects/root.dat"
-- ".yardoc/proxy_types"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - cliutils.gemspec
-- features/cli_manager.feature
-- features/step_definitions/cli_manager_steps.rb
-- features/support/env.rb
 - lib/.DS_Store
 - lib/cliutils.rb
 - lib/cliutils/configuration.rb
@@ -104,6 +98,7 @@ files:
 - res/readme-images/messenger-types-1.png
 - res/readme-images/messenger-warn.png
 - res/readme-images/multi-logger.png
+- res/readme-images/prefs-ask.png
 - res/readme-images/prettyio-color-chart.png
 - res/readme-images/prettyio-gnarly-text.png
 - res/readme-images/prettyio-red-text.png
@@ -116,17 +111,12 @@ files:
 - test/prefs_test.rb
 - test/string_extesions_test.rb
 - test/test_files/prefstest.yaml
-homepage: https://github.com/bachya/cli-utils
+homepage: http://www.bachyaproductions.com/cliutils-ruby-library-cli-apps/
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--title"
-- CLIUtils
-- "--main"
-- README.md
-- "-ri"
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -146,9 +136,6 @@ signing_key:
 specification_version: 4
 summary: Sugary goodness for Ruby CLI apps.
 test_files:
-- features/cli_manager.feature
-- features/step_definitions/cli_manager_steps.rb
-- features/support/env.rb
 - test/configurator_test.rb
 - test/hash_extensions_test.rb
 - test/logger_extensions_test.rb
@@ -156,4 +143,4 @@ test_files:
 - test/prefs_test.rb
 - test/string_extesions_test.rb
 - test/test_files/prefstest.yaml
-has_rdoc: true
+has_rdoc: 

data/.yardoc/checksums

@@ -1,11 +0,0 @@
-lib/cliutils.rb 4f397f5444c33ebcebd8384e5b7b498186785d0d
-lib/cliutils/prefs.rb 66f1c006d76b5334ad4b2b427141796d35065c27
-lib/cliutils/version.rb 70a1622cf96c5c986b312e8b7f5751131090b30e
-lib/cliutils/pretty-io.rb fba4516ec1e2561d1b5e613e4f61b04f03e8abc0
-lib/cliutils/messenging.rb c0362bcb8e1090d83966d2b3596532c7f1576570
-lib/cliutils/configurator.rb c202ac417ea4891c990da586d1edf6333f0fa8d6
-lib/cliutils/configuration.rb 02752324c57b7c7054d9a8158f70641cd73682bc
-lib/cliutils/logger-delegator.rb 507b215088c1d019d42059832ef8280f746ee26b
-lib/cliutils/ext/Hash+Extensions.rb e51f7475afccd3ad38a4a62ddcf87216f2dcc974
-lib/cliutils/ext/Logger+Extensions.rb 946bf8385446f369264877a2fe6bb415f24dbcd8
-lib/cliutils/ext/String+Extensions.rb a0a39b16d1709e7f5c5c4eff0d6d8258e691582d

data/features/cli_manager.feature

@@ -1,13 +0,0 @@
-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

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

data/features/support/env.rb

@@ -1,16 +0,0 @@
-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