update_repo 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe97d312b2d580418707a7a5e139b9ce446e2564
-  data.tar.gz: ea880a88cc78769ae33ab2f9cd13f88800243ff3
+  metadata.gz: b68ac5a08795af79e528b813aa2e74fe628a816f
+  data.tar.gz: 5efdbb27dc053c02f4bfb76dcfd2f353b7f3b290
 SHA512:
-  metadata.gz: bc289788fbb7460a45a18154ea271e5c1f24b71a17f533f26ebfc93a66f8c2c021fdb580fe165df8f17466bb2043a5a2e5a981f5ee08eeaf162a8a95148caf49
-  data.tar.gz: ebf55d5a2f734362bce499c0f87f7697f50fd98564f5ebdf0bfde257bdd6e12b82a23ce357ed1e1c8d0dbbb414a896fdef07baf827376f135f2ed414bced3335
+  metadata.gz: 47348f246c0c6e179da7e689f2fb1b35ffacf3e0da72b2b798c1536815fce3d50d6f2859565ecd9bec06bfb9aba7a20a9f1839c08dcf10d5ca28c389b13ccce2
+  data.tar.gz: ddc661515526cbc5414deb1de0f8bb5f6eaea8057c6efba573b743a5e94c95231cefdf64efc8288a8285f188c60a4d87a17d1726dd974578432ac1b1e6da08aa

data/.gitignore

@@ -11,3 +11,4 @@
 .token
 .updatereporc
 *.log
+*.sublime*

data/README.md

@@ -101,6 +101,7 @@ Add functionality, not in any specific order :
 - 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.
 - Improve the stats / info at end-of-job :
   * errors or connection problems `[IN PROGRESS]`
+  * List the skipped / failed repos. Later make this dependant on 'verbose' status.
   * _more..._
 - Add command line options to override configuration, and even specify an alternate config file. Any options so specified will have precedence over settings specified in the configuration file. `[IN PROGRESS]`
 - Add command line options for verbose or quiet, with same options in config file.
@@ -110,7 +111,7 @@ Add functionality, not in any specific order :
 - Add option to only display a (text) tree of the discovered git repositories, not updating them.
 - Add Import & Export functionality :
   * ability to export a text dump of each repo location and remote as a CSV file. `[DONE]`
-  * re-import the above dump on a different machine or after reinstall
+  * re-import the above dump on a different machine or after reinstall. Modify the '--prune' command to apply to this function also, removing the required number of directory levels before importing.
 - Add option to use alternative git command if required, either globally or on a case-by-case basis (see also comments on 'variants' above). Currently the script just uses a blanket `git pull` command on all repositories.
 - Document configuration file format and options. `[IN PROGRESS]`
 

data/Rakefile

@@ -35,4 +35,4 @@ else
   end
 end
 
-task default: [:rubocop, :reek, :spec, :build]
+task default: [:rubocop, :reek, :spec, :inch, :build]

data/lib/update_repo/cmd_config.rb

@@ -26,13 +26,18 @@ module UpdateRepo
     end
 
     # return the configuration hash variable
+    # @param [none]
+    # @return [Class] Returns the base 'confoog' class to the caller.
+    # @example
+    #   @config = @cmd.getconfig
     def getconfig
       @conf
     end
 
     # This will return the 'true' version of a command, taking into account
     # both command line (given preference) and the configuration file.
-    # parameter is a :symbol
+    # @param command [symbol] The symbol of the defined command
+    # @return [various] Returns the true value of the comamnd symbol
     def true_cmd(command)
       cmd_given = @conf['cmd'][(command.to_s + '_given').to_sym]
       cmd_line = @conf['cmd'][command.to_sym]
@@ -49,18 +54,26 @@ module UpdateRepo
       end
     end
 
-    # make sure the parameter combinations are valid
+    # rubocop:disable Metrics/LineLength
+    # make sure the parameter combinations are valid, terminating otherwise.
+    # @param [none]
+    # @return [void]
     def check_params
