confoog 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4336bba436a680049e0f664d3160f0be3089664
-  data.tar.gz: 026279c492238be89eba517417e884e9dc992109
+  metadata.gz: 426cd876ac4934a3f852d3bd3a488d5eb67e2457
+  data.tar.gz: 49c365ae6ef73ba9dc8beac001aa2f08d5cd01b1
 SHA512:
-  metadata.gz: d961c0d7fd8e277ff37a903d5cda39e229aa46bdaa2bb3eddb8f5dfee833c09a7aaf2001d2796fa070c9ed168bdc7df22824e4d1253fb1ab47f4f10afa7fd689
-  data.tar.gz: af619574ceedd1841ee0ce75665344ff959613068b6286ada339695d31df2562a67230700558bc472b80aec36cf6b67a88e006ce663742ac99184bfcca01ad2c
+  metadata.gz: 1eeeced36fe38ce14adc23bc85a4502b1f2a7296b32fad3741b585d310ec7a4a830c5b592ca7a49e3b47bc9154fb83b6ba4f1cd16373b9965cf57a797bee7527
+  data.tar.gz: a9a1993322fb9f67db21274371a97aed463d0deab4d7e506d9c5e9e1d406b26c82882d71b0405bb1d5ca0f5d381d4fe051daf8736bba266e6e1b49991c9ca9fc

data/README.md

@@ -31,6 +31,8 @@ Or install it yourself as:
 ## Usage
 Currently Confoog will not allow 'nested' configuration types, however each variable can be an array or hash so multiple settings can be recorded for each variable and accessed (for a hash) by `settings[variable][hash_key]` or array using `settings[array].each`. In other words, treat the return from `settings[var]` as the type it contains. See examples below.
 
+By default, each time a configuration variable is created or changed the file on disk will be updated with this addition or change. If you intend to make a lot of consecutive changes or do not want the small performance hit of this, pass `autosave: false` as a parameter to #new, or set it false using the #autosave accessor.
+
 ```ruby
 require 'confoog'
 
@@ -57,6 +59,10 @@ settings[50]
 settings[50][:two]
 # => "for the show"
 
+settings.quiet = true # squelch any error or status messages to console
+
+settings.autosave = false # disable autosave if it has been enabled with #new or #autosave
+
 settings.save # save all current parameters to the YAML file
 
 settings.load # load the settings from YAML file.
@@ -81,9 +87,12 @@ prefix: 'My Application'
 quiet: true | false
 
 # Should we automatically load the configuration file when the class is created?
-auto_load: true | false
+autoload: true | false
+
+# Should we automatically save the configuration file when a variable is created or changed?
+autosave: true | false
 ```
-If these are not specified, Confoog will use the following defaults :
+If any of these are not specified, Confoog will use the following defaults :
 
 ```ruby
 location: '~/'
@@ -91,7 +100,8 @@ filename: '.confoog'
 create_file: false
 prefix: 'Configuration'
 quiet: false
-auto_load: false
+autoload: false
+autosave: true
 ```
 
 Confoog will set the following error constants which will be returned in the `.status['errors']` variable as needed :
@@ -117,7 +127,6 @@ Thoughts in no particular order.
 
 - Restrict configuration variables to a specified subset, or to only those that already exist in the YAML file.
 - A better way of dealing with multi-level variables - i.e. nested arrays, hashes etc.
-- option to save config file after any config variables are changed, not just explicitly with `Confoog::Settings.save`
 
 ## Development
 

data/Rakefile

@@ -9,8 +9,7 @@ RuboCop::RakeTask.new do |task|
   task.options << 'lib'
 end
 Inch::Rake::Suggest.new do |suggest|
-  suggest.args << "--pedantic"
+  suggest.args << '--pedantic'
 end
 
-
 task default: [:rubocop, :inch, :spec]

data/lib/confoog/utility.rb

@@ -0,0 +1,10 @@
+# A collection of utility functions for the Confoog class
+module ConfoogUtils
+  private
+
+  # Display output to the console with the severity noted, unless we are quiet.
+  def console_output(message, severity)
+    return unless @options[:quiet] == false
+    $stderr.puts "#{@options[:prefix]} : #{severity} - #{message}"
+  end
+end

data/lib/confoog/version.rb

@@ -2,5 +2,5 @@
 module Confoog
   # Version of this Gem, using Semantic Versioning 2.0.0
   # http://semver.org/
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/confoog.rb

@@ -1,4 +1,5 @@
 require 'confoog/version'
+require 'confoog/utility'
 require 'yaml'
 
 # rubocop:disable LineLength
@@ -47,7 +48,8 @@ module Confoog
     prefix: 'Configuration',
     location: '~/',
     filename: DEFAULT_CONFIG,
-    auto_load: false
+    autoload: false,
+    autosave: true
   }
 
   # Provide an encapsulated class to access a YAML configuration file.
@@ -82,6 +84,7 @@ module Confoog
   #   settings[50][:two]
   #   # => "for the show"
   class Settings
+    include ConfoogUtils
     attr_reader :filename, :location, :status
 
     # rubocop:enable LineLength
@@ -109,7 +112,27 @@ module Confoog
       check_exists(options)
 
       # if auto_load is true, automatically load from file
-      load unless @options[:auto_load] == false
+      load unless @options[:autoload] == false
+    end
+
+    # Return the value of the 'auto_save' option.
+    # @example
+    #   autosave_status = settings.autosave
+    #   => true
+    # @param [None]
+    # @return [Boolen] true if we are autosaving on change or addition.
+    def autosave
+      @options[:autosave]
+    end
+
+    # Change the 'auto_save' option.
+    # @example
+    #   settings.autosave = false
+    #   => false
+    # @return [Boolean] The new value [true | false]
+    # @param autosave [Boolean] True to send messages to console for errors.
+    def autosave=(autosave)
+      @options[:autosave] = autosave
     end
 
     # Return the value of the 'quiet' option.
@@ -189,13 +212,16 @@ module Confoog
       @config[key]
     end
 
-    # Set a configuration key
+    # Set a configuration key.
+    # If auto_save: true then will also update the config file (default is true)
     # @example
     #   settings[:key] = "Value"
     #   settings[:array] = ["first", "second", "third"]
     # @return [<various>] Returns the variable that was assigned.
     def []=(key, value)
       @config[key] = value
+      # automatically save to file if this has been requested.
+      save unless @options[:autosave] == false
     end
 
     # Returns the fully qualified path to the configuration file in use.
@@ -208,11 +234,6 @@ module Confoog
 
     private
 
-    def console_output(message, severity)
-      return unless @options[:quiet] == false
-      $stderr.puts "#{@options[:prefix]} : #{severity} - #{message}"
-    end
-
     def save_to_yaml
       file = File.open(config_path, 'w')
       file.write(@config.to_yaml)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confoog
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Seapagan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,6 +154,7 @@ files:
 - bin/setup
 - confoog.gemspec
 - lib/confoog.rb
+- lib/confoog/utility.rb
 - lib/confoog/version.rb
 homepage: https://github.com/seapagan/confoog
 licenses: