update_repo 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc3f29affb360bc461efe93b1d164e7ef7813fde
-  data.tar.gz: 061f998c505667dbd68b590d02964ba3fbddb629
+  metadata.gz: 9f3535241ed1c52eb02d217ed8527c1b157b2eef
+  data.tar.gz: 63024bbfebe62bb05f82bb328a1ba6c0e127fda1
 SHA512:
-  metadata.gz: 553c44b86f68898dea104f8076c0315d5fba1a02399be13d931518bfbf4083dba0b8724173de6a1c939121e9c0d2e999a737a64d65e9e1a248f6e96f0407cca3
-  data.tar.gz: 212c861b4d1ccf9183763ca0da23fd437f8403deec6ff122b11ac1d928d22328c7c75f942cff577b1a1aa95080799e7b90315b97987a9aebb626f754b8583070
+  metadata.gz: 0c29335e5df44c273e7666a36e03a79d4c9b02490f0c3cd715d089a63e9d1a428e53dd88aee4296ae39f379c1f7c81aa24a17884373f2ec5e5539f22eb45ca95
+  data.tar.gz: eed327dfa5518532b4f01c0e757e5570b8584ecbc9377436e128804eec981a73c02f3960a88effbfd55a8c573e7d0be794f2361cf71f4ad30f4d1aecf68fa594

data/README.md

@@ -23,7 +23,7 @@ It goes without saying that at the very least a working copy of both [`Git`][git
 Install this from the shell prompt as you would any other Ruby Gem
 
 ```
- $ gem install update_repo
+$ gem install update_repo
 ```
 
 ## Usage

data/lib/update_repo.rb

@@ -1,6 +1,8 @@
 require 'update_repo/version'
 require 'update_repo/helpers'
 require 'update_repo/cmd_config'
+require 'update_repo/logger'
+require 'update_repo/console_output'
 require 'yaml'
 require 'colorize'
 require 'confoog'
@@ -15,7 +17,6 @@ module UpdateRepo
 
   # An encapsulated class to walk the repo directories and update all Git
   # repositories found therein.
-  # rubocop:disable Metrics/ClassLength
   class WalkRepo
     include Helpers
     # Class constructor. No parameters required.
@@ -23,12 +24,12 @@ module UpdateRepo
     def initialize
       @metrics = { processed: 0, skipped: 0, failed: 0, updated: 0,
                    start_time: 0, failed_list: [] }
-      @summary = { processed: 'green', updated: 'cyan', skipped: 'yellow',
-                   failed: 'red' }
       # create a new instance of the CmdConfig class then read the config var
       @cmd = CmdConfig.new
       # set up the logfile if needed
-      setup_logfile if cmd(:log)
+      @log = Logger.new(cmd(:log), cmd(:timestamp))
+      # instantiate the console output class for header, footer etc
+      @cons = ConsoleOutput.new(@log, @metrics, @cmd)
     end
 
     # This function will perform the required actions to traverse the Repo.
@@ -37,15 +38,13 @@ module UpdateRepo
     #   walk_repo.start
     def start
       String.disable_colorization = !cmd(:color)
-      # make sure we dont have bad cmd-line parameter combinations ...
-      @cmd.check_params # TODO - check this since is already called in @cmd.init
       # print out our header unless we are dumping / importing ...
-      show_header unless dumping?
+      @cons.show_header unless dumping?
       config['location'].each do |loc|
         cmd(:dump_tree) ? dump_tree(File.join(loc)) : recurse_dir(loc)
       end
       # print out an informative footer unless dump / import ...
-      footer unless dumping?
+      @cons.show_footer unless dumping?
     end
 
     private
@@ -72,20 +71,6 @@ module UpdateRepo
       @cmd.true_cmd(command.to_sym)
     end
 
-    # Set up the log file - determine if we need to timestamp the filename and
-    # then actually open it and set to sync.
-    # @param [none]
-    # @return [void]
-    def setup_logfile
-      filename = if cmd(:timestamp)
-                   'updaterepo-' + Time.new.strftime('%y%m%d-%H%M%S') + '.log'
-                 else
-                   'updaterepo.log'
-                 end
-      @logfile = File.open(filename, 'w')
-      @logfile.sync = true
-    end
-
     # take each directory contained in the Repo directory, if it is detected as
     # a Git repository then update it (or as directed by command line)
     # @param dirname [string] Contains the directory to search for Git repos.]
@@ -110,77 +95,6 @@ module UpdateRepo
       !config['exceptions'].include?(File.basename(dir))
     end
 
-    # Display a simple header to the console
-    # @example
-    #   show_header
-    # @return [void]
-    # @param [none]
-    def show_header
-      # print an informative header before starting
-      print_log "\nGit Repo update utility (v", VERSION, ')',
-                " \u00A9 Grant Ramsay <seapagan@gmail.com>\n"
-      print_log "Using Configuration from '#{config.config_path}'\n"
-      # print_log "Command line is : #{config['cmd']}\n"
-      # list out the locations that will be searched
-      list_locations
-      # list any exceptions that we have from the config file
-      list_exceptions
-      # save the start time for later display in the footer...
-      @metrics[:start_time] = Time.now
-      print_log "\n" # blank line before processing starts
-    end
-
-    # print out a brief footer. This will be expanded later.
-    # @return [void]
-    # @param [none]
-    def footer
-      duration = Time.now - @metrics[:start_time]
-      print_log "\nUpdates completed in ", show_time(duration).cyan
-      print_metrics
-      print_log " \n\n"
-      # close the log file now as we are done, just to be sure ...
-      @logfile.close if @logfile
-    end
-
-    # Print end-of-run metrics to console / log
-    # @return [void]
-    # @param [none]
-    def print_metrics
-      @summary.each do |metric, color|
-        metric_value = @metrics[metric]
-        output = "#{metric_value} #{metric.capitalize}"
-        print_log ' | ', output.send(color.to_sym) unless metric_value.zero?
-      end
-      print_log ' |'
-      return if @metrics[:failed_list].empty?
-      print_log "\n\n!! Note : The following repositories ",
-                'FAILED'.red.underline, ' during this run :'
-      @metrics[:failed_list].each do |failed|
-        print_log "\n  [", 'x'.red, "] #{failed[:loc]}"
-        print_log "\n    -> ", "\"#{failed[:line].chomp}\"".red
-      end
-    end
-
-    # Print a list of any defined expections that will not be updated.
-    # @return [void]
-    # @param [none]
-    def list_exceptions
-      exceptions = config['exceptions']
-      return unless exceptions
-      print_log "\nExclusions:".underline, ' ',
-                exceptions.join(', ').yellow, "\n"
-    end
-
-    # Print a list of all top-level directories that will be searched and any
-    # Git repos contained within updated.
-    # @return [void]
-    def list_locations
-      print_log "\nRepo location(s):\n".underline
-      config['location'].each do |loc|
-        print_log '-> ', loc.cyan, "\n"
-      end
-    end
-
     # Takes the specified Repo and does not update it, outputing a note to the
     # console / log to this effect.
     # @param dirpath [string] The directory with Git repository to be skipped

data/lib/update_repo/cmd_config.rb

@@ -60,12 +60,8 @@ module UpdateRepo
     # @return [void]
     def check_params
       return unless true_cmd(:dump)
-      # if  true_cmd(:import)
       Trollop.die 'You cannot use --dump AND --import'.red if true_cmd(:import)
-      # end
-      # if true_cmd(:dump_remote)
       Trollop.die 'You cannot use --dump AND --dump-remote'.red if true_cmd(:dump_remote)
-      # end
     end
     # rubocop:enable  Metrics/LineLength
 

data/lib/update_repo/console_output.rb

@@ -0,0 +1,101 @@
+require 'update_repo/version'
+require 'update_repo/helpers'
+
+module UpdateRepo
+  # Class : ConsoleOutput.
+  # This class has functions to print header, footer and metrics.
+  class ConsoleOutput
+    include Helpers
+
+    # Constructor for the ConsoleOutput class.
+    # @param logger [class] Pointer to the Logger class
+    # @param metrics [hash] Hash of metrics and their values
+    # @param config [class] Pointer to the Confoog class
+    # @return [void]
+    # @example
+    #   console = ConsoleOutput.new(@log)
+    def initialize(logger, metrics, config)
+      @summary = { processed: 'green', updated: 'cyan', skipped: 'yellow',
+                   failed: 'red' }
+      @metrics = metrics
+      @log = logger
+      @config = config.getconfig
+    end
+
+    # Display a simple header to the console
+    # @example
+    #   show_header
+    # @return [void]
+    # @param [none]
+    def show_header
+      # print an informative header before starting
+      print_log "\nGit Repo update utility (v", VERSION, ')',
+                " \u00A9 Grant Ramsay <seapagan@gmail.com>\n"
+      print_log "Using Configuration from '#{@config.config_path}'\n"
+      # list out the locations that will be searched
+      list_locations
+      # list any exceptions that we have from the config file
+      list_exceptions
+      # save the start time for later display in the footer...
+      @metrics[:start_time] = Time.now
+      print_log "\n" # blank line before processing starts
+    end
+
+    # print out a brief footer. This will be expanded later.
+    # @return [void]
+    # @param [none]
+    def show_footer
+      duration = Time.now - @metrics[:start_time]
+      print_log "\nUpdates completed in ", show_time(duration).cyan
+      print_metrics
+      print_log " \n\n"
+      # close the log file now as we are done, just to be sure ...
+      @log.close
+    end
+
+    # Print end-of-run metrics to console / log
+    # @return [void]
+    # @param [none]
+    def print_metrics
+      @summary.each do |metric, color|
+        metric_value = @metrics[metric]
+        output = "#{metric_value} #{metric.capitalize}"
+        print_log ' | ', output.send(color.to_sym) unless metric_value.zero?
+      end
+      print_log ' |'
+      list_failures unless @metrics[:failed_list].empty?
+    end
+
+    # List any repositories that failed their update, and the error.
+    # @param [none]
+    # @return [void]
+    def list_failures
+      print_log "\n\n!! Note : The following repositories ",
+                'FAILED'.red.underline, ' during this run :'
+      @metrics[:failed_list].each do |failed|
+        print_log "\n  [", 'x'.red, "] #{failed[:loc]}"
+        print_log "\n    -> ", "\"#{failed[:line].chomp}\"".red
+      end
+    end
+
+    # Print a list of any defined expections that will not be updated.
+    # @return [void]
+    # @param [none]
+    def list_exceptions
+      exceptions = @config['exceptions']
+      return unless exceptions
+      print_log "\nExclusions:".underline, ' ',
+                exceptions.join(', ').yellow, "\n"
+    end
+
+    # Print a list of all top-level directories that will be searched and any
+    # Git repos contained within updated.
+    # @return [void]
+    def list_locations
+      print_log "\nRepo location(s):\n".underline
+      @config['location'].each do |loc|
+        print_log '-> ', loc.cyan, "\n"
+      end
+    end
+  end
+end

data/lib/update_repo/helpers.rb

@@ -14,17 +14,6 @@ module Helpers
     File.join(path_array)
   end
 
-  # this function will simply pass the given string to 'print', and also
-  # log to file if that is specified.
-  # @param string [array] Array of strings for print formatting
-  # @return [void]
-  def print_log(*string)
-    # log to screen regardless
-    print(*string)
-    # log to file if that has been enabled
-    @logfile.write(string.join('').gsub(/\e\[(\d+)(;\d+)*m/, '')) if cmd('log')
-  end
-
   # mark these as private simply so that 'reek' wont flag as utility function.
   private
 
@@ -37,4 +26,11 @@ module Helpers
     time_taken = Time.at(duration).utc
     time_taken.strftime('%-H hours, %-M Minutes and %-S seconds')
   end
+
+  # helper function to call the Logger class output method.
+  # @param *string [Array] Array of strings to be passed to the 'print' fn
+  # @return [*string] Output of the Logger
+  def print_log(*string)
+    @log.output(*string)
+  end
 end

data/lib/update_repo/logger.rb

@@ -0,0 +1,57 @@
+require 'update_repo/version'
+require 'update_repo/helpers'
+
+module UpdateRepo
+  # Class : Logger.
+  # This class encapsulates printing to screen and logging to file if requried.
+  class Logger
+    include Helpers
+
+    # Constructor for the Logger class.
+    # @param enabled [boolean] True if we log to file
+    # @param timestamp [boolean] True if we timestamp the filename
+    # @return [void]
+    # @example
+    #   log = Logger.new(true, false)
+    def initialize(enabled, timestamp)
+      @settings = { enabled: enabled, timestamp: timestamp }
+      # don't prepare a logfile unless it's been requested.
+      return unless @settings[:enabled]
+      # generate a filename depending on 'timestamp' setting.
+      filename = generate_filename
+      # open the logfile and set sync mode.
+      @logfile = File.open(filename, 'w')
+      @logfile.sync = true
+    end
+
+    # generate a filename for the log, with or without a timestamp
+    # @param [none]
+    # @return [string] Filename for the logfile.
+    def generate_filename
+      if @settings[:timestamp]
+        'updaterepo-' + Time.new.strftime('%y%m%d-%H%M%S') + '.log'
+      else
+        'updaterepo.log'
+      end
+    end
+
+    # this function will simply pass the given string to 'print', and also
+    # log to file if that is specified.
+    # @param string [array] Array of strings for print formatting
+    # @return [void]
+    def output(*string)
+      # log to screen regardless
+      print(*string)
+      # log to file if that has been enabled
+      return unless @settings[:enabled]
+      @logfile.write(string.join('').gsub(/\e\[(\d+)(;\d+)*m/, ''))
+    end
+
+    # close the logfile, if it exists
+    # @param [none]
+    # @return [void]
+    def close
+      @logfile.close if @logfile
+    end
+  end
+end

data/lib/update_repo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-08 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -286,7 +286,9 @@ files:
 - exe/update_repo
 - lib/update_repo.rb
 - lib/update_repo/cmd_config.rb
+- lib/update_repo/console_output.rb
 - lib/update_repo/helpers.rb
+- lib/update_repo/logger.rb
 - lib/update_repo/version.rb
 - update_repo.gemspec
 homepage: http://updaterepo.seapagan.net