-      if true_cmd(:dump) && true_cmd(:import)
-        Trollop.die 'Sorry, you cannot specify --dump AND --import'.red
-      end
-      if true_cmd(:dump) && true_cmd(:dump_remote)
-        Trollop.die 'Sorry, you cannot specify --dump AND --dump-remote'.red
-      end
+      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
 
     private
 
+    # terminate if we cannot load the configuration file for any reason.
+    # @param [none]
+    # @return [integer] exit code 1
     def config_error
       if @conf.status[:errors] == Status::ERR_CANT_LOAD
         print_log 'Note that the the default configuration file was '.red,
@@ -69,6 +82,9 @@ module UpdateRepo
       exit 1
     end
 
+    # Set up the Trollop options and banner
+    # @param [none]
+    # @return [void]
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/LineLength
     def set_options
@@ -94,6 +110,7 @@ EOS
         opt :log, "Create a logfile of all program output to './update_repo.log'. Any older logs will be overwritten.", default: false
         opt :timestamp, 'Timestamp the logfile instead of overwriting. Does nothing unless the --log option is also specified.', default: false
         opt :dump_remote, 'Create a dump to screen or log listing all the git remote URLS found in the specified directories.', default: false, short: 'r'
+        opt :dump_tree, 'Create a dump to screen or log listing all subdirectories found below the specified locations in tree format.', default: false, short: 'u'
         # opt :quiet, 'Only minimal output to the terminal', default: false
         # opt :silent, 'Completely silent, no output to terminal at all.', default: false
       end

data/lib/update_repo/helpers.rb

@@ -16,6 +16,8 @@ module Helpers
 
   # 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)

data/lib/update_repo/version.rb

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

data/lib/update_repo.rb

@@ -22,7 +22,7 @@ module UpdateRepo
     # @return [void]
     def initialize
       @metrics = { processed: 0, skipped: 0, failed: 0, updated: 0,
-                   start_time: 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
@@ -38,28 +38,44 @@ module UpdateRepo
     def start
       String.disable_colorization = !cmd(:color)
       # make sure we dont have bad cmd-line parameter combinations ...
-      @cmd.check_params
+      @cmd.check_params # TODO - check this since is already called in @cmd.init
       # print out our header unless we are dumping / importing ...
-      no_header = cmd(:dump) || cmd(:import) || cmd(:dump_remote)
-      show_header unless no_header
+      show_header unless dumping?
       config['location'].each do |loc|
-        recurse_dir(loc)
+        cmd(:dump_tree) ? dump_tree(File.join(loc)) : recurse_dir(loc)
       end
       # print out an informative footer unless dump / import ...
-      footer unless no_header
+      footer unless dumping?
     end
 
-    # private
+    private
+
+    def dumping?
+      cmd(:dump) || cmd(:dump_remote) || cmd(:dump_tree)
+    end
 
     # returns the Confoog class which can then be used to access any config var
+    # @return [void]
+    # @param [none]
     def config
       @cmd.getconfig
     end
 
+    # Return the true value of the specified configuration parameter. This is a
+    # helper function that simply calls the 'true_cmd' function in the @cmd
+    # class
+    # @param command [symbol] The defined command symbol that is to be returned
+    # @return [various] The value of the requested command option
+    # @example
+    #   logging = cmd(:log)
     def cmd(command)
       @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'
@@ -72,12 +88,13 @@ module UpdateRepo
 
     # 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.
+    # @param dirname [string] Contains the directory to search for Git repos.]
+    # @return [void]
     def recurse_dir(dirname)
       Dir.chdir(dirname) do
         Dir['**/'].each do |dir|
           next unless gitdir?(dir)
-          if cmd(:dump) || cmd(:dump_remote)
+          if dumping?
             dump_repo(File.join(dirname, dir))
           else
             notexception?(dir) ? update_repo(dir) : skip_repo(dir)
@@ -97,12 +114,13 @@ module UpdateRepo
     # @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"
+      # 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
@@ -114,31 +132,49 @@ module UpdateRepo
 
     # 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"
+      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}"
+      end
     end
 
+    # Print a list of any defined expections that will not be updated.
+    # @return [void]
+    # @param [none]
     def list_exceptions
       exceptions = config['exceptions']
-      if exceptions
-        print_log "\nExclusions:".underline, ' ',
-                  exceptions.join(', ').yellow, "\n"
-      end
+      return unless exceptions
+      # if exceptions
+      print_log "\nExclusions:".underline, ' ',
+                exceptions.join(', ').yellow, "\n"
+      # end
     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|
@@ -146,6 +182,12 @@ module UpdateRepo
       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
+    # @return [void]
+    # @example
+    #   skip_repo('/Repo/Personal/work-in-progress')
     def skip_repo(dirpath)
       Dir.chdir(dirpath.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
@@ -154,30 +196,49 @@ module UpdateRepo
       end
     end
 
+    # Takes the specified Repo outputs information and the repo URL then calls
+    # #do_update to actually update it.
+    # @param dirname [string] The directory that will be updated
+    # @return [void]
+    # @example
+    #   update_repo('/Repo/linux/stable')
     def update_repo(dirname)
       Dir.chdir(dirname.chomp!('/')) do
-        repo_url = `git config remote.origin.url`.chomp
-        do_update(repo_url)
+        # repo_url = `git config remote.origin.url`.chomp
+        do_update
         @metrics[:processed] += 1
       end
     end
 
-    def do_update(repo_url)
+    # Actually perform the update of this specific repository, calling the
+    # function #do_threads to handle the output to screen and log.
+    # @param none
+    # @return [void]
+    def do_update
+      repo_url = `git config remote.origin.url`.chomp
       print_log '* Checking ', Dir.pwd.green, " (#{repo_url})\n"
       Open3.popen3('git pull') do |stdin, stdout, stderr, thread|
         stdin.close
-        do_threads(stdout, stderr)
+        do_threads(stdout, stderr, repo_url)
         thread.join
       end
     end
 
-    def do_threads(stdout, stderr)
+    # Create 2 individual threads to handle both STDOUT and STDERR streams,
+    # writing to console and log if specified.
+    # @param stdout [stream] STDOUT Stream from the popen3 call
+    # @param stderr [stream] STDERR Stream from the popen3 call
+    # @param repo_url [string] URL of the associated repository
+    # @return [void]
+    def do_threads(stdout, stderr, repo_url)
       { out: stdout, err: stderr }.each do |key, stream|
         Thread.new do
           while (line = stream.gets)
-            if key == :err && line =~ /^fatal:/
+            if key == :err && line =~ /^fatal:|^error:/
               print_log '   ', line.red
               @metrics[:failed] += 1
+              fullpath = Dir.pwd.red
+              @metrics[:failed_list].push("#{fullpath} (#{repo_url})")
             else
               print_log '   ', line.cyan
               @metrics[:updated] += 1 if line =~ %r{^From\s(?:https?|git)://}
@@ -189,6 +250,8 @@ module UpdateRepo
 
     # this function will either dump out a CSV with the directory and remote,
     # or just the remote depending if we called --dump or --dump-remote
+    # @param dir [string] The local directory for the repository
+    # @return [void]
     def dump_repo(dir)
       Dir.chdir(dir.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
@@ -196,5 +259,11 @@ module UpdateRepo
         print_log "#{repo_url}\n"
       end
     end
+
+    # This function will recurse though all the subdirectories of the specified
+    # directory and print only the directory name in a tree format.
+    def dump_tree(dir)
+      print "here for #{dir}\n"
+    end
   end
 end

data/update_repo.gemspec

@@ -37,6 +37,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'colorize'
   spec.add_dependency 'confoog'
   spec.add_dependency 'trollop'
+  # on Ruby 1.9.3 we lock the 'term-ansicolor' gem to very 1.3.2
+  spec.add_dependency 'term-ansicolor', '= 1.3.2' if RUBY_VERSION < '2.0'
 
   # 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.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -314,3 +314,4 @@ signing_key:
 specification_version: 4
 summary: A Simple Gem to keep multiple locally-cloned Git Repositories up to date
 test_files: []
+has_rdoc: