cliutils 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb6abdf9f2796a668951e2178193ebfa1110b5bf
-  data.tar.gz: 6216f1699daa43bbd541d5c27037278000455b16
+  metadata.gz: 97a26794fd111748a7122e364fd21179f7d1f082
+  data.tar.gz: 78a1352fde30e33340c46340164ddc88a9bf526f
 SHA512:
-  metadata.gz: 4283a18fa302cd1c59aee7d376da17930555b5362f46fda1fe6cb8853ea62ac417e129afc0ef97776c35cc1073678b37e7f88e862d4c05c74770015a8722d62b
-  data.tar.gz: 807478504596067deb636925a4d04a335abac239f775edd4079ac27efe784dd604412d94b24d564ae28190d35a6ba7b1cb8bf1e856fcc4ac86b43e0225d5e228
+  metadata.gz: c92816990f22349112121b23694c85ff0d85b04b8420999ec1047fb6727acc688073b3eb321ef68bb94082972c0a69150b1292a1d5254014c05a7cd76ad671c7
+  data.tar.gz: c9d7ccaaee1a0416cd24030588c936ec285f1b7ea8ed56cc89e9c2c935631b20ab035443da84139a76c426368e33b8f7f540284091eab26b9325567b74722a7f

data/HISTORY.md

@@ -1,3 +1,11 @@
+# 1.2.9 (2014-04-09)
+
+* Added time Pref validator
+* Added datetime Pref validator
+* Added filepath_exists Pref validator
+* Pref Validator change: numeric => number
+* Pref Behavior change: local_filepath => expand_filepath
+
 # 1.2.8 (2014-04-08)
 
 * Global name changes

data/README.md

@@ -122,7 +122,7 @@ messenger.warn('Hey pal, you need to be careful.')
 * `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.
+* `messenger.warn`: used to show a formatted-yellow warning message.
 
 Let's see an example that uses them all:
 
@@ -138,24 +138,37 @@ messenger.success('But Luke still blew up the Death Star!')
 `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 }
-```
+# Outputs 'Starting up...', runs the code in
+# `# do stuff here`, and once complete,
+# outputs 'Done!' on the same line.
+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!).
+# Outputs 'MY SECTION' and then runs
+# the code in `# do stuff here` before
+# proceeding.
+section_block('MY SECTION', multiline = true) {
+  # ...do stuff here...
+}
+```
 
 ### 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
+long_string = 'This is a really long message, okay? ' \
+'It should wrap at some point. Seriously. Wrapping is nice.'
+
 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.')
+messenger.info(long_string)
 puts ''
 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.')
+messenger.info(long_string)
 puts ''
 CLIUtils::PrettyIO.wrap = false
-messenger.info('This is a really long message, okay? It should wrap at some point. Seriously. Wrapping is nice.')
+messenger.info(long_string)
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/wrapping.png "Text Wrapping")
 
@@ -208,7 +221,7 @@ E, [2014-03-29T15:14:34.844553 #4497] ERROR -- : This error should appear in STD
 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!
+Since you are attaching Logger objects, each can have it's own format and severity level. Cool!
 
 ## Configuration
 
@@ -242,9 +255,9 @@ configuration.delete_section(:program_data)
 There are two ways data can be managed in `configurator`: via its `@data` property or via some magic methods; your call:
 
 ```Ruby
-configuration.data[:user_data].merge!(username: 'bob')
+configuration.data[:user_data].merge!({ username: 'bob', age: 45 })
 # OR
-configuration.user_data.merge!(username: 'bob')
+configuration.user_data.merge!({ username: 'bob', age: 45 })
 ```
 
 ### Saving to a File
@@ -262,6 +275,7 @@ Note that all your keys are converted to strings before saving (and, likewise, a
 app_data:
 user_data:
   username: bob
+  age: 45
 ```
 
 ### Checking Configuration Versions
@@ -292,8 +306,7 @@ app_data:
 configuration.cur_version_key = :APP_VERSION
 
 # Tell your configurator the name of the key that
-# stores the last version that needed a configuration
-# change.
+# stores the last version that needed a configuration change.
 # NOTE that you don't have to specify the section.
 configuration.last_version_key = :NEWEST_CONFIG_VERSION
 
@@ -316,7 +329,7 @@ Many times, CLI apps need to ask their users some questions, collect the feedbac
 
 ### Basic Schema
 
-`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:
+`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
@@ -347,7 +360,7 @@ Assuming the above, `Prefs` is instantiated like so:
 prefs = CLIUtils::Prefs.new('path/to/yaml/file')
 ```
 
-`Prefs` can also be instantiated via a Hash or an array of prompts; the overall schema remains the same:
+`Prefs` can also be instantiated via a Hash or an Array of prompts; the overall schema remains the same:
 
 ```Ruby
 # Instantiation through a Hash
@@ -375,9 +388,9 @@ h = {
 }
 
 prefs = CLIUtils::Prefs.new(h)
-
+```
+```Ruby
 # Instantiation through an Array
-
 a = [
   {
     prompt: 'What is your name?',
@@ -502,12 +515,15 @@ prefs.ask
 
 ```YAML
 validators:
-  - alphabetic   # Must be made up of letters and spaces
-  - alphanumeric # Must be made up of letters, numbers, and spaces
-  - date         # Must be a parsable date (e.g., 2014-04-03)
-  - non_nil      # Must be a non-nil value
-  - numeric      # Must be made up of numbers
-  - url          # Must be a fully-qualified URL
+  - alphabetic       # Must be made up of letters and spaces
+  - alphanumeric     # Must be made up of letters, numbers, and spaces
+  - date             # Must be a parsable date (e.g., 2014-04-03)
+  - datetime         # Must be a parsable datetime (e.g., 2014-04-03 9:34am)
+  - non_nil          # Must be a non-nil value
+  - number           # Must be made up of numbers
+  - filepath_exists  # Must be a local filepath that exists (e.g., `/tmp/`)
+  - time             # Must be a parsable time (e.g., 12:45pm or 21:08)
+  - url              # Must be a fully-qualified URL
 ```
 
 An example:
@@ -523,7 +539,7 @@ prompts:
     config_key: age
     config_section: personal_info
     validators:
-      - numeric
+      - number
 ```
 
 ```Ruby
@@ -540,7 +556,7 @@ Finally, a common desire might be to modify the user's answer in some way before
 ```YAML
 validators:
   - capitalize      # Turns "answer" into "Answer"
-  - local_filepath  # Runs File.expand_path on the answer
+  - expand_filepath # Runs File.expand_path on the answer
   - lowercase       # Turns "AnSwEr" into "answer"
   - prefix: 'test ' # Prepends 'test ' to the answer
   - suffix: 'test ' # Appends 'test ' to the answer 
@@ -568,7 +584,7 @@ prefs.ask
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prefs-ask-behaviors.png "Behaviors")
 
-Note that behaviors are executed in order, which might give you different results than you're expecting. In the example above, for example, placing the `uppercase` behavior last in the list will uppercase *the entire string* (including prefix and suffix).
+Note that behaviors are executed in order, which might give you different results than you're expecting. Using the YAML above, for example, placing the `uppercase` behavior last in the list will uppercase *the entire string* (including prefix and suffix).
 
 ### Adding Pref Responses to a Configurator
 

data/lib/cliutils/constants.rb

@@ -1,5 +1,5 @@
 # Stores constants to use.
 module CLIUtils
   # The current version of the gem
-  VERSION = '1.2.8'
+  VERSION = '1.2.9'
 end

data/lib/cliutils/logger_delegator.rb

@@ -16,7 +16,7 @@ module CLIUtils
     end
 
     # Attaches a new target to delegate to.
-    # @param [Logger] target The targets to delegate to
+    # @param [Hash] target A hash describing a reference key and a Logger
     # @return [void]
     def attach(target)
       fail "Cannot add invalid target: #{ target }" unless target.is_a?(Hash)

data/lib/cliutils/prefs/pref_behavior.rb

@@ -14,7 +14,7 @@ module CLIUtils
     # is a filepath).
     # @param [String] args[0] The text to evaluate
     # @return [String]
-    def self.local_filepath(*args)
+    def self.expand_filepath(*args)
       File.expand_path(args[0])
     end
 

data/lib/cliutils/prefs/pref_validation.rb

@@ -8,7 +8,8 @@ module CLIUtils
     # and a result message.
     Validator = Struct.new(:code, :message)
 
-    # Validates that a value is only letters.
+    # Validates that a value is only letters
+    # and spaces.
     # @param [String] text The text to inspect
     # @return [Boolean]
     def self.alphabetic(text)
@@ -17,7 +18,8 @@ module CLIUtils
       Validator.new(c, m)
     end
 
-    # Validates that a value is only letters and numbers.
+    # Validates that a value is only letters, numbers
+    # and spaces.
     # @param [String] text The text to inspect
     # @return [Boolean]
     def self.alphanumeric(text)
@@ -35,6 +37,15 @@ module CLIUtils
       Validator.new(c, m)
     end
 
+    # Validates that a value is a datetime.
+    # @param [String] text The text to inspect
+    # @return [Boolean]
+    def self.datetime(text)
+      m = "Response is not a datetime: #{ text }"
+      c = !(DateTime.parse(text) rescue nil).nil?
+      Validator.new(c, m)
+    end
+
     # Validates that a value is passed and is not
     # empty.
     # @param [String] text The text to inspect
@@ -48,12 +59,31 @@ module CLIUtils
     # Validates that a value is some sort of number.
     # @param [String] text The text to inspect
     # @return [Boolean]
-    def self.numeric(text)
+    def self.number(text)
       m = "Response is not a number: #{ text }"
       c = text.to_s =~ /\A[-+]?\d*\.?\d+\z/
       Validator.new(c, m)
     end
 
+    # Validates that a filepath exists on the
+    # local filesystem.
+    # @param [String] text The text to inspect
+    # @return [Boolean]
+    def self.filepath_exists(text)
+      m = "Path does not exist locally: #{ text }"
+      c = Pathname.new(text).exist?
+      Validator.new(c, m)
+    end
+
+    # Validates that a value is a time.
+    # @param [String] text The text to inspect
+    # @return [Boolean]
+    def self.time(text)
+      m = "Response is not a time: #{ text }"
+      c = !(Time.parse(text) rescue nil).nil?
+      Validator.new(c, m)
+    end
+
     # Validates that passed value is a URL.
     # @param [String] text The text to inspect
     # @return [Boolean]

data/test/test_files/prefstest.yaml

@@ -7,4 +7,4 @@ prompts:
     behaviors:
       - uppercase
       - prefix: 'My favorite food: '
-      - suffix: ' (Italian food FTW!)'
+      - suffix: ' (soooo good!)'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Aaron Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,6 @@ files:
 - README.md
 - Rakefile
 - cliutils.gemspec
-- lib/.DS_Store
 - lib/cliutils.rb
 - lib/cliutils/configuration.rb
 - lib/cliutils/configurator.rb