cliutils 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96c4a2208dc32603d60a3d1615cbcee89e35089f
-  data.tar.gz: 74a8b7774dc1b13e054de3449e2fdf8666648673
+  metadata.gz: 1bba7fa0a39d1e55ba1a84a6ffadb7ebd649d2a0
+  data.tar.gz: b4ba62f707e30bc694310c612b738458739cf139
 SHA512:
-  metadata.gz: e29a35f2889f09151ff12dcd1db686f8b984a5fa84eb8d93e2e54cbdf3975afa20e71c444dd549a6f877ee07bc9553d708f36affa1963f681a0d1bfb41e7c942
-  data.tar.gz: d9c9efd319ad362fa145c8abee217898fccb46f175fa3d5a120a922a1c714c5e95e11162e99bd80cb653d881e840d9cfac28f0fbfe902b5077952dbc2d9dc923
+  metadata.gz: a64a0501b9af9eec35d8d80d6e2ff25926e653705e3ddfd446345cc1614f55eb3d6da5e8351182ea069eaa88f8099e50586682d5c3bd0a085b324e06125166ca
+  data.tar.gz: 1aa47c68d25a0981f8f08ec10d9a99ba5cce648f74d155a51181c33034eb683a289d7937d1e5106b3d594fcd6b9a3661a11d5f901749a479a7b55e53601d5347

data/Gemfile.lock

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

data/HISTORY.md

@@ -1,3 +1,10 @@
+# 1.1.0 (2014-04-01)
+
+* Added notice of valid options in Prefs
+* Added ability for Prefs to use defaults from Configuration values
+* Increased default wrapping to 80 characters
+* Fixed a bug in which Prefs would not convert answer keys to symbols
+
 # 1.0.7 (2014-03-30)
 
 * Modified Messenging targets to be a Hash for easier lookup/deletion

data/README.md

@@ -178,7 +178,7 @@ For instance, let's say you wanted to log a few messages to both your user's STD
 ```Ruby
 messenger.info('This should only appear in STDOUT.')
 
-#messenger.attach takes a Hash of string/symbol keys
+# messenger.attach takes a Hash of string/symbol keys
 # and Logger values (so you can refer to them later on).
 messenger.attach(MY\_FILE\_LOGGER: Logger.new('file.txt'))
 
@@ -328,6 +328,14 @@ configuration.ingest(prefs)
 configuration.save
 ```
 
+Note that you can also initialize a `Prefs` object with a Configurator:
+
+```Ruby
+prefs = CLIUtils::Prefs.new('path/to/yaml/file', my_configurator)
+```
+
+In this case, `Prefs` will look to see if any values already exist for a specific prompt; if so, that value will be used as the default, rather than the default specified in the YAML.
+
 ### 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.

data/lib/cliutils/configurator.rb

@@ -57,8 +57,8 @@ module CLIUtils
     def ingest_prefs(prefs)
       fail 'Invaid Prefs class' if !prefs.kind_of?(Prefs) || prefs.answers.nil?
       prefs.answers.each do |p|
-        add_section(p[:section]) unless @data.key?(p[:section])
-        @data[p[:section]].merge!(p[:key] => p[:answer])
+        add_section(p[:section].to_sym) unless @data.key?(p[:section].to_sym)
+        @data[p[:section].to_sym].merge!(p[:key].to_sym => p[:answer])
       end
     end
 

data/lib/cliutils/prefs.rb

@@ -1,4 +1,5 @@
 require 'cliutils/pretty-io'
+require 'cliutils/configuration'
 
 module CLIUtils
   # Engine to derive preferences from a YAML file, deliver
@@ -6,12 +7,16 @@ module CLIUtils
   class Prefs
     include PrettyIO
     # Stores answers to prompt questions.
-    # @return [Hash]
+    # @return [Array]
     attr_reader :answers
     
     # Stores the filepath (if it exists) to the prefs file.
     # @return [String]
     attr_reader :config_path
+
+    # Stores a Configurator instance.
+    # @return [Configurator]
+    attr_reader :configurator
     
     # Stores answers to prompt questions.
     # @return [Hash]
@@ -19,9 +24,11 @@ module CLIUtils
 
     # Reads prompt data from and stores it.
     # @param [<String, Hash, Array>] data Filepath to YAML, Hash, or Array
+    # @param [Configurator] configurator The configurator to take default values from
     # @return [void]
-    def initialize(data)
+    def initialize(data, configurator = nil)
       @answers = []
+      @configurator = configurator
       @prompts = {}
 
       case data
@@ -71,20 +78,28 @@ module CLIUtils
     # @param [Hash] p The prompt
     # @return [void]
     def _deliver_prompt(p)
+      default = p[:default]
+      
+      unless @configurator.nil?
+        unless @configurator.data[p[:section].to_sym].nil?
+          config_val = @configurator.data[p[:section].to_sym][p[:key].to_sym]
+          default = config_val unless config_val.nil?
+        end
+      end
+      
       if p[:options].nil?
-        pref = prompt(p[:prompt], p[:default])
+        pref = prompt(p[:prompt], default)
       else
         valid_option_chosen = false
         until valid_option_chosen
-          pref = prompt(p[:prompt], p[:default])
+          pref = prompt(p[:prompt], default)
           if p[:options].include?(pref)
             valid_option_chosen = true
           else
-            error("Invalid option chosen: #{ pref }")
+            error("Invalid option chosen (\"#{ pref }\"); valid options are: #{ p[:options] }")
           end
         end
       end
-
       p[:answer] = pref
       @answers << p
     end

data/lib/cliutils/pretty-io.rb

@@ -10,7 +10,6 @@ module CLIUtils
   # CLIMessenger Module
   # Outputs color-coordinated messages to a CLI
   module PrettyIO
-
     class << self
       # Determines whether wrapping should be enabled.
       # @return [Boolean]
@@ -22,7 +21,7 @@ module CLIUtils
     end
     
     self.wrap = true
-    self.wrap_char_limit = 40
+    self.wrap_char_limit = 80
 
     # Hook that triggers when this module is included.
     # @param [Object] k The includer object

data/lib/cliutils/version.rb

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

data/test/test_files/prefstest.yaml

@@ -1,7 +1,10 @@
 prompts:
-  - prompt: What is the hostname of your DD-WRT router?
+  - prompt: What is the local hostname of your DD-WRT router?
     default: 192.168.1.1
-    key: hostname
+    key: local_hostname
+    section: ssh_info
+  - prompt: What is the remote hostname of your DD-WRT router?
+    key: remote_hostname
     section: ssh_info
   - prompt: What is the SSH username of your DD-WRT router?
     default: root

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Aaron Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler