update_repo 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95636a13072e10a0e61e827a2568a67d7cbdd5d4
-  data.tar.gz: 6ade5972d1a78a9b1105cbfa5495dc024e4a59ac
+  metadata.gz: 00f7cdd0ea4d8be3e8cde3ce7af7d2bea7edfa18
+  data.tar.gz: b4d2f9eba172fa64293855bb3acb03e09b16024e
 SHA512:
-  metadata.gz: 3b9ed7721e92dab35898841644d2b40047501bec8e2c3e6a7e74b546a253d1dcd6fb0832c47a96e37f4130cecc6c7114a79b5d38e2c7edd43bcce37e884dfaaa
-  data.tar.gz: b810473dfa95026f9f70e8dc02fc0064e53d9934eaac4fd4af097d2b61fd9135903bce30993cf148f3ca80345001c5d90005e0912d4cfcdfd3ffe14e4dc5cf03
+  metadata.gz: 4442b8cf9ffc01891eef1828f5fcf4c88f417cfcb7a7ec2268d0d9b1e19c7b0b0ddd7e922ea3b99de9b47c1065cf871300e08ae7f84274bd553d592af91e0bd4
+  data.tar.gz: 25439ccabe091bcc00b4c968272c3b00043aa3ffcf4a285b740877d47423ca9d9830dd26160d84631ff109fcbbcfab618b1c82eeabaf710d166d205d0125a98a

data/.gitignore

@@ -10,3 +10,4 @@
 .remote-sync.json
 .token
 .updatereporc
+*.log

data/README.md

@@ -78,8 +78,7 @@ Not in any specific order :
 - Error checking and reporting for the git processes `[IN PROGRESS]`
   * Add more failure cases, not all git errors fail with "fatal:"
 - retry for connection issues etc (config setting).
-- Add extra (optional) stats / info at end-of-job :
-  * list of changed repos
+- Improve the stats / info at end-of-job :
   * errors or connection problems `[IN PROGRESS]`
   * _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.
@@ -87,9 +86,10 @@ Not in any specific order :
 - Add ability to specify a new directory (containing Git repos) to search from the command line, and optionally save this to the standard configuration.
 - Add new repo from the command line that will be cloned to the default repo directory and then updated as usual. Extra flag added for "add only, clone later" for offline use.
 - Add flag for 'default' repo directory (or another specific directory - if it does not already exist it will be created and added to the standard list) which will be used for new additions.
-- Option to save log file for each run.
 - Add option to only display a (text) tree of the discovered git repositories, not updating them; Similar option to just dump a list of the remote git locations.
-- Add ability to export a text dump of each repo location `[DONE]` and then re-import this on a different machine or after reinstall `[TODO]`
+- Add Import & Export functionality :
+  * ability to export a text dump of each repo location `[DONE]`
+  * re-import the above dump on a different machine or after reinstall
 - Document configuration file format and options.
 - Add testing!
 

data/Rakefile

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

data/lib/update_repo/helpers.rb

@@ -14,9 +14,6 @@ module Helpers
     File.join(path_array)
   end
 
-  # mark these as private simply so that 'reek' wont flag as utility function.
-  private
-
   # true if we are dumping the file structure and git urls instead of updating.
   def dumping?
     param_set('dump')
@@ -27,6 +24,23 @@ module Helpers
     param_set('import')
   end
 
+  # true if we are logging to file.
+  def logging?
+    param_set('log')
+  end
+
+  # this function will simply pass the given string to 'print', and also
+  # log to file if that is specified.
+  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 logging?
+  end
+
+  # mark these as private simply so that 'reek' wont flag as utility function.
+  private
+
   def gitdir?(dirpath)
     gitpath = dirpath + '/.git'
     File.exist?(gitpath) && File.directory?(gitpath)
@@ -34,17 +48,11 @@ module Helpers
 
   def show_time(duration)
     time_taken = Time.at(duration).utc
-    time_taken.strftime('%-H hours, %-M Minutes and %-S seconds.')
+    time_taken.strftime('%-H hours, %-M Minutes and %-S seconds')
   end
 
   # we cant use --dump and --import on the same command line
   def no_import_export
     Trollop.die 'update_repo : Cannot specify both --dump and --import'
   end
