cliutils 1.0.2 → 1.0.3

data/lib/cliutils/logger-delegator.rb

@@ -1,49 +1,29 @@
 module CLIUtils
-  #  ======================================================
-  #  LoggerDelegator Class
-  #
-  #  Manages any configuration values and the flat YAML file
-  #  into which they get stored.
-  #  ======================================================
+  # LoggerDelegator Class
+  # Delegates certain Logger methods to a number of different
+  # targets.
   class LoggerDelegator
-    #  ====================================================
-    #  Attributes
-    #  ====================================================  
-    attr_reader :devices
+    attr_reader :targets
 
-    #  ====================================================
-    #  Methods
-    #  ====================================================
-    #  ----------------------------------------------------
-    #  initialize method
-    #
-    #  Initializer
-    #  @param *targets The endpoints to delegate to
-    #  @return void
-    #  ----------------------------------------------------
+    # Initializes and creates methods for the passed targets.
+    # @param [Logger] targets The endpoints to delegate to
+    # @return [void]
     def initialize(*targets)
       @targets = targets
       LoggerDelegator.delegate
     end
 
-    #  ----------------------------------------------------
-    #  attach method
-    #
-    #  Attaches a new target to delegate to.
-    #  @return void
-    #  ----------------------------------------------------  
+    # Attaches a new target to delegate to.
+    # @param [Logger] target The targets to delegate to
+    # @return [void]
     def attach(target)
       @targets << target
       LoggerDelegator.delegate
     end
 
-    #  ----------------------------------------------------
-    #  delegate_all method
-    #
-    #  Creates delegator methods for all of the methods
-    #  on IO.
-    #  @return void
-    #  ----------------------------------------------------
+    # Creates delegator methods for a specific list of Logger
+    # functions.
+    # @return [void]
     def self.delegate
       %w(log debug info warn error section success).each do |m|
         define_method(m) do |*args|
@@ -52,12 +32,8 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  detach method
-    #
-    #  Detaches a delegation target.
-    #  @return void
-    #  ----------------------------------------------------  
+    # Detaches a delegation target.
+    # @return [void]
     def detach(target)
       @targets.delete(target)
       LoggerDelegator.delegate

data/lib/cliutils/messenging.rb

@@ -1,33 +1,19 @@
 module CLIUtils
-  #  ======================================================
   #  CLIMessenger Module
-  #  Outputs color-coordinated messages to a CLI
-  #  ======================================================
+  #  Outputs coordinated messages to a variety of targets.
   module Messenging
     include CLIUtils::PrettyIO
 
-    #  ====================================================
-    #  Methods
-    #  ====================================================
-    #  ----------------------------------------------------
-    #  included method
-    #
-    #  Hook called when this module gets mixed in; extends
-    #  the includer with the methods defined here.
-    #  @param k The includer
-    #  @return Void
-    #  ----------------------------------------------------
+    # Hook that triggers when this module is included.
+    # @param [Object] k The includer object
+    # @return [void]
     def self.included(k)
       k.extend(self)
     end
 
-    #  ----------------------------------------------------
-    #  default_instance method
-    #
-    #  Returns a default instance of LoggerDelegator that
-    #  delegates to STDOUT only.
-    #  @return LoggerDelegator
-    #  ----------------------------------------------------
+    # Returns a default instance of LoggerDelegator that
+    # delegates to STDOUT only.
+    # @return [LoggerDelegator]
     def default_instance
       stdout_logger = Logger.new(STDOUT)
       stdout_logger.formatter = proc do |severity, datetime, progname, msg|
@@ -37,13 +23,9 @@ module CLIUtils
       LoggerDelegator.new(stdout_logger)
     end
 
-    #  ----------------------------------------------------
-    #  messenger method
-    #
-    #  Singleton method to return (or initialize, if needed)
-    #  a LoggerDelegator.
-    #  @return LoggerDelegator
-    #  ----------------------------------------------------
+    # Singleton method to return (or initialize, if needed)
+    # a LoggerDelegator.
+    # @return [LoggerDelegator]
     def messenger
       @messenger ||= default_instance
     end

data/lib/cliutils/prefs.rb

@@ -1,26 +1,13 @@
 module CLIUtils
-  #  ======================================================
-  #  PrefManager Class
-  #
-  #  Engine to derive preferences from a YAML file, deliver
-  #  those to a user via a prompt, and collect the results.
-  #  ======================================================
+  # Engine to derive preferences from a YAML file, deliver
+  # those to a user via a prompt, and collect the results.
   class Prefs
     include PrettyIO
-    #  ====================================================
-    #  Attributes
-    #  ====================================================
     attr_reader :answers, :config_path, :prompts
 
-    #  ====================================================
-    #  Methods
-    #  ====================================================
-    #  ----------------------------------------------------
-    #  initialize method
-    #
-    #  Reads prompt data from YAML file.
-    #  @return Void
-    #  ----------------------------------------------------
+    # Reads prompt data from and stores it.
+    # @param [<String, Array>] data Either a filepath or an array
+    # @return [void]
     def initialize(data)
       @answers = []
       @prompts = {}
@@ -45,15 +32,11 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  ask method
-    #
-    #  Runs through all of the prompt questions and collects
-    #  answers from the user. Note that all questions w/o
-    #  requirements are examined first; once those are
-    #  complete, questions w/ requirements are examined.
-    #  @return Void
-    #  ----------------------------------------------------
+    # Runs through all of the prompt questions and collects
+    # answers from the user. Note that all questions w/o
+    # requirements are examined first; once those are
+    # complete, questions w/ requirements are examined.
+    # @return [void]
     def ask
       @prompts[:prompts].reject { |p| p[:requirements] }.each do |p|
         _deliver_prompt(p)
@@ -66,14 +49,10 @@ module CLIUtils
 
     private
 
-    #  ----------------------------------------------------
-    #  _deliver_prompt method
-    #
-    #  Utility method for prompting the user to answer the
-    #  question (taking into account any options).
-    #  @param p The prompt
-    #  @return Void
-    #  ----------------------------------------------------
+    # Utility method for prompting the user to answer the
+    # question (taking into account any options).
+    # @param [Hash] p The prompt
+    # @return [void]
     def _deliver_prompt(p)
       if p[:options].nil?
         pref = prompt(p[:prompt], p[:default])
@@ -93,14 +72,10 @@ module CLIUtils
       @answers << p
     end
 
-    #  ----------------------------------------------------
-    #  _requirements_fulfilled? method
-    #
-    #  Utility method for determining whether a prompt's
-    #  requirements have already been fulfilled.
-    #  @param p The prompt
-    #  @return Void
-    #  ----------------------------------------------------
+    # Utility method for determining whether a prompt's
+    # requirements have already been fulfilled.
+    # @param [Hash] p The prompt
+    # @return [void]
     def _requirements_fulfilled?(p)
       ret = true
       p[:requirements].each do |req|

data/lib/cliutils/pretty-io.rb

@@ -7,36 +7,22 @@ end
 require 'readline'
 
 module CLIUtils
-  #  ======================================================
-  #  CLIMessenger Module
-  #  Outputs color-coordinated messages to a CLI
-  #  ======================================================
+  # CLIMessenger Module
+  # Outputs color-coordinated messages to a CLI
   module PrettyIO
     @@wrap = true
     @@wrap_char_limit = 40
 
-    #  ====================================================
-    #  Methods
-    #  ====================================================  
-    #  ----------------------------------------------------
-    #  included method
-    #
-    #  Hook called when this module gets mixed in; extends
-    #  the includer with the methods defined here.
-    #  @param k The includer
-    #  @return Void
-    #  ----------------------------------------------------
+    # Hook that triggers when this module is included.
+    # @param [Object] k The includer object
+    # @return [void]
     def self.included(k)
       k.extend(self)
     end
 
-    #  ----------------------------------------------------
-    #  color_chart method
-    #
-    #  Displays a chart of all the possible ANSI foreground
-    #  and background color combinations.
-    #  @return Void
-    #  ----------------------------------------------------
+    # Displays a chart of all the possible ANSI foreground
+    # and background color combinations.
+    # @return [void]
     def color_chart
       [0, 1, 4, 5, 7].each do |attr|
         puts '----------------------------------------------------------------'
@@ -50,46 +36,31 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  debug method
-    #
-    #  Empty method so that Messenging doesn't freak
-    #  out when passed a debug message.
-    #  @return Void
-    #  ----------------------------------------------------
+    # Empty method so that Messenging doesn't freak
+    # out when passed a debug message.
+    # @return [void]
     def debug(m); end
 
-    #  ----------------------------------------------------
-    #  error method
-    #
-    #  Outputs a formatted-red error message.
-    #  @param m The message to output
-    #  @return Void
-    #  ----------------------------------------------------
+    # Outputs a formatted-red error message.
+    # @param [String] m The message to output
+    # @return [void]
     def error(m)
       puts _word_wrap(m, '# ').red
     end
 
-    #  ----------------------------------------------------
-    #  info method
-    #
-    #  Outputs a formatted-blue informational message.
-    #  @param m The message to output
-    #  @return Void
-    #  ----------------------------------------------------
+    # Outputs a formatted-blue informational message.
+    # @param [String] m The message to output
+    # @return [void]
     def info(m)
       puts _word_wrap(m, '# ').blue
     end
 
-    #  ----------------------------------------------------
-    #  info_block method
-    #
-    #  Wraps a block in an opening and closing info message.
-    #  @param m1 The opening message to output
-    #  @param m2 The closing message to output
-    #  @param multiline Whether the message should be multiline
-    #  @return Void
-    #  ----------------------------------------------------
+    # Wraps a block in an opening and closing info message.
+    # @param [String] m1 The opening message to output
+    # @param [String] m2 The closing message to output
+    # @param [<True, False>] multiline Whether the message should be multiline
+    # @yield
+    # @return [void]
     def info_block(m1, m2 = 'Done.', multiline = false)
       if block_given?
         if multiline
@@ -110,24 +81,17 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  log method
-    #
-    #  Empty method so that Messenging doesn't freak
-    #  out when passed a debug message.
-    #  @return Void
-    #  ----------------------------------------------------
+    # Empty method so that Messenging doesn't freak
+    # out when passed a debug message.
+    # @return [void]
     def log(m); end
 
-    #  ----------------------------------------------------
-    #  prompt method
-    #
-    #  Outputs a prompt, collects the user's response, and
-    #  returns it.
-    #  @param prompt The prompt to output
-    #  @param default The default option
-    #  @return String
-    #  ----------------------------------------------------
+    # Outputs a prompt, collects the user's response, and
+    # returns it.
+    # @param [String] prompt The prompt to output
+    # @param [String] default The default option
+    # @param [String] start_dir The directory to start from for autocompletion
+    # @return [String]
     def prompt(prompt, default = nil, start_dir = '')
       Readline.completion_append_character = nil
       Readline.completion_proc = lambda do |prefix|
@@ -144,27 +108,18 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  section method
-    #
-    #  Outputs a formatted-purple section message.
-    #  @param m The message to output
-    #  @return Void
-    #  ----------------------------------------------------
+    # Outputs a formatted-purple section message.
+    # @param [String] m The message to output
+    # @return [void]
     def section(m)
       puts _word_wrap(m, '---> ').purple
     end
 
-    #  ----------------------------------------------------
-    #  section_block method
-    #
-    #  Wraps a block in an opening and closing section
-    #  message.
-    #  @param m1 The opening message to output
-    #  @param m2 The closing message to output
-    #  @param multiline A multiline message or not
-    #  @return Void
-    #  ----------------------------------------------------
+    # Wraps a block in an opening and closing section message.
+    # @param [String] m The opening message to output
+    # @param [<True, False>] multiline Whether the message should be multiline
+    # @yield
+    # @return [void]
     def section_block(m, multiline = true)
       if block_given?
         if multiline
@@ -179,70 +134,47 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  success method
-    #
-    #  Outputs a formatted-green success message.
-    #  @param m The message to output
-    #  @return Void
-    #  ----------------------------------------------------
+    # Outputs a formatted-green success message.
+    # @param [String] m The message to output
+    # @return [void]
     def success(m)
       puts _word_wrap(m, '# ').green
     end
 
-    #  ----------------------------------------------------
-    #  warning method
-    #
-    #  Outputs a formatted-yellow warning message.
-    #  @param m The message to output
-    #  @return Void
-    #  ----------------------------------------------------
+    # Outputs a formatted-yellow warning message.
+    # @param [String] m The message to output
+    # @return [void]
     def warn(m)
       puts _word_wrap(m, '# ').yellow
     end
 
-    #  ----------------------------------------------------
-    #  wrap method
-    #
-    #  Toggles wrapping on or off
-    #  @return Integer
-    #  ----------------------------------------------------
+    # Toggles wrapping on or off
+    # @param [<True, False>] on
+    # @return [void]
     def self.wrap(on)
       @@wrap = on
     end
 
-    #  ----------------------------------------------------
-    #  wrap_limit method
-    #
-    #  Returns the current character wrap amount
-    #  @return Integer
-    #  ----------------------------------------------------
+    # Returns the current character wrap amount
+    # @return [Integer]
     def self.wrap_limit
       @@wrap_char_limit
     end
 
-    #  ----------------------------------------------------
-    #  wrap_at method
-    #
-    #  Sets the number of characters at which to wrap
-    #  @return Integer
-    #  ----------------------------------------------------
+    # 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
 
-    #  ----------------------------------------------------
-    #  _word_wrap method
-    #
-    #  Outputs a wrapped string (where each line is limited
-    #  to a certain number of characters).
-    #  @param text The text to wrap
-    #  @param prefix_str The prefix for each line
-    #  @param line_width The number of characters per line
-    #  @return String
-    #  ----------------------------------------------------
+    # Outputs a wrapped string (where each line is limited
+    # to a certain number of characters).
+    # @param [String] text The text to wrap
+    # @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

data/lib/cliutils/version.rb

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

data/lib/cliutils.rb

@@ -10,6 +10,8 @@ require 'cliutils/messenging'
 require 'cliutils/prefs'
 require 'cliutils/version'
 
+# The CLIUtils module, which wraps everything
+# in this gem.
 module CLIUtils
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Aaron Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-29 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,12 +52,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
 description: A library of functionality designed to alleviate common tasks and headaches
   when developing command-line (CLI) apps in Ruby.
 email:
 - bachya1208@googlemail.com
-executables:
-- cliutils
+executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -72,32 +85,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/cliutils
 - cliutils.gemspec
-- doc/CLIUtils.html
-- doc/CLIUtils/Configuration.html
-- doc/CLIUtils/Configurator.html
-- doc/CLIUtils/LoggerDelegator.html
-- doc/CLIUtils/Messenging.html
-- doc/CLIUtils/Prefs.html
-- doc/CLIUtils/PrettyIO.html
-- doc/Hash.html
-- doc/Logger.html
-- doc/String.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - features/cli_manager.feature
 - features/step_definitions/cli_manager_steps.rb
 - features/support/env.rb

data/bin/cliutils

@@ -1,38 +0,0 @@
-#!/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