update_repo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c8f69a7896ee9033c3795a0f5fb64bdc4ad203b
-  data.tar.gz: 5e2d5e0e24ce6832a86c86aff898207dff696f46
+  metadata.gz: ea5b6e02f412859fd3016b0a96551f9dee113b59
+  data.tar.gz: cf62ffcdc1ae9cc7d59ef280ffdb81bd1cb3996b
 SHA512:
-  metadata.gz: eef4c5f91858e5122667332b6bde79ee23565fd93231c4e6af0ba7d9beba7b8fc28b8c229f4ad3a695f90b4456517909c94707b5174a6a9dcd4fcea3b6c56dd4
-  data.tar.gz: 3edc6e7429277294ddc163a541aa7ca9c85f606e15a78a5813e3ea49cf82bf40713c7f1e7e687bfbf6654a982659c41b840d5379648f10577e654fc5fed86be0
+  metadata.gz: f9451f2add48a93bfa1b7214df62286d4d1d9f73560aefc69a576d130d2820a79f1f04f7931a31523dfcfabd5b17c11e20ed46c3342ba2084b43442d6b719b40
+  data.tar.gz: 108bad544e5cc9344be67a5fcebd31642783a30c12e17744b5fe52accd0a6f2f1ab70afead2cce3808c54b8c0e30053fa0bc81fbb8753e7f57dd1e057c43e038

data/README.md

@@ -46,9 +46,8 @@ To be added.
 ## To-Do
 Not in any specific order :
 
-- Improve error-checking and recovery while parsing the configuration file (convert to using my '[Confoog][confoog]' gem for example)
+- Improve error-checking and recovery while parsing the configuration file
   * Ignore and report invalid or missing directories
-  * Expand eg '~/' to full valid path.
 - Either add an option 'variants' or similar to allow non-standard git pull commands (eg Ubuntu kernel), or update the 'exceptions' option to do same.
 - Error checking and reporting for the git processes - retry for connection issues etc (config setting).
 - Add extra (optional) stats / info at end-of-job :

data/lib/update_repo.rb

@@ -2,6 +2,7 @@ require 'update_repo/version'
 require 'yaml'
 require 'colorize'
 require 'update_repo/version'
+require 'confoog'
 
 # Overall module with classes performing the functionality
 # Contains Class UpdateRepo::WalkRepo
@@ -19,8 +20,16 @@ module UpdateRepo
     # Class constructor. No parameters required.
     # @return [void]
     def initialize
+      # @counter - this will be ioncremented with each repo updated.
       @counter = 0
+      # @ start_time - will be used to get elapsed time
       @start_time = 0
+      # @config - Class. Reads the configuration from a file in YAML format and
+      # allows easy access to the configuration data
+      @config = Confoog::Settings.new(filename: '.updatereporc',
+                                      prefix: 'update_repo',
+                                      autoload: true)
+      exit 1 unless @config.status[:errors] == Status::INFO_FILE_LOADED
     end
 
     # This function will perform the required actions to traverse the Repo.
@@ -28,10 +37,10 @@ module UpdateRepo
     #   walk_repo = UpdateRepo::WalkRepo.new
     #   walk_repo.start
     def start
-      configs, location = check_config
-      show_header(configs, location)
-      configs['location'].each do |loc|
-        recurse_dir(loc, configs['exceptions'])
+      exceptions = @config['exceptions']
+      show_header(exceptions)
+      @config['location'].each do |loc|
+        recurse_dir(loc, exceptions)
       end
       # print out an informative footer...
       footer
@@ -48,7 +57,6 @@ module UpdateRepo
         dirpath = dirname + '/' + dir
         next unless File.directory?(dirpath) && notdot?(dir)
         if gitdir?(dirpath)
-          dir.chomp!
           !exceptions.include?(dir) ? update_repo(dirpath) : skip_dir(dirpath)
         else
           recurse_dir(dirpath, exceptions)
@@ -56,45 +64,19 @@ module UpdateRepo
       end
     end
 
-    # locate the configuration file and return this data.
-    # Note that this will be re-written later to use my 'confoog' gem.
-    # @return [hash] Hash containing all the configuration parameters.
-    # @return [string] Location of the configuration file.
-    def check_config
-      # locate the configuration file.
-      # first we check in this script location and if present then we ignore any
-      # further files.
-      dev_config = File.join '.', CONFIG_FILE
-      user_config = File.join Gem.user_home, CONFIG_FILE
-
-      if File.exist? dev_config
-        # configuration exists in script directory so we ignore any others.
-        return YAML.load_file(dev_config), File.expand_path(dev_config)
-      elsif File.exist? user_config
-        # configuration exists in user home directory so we use that.
-        return YAML.load_file(user_config), File.expand_path(user_config)
-      end
-      # otherwise return error
-      print 'Error : Cannot find configuration file'.red, user_config.red,
-            'aborting'.red
-      exit 1
-    end
-
     # Display a simple header to the console
-    # @param configs [hash] Configuration hash, used here to list exceptions.
-    # @param location [string] location of config file.
     # @example
-    #   show_header
-    # @return []
-    def show_header(configs, location)
+    #   show_header(exceptions)
+    # @return [void]
+    def show_header(exceptions)
       # print an informative header before starting
       print "\nGit Repo update utility (v", VERSION, ')',
             " \u00A9 Grant Ramsay <seapagan@gmail.com>\n"
-      print "Using Configuration from #{location}\n"
-      list_locations(configs)
-      if configs['exceptions']
+      print "Using Configuration from '#{@config.config_path}'\n"
+      list_locations
+      if exceptions
         print "\nExclusions:".underline, ' ',
-              configs['exceptions'].join(', ').yellow, "\n"
+              exceptions.join(', ').yellow, "\n"
       end
       # save the start time for later display in the footer...
       @start_time = Time.now
@@ -109,9 +91,9 @@ module UpdateRepo
             "#{Time.at(duration).utc.strftime('%H:%M:%S')}\n\n".cyan
     end
 
-    def list_locations(configs)
+    def list_locations
       print "\nRepo location(s):\n".underline
-      configs['location'].each do |loc|
+      @config['location'].each do |loc|
         print '-> ', loc.cyan, "\n"
       end
     end

data/lib/update_repo/version.rb

@@ -1,4 +1,4 @@
 module UpdateRepo
   # constant, current version of this Gem
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/update_repo.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'wwtd'
 
   spec.add_dependency 'colorize'
+  spec.add_dependency 'confoog'
 
   # Depends on Ruby version if we can use 'Reek'
   spec.add_development_dependency 'reek', '~> 3.3' if RUBY_VERSION > '2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: confoog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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