cliutils 1.2.9 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97a26794fd111748a7122e364fd21179f7d1f082
-  data.tar.gz: 78a1352fde30e33340c46340164ddc88a9bf526f
+  metadata.gz: c9dcbf526eb200d6ad6ce2b5c1e76ffdcf3ae0c4
+  data.tar.gz: 62fe908e18ab47851682dd3dd53c71b425c9aa81
 SHA512:
-  metadata.gz: c92816990f22349112121b23694c85ff0d85b04b8420999ec1047fb6727acc688073b3eb321ef68bb94082972c0a69150b1292a1d5254014c05a7cd76ad671c7
-  data.tar.gz: c9d7ccaaee1a0416cd24030588c936ec285f1b7ea8ed56cc89e9c2c935631b20ab035443da84139a76c426368e33b8f7f540284091eab26b9325567b74722a7f
+  metadata.gz: 5916ccafc3e3e5df98ac6edb49a05ab04676df72d271774c4fb1230b7b8fd106d33cfa64813a0a8526314d6026bfbe81e1ce3b6616293337bb8c96c1e1e38912
+  data.tar.gz: 1e01491ced1114a355c9721d8c5e3969909d904fa0cc1b4738a17253af92c727870d2b47485e1a9a18c0be7baffcef7df1abd83ce740963bcc545eb32868f10e

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 1.3.9 (2014-04-12)
+
+* Revised Configurator version checking
+* Added some documentation
+
 # 1.2.9 (2014-04-09)
 
 * Added time Pref validator

data/README.md

@@ -1,6 +1,6 @@
 CLIUtils
 ====
-[![Build Status](https://travis-ci.org/bachya/cliutils.png?branch=master)](https://travis-ci.org/bachya/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)
 
 CLIUtils is a library of functionality designed to alleviate common tasks and headaches when developing command-line (CLI) apps in Ruby.
@@ -66,6 +66,8 @@ First stop on our journey is better client IO via `PrettyIO`. To activate, simpl
 include CLIUtils::PrettyIO
 ```
 
+### Colored Strings
+
 To start, `PrettyIO` affords you colorized strings:
 
 ```ruby
@@ -288,41 +290,39 @@ Assume you have a config file that looks like this:
 ---
 app_data:
   # The current version of the app
-  APP_VERSION: 1.0.0
-
-  # The last version that required
-  # a configuration change
-  NEWEST_CONFIG_VERSION: 1.8.0
+  APP_VERSION: 0.8.8
 
   # ...other keys...
 ```
 
+...and that, somewhere in your app, you store a constant that contains the config version that requires a re-configuration:
+
+```Ruby
+LATEST_CONFIG_VERSION = 0.9.5
+```
+
 ...this will initiate a version check (and give you the option to do something with that information):
 
 ```Ruby
-# Tell your configurator the name of the key that
-# stores the app's version in its configuration file.
-# NOTE that you don't have to specify the section.
-configuration.cur_version_key = :APP_VERSION
+# Store the current version of your app in a
+# property of the Configurator.
+configuration.current_version = configuration.app_data['APP_VERSION']
 
-# Tell your configurator the name of the key that
-# 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
+# Store the last version of your app that required
+# a re-configuration in a property of the Configurator.
+configuration.last_version = LATEST_CONFIG_VERSION
 
 # Run the check and use a block to get
 # the current and "last-needing-changes"
 # versions (and do something about it).
 configuration.compare_version do |c, l|
-  if c < l
-    puts "You need to update your app; here's how:"
-    # ...do stuff...
-  else
-    puts "No need to update your app's config file!"
-  end
+  puts "We need to update from #{c} to #{l}..."
+  # ...do stuff...
 end
 ```
 
+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
 
 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.

data/lib/cliutils/configurator.rb

@@ -8,13 +8,13 @@ module CLIUtils
     # Stores the Configurator key that refers
     # to the current configuration version.
     # @return [Symbol]
-    attr_accessor :cur_version_key
+    attr_accessor :current_version
 
     # Stores the Configurator key that refers
     # to the value at which the app last changed
     # config versions.
     # @return [Symbol]
-    attr_accessor :last_version_key
+    attr_accessor :last_version
 
     # Stores the path to the configuration file.
     # @return [String]
@@ -55,15 +55,6 @@ module CLIUtils
       end
     end
 
-    # Checks to see whether the passed key (and a
-    # non-nil value) exist in the @data Hash.
-    # @param [Symbol] key The key to search for
-    # @return [Boolean]
-    def check_key_and_value(key)
-      !@data.recursive_find_by_key(key).nil? &&
-      !@data.recursive_find_by_key(key).empty?
-    end
-
     # Compares the current version (if it exists) to
     # the last version that needed a configuration
     # change (if it exists). Assuming they exist and
@@ -71,22 +62,11 @@ module CLIUtils
     # version, execute a passed block.
     # @return [void]
     def compare_version
-      unless check_key_and_value(@cur_version_key)
-        fail 'Cannot check version; no current version found'
-      end
-      
-      unless check_key_and_value(@last_version_key)
-        fail 'Cannot check version; no previous version found'
-      end
-      
-      c_version = @data.recursive_find_by_key(@cur_version_key)
-      c_version_gem = Gem::Version.new(c_version)
-
-      l_version = @data.recursive_find_by_key(@last_version_key)
-      l_version_gem = Gem::Version.new(l_version)
+      c_version = Gem::Version.new(@current_version)
+      l_version = Gem::Version.new(@last_version)
 
-      if c_version_gem < l_version_gem
-        yield c_version, l_version
+      if c_version < l_version
+        yield @current_version, @last_version
       end
     end
 

data/lib/cliutils/constants.rb

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

data/lib/cliutils/pretty_io.rb

@@ -94,7 +94,7 @@ module CLIUtils
     end
 
     # Empty method so that Messaging doesn't freak
-    # out when passed a debug message.
+    # out when passed a log message.
     # @return [void]
     def log(m); end
 

metadata

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