confoog 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a220c741772bd56e80ac5e99f16975c1d53c4260
-  data.tar.gz: 4567baf4606fe935fdff4d78946891a9339e4ad4
+  metadata.gz: 9422eaf268b310c4933473e850ae17b7cb2af2fe
+  data.tar.gz: f19cf7d265b7d48023c3246c3ff33e9c25c7e4d1
 SHA512:
-  metadata.gz: 2d7b337afa691225075653fc47a7b8bcedb20c50249ac9949d4450acf4e3a6759af35f64c490a5586d02537ca945573316c3d9c98da171a15812ad91dcb5541b
-  data.tar.gz: 22284144648177edba6e42c05bb983584863a98782a4467a7657786d7cb0bdee5eb781326acd2a11932183e76de9e38980f40cea39cd5d0a0084dcfaf12ee1b4
+  metadata.gz: 95a01b11a275022152f9de1b8cd0b1711f3fcfd78db7b21a96e77af83a32e705bacb12c0f10cd0d3c79b2ddccebfb573b6da8fb9b4eb735955064089de40292a
+  data.tar.gz: 455181a8fc2b81bff5ab62a7dbad00c10e72141b3c28e13d67fe8520d6aefad5c1c19b62c45fd99b3d36c48ded2e0bae165f7d4e42ffc60a3b9e3ca63cb2fa7c

data/.pullreview.yml

@@ -0,0 +1,4 @@
+---
+notifications:
+  pullrequest:
+    comment: verbose

data/README.md

@@ -110,12 +110,11 @@ Confoog will set the following error constants which will be returned in the `.s
 ```ruby
 ERR_NO_ERROR = 0 # no error condition, command was succesfull
 ERR_FILE_NOT_EXIST = 1 # specified configuration file does not exist
-ERR_CANT_CHANGE = 2 # directory and file can only be specified through `.new()`
-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.
+ERR_CANT_CREATE_FILE = 2 # cannot create the requested configuration file
+ERR_NOT_WRITING_EMPTY_FILE = 4 # not attempting to save an empty configuration
+ERR_CANT_SAVE_CONFIGURATION = 8 # Failed to save the configuration file
+ERR_NOT_LOADING_EMPTY_FILE = 16 # not atempting to load an empty config file
+ERR_CANT_LOAD = 32 # 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
@@ -129,6 +128,7 @@ 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.
+- Write standalone tests for the 'Status' class - right now it is tested at 100% by the application tests though would probably be good to have dedicated tests too
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'reek/rake/task'
 require 'inch/rake'
 
 RSpec::Core::RakeTask.new(:spec)
@@ -8,8 +9,15 @@ RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new do |task|
   task.options << 'lib'
 end
+
 Inch::Rake::Suggest.new do |suggest|
   suggest.args << '--pedantic'
 end
 
-task default: [:rubocop, :inch, :spec]
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+  t.verbose       = true
+  t.reek_opts     = '-U'
+end
+
+task default: [:rubocop, :inch, :reek, :spec]

data/confoog.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'inch'
   spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'pullreview-coverage'
+  spec.add_development_dependency 'reek', '~> 3.3'
 end

data/lib/confoog.rb

@@ -22,10 +22,6 @@ module Confoog
   }
 
   # Provide an encapsulated class to access a YAML configuration file.
-  # @!attribute [r] filename
-  #   @return [String] The configuration filename in use.
-  # @!attribute [r] location
-  #   @return [String] The directory storing the configuration file.
   # @!attribute [r] status
   #   @return [Hash] A hash containing status variables.
   # @example
@@ -53,7 +49,7 @@ module Confoog
   #   settings[50][:two]
   #   # => "for the show"
   class Settings
-    attr_reader :filename, :location, :status
+    attr_reader :status
 
     # rubocop:enable LineLength
 
@@ -69,13 +65,12 @@ module Confoog
 
       # Hash containing any error or return from methods
       @status = Status.new(@options[:quiet], @options[:prefix])
-      @location = @options[:location]
-      @filename = @options[:filename]
+      # clear the error condition as default.
+      @status.clear_error
 
+      # Initialize the Configuration to and empty hash.
       @config = {}
 
-      # clear the error condition as default.
-      @status.clear_error
       # make sure the file exists or can be created...
       check_exists(options)
 
@@ -149,20 +144,6 @@ module Confoog
       @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: 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: Status::ERR_CANT_CHANGE)
-    end
-
     # Read the configuration key (key)
     # @example
     #   key = settings[:key]
@@ -188,7 +169,7 @@ module Confoog
     #   path = config_path
     # @return [String] Full path and filename of the configuration file.
     def config_path
-      File.expand_path(File.join(@location, @filename))
+      File.expand_path(File.join(@options[:location], @options[:filename]))
     end
 
     private
@@ -198,9 +179,7 @@ module Confoog
         @status.set(config_exists: false, errors: Status::ERR_FILE_NOT_EXIST)
         return
       end
-      file = File.open(config_path, 'w')
-      file.write(@config.to_yaml)
-      file.close
+      File.open(config_path, 'w') { |file| file.write(@config.to_yaml) }
     rescue
       @status.set(errors: Status::ERR_CANT_SAVE_CONFIGURATION)
     end

data/lib/confoog/status.rb

@@ -1,27 +1,19 @@
 # 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
+  ERR_CANT_CREATE_FILE = 2
   # There are no configuration variables set, so not writing empty file
-  ERR_NOT_WRITING_EMPTY_FILE = 8
+  ERR_NOT_WRITING_EMPTY_FILE = 4
   # Cannot save to the specified file for some reason
-  ERR_CANT_SAVE_CONFIGURATION = 16
+  ERR_CANT_SAVE_CONFIGURATION = 8
   # The specified file is empty so not trying to load settings from it
-  ERR_NOT_LOADING_EMPTY_FILE = 32
+  ERR_NOT_LOADING_EMPTY_FILE = 16
   # Cannot load the specified file for some reason.
-  ERR_CANT_LOAD = 64
+  ERR_CANT_LOAD = 32
 
   # Information - file was created successfully
   INFO_FILE_CREATED = 256
@@ -39,7 +31,6 @@ class Status
   # 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!',
@@ -56,8 +47,24 @@ class Status
     # Initialize the status container to an empty hash. Will return nil
     # for missing keys by default.
     @status = {}
-    @quiet = quiet
-    @prefix = prefix
+    # ititialize a hash to store our own internal options.
+    @options = {}
+    # and fill it.
+    @options[:quiet] = quiet
+    @options[:prefix] = prefix
+  end
+
+  # Set whether we output to the console or not
+  # @param quiet [Boolean] True to output Errors to the console.
+  # @return [Boolean] Value of #quiet
+  def quiet=(quiet)
+    @options[:quiet] = quiet
+  end
+
+  # return the current 'quiet' status
+  # @return [Boolean] Value of #quiet
+  def quiet
+    @options[:quiet]
   end
 
   # Clear the error status.
@@ -94,20 +101,22 @@ class Status
   # @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)
+    status.each { |key, value| @status[key] = value }
+    return unless error_string
+    console_output(error_string, (@status[:errors] < 256) ? 'Error' : 'Info')
   end
 
   private
 
+  # return the error string corresponding to the current error number
+  def error_string
+    ERROR_STRINGS[@status[:errors]]
+  end
+
   # 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}"
+    return unless @options[:quiet] == false
+    $stderr.puts "#{@options[:prefix]} : #{severity} - #{message}"
   end
 end

data/lib/confoog/version.rb

@@ -1,6 +1,5 @@
 # Define the Gem version string
 module Confoog
-  # Version of this Gem, using Semantic Versioning 2.0.1
   # http://semver.org/
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confoog
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Seapagan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pullreview-coverage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: A simple Gem to add YAML configuration files to your Ruby script or Gem
 email:
 - seapagan@gmail.com
@@ -144,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".pullreview.yml"
 - ".rspec"
 - ".travis.yml"
 - Gemfile