cliutils 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b935a6abdb2d5219fc26e2e48196ac7457d1356
-  data.tar.gz: d0e4774d9efc3c844f7d88adf646a3466d8625f0
+  metadata.gz: fcb17ad9640f90cacc87af17bac0d029d40ca4f0
+  data.tar.gz: 97a656dee8638fb13c0548d802b1c88a66b40e58
 SHA512:
-  metadata.gz: 9e27d2ac30177630a86aeb0e994a31160fb598fd2ad9970ad1958e46a2af80f7b6837a3cab7a0a962a5d97d3ef25f1e6860b5df8111fb3a7e01f2adae9a33f53
-  data.tar.gz: 9970736e7841b7a8762fc3c2cee06c0412b8c076c01e4e21fc46d0f4429316a1430a3d66f5dfb89e8c6fe874aed0cb7008db63c53e70f1eda30f2cc64ae89971
+  metadata.gz: c54f72b7d9af949a9840a4f89325a6a767d646495611996bf8a60722bc20c72517d62904e9bb55c798c542fc45744811ae30fc30907e6983004a8f269e3c797d
+  data.tar.gz: 0af2677afcd529a66ce4d64a2483f2a79612ae3430c2efeee05850e562bcb68a3f6bfd66327c01b6d2101b64350abba55113e3d53d299e31b20ded8e06dda4b2

data/HISTORY.md

@@ -1,3 +1,7 @@
+# 1.4.0 (2014-04-14)
+
+* Added Pref actions
+
 # 1.3.1 (2014-04-12)
 
 * Modified version check to include missing current version

data/README.md

@@ -1,7 +1,7 @@
 CLIUtils
 ====
 [![Build Status](https://travis-ci.org/bachya/cliutils.svg?branch=master)](https://travis-ci.org/bachya/cliutils)
-[![Gem Version](https://badge.fury.io/rb/cliutils.png)](http://badge.fury.io/rb/cliutils)
+[![Gem Version](https://badge.fury.io/rb/cliutils.svg)](http://badge.fury.io/rb/cliutils)
 
 CLIUtils is a library of functionality designed to alleviate common tasks and headaches when developing command-line (CLI) apps in Ruby.
 
@@ -13,6 +13,10 @@ It's fairly simple:
 2. I found myself copy/pasting common code from one to another.
 3. I decided to do something about it.
 
+# Can I use it with...?
+
+I often get asked how nicely CLIUtils plays with other Ruby-based CLI libraries (like Dave Copeland's excellent [Methadone](https://github.com/davetron5000/methadone "Methadone") and [GLI](https://github.com/davetron5000/gli "GLI")). Answer: they play very nicely. I use CLIUtils in [Sifttter Redux](https://github.com/bachya/Sifttter-Redux "Sifttter Redux") (which is built on GLI) and [ExpandSync](https://github.com/bachya/ExpandSync "ExpandSync") (which is built on Methadone).
+
 # Installation
 
 Add this line to your application's Gemfile:
@@ -35,7 +39,7 @@ $ gem install cliutils
 
 # Usage
 
-```ruby
+```rub
 require 'cliutils'
 ```
 
@@ -58,7 +62,7 @@ CLIUtils offers:
 * [Configuration](#configuration): a app configuration manager
 * [Prefs](#prefs): a preferences prompter and manager
 
-## PrettyIO
+# PrettyIO
 
 First stop on our journey is better client IO via `PrettyIO`. To activate, simply mix into your project:
 
@@ -66,7 +70,7 @@ First stop on our journey is better client IO via `PrettyIO`. To activate, simpl
 include CLIUtils::PrettyIO
 ```
 
-### Colored Strings
+## Colored Strings
 
 To start, `PrettyIO` affords you colorized strings:
 
@@ -101,7 +105,7 @@ color_chart
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prettyio-color-chart.png "PrettyIO Color Chart")
 
-## Messaging
+# Messaging
 
 Throughout the life of your application, you will most likely want to send several messages to your user (warnings, errors, info, etc.). `Messaging` makes this a snap. It, too, is a mixin:
 
@@ -116,9 +120,9 @@ messenger.warn('Hey pal, you need to be careful.')
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/messenger-warn.png "A Warning from Messenger")
 
-### Messaging Methods
+## Messaging Methods
 
-`messenger` gives you access to several basic methods:
+`messenger` gives you access to several basic "read-only" methods:
 
 * `messenger.error`: used to show a formatted-red error message.
 * `messenger.info`: used to show a formatted-blue infomational message.
@@ -155,7 +159,7 @@ section_block('MY SECTION', multiline = true) {
 }
 ```
 
-### Message Wrapping
+## 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:
 
@@ -174,7 +178,7 @@ messenger.info(long_string)
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/wrapping.png "Text Wrapping")
 
-### Prompting
+## Prompting
 
 `messenger` also carries a convenient method to prompt your users to give input (including an optional default). It makes use of `readline`, so you can do cool things like text expansion of paths.
 
@@ -186,9 +190,9 @@ messenger.info("You answered: #{ p }")
 
 When you pass a default to `messaging.prompt`, hitting `Enter` (i.e., leaving the prompt blank) will return the value of the default.
 
-### Logging
+## Logging
 
-Often, it's desirable to log messages as they appear to your user. `messaging` makes this a breeze by allowing you to attach and detach Logger instances at will.
+Often, it's desirable to log messages as they appear to your user. `Messaging` makes this a breeze by allowing you to attach and detach Logger instances at will.
 
 For instance, let's say you wanted to log a few messages to both your user's STDOUT and to `file.txt`:
 
@@ -225,25 +229,27 @@ D, [2014-03-29T15:14:34.844609 #4497] DEBUG -- : This debug message should only
 
 Since you are attaching Logger objects, each can have it's own format and severity level. Cool!
 
-## Configuration
+# Configuration
+
+CLIUtils offers a `Configurator` class and a `Configuration` module (which provides access to a shared instance of `Configurator`) that make managing a user's configuration parameters easy. Although the examples in this README use that shared instance, you should note that you can always use your own `Configurator`.
 
-CLIUtils offers a `Configurator` class and a `Configuration` module (which provides access to a shared instance of `Configurator`) that make managing a user's configuration parameters easy. Mix it in!
+To use, mix it in!
 
 ```Ruby
 include CLIUtils::Configuration
 ```
 
-### Loading a Configuration File
+## Loading a Configuration File
 
 ```Ruby
 load_configuration('~/.my-app-config')
 ```
 
-If there's data in there, it will be consumed into the `configurator`'s `data` property.
+If there's data in there, it will be consumed into the `Configurator`'s `data` property.
 
-### Adding/Removing Sections
+## Adding/Removing Sections
 
-Sections are top levels of the configuration file and are managed via the `configurator` object:
+Sections are top levels of the configuration file and are managed via the `Configurator` object:
 
 ```Ruby
 configuration.add_section(:app_data)
@@ -252,9 +258,9 @@ configuration.add_section(:program_data)
 configuration.delete_section(:program_data)
 ```
 
-### Adding Data to Sections
+## Adding Data to Sections
 
-There are two ways data can be managed in `configurator`: via its `@data` property or via some magic methods; your call:
+There are two ways data can be managed in the `Configurator`: via its `@data` property or via some magic methods; your call:
 
 ```Ruby
 configuration.data[:user_data].merge!({ username: 'bob', age: 45 })
@@ -262,7 +268,7 @@ configuration.data[:user_data].merge!({ username: 'bob', age: 45 })
 configuration.user_data.merge!({ username: 'bob', age: 45 })
 ```
 
-### Saving to a File
+## Saving to a File
 
 When you're ready to save your configuration data to a YAML file:
 
@@ -280,11 +286,11 @@ user_data:
   age: 45
 ```
 
-### Checking Configuration Versions
+## Checking Configuration Versions
 
 Often, you'll want to check the user's current version of your app against the last version that required some sort of configuration change; moreover, you'll want to run some "re-configuration" steps if the user's version is older than the last version that required a configuration update.
 
-`configurator` allows for this via its `compare_version` method.
+The `Configurator` allows for this via its `compare_version` method.
 
 Assume you have a config file that looks like this:
 
@@ -328,15 +334,15 @@ Two items to note:
 1. If the `current_version` parameter is `nil`, the Configurator will assume that it the app needs to be updated when `compare_version` is run.
 2. Note that if the current version is *later* than the last version that required re-configuration, the whole block is skipped over (allowing your app to get on with its day).
 
-## Prefs
+# Prefs
 
 Many times, CLI apps need to ask their users some questions, collect the feedback, validate it, and store it. CLIUtils makes this a breeze via the `Prefs` class.
 
-### Basic Schema
+## 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:
 
-* `prompt` (**required**): the string to prompt your user with
+* `prompt_text` (**required**): the string to prompt your user with
 * `default` (*optional*): an optional default to offer
 * `config_key` (**required**): the Configurator key that this preference will use
 * `config_section` (**required**): the Configurator section that this preference applies to
@@ -345,15 +351,15 @@ Here's an example YAML preferences file.
 
 ```YAML
 prompts:
-  - prompt: What is your name?
+  - prompt_text: What is your name?
     default: Bob Cobb
     config_key: name
     config_section: personal_info
-  - prompt: What is your age?
+  - prompt_text: What is your age?
     default: 45
     config_key: age
     config_section: personal_info
-  - prompt: Batman or Superman?
+  - prompt_text: Batman or Superman?
     default: Batman
     config_key: superhero
     config_section: personal_info
@@ -372,19 +378,19 @@ prefs = CLIUtils::Prefs.new('path/to/yaml/file')
 h = {
   prompts: [
     {
-      prompt: 'What is your name?',
+      prompt_text: 'What is your name?',
       default: 'Bob Cobb',
       config_key: :name,
       config_section: :personal_info
     },
     {
-      prompt: 'What is your age?',
+      prompt_text: 'What is your age?',
       default: '45',
       config_key: :age,
       config_section: :personal_info
     },
     {
-      prompt: 'Batman or Superman?',
+      prompt_text: 'Batman or Superman?',
       default: 'Batman',
       config_key: :superhero,
       config_section: :personal_info
@@ -398,19 +404,19 @@ prefs = CLIUtils::Prefs.new(h)
 # Instantiation through an Array
 a = [
   {
-    prompt: 'What is your name?',
+    prompt_text: 'What is your name?',
     default: 'Bob Cobb',
     config_key: :name,
     config_section: :personal_info
   },
   {
-    prompt: 'What is your age?',
+    prompt_text: 'What is your age?',
     default: '45',
     config_key: :age,
     config_section: :personal_info
   },
   {
-    prompt: 'Batman or Superman?',
+    prompt_text: 'Batman or Superman?',
     default: 'Batman',
     config_key: :superhero,
     config_section: :personal_info
@@ -420,7 +426,7 @@ a = [
 prefs = CLIUtils::Prefs.new(a)
 ```
 
-### Prompting the User
+## Prompting the User
 
 With valid preferences loaded, simply use `ask` to begin prompting your user:
 
@@ -429,31 +435,31 @@ prefs.ask
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prefs-ask.png "Prefs.ask")
 
-### Prerequisites
+## Prerequisites
 
 Sometimes, you need to answer certain prompts before others become relevant. `Prefs` allows this via a `prereqs` key, which can contain multiple already-answered key/value pairs to check for. For instance, imagine we want to drill into a user's superhero preference a bit further; using our previously-used YAML prefs file:
 
 ```YAML
 prompts:
-  - prompt: Batman or Superman?
+  - prompt_text: Batman or Superman?
     default: Batman
     config_key: superhero
     config_section: personal_info
-  - prompt: Do you feel smart for preferring Batman?
+  - prompt_text: 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?!
+  - prompt_text: 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?
+  - prompt_text: Why don't you have a clue?
     config_key: no_clue
     config_section: personal_info
     prereqs:
@@ -472,32 +478,32 @@ prefs.ask
 
 Be careful that you don't define any circular prerequisities (e.g., A requires B and B requires A). In that case, both preferences will be ignored by `Prefs.ask`.
 
-### Options
+## Options
 
 What if you want to limit a preference to a certain set of options? Easy! Imagine we want to expand the previous example and force the user to choose either "Batman" or "Superman":
 
 ```YAML
 prompts:
-  - prompt: Batman or Superman?
+  - prompt_text: Batman or Superman?
     default: Batman
     config_key: superhero
     config_section: personal_info
     options: ['Batman', 'Superman']
-  - prompt: Do you feel smart for preferring Batman?
+  - prompt_text: 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?!
+  - prompt_text: 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?
+  - prompt_text: Why don't you have a clue?
     config_key: no_clue
     config_section: personal_info
     prereqs:
@@ -514,7 +520,7 @@ prefs.ask
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prefs-ask-options.png "Options")
 
-### Validators
+## Validators
 
 "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:
 
@@ -535,12 +541,12 @@ An example:
 
 ```YAML
 prompts:
-  - prompt: What is your name?
+  - prompt_text: What is your name?
     config_key: name
     config_section: personal_info
     validators:
       - alphabetic
-  - prompt: How old are you?
+  - prompt_text: How old are you?
     config_key: age
     config_section: personal_info
     validators:
@@ -554,7 +560,7 @@ prefs.ask
 
 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
+## Behaviors
 
 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:
 
@@ -573,7 +579,7 @@ An example:
 
 ```YAML
 prompts:
-  - prompt: What is your favorite food?
+  - prompt_text: What is your favorite food?
     config_key: food
     config_section: personal_info
     validators:
@@ -591,7 +597,70 @@ prefs.ask
 
 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
+## Pre- and Post-Messages/Actions
+
+`Prefs` allows you to define messages and "action" plugins that can be executed before and after the prompt is given.
+
+For example, imagine that before delivering a prompt, we want to open the user's default browser (notfying the user first, of course) so that they can collect some information before coming back. Once the user puts that information into the prompt, we want to provide a close-out message. We can accomplish this by writing a set of pre- and post-messages/actions on the prompt.
+
+### Defining the Schema
+
+```YAML
+prompts:
+  - prompt_text: What is the top story on espn.com?
+    config_key: top_story
+    config_section: app_data
+    pre:
+      message: 'I will now open espn.com in your default browser.'
+      action: open_url
+      action_parameters:
+        - url: http://www.espn.com
+    post:
+      message: 'Thanks for inputting!'
+    validators:
+      - non_nil
+```
+
+Both `pre` and `post` keys can contain up to 3 child keys:
+
+* `message` (**required**): the message to display in the pre or post stage
+* `action` (*optional*): the name of the action to execute in the pre or post stage
+* `action_parameters` (*optional*): an array of key/value pairs to be used in the action
+
+### Creating the Action
+
+`Prefs` actions are simply Ruby classes. A simple `open_url` action might be look like this:
+
+```Ruby
+module CLIUtils
+  class OpenUrlAction < PrefAction
+    def run(parameters)
+      `open #{ parameters[:url] }`
+    end
+  end
+end
+```
+
+Several items to note:
+
+1. The action class needs to be wrapped in the CLIUtils module.
+2. The class name needs to be the camel-case version of the `action` key in the YAML.
+3. The class name needs to end with "Action".
+4. The class needs to inherit from the PrefAction class.
+5. The class needs to implement one method: `method(parameters)`
+
+### Testing
+
+Let's run it!
+
+```Ruby
+prefs.ask
+```
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/actions-1.png "Pre-action")
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/actions-2.png "Action")
+![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/actions-3.png "Post-action")
+
+## Adding Pref Responses to a Configurator
 
 Once the user has answered all the preference prompts, you can fold those answers back into a Configurator using the `ingest` method:
 
@@ -604,7 +673,7 @@ configuration.ingest_prefs(prefs)
 configuration.save
 ```
 
-### Using Configurator Values as Defaults
+## Using Configurator Values as Defaults
 
 Note that you can also initialize a `Prefs` object with 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.3.1'
+  VERSION = '1.4.0'
 end

data/lib/cliutils/ext/string_extensions.rb

@@ -1,5 +1,19 @@
 #  String Class extensions
 class String
+  # Makes the associated string blue.
+  # @return [void]
+  def blue
+    colorize(34)
+  end
+
+  # Converts a snake_case string to its
+  # CamelCase variant.
+  # @return [String]
+  def camelize
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map{|e| e.capitalize}.join
+  end
+
   # Outputs a string in a formatted color.
   # @param [<Integer, String>] color_code The code to use
   # @return [void]
@@ -7,12 +21,6 @@ class String
     "\033[#{ color_code }m#{ self }\033[0m"
   end
 
-  # Makes the associated string blue.
-  # @return [void]
-  def blue
-    colorize(34)
-  end
-
   # Makes the associated string cyan.
   # @return [void]
   def cyan
@@ -37,6 +45,16 @@ class String
     colorize(31)
   end
 
+  # Converts a CamelCase string to its
+  # snake_case variant.
+  # @return [String]
+  def snakify
+    return downcase if match(/\A[A-Z]+\z/)
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+    gsub(/([a-z])([A-Z])/, '\1_\2').
+    downcase
+  end
+
   # Makes the associated string white.
   # @return [void]
   def white

data/lib/cliutils/prefs/pref.rb

@@ -36,13 +36,23 @@ module CLIUtils
     # @return [Array]
     attr_accessor :options
 
+    # Stores the message and behavior that should be
+    # executed after the prompt is delivered.
+    # @return [Hash]
+    attr_accessor :post
+
+    # Stores the message and behavior that should be
+    # executed before the prompt is delivered.
+    # @return [Hash]
+    attr_accessor :pre
+
     # Stores the prereqs information.
     # @return [Array]
     attr_accessor :prereqs
 
     # Stores the prompt text.
     # @return [String]
-    attr_accessor :prompt
+    attr_accessor :prompt_text
 
     # Stores key/value combinations required to show this Pref.
     # @return [Hash]
@@ -61,7 +71,32 @@ module CLIUtils
     def ==(other)
       @config_key == other.config_key &&
       @config_section == other.config_section &&
-      @prompt == other.prompt
+      @prompt_text == other.prompt_text
+    end
+
+    # Delivers the prompt the user. Handles retries
+    # after incorrect answers, validation, behavior
+    # evaluation, and pre-/post-behaviors.
+    # @param [String] default The default option
+    # @return [void]
+    def deliver(default = nil)
+      # Design decision: the pre-prompt behavior
+      # gets evaluated *once*, not every time the
+      # user gets prompted. This prevents multiple
+      # evaluations when bad options are provided.
+      _eval_pre
+
+      valid_option_chosen = false
+      until valid_option_chosen
+        response = prompt(@prompt_text, default)
+        if validate(response)
+          valid_option_chosen = true
+          @answer = evaluate_behaviors(response)
+          _eval_post
+        else
+          messenger.error(@last_error_message)
+        end
+      end
     end
 
     # Runs the passed text through this Pref's behaviors.
@@ -80,7 +115,7 @@ module CLIUtils
           if PrefBehavior.respond_to?(method)
             modified_text = PrefBehavior.send(method, *args)
           else
-            messenger.warn("Skipping undefined Pref behavior: #{ b }")
+            messenger.warn("Skipping undefined Pref Behavior: #{ b }")
           end
         end
         modified_text
@@ -129,11 +164,64 @@ module CLIUtils
               ret = false
             end
           else
-            messenger.warn("Skipping undefined Pref validator: #{ v }")
+            messenger.warn("Skipping undefined Pref Validator: #{ v }")
           end
         end
       end
       ret
     end
+
+    # Evaluates the pre-prompt Hash and does the right thing. :)
+    # @return [void]
+    def _eval_pre
+      info(@pre[:message])
+      prompt('Press enter to continue')
+      
+      if (@pre[:action])
+        action_obj = _load_action(@pre[:action])
+        action_obj.run(@pre[:action_parameters][0])
+      end
+    end
+
+    # Evaluates the post-prompt Hash and does the right thing. :)
+    # @return [void]
+    def _eval_post
+      info(@post[:message])
+
+      if (@post[:action])
+        action_obj = _load_action(@post[:action])
+        action_obj.run(@post[:action_parameters][0])
+      end
+    end
+
+    # Loads a Pref Action, instantiates it (if it exists),
+    # and returns that instance. Note that the passed
+    # String can be a name (thus translating to an included
+    # Action) or a filepath to a user-defined Action.
+    # @param [String] path_or_name The name of or path to an Action
+    # @return [Object]
+    def _load_action(path_or_name)
+      if File.exist?(path_or_name)
+        # If the file exists, we're assuming that the user
+        # passed a filepath.
+        action_path = "#{ path_or_name }_action"
+        action_name = File.basename(path_or_name, '.*').camelize
+      else
+        # If it doesn't, we're assuming that the user
+        # passed a class name.
+        _default =  File.join(File.dirname(__FILE__), 'pref_actions')
+        action_path = File.join(_default, "#{ path_or_name }_action")
+        action_name = path_or_name.camelize
+      end
+
+      # Try to load and instantiate the Action. If that fails, warn
+      # the user with a message and skip over it.
+      begin
+        require action_path
+        Object.const_get("CLIUtils::#{ action_name }Action").new
+      rescue
+        messenger.warn("Skipping undefined Pref Action: #{ path_or_name }")
+      end
+    end
   end
 end

data/lib/cliutils/prefs.rb

@@ -73,7 +73,6 @@ module CLIUtils
     # @return [void]
     def _deliver_prompt(p)
       default = p.default
-
       unless @configurator.nil?
         section_sym = p.config_section.to_sym
         unless @configurator.data[section_sym].nil?
@@ -82,16 +81,7 @@ module CLIUtils
         end
       end
 
-      valid_option_chosen = false
-      until valid_option_chosen
-        response = prompt(p.prompt, default)
-        if p.validate(response)
-          valid_option_chosen = true
-          p.answer = p.evaluate_behaviors(response)
-        else
-          messenger.error(p.last_error_message)
-        end
-      end
+      p.deliver(default)
     end
 
     # Generates an Array of Prefs based on passed

data/lib/cliutils.rb

@@ -10,6 +10,7 @@ require 'cliutils/logger_delegator'
 require 'cliutils/messaging'
 require 'cliutils/prefs'
 require 'cliutils/prefs/pref'
+require 'cliutils/prefs/pref_actions/pref_action'
 
 # The CLIUtils module, which wraps everything
 # in this gem.

data/test/configurator_test.rb

@@ -51,13 +51,13 @@ class TestConfigurator < Test::Unit::TestCase
   
   def test_compare_version
     @config.add_section(:app_data)
-    @config.app_data.merge!({ VERSION: '1.0.0', NEWEST_CONFIG_VERSION: '1.8.8' })
+    @config.app_data.merge!({ VERSION: '1.0.0' })
 
-    @config.cur_version_key = :VERSION
-    @config.last_version_key = :NEWEST_CONFIG_VERSION
+    @config.current_version = @config.app_data['VERSION']
+    @config.last_version = '1.0.8'
 
     @config.compare_version do |c, l|
-      assert_output('true') { print c < l }
+      assert_output('true') { print 'true' }
     end
   end
 end

data/test/prefs_test.rb

@@ -10,13 +10,13 @@ class TestPrefs < Test::Unit::TestCase
   def setup
     @prefs_arr = [
       {
-        'prompt' => 'Batman or Superman?',
+        'prompt_text' => 'Batman or Superman?',
         'default' => 'Batman',
         'config_key' => 'superhero',
         'config_section' => 'personal_info'
       },
       {
-        'prompt' => 'Do you feel smart for preferring Batman?',
+        'prompt_text' => 'Do you feel smart for preferring Batman?',
         'default' => 'Y',
         'config_key' => 'batman_answer',
         'config_section' => 'personal_info',
@@ -28,7 +28,7 @@ class TestPrefs < Test::Unit::TestCase
         ]
       },
       {
-        'prompt' => 'Why do you prefer Superman?!',
+        'prompt_text' => 'Why do you prefer Superman?!',
         'default' => 'No clue',
         'config_key' => 'superman_answer',
         'config_section' => 'personal_info',

data/test/test_files/prefstest.yaml

@@ -1,10 +1,13 @@
 prompts:
-  - prompt: What is your favorite food?
-    config_key: food
-    config_section: personal_info
+  - prompt_text: What is the top story on espn.com?
+    config_key: top_story
+    config_section: app_data
+    pre:
+      message: 'I will now open espn.com in your default browser.'
+      action: open_url
+      action_parameters:
+        - url: http://www.espn.com
+    post:
+      message: 'Thanks for inputting!'
     validators:
-      - non_nil
-    behaviors:
-      - uppercase
-      - prefix: 'My favorite food: '
-      - suffix: ' (soooo good!)'
+      - non_nil

metadata

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