confoog 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 426cd876ac4934a3f852d3bd3a488d5eb67e2457
-  data.tar.gz: 49c365ae6ef73ba9dc8beac001aa2f08d5cd01b1
+  metadata.gz: f947a6f8d6ac5314c4cc95283c0f96342073f5f0
+  data.tar.gz: ce1050b7ef2b58be9e4aacdee1fe209986474873
 SHA512:
-  metadata.gz: 1eeeced36fe38ce14adc23bc85a4502b1f2a7296b32fad3741b585d310ec7a4a830c5b592ca7a49e3b47bc9154fb83b6ba4f1cd16373b9965cf57a797bee7527
-  data.tar.gz: a9a1993322fb9f67db21274371a97aed463d0deab4d7e506d9c5e9e1d406b26c82882d71b0405bb1d5ca0f5d381d4fe051daf8736bba266e6e1b49991c9ca9fc
+  metadata.gz: 88a306dd5acaabd9f402ca4a772f2a9dbff146beb4be81dfec2ece2461c4a953e3d59c018b87cecea7a53fd5a56192183bd109a79aaed33bbf56ddfa7b74ec78
+  data.tar.gz: 17f9def6311f6ad7f41ee7fe52b23135d60c1fd41e84d888c6cb02b6e2d9604fdbb937f5191150320d4335a07bce0eb7987c9a016ee9fc373dee0940d1158d81

data/README.md

@@ -114,6 +114,7 @@ ERR_CANT_CREATE_FILE = 4 # cannot create the requested configuration file
 ERR_NOT_WRITING_EMPTY_FILE = 8 # not attempting to save an empty configuration
 ERR_CANT_SAVE_CONFIGURATION = 16 # Failed to save the configuration file
 ERR_NOT_LOADING_EMPTY_FILE = 32 # not atempting to load an empty config file
+ERR_CANT_LOAD = 64 # Cannot load configuration data from file.
 
 INFO_FILE_CREATED = 256 # Information - specified file was created
 INFO_FILE_LOADED = 512 # Information - Config file was loaded successfully

data/lib/confoog.rb

@@ -1,5 +1,5 @@
 require 'confoog/version'
-require 'confoog/utility'
+require 'confoog/status'
 require 'yaml'
 
 # rubocop:disable LineLength
@@ -10,37 +10,6 @@ module Confoog
   # The default filename used if none specified when created.
   DEFAULT_CONFIG = '.confoog'
 
-  # Error messages to be returned
-
-  # No error condition exists
-  ERR_NO_ERROR = 0
-  # The specified file does not exist
-  ERR_FILE_NOT_EXIST = 1
-  # You cannot change location or filename after class is instantiated
-  ERR_CANT_CHANGE = 2
-  # Was unable to create the specified file
-  ERR_CANT_CREATE_FILE = 4
-  # There are no configuration variables set, so not writing empty file
-  ERR_NOT_WRITING_EMPTY_FILE = 8
-  # Cannot save to the specified file for some reason
-  ERR_CANT_SAVE_CONFIGURATION = 16
-  # The specified file is empty so not trying to load settings from it
-  ERR_NOT_LOADING_EMPTY_FILE = 32
-
-  # Info messages to be returned
-
-  # Information - file was created successfully
-  INFO_FILE_CREATED = 256
-  # Information - configuration was successfully loaded
-  INFO_FILE_LOADED = 512
-
-  # Hash containing text versions of the assorted error severity.
-  OUTPUT_SEVERITY = {
-    ERR: 'Error',
-    WARN: 'Warning',
-    INFO: 'Information'
-  }
-
   # Hash containing default values of initialization variables
   DEFAULT_OPTIONS = {
     create_file: false,
@@ -84,7 +53,6 @@ module Confoog
   #   settings[50][:two]
   #   # => "for the show"
   class Settings
-    include ConfoogUtils
     attr_reader :filename, :location, :status
 
     # rubocop:enable LineLength
@@ -100,14 +68,14 @@ module Confoog
       @options.default = false
 
       # Hash containing any error or return from methods
-      @status = {}
+      @status = Status.new(@options[:quiet], @options[:prefix])
       @location = @options[:location]
       @filename = @options[:filename]
 
       @config = {}
 
       # clear the error condition as default.
-      status_set(errors: ERR_NO_ERROR)
+      @status.clear_error
       # make sure the file exists or can be created...
       check_exists(options)
 
@@ -115,7 +83,7 @@ module Confoog
       load unless @options[:autoload] == false
     end
 
-    # Return the value of the 'auto_save' option.
+    # Return the value of the 'autosave' option.
     # @example
     #   autosave_status = settings.autosave
     #   => true
@@ -125,7 +93,7 @@ module Confoog
       @options[:autosave]
     end
 
-    # Change the 'auto_save' option.
+    # Change the 'autosave' option.
     # @example
     #   settings.autosave = false
     #   => false
@@ -141,7 +109,7 @@ module Confoog
     # @param [None]
     # @return [Boolean] True if we are not writing to the console on error
     def quiet
-      @options[:quiet]
+      @status.quiet
     end
 
     # Change the 'quiet' option.
@@ -150,7 +118,7 @@ module Confoog
     # @return [Boolean] The new value [true | false]
     # @param quiet [Boolean] True to send messages to console for errors.
     def quiet=(quiet)
-      @options[:quiet] = quiet
+      @status.quiet = quiet
     end
 
     # Save the entire configuration (@config) to the YAML file.
@@ -162,9 +130,7 @@ module Confoog
       if @config.count > 0
         save_to_yaml
       else
-        console_output("Not saving empty configuration data to #{config_path}",
-                       OUTPUT_SEVERITY[:WARN])
-        status_set(errors: ERR_NOT_WRITING_EMPTY_FILE)
+        @status.set(errors: Status::ERR_NOT_WRITING_EMPTY_FILE)
       end
     end
 
@@ -175,33 +141,28 @@ module Confoog
     # @return Unspecified
     def load
       @config = YAML.load_file(config_path)
-      status_set(errors: INFO_FILE_LOADED)
+      @status.set(errors: Status::INFO_FILE_LOADED)
       if @config == false
-        console_output("Configuration file #{config_path} is empty!",
-                       OUTPUT_SEVERITY[:WARN])
-        status_set(errors: ERR_NOT_LOADING_EMPTY_FILE)
+        # console_output("Configuration file #{config_path} is empty!",
+        #                OUTPUT_SEVERITY[:WARN])
+        @status.set(errors: Status::ERR_NOT_LOADING_EMPTY_FILE)
       end
     rescue
-      console_output("Cannot load configuration data from #{config_path}",
-                     OUTPUT_SEVERITY[:ERR])
+      @status.set(errors: Status::ERR_CANT_LOAD)
     end
 
     # dummy method currently to stop changing location by caller once created,
     # @return [hash] an error flag in the ':status' variable.
     # @param [Optional] Parameter is ignored
     def location=(*)
-      status_set(errors: ERR_CANT_CHANGE)
-      console_output('Cannot change file location after creation',
-                     OUTPUT_SEVERITY[:WARN])
+      @status.set(errors: Status::ERR_CANT_CHANGE)
     end
 
     # dummy method currently to stop changing filename by caller once created,
     # @return [hash] an error flag in the ':status' variable.
     # @param optional Parameter is ignored
     def filename=(*)
-      status_set(errors: ERR_CANT_CHANGE)
-      console_output('Cannot change filename after creation',
-                     OUTPUT_SEVERITY[:WARN])
+      @status.set(errors: Status::ERR_CANT_CHANGE)
     end
 
     # Read the configuration key (key)
@@ -213,7 +174,7 @@ module Confoog
     end
 
     # Set a configuration key.
-    # If auto_save: true then will also update the config file (default is true)
+    # If autosave: true then will also update the config file (default is true)
     # @example
     #   settings[:key] = "Value"
     #   settings[:array] = ["first", "second", "third"]
@@ -239,37 +200,25 @@ module Confoog
       file.write(@config.to_yaml)
       file.close
     rescue
-      status_set(errors: ERR_CANT_SAVE_CONFIGURATION)
-      console_output("Cannot save configuration data to #{config_path}",
-                     OUTPUT_SEVERITY[:ERR])
+      @status.set(errors: Status::ERR_CANT_SAVE_CONFIGURATION)
     end
 
     def create_new_file
       File.new(config_path, 'w').close
-      status_set(config_exists: true, errors: INFO_FILE_CREATED)
+      @status.set(config_exists: true, errors: Status::INFO_FILE_CREATED)
     rescue
-      status_set(config_exists: false, errors: ERR_CANT_CREATE_FILE)
-      console_output('Cannot create the specified Configuration file!',
-                     OUTPUT_SEVERITY[:ERR])
-    end
-
-    def status_set(status)
-      status.each do |key, value|
-        @status[key] = value
-      end
+      @status.set(config_exists: false, errors: Status::ERR_CANT_CREATE_FILE)
     end
 
     def check_exists(options)
-      status_set(config_exists: true)
+      @status[:config_exists] = true
       return if File.exist?(config_path)
 
       # file does not exist so we create if requested otherwise error out
       if options[:create_file] == true
         create_new_file
       else
-        status_set(config_exists: false, errors: ERR_FILE_NOT_EXIST)
-        console_output('The specified Configuration file does not exist.',
-                       OUTPUT_SEVERITY[:ERR])
+        @status.set(config_exists: false, errors: Status::ERR_FILE_NOT_EXIST)
       end
     end
   end

data/lib/confoog/status.rb

@@ -0,0 +1,113 @@
+# Provide error messages and console output when required.
+class Status
+  # @!attribute prefix
+  #   @return [String] String to pre-pend on any error put to console
+  attr_accessor :prefix
+  # @!attribute quiet
+  #   @return [Boolean] Do we output anything to console or not
+  attr_accessor :quiet
+  # No error condition exists
+  ERR_NO_ERROR = 0
+  # The specified file does not exist
+  ERR_FILE_NOT_EXIST = 1
+  # You cannot change location or filename after class is instantiated
+  ERR_CANT_CHANGE = 2
+  # Was unable to create the specified file
+  ERR_CANT_CREATE_FILE = 4
+  # There are no configuration variables set, so not writing empty file
+  ERR_NOT_WRITING_EMPTY_FILE = 8
+  # Cannot save to the specified file for some reason
+  ERR_CANT_SAVE_CONFIGURATION = 16
+  # The specified file is empty so not trying to load settings from it
+  ERR_NOT_LOADING_EMPTY_FILE = 32
+  # Cannot load the specified file for some reason.
+  ERR_CANT_LOAD = 64
+
+  # Information - file was created successfully
+  INFO_FILE_CREATED = 256
+  # Information - configuration was successfully loaded
+  INFO_FILE_LOADED = 512
+
+  # Hash containing text versions of the assorted error severity.
+  OUTPUT_SEVERITY = {
+    ERR: 'Error',
+    WARN: 'Warning',
+    INFO: 'Information'
+  }
+
+  # Hash containing the error messages for each ERR condition. If an ERR does
+  # not have a message, there will be no output.
+  ERROR_STRINGS = {
+    ERR_FILE_NOT_EXIST => 'The specified Configuration file does not exist.',
+    ERR_CANT_CHANGE => 'Cannot change filename after creation',
+    ERR_CANT_CREATE_FILE => 'Cannot create the specified Configuration file!',
+    ERR_NOT_WRITING_EMPTY_FILE => 'Not saving empty configuration data!',
+    ERR_CANT_SAVE_CONFIGURATION => 'Cannot save configuration data!',
+    ERR_NOT_LOADING_EMPTY_FILE => 'The configuration file is empty!',
+    ERR_CANT_LOAD => 'Cannot load configuration Data!'
+  }
+
+  # Class initializer.
+  # @example
+  #   status = Status.new(quiet: true, prefix: "My Fab App")
+  # @param quiet [Boolean] Do we output to the console?
+  # @param prefix [String] Prefix to put before any error message.
+  def initialize(quiet, prefix)
+    # Initialize the status container to an empty hash. Will return nil
+    # for missing keys by default.
+    @status = {}
+    @quiet = quiet
+    @prefix = prefix
+  end
+
+  # Clear the error status.
+  # @example
+  #   status.clear_error
+  # @return [Integer] 0
+  def clear_error
+    @status[:errors] = ERR_NO_ERROR
+  end
+
+  # Read the value of a status.
+  # @example
+  #   key = status[:key]
+  # @return [<various>] Return value depends on the type of variable stored
+  def [](key)
+    @status[key]
+  end
+
+  # Set the value of status.
+  # @example
+  #   status[:key] = "Value"
+  #   status[:error] = ERR_NOT_LOADING_EMPTY_FILE
+  # @param key [Any] Key name to be added or updated.
+  # @param value [Any] New value for the status. May be any type.
+  # @return [<various>] Returns the value that was assigned.
+  def []=(key, value)
+    @status[key] = value
+  end
+
+  # Set one or multiple status variables, optionally outputing a console
+  # message if one exists for that status.
+  # @example
+  #   status.set(errors: Status::ERR_CANT_SAVE_CONFIGURATION)
+  # @param status [Hash] one or more hash-pairs of status information.
+  # @return Unspecified
+  def set(status)
+    status.each do |key, value|
+      @status[key] = value
+    end
+    return if ERROR_STRINGS[@status[:errors]].nil?
+    severity = (@status[:errors] <= 64) ? 'Error' : 'Info'
+    console_output(ERROR_STRINGS[@status[:errors]], severity)
+  end
+
+  private
+
+  # Display output to the console with the severity noted, unless we are quiet.
+  # @param [String] message
+  def console_output(message, severity)
+    return unless @quiet == false
+    $stderr.puts "#{@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.4.0'
+  VERSION = '0.4.1'
 end

metadata

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

data/lib/confoog/utility.rb

@@ -1,10 +0,0 @@
-# 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