cliutils 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca5b15c24edde2e480643aa5000e91a68943f766
-  data.tar.gz: d283212ce924d7ece2287cea5f9dc32c3afb15f6
+  metadata.gz: 8839468d53bb07c10d7e1d3bbda3fce0d65d9f4c
+  data.tar.gz: 7bea2c8039d87cbb73660649f42350501a84efe6
 SHA512:
-  metadata.gz: a5b85729adf2be08e8855619f406dd68a2671292a0c90b2f8afab1669096929bf8a45a7ea54e0637ac299d4d59542be50b07bc5dfea22c0446969a305147bbcd
-  data.tar.gz: 74445a9470d3f3a226f15af32a678c4abfbd832b0ac7258c7e0d70278ca60bc3e38cb17797c6e253e939c5cecf7ee7e874d74772168f97dcff6dc601688681b2
+  metadata.gz: 67a30a0cc57dbc88a773262a2ac543424b1ff1dd7952bf7ecf7419e2c93a74fce2cb8d6a1b8aa45bfb1b11f801f336bf0c646d5b871e31cb0dc71730cca4cf61
+  data.tar.gz: c10b1b10d0f32a72a389a513727c3c9e1c3da504fd3981a1896dfce648d0b3d036e6c46cc86e8216204663523dca8dfbae93e8ed5db94219c05e62af2c997e38

data/Gemfile.lock

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

data/HISTORY.md

@@ -1,3 +1,7 @@
+# 1.0.6 (2014-03-30)
+
+* Added convenience logging constant to Configuration
+
 # 1.0.5 (2014-03-30)
 
 * Fixed a bug with Configuration singleton

data/lib/cliutils/configuration.rb

@@ -5,6 +5,15 @@ module CLIUtils
   # Manages any configuration values and the flat YAML file
   # into which they get stored.
   module Configuration
+    # Allows easy access to Logger levels.
+    LOG_LEVELS = {
+      'DEBUG' => Logger::DEBUG,
+      'INFO'  => Logger::INFO,
+      'WARN'  => Logger::WARN,
+      'ERROR' => Logger::ERROR,
+      'FATAL' => Logger::FATAL,
+    }
+
     # Hook that triggers when this module is included.
     # @param [Object] k The includer object
     # @return [void]

data/lib/cliutils/configurator.rb

@@ -5,7 +5,13 @@ module CLIUtils
   #  Manages any configuration values and the flat YAML file
   #  into which they get stored.
   class Configurator
-    attr_reader :config_path, :data
+    # Stores the path to the configuration file.
+    # @return [String]
+    attr_reader :config_path
+    
+    # Stores the configuration data itself.
+    # @return [Hash]
+    attr_reader :data
 
     # Initializes configuration from a flat file.
     # @param [String] path The filepath to the config YAML

data/lib/cliutils/logger-delegator.rb

@@ -3,6 +3,8 @@ module CLIUtils
   # Delegates certain Logger methods to a number of different
   # targets.
   class LoggerDelegator
+    # The endpoints to which delegation occurs.
+    # @return [Array]
     attr_reader :targets
 
     # Initializes and creates methods for the passed targets.

data/lib/cliutils/prefs.rb

@@ -5,7 +5,17 @@ module CLIUtils
   # those to a user via a prompt, and collect the results.
   class Prefs
     include PrettyIO
-    attr_reader :answers, :config_path, :prompts
+    # Stores answers to prompt questions.
+    # @return [Hash]
+    attr_reader :answers
+    
+    # Stores the filepath (if it exists) to the prefs file.
+    # @return [String]
+    attr_reader :config_path
+    
+    # Stores answers to prompt questions.
+    # @return [Hash]
+    attr_reader :prompts
 
     # Reads prompt data from and stores it.
     # @param [<String, Hash, Array>] data Filepath to YAML, Hash, or Array

data/lib/cliutils/pretty-io.rb

@@ -12,7 +12,12 @@ module CLIUtils
   module PrettyIO
 
     class << self
+      # Determines whether wrapping should be enabled.
+      # @return [Boolean]
       attr_accessor :wrap
+
+      # Determines when strings should begin to wrap
+      # @return [Integer]
       attr_accessor :wrap_char_limit
     end
     

data/lib/cliutils/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Aaron Bach