-
-  # print the specified summary metric, called from the footer.
-  def summary(which, color, event)
-    output = "#{which} #{event}"
-    print ' / ', output.send(color.to_sym) unless which.zero?
-  end
 end

data/lib/update_repo/version.rb

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

data/lib/update_repo.rb

@@ -20,7 +20,10 @@ module UpdateRepo
     # Class constructor. No parameters required.
     # @return [void]
     def initialize
-      @metrics = { count: 0, skipped: 0, failed: 0, updated: 0, start_time: 0 }
+      @metrics = { processed: 0, skipped: 0, failed: 0, updated: 0,
+                   start_time: 0 }
+      @summary = { processed: 'green', updated: 'cyan', skipped: 'yellow',
+                   failed: 'red' }
       # read the options from Trollop and store in temp variable.
       # we do it this way around otherwise if configuration file is missing it
       # gives the error messages even on '--help' and '--version'
@@ -29,8 +32,7 @@ module UpdateRepo
       # allows easy access to the configuration data
       @config = Confoog::Settings.new(filename: CONFIG_FILE,
                                       prefix: 'update_repo',
-                                      autoload: true,
-                                      autosave: false)
+                                      autoload: true, autosave: false)
       # store the command line variables in a configuration variable
       @config['cmd'] = temp_opt
       config_error unless @config.status[:errors] == Status::INFO_FILE_LOADED
@@ -42,20 +44,39 @@ module UpdateRepo
     #   walk_repo.start
     def start
       String.disable_colorization = true unless param_set('color')
-      no_import_export if dumping? && importing?
+      # make sure we dont have bad cmd-line parameter combinations ...
+      check_params
+      # print out our header ...
+      show_header unless dumping? || importing?
+      @config['location'].each do |loc|
+        recurse_dir(loc)
+      end
+      # print out an informative footer ...
+      footer unless dumping? || importing?
+    end
+
+    private
+
+    def check_params
+      setup_logfile if logging?
+      if dumping? && importing?
+        Trollop.die 'Sorry, you cannot specify both --dump and --import '.red
+      end
       if importing?
         Trollop.die "Sorry 'Import' functionality is not implemented yet".red
-      else
-        show_header
-        @config['location'].each do |loc|
-          recurse_dir(loc)
-        end
       end
-      # print out an informative footer...
-      footer
     end
 
-    private
+    def setup_logfile
+      filename = if param_set('timestamp')
+                   'updaterepo-' + Time.new.strftime('%y%m%d-%H%M%S') + '.log'
+                 else
+                   'updaterepo.log'
+                 end
+      # filename = 'updaterepo' + prefix + '.log'
+      @logfile = File.open(filename, 'w')
+      @logfile.sync = true
+    end
 
     # Determine options from the command line and configuration file. Command
     # line takes precedence
@@ -65,8 +86,8 @@ module UpdateRepo
 
     def config_error
       if @config.status[:errors] == Status::ERR_CANT_LOAD
-        print 'Note that the the default configuration file was '.red,
-              "changed to ~/#{CONFIG_FILE} from v0.4.0 onwards\n\n".red
+        print_log 'Note that the the default configuration file was '.red,
+                  "changed to ~/#{CONFIG_FILE} from v0.4.0 onwards\n\n".red
       end
       exit 1
     end
@@ -93,9 +114,10 @@ EOS
         opt :dump, 'Dump a list of Directories and Git URL\'s to STDOUT in CSV format', default: false
         opt :prune, "Number of directory levels to remove from the --dump output.\nOnly valid when --dump or -d specified", default: 0
         opt :import, "Import a previous dump of directories and Git repository URL's,\n(created using --dump) then proceed to clone them locally.", default: false
+        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 :quiet, 'Only minimal output to the terminal', default: false
-        # opt :silent, 'Completely silent, no output to terminal at all.',
-        #    default: false
+        # opt :silent, 'Completely silent, no output to terminal at all.', default: false
       end
     end
     # rubocop:enable Metrics/MethodLength
@@ -110,8 +132,6 @@ EOS
           next unless gitdir?(dir)
           if dumping?
             dump_repo(File.join(dirname, dir))
-          elsif importing?
-            # placeholder
           else
             notexception?(dir) ? update_repo(dir) : skip_repo(dir)
           end
@@ -133,53 +153,57 @@ EOS
     def show_header
       # print an informative header before starting
       # unless we are dumping the repo information
-      return if dumping?
-      print "\nGit Repo update utility (v", VERSION, ')',
-            " \u00A9 Grant Ramsay <seapagan@gmail.com>\n"
-      print "Using Configuration from '#{@config.config_path}'\n"
-      print "Command line is : #{@config['cmd']}\n"
+      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 "\n" # blank line before processing starts
+      print_log "\n" # blank line before processing starts
     end
 
     # print out a brief footer. This will be expanded later.
     # @return [void]
     def footer
-      # no footer if we are dumping the repo information
-      return if dumping?
       duration = Time.now - @metrics[:start_time]
-      print "\nUpdates completed : ", @metrics[:count].to_s.green,
-            ' repositories processed'.green
-      summary(@metrics[:updated], 'cyan', 'updated')
-      summary(@metrics[:skipped], 'yellow', 'skipped')
-      summary(@metrics[:failed], 'red', 'failed')
-      print ' in ', show_time(duration).cyan, "\n\n"
+      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
+
+    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
     end
 
     def list_exceptions
       exceptions = @config['exceptions']
       if exceptions
-        print "\nExclusions:".underline, ' ',
-              exceptions.join(', ').yellow, "\n"
+        print_log "\nExclusions:".underline, ' ',
+                  exceptions.join(', ').yellow, "\n"
       end
     end
 
     def list_locations
-      print "\nRepo location(s):\n".underline
+      print_log "\nRepo location(s):\n".underline
       @config['location'].each do |loc|
-        print '-> ', loc.cyan, "\n"
+        print_log '-> ', loc.cyan, "\n"
       end
     end
 
     def skip_repo(dirpath)
       Dir.chdir(dirpath.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
-        print '* Skipping ', Dir.pwd.yellow, " (#{repo_url})\n"
+        print_log '* Skipping ', Dir.pwd.yellow, " (#{repo_url})\n"
         @metrics[:skipped] += 1
       end
     end
@@ -188,13 +212,14 @@ EOS
       Dir.chdir(dirname.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
         do_update(repo_url)
-        @metrics[:count] += 1
+        @metrics[:processed] += 1
       end
     end
 
     def do_update(repo_url)
-      print '* Checking ', Dir.pwd.green, " (#{repo_url})\n"
-      Open3.popen3('git pull') do |_stdin, stdout, stderr, thread|
+      print_log '* Checking ', Dir.pwd.green, " (#{repo_url})\n"
+      Open3.popen3('git pull') do |stdin, stdout, stderr, thread|
+        stdin.close
         do_threads(stdout, stderr)
         thread.join
       end
@@ -205,12 +230,11 @@ EOS
         Thread.new do
           while (line = stream.gets)
             if key == :err && line =~ /^fatal:/
-              print '   ', line.red
+              print_log '   ', line.red
               @metrics[:failed] += 1
             else
-              print '   ', line.cyan
-              # @metrics[:updated] += 1 if line =~ /files?\schanged/
-              @metrics[:updated] += 1 if line =~ /^From\shttps?:\/\//
+              print_log '   ', line.cyan
+              @metrics[:updated] += 1 if line =~ %r{^From\shttps?://}
             end
           end
         end
@@ -220,7 +244,7 @@ EOS
     def dump_repo(dir)
       Dir.chdir(dir.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
-        print "#{trunc_dir(dir, @config['cmd'][:prune])},#{repo_url}\n"
+        print_log "#{trunc_dir(dir, @config['cmd'][:prune])},#{repo_url}\n"
       end
     end
   end

data/update_repo.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'fakefs'
   spec.add_development_dependency 'json', '= 1.8.3'
+  spec.add_development_dependency 'tins', '= 1.6.0'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'inch'
   spec.add_development_dependency 'simplecov', '~> 0.10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement