cliutils 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 069c2e2c3141bb0295825c6a7ddcbaa9e5fce3b5
-  data.tar.gz: bd67db92f1833ecec791f0d58974687d2e5dae5a
+  metadata.gz: ac9423ddd995d1468da91eff3b3abf630b7c5aa1
+  data.tar.gz: 6e430afb3d34414ee453b4fa70be21878f9a8c2f
 SHA512:
-  metadata.gz: d2a266ed437b59e7a41733ac86659f75def0aebb7dda0566530d2f7debd22ba7573acb6c4376cc7447a8a98cba505d96af9c452bb6cc1da6ebed6cf2e63b9c70
-  data.tar.gz: d5860547ff62f94989e8de94fa9502295b1f4439db0b8e9eac2638fe7d8beb38d9c173eeea7697935c4898bf975c0d261651383d35eeee4384c2f76875472d96
+  metadata.gz: d96e9df275ed3a6272ae23c85023c82671b6af7e1168867a1f675904b50369e0567bd47b6e4c1183f471f928b56c20c4ba21883b82af35d5386e2fc240791218
+  data.tar.gz: 28cb0e9a8af04179edefaba915f7ecb6f3fcddc8d33e460323c28cb11924ebb5ae476578fcc74e023389246d09851c25e58d21cce12bc5ec7478a7a253b5a255

data/HISTORY.md

@@ -1,3 +1,7 @@
+# 1.2.7 (2014-04-08)
+
+* Added more Behaviors
+
 # 1.2.6 (2014-04-08)
 
 * More documentation

data/README.md

@@ -498,7 +498,20 @@ prefs.ask
 
 ### Validators
 
-"But," you say, "I want to ensure that my user gives answers that conform to certain specifications!" Not a problem, dear user, `Prefs` has you covered:
+"But," you say, "I want to ensure that my user gives answers that conform to certain specifications!" Not a problem, dear user: `Prefs` gives you Validators. Currently supported Validators are:
+
+```YAML
+validators:
+  - numeric      # Must be a number
+  - 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
+```
+
+An example:
 
 ```YAML
 prompts:
@@ -519,33 +532,44 @@ prefs.ask
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prefs-ask-validators.png "Validators")
 
-`Prefs` currently supports these 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
+Note that validators are evaluated in order, from top to bottom. If any validator fails, `messenger` will display an error and prompt the user to try again.
 
 ### Behaviors
 
-Finally, a common desire might be to modify the user's answer in some way:
+Finally, a common desire might be to modify the user's answer in some way before storing it. `Prefs` accomplishes this via Behaviors. Currently supported Behaviors are:
+
+```YAML
+validators:
+  - capitalize      # Turns "answer" into "Answer"
+  - local_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 
+  - titlecase       # Turns "the answer" into "The Answer"
+  - uppercase       # Turns "answer" to "ANSWER"
+```
+
+An example:
 
 ```YAML
 prompts:
-  - prompt: Where is your SSH public key located?
-    config_key: pub_key
+  - prompt: What is your favorite food?
+    config_key: food
     config_section: personal_info
+    validators:
+      - non_nil
     behaviors:
-      - local_filepath
+      - uppercase
+      - prefix: 'My favorite food: '
+      - suffix: ' (soooo good!)'
 ```
 
-The `local_filepath` behavior will expand the user's answer as a filepath (e.g., `~/.ssh` will get saved as `/Users/bob/.ssh/`).
-
-`Prefs` currently supports these behaviors:
+```Ruby
+prefs.ask
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prefs-ask-behaviors.png "Behaviors")
 
-* `local_filepath`: runs File.expand_path on the answer
+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).
 
 ### Adding Pref Responses to a Configurator
 
@@ -604,5 +628,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-

data/lib/cliutils/constants.rb

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

data/lib/cliutils/prefs/pref.rb

@@ -70,9 +70,15 @@ module CLIUtils
     def evaluate_behaviors(text)
       if @behaviors
         modified_text = text
-        @behaviors.each do |b|
-          if PrefBehavior.respond_to?(b)
-            modified_text = PrefBehavior.send(b, modified_text)
+        @behaviors.each do |method|
+          if method.is_a?(Hash)
+            parameter = method.values[0]
+            method = method.keys[0]
+          end
+
+          args = [modified_text, parameter]
+          if PrefBehavior.respond_to?(method)
+            modified_text = PrefBehavior.send(method, *args)
           else
             messenger.warn("Skipping undefined Pref behavior: #{ b }")
           end

data/lib/cliutils/prefs/pref_behavior.rb

@@ -3,12 +3,56 @@ module CLIUtils
   # Behaviors that should be applied to a Pref's
   # final value
   module PrefBehavior
+    # Capitalizes the first word of the passed text.
+    # @param [String] args[0] The text to evaluate
+    # @return [String]
+    def self.capitalize(*args)
+      args[0].capitalize
+    end
+
     # Expands the passed text (assumes it
     # is a filepath).
-    # @param [String] text The text to evaluate
+    # @param [String] args[0] The text to evaluate
+    # @return [String]
+    def self.local_filepath(*args)
+      File.expand_path(args[0])
+    end
+
+    # Lowercases all characters in the passed text.
+    # @param [String] args[0] The text to evaluate
+    # @return [String]
+    def self.lowercase(*args)
+      args[0].downcase
+    end
+
+    # Adds a prefix to the passed text.
+    # @param [String] args[0] The text to evaluate
+    # @param [String] args[1] The prefix to add
+    # @return [String]
+    def self.prefix(*args)
+      args[1] + args[0]
+    end
+
+    # Adds a suffix to the passed text.
+    # @param [String] args[0] The text to evaluate
+    # @param [String] args[1] The suffix to add
+    # @return [String]
+    def self.suffix(*args)
+      args[0] + args[1]
+    end
+
+    # Capitalizes each word in the passed text.
+    # @param [String] args[0] The text to evaluate
+    # @return [String]
+    def self.titlecase(*args)
+      args[0].split.map(&:capitalize).join(' ')
+    end
+
+    # Uppercases all characters in the passed text.
+    # @param [String] args[0] The text to evaluate
     # @return [String]
-    def self.local_filepath(text)
-      File.expand_path(text)
+    def self.uppercase(*args)
+      args[0].upcase
     end
   end
 end

data/test/test_files/prefstest.yaml

@@ -1,28 +1,10 @@
 prompts:
-  - prompt: Batman or Superman?
-    default: Batman
-    config_key: superhero
-    config_section: personal_info
-    options: ['Batman', 'Superman']
-  - prompt: Do you feel smart for preferring Batman?
-    default: Y
-    config_key: batman_answer
-    config_section: personal_info
-    prereqs:
-      - config_key: superhero
-        config_value: Batman
-  - prompt: Why do you prefer Superman?!
-    default: No clue
-    config_key: superman_answer
-    config_section: personal_info
-    prereqs:
-      - config_key: superhero
-        config_value: Superman
-  - prompt: Why don't you have a clue?
-    config_key: no_clue
-    config_section: personal_info
-    prereqs:
-      - config_key: superhero
-        config_value: Superman
-      - config_key: superman_answer
-        config_value: No clue
+  - prompt: What is your favorite food?
+    config_key: food
+    config_section: personal_info
+    validators:
+      - non_nil
+    behaviors:
+      - uppercase
+      - prefix: 'My favorite food: '
+      - suffix: ' (Italian food FTW!)'

metadata

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