cliutils 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9dcbf526eb200d6ad6ce2b5c1e76ffdcf3ae0c4
-  data.tar.gz: 62fe908e18ab47851682dd3dd53c71b425c9aa81
+  metadata.gz: 0b935a6abdb2d5219fc26e2e48196ac7457d1356
+  data.tar.gz: d0e4774d9efc3c844f7d88adf646a3466d8625f0
 SHA512:
-  metadata.gz: 5916ccafc3e3e5df98ac6edb49a05ab04676df72d271774c4fb1230b7b8fd106d33cfa64813a0a8526314d6026bfbe81e1ce3b6616293337bb8c96c1e1e38912
-  data.tar.gz: 1e01491ced1114a355c9721d8c5e3969909d904fa0cc1b4738a17253af92c727870d2b47485e1a9a18c0be7baffcef7df1abd83ce740963bcc545eb32868f10e
+  metadata.gz: 9e27d2ac30177630a86aeb0e994a31160fb598fd2ad9970ad1958e46a2af80f7b6837a3cab7a0a962a5d97d3ef25f1e6860b5df8111fb3a7e01f2adae9a33f53
+  data.tar.gz: 9970736e7841b7a8762fc3c2cee06c0412b8c076c01e4e21fc46d0f4429316a1430a3d66f5dfb89e8c6fe874aed0cb7008db63c53e70f1eda30f2cc64ae89971

data/HISTORY.md

@@ -1,4 +1,8 @@
-# 1.3.9 (2014-04-12)
+# 1.3.1 (2014-04-12)
+
+* Modified version check to include missing current version
+
+# 1.3.0 (2014-04-12)
 
 * Revised Configurator version checking
 * Added some documentation

data/README.md

@@ -143,7 +143,7 @@ messenger.success('But Luke still blew up the Death Star!')
 # 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) { 
+messenger.info_block('Starting up...', 'Done!', multiline = false) {
   # ...do stuff here...
 }
 
@@ -282,7 +282,9 @@ user_data:
 
 ### 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. `configurator` allows for this via its `compare_version` method.
+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.
 
 Assume you have a config file that looks like this:
 
@@ -312,16 +314,19 @@ configuration.current_version = configuration.app_data['APP_VERSION']
 # 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).
+# Run the check. If the current version is older than
+# the "last" version, use a block to tell the Configurator
+# what to do.
 configuration.compare_version do |c, l|
   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).
+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
 
@@ -559,7 +564,7 @@ validators:
   - 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 
+  - suffix: 'test ' # Appends 'test ' to the answer
   - titlecase       # Turns "the answer" into "The Answer"
   - uppercase       # Turns "answer" to "ANSWER"
 ```

data/lib/cliutils/configurator.rb

@@ -65,7 +65,7 @@ module CLIUtils
       c_version = Gem::Version.new(@current_version)
       l_version = Gem::Version.new(@last_version)
 
-      if c_version < l_version
+      if @current_version.nil? || 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.3.0'
+  VERSION = '1.3.1'
 end

metadata

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