cliutils 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c6e6e5b1a7f34b7dcfa6c887f2d1a704379f667
-  data.tar.gz: 67434a07cf330007da7640ee0e73f20355c70133
+  metadata.gz: fdf67aa4209a6fcb36db63a0b84313c539c7d2f3
+  data.tar.gz: c180f98c6075639be2c28ab114ea2b331abaf111
 SHA512:
-  metadata.gz: 86e74f6a482775f620e316fecf3e96cf5bb6e8ef3f0afb447f41d5cfb5069482e76238bd9bd882b0808baa1c0847778094d1b3dedd0338ad6512d3529efa24e3
-  data.tar.gz: a33d59a428bbd13e22f972ec9f56718fece03e952124171dd454046c7494253382551e1ef7aa678cfbf22d79b4fbe7772745c492914f939f4f1c97b555f8a024
+  metadata.gz: fa8a999f929b9bd694983ce2e4f2e6430ec1c8c21bb03b715d1fe8215e40cccc4c55df1e7d95ac968fe4099fd1ab250d078eb909d67580056980ed584207c0af
+  data.tar.gz: 41f09163ab9109af87277c860cdd0955d1382bef320b151206882e31074af675098de80ba3139325cea8de81b5aed41f288231f07d87a5a7ee225492c52ecc78

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 2.0.2 (2014-04-16)
+
+* Created backup method in Configurator
+* Modified YARD documentation
+
 # 2.0.1 (2014-04-16)
 
 * Modified PrettyIO word wrapping to coerce to String first

data/lib/cliutils/configurator.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'yaml'
 
 module CLIUtils
@@ -55,6 +56,18 @@ module CLIUtils
       end
     end
 
+    # Convenience method to backup the configuration file
+    # in the same directory that the original inhabits.
+    # @return [String] The backed-up filepath
+    def backup
+      backup_path = ''
+      unless @config_path.nil? || @config_path.empty?
+        backup_path = "#{ @config_path }-#{ Time.now.to_i }"
+        FileUtils.cp(@config_path, backup_path)
+      end
+      backup_path
+    end
+
     # Compares the current version (if it exists) to
     # the last version that needed a configuration
     # change (if it exists). Assuming they exist and
@@ -97,7 +110,7 @@ module CLIUtils
     # Hook that fires when a non-existent method is called.
     # Allows this module to return data from the config
     # Hash when given a method name that matches a key.
-    # @return [Hash]
+    # @return [Hash] The hash with the method's name as key
     def method_missing(name, *args, &block)
       @data[name.to_sym] || @data.merge!(name.to_sym => {})
     end

data/lib/cliutils/constants.rb

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

data/lib/cliutils/ext/hash_extensions.rb

@@ -5,7 +5,7 @@ class Hash
   # Deep merges a hash into the current one.
   # @param [Hash] other_hash The hash to merge in
   # @yield &block
-  # @return [Hash]
+  # @return [Hash] The original Hash
   def deep_merge!(other_hash, &block)
     other_hash.each_pair do |k, v|
       tv = self[k]
@@ -20,28 +20,28 @@ class Hash
 
   # Recursively turns all Hash keys into strings and
   # returns the new Hash.
-  # @return [Hash]
+  # @return [Hash] A new copy of the original Hash
   def deep_stringify_keys
     deep_transform_keys { |key| key.to_s }
   end
 
   # Same as deep_stringify_keys, but destructively
   # alters the original Hash.
-  # @return [Hash]
+  # @return [Hash] The original Hash
   def deep_stringify_keys!
     deep_transform_keys! { |key| key.to_s }
   end
 
   # Recursively turns all Hash keys into symbols and
   # returns the new Hash.
-  # @return [Hash]
+  # @return [Hash] A new copy of the original Hash
   def deep_symbolize_keys
     deep_transform_keys { |key| key.to_sym rescue key }
   end
 
   # Same as deep_symbolize_keys, but destructively
   # alters the original Hash.
-  # @return [Hash]
+  # @return [Hash] The original Hash
   def deep_symbolize_keys!
     deep_transform_keys! { |key| key.to_sym rescue key }
   end
@@ -49,7 +49,7 @@ class Hash
   # Generic method to perform recursive operations on a
   # Hash.
   # @yield &block
-  # @return [Hash]
+  # @return [Hash] A new copy of the original Hash
   def deep_transform_keys(&block)
     _deep_transform_keys_in_object(self, &block)
   end
@@ -57,7 +57,7 @@ class Hash
   # Same as deep_transform_keys, but destructively
   # alters the original Hash.
   # @yield &block
-  # @return [Hash]
+  # @return [Hash] The original Hash
   def deep_transform_keys!(&block)
     _deep_transform_keys_in_object!(self, &block)
   end

metadata

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