update_repo 0.8.8 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 893b9fd1eae35a35c0d7ce7a82b6efe253a15449
-  data.tar.gz: 29c9899ac3a25735ac57ceb3c3d9efb831268fc0
+  metadata.gz: 54b552a96cddc68af766238152689994aafe1bb6
+  data.tar.gz: 747b8dbf6ff74ca6c9269d0f6bcf8b29407a8069
 SHA512:
-  metadata.gz: f7666c09dddb317c4cca5a47ac27f27fbdd1a35e41ca92459c11b2e3da467e74a097669106d46008dda0134b063d9d632c3164eae60b81a201204fe696feeae3
-  data.tar.gz: 20c9a53429cabdaf77e978c5f8ae2e092048e776af8d5c75b3adec0f5f1cbc5a603b8a93ff4ff0e3f103f586d8cfb5023d02bdc9a09d57761846170a05fefa2e
+  metadata.gz: 2c58773f1dcb1f4c1116cfed2961cdebb20e23384b91c563113267ff70c969a76fbc0f5e5d31dbd78bccb37e9cb2df20d4c9ba4a74a3ebe9d703410ee1180a2f
+  data.tar.gz: 440ec4e0c252ab6670a00816c501e0b1b51567870406babe2587b8d2365484ba3744c29ce286c7a9743b3455a3d4431f3e896d45052469be4ea622cd09d7c950

data/.reek

@@ -1,6 +1,8 @@
 ---
 TooManyStatements:
-  max_statements: 10
+  max_statements: 8
+  exclude:
+  - set_options
 
 UtilityFunction:
   public_methods_only: true

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
+  - 1.9.3-p551
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
 before_install: gem install bundler -v 1.13.6

data/README.md

@@ -11,6 +11,8 @@ A Simple Gem to keep multiple locally-cloned Git Repositories up to date.
 This is the conversion to a Gem of one of my standalone Ruby scripts. Still very much a work in progress but the required basic functionality is there.
 The script will simply run `git pull` on every local clone of a git repository that it finds under the specified directory or directories.
 
+__Note:__ From version 0.9.0 onwards, the default mode of operation is non-verbose. If you wish the same output as previous versions then specify `--verbose` on the command line or `verbose: true` in the configuration file.
+
 ## Installation
 
 #### Pre-requirements

data/lib/update_repo/cmd_config.rb

@@ -38,6 +38,7 @@ module UpdateRepo
     # both command line (given preference) and the configuration file.
     # @param command [symbol] The symbol of the defined command
     # @return [various] Returns the true value of the comamnd symbol
+    # ignore the :reek:NilCheck for this function
     def true_cmd(command)
       cmd_given = @conf['cmd'][(command.to_s + '_given').to_sym]
       cmd_line = @conf['cmd'][command.to_sym]
@@ -101,13 +102,14 @@ Options:
 EOS
         opt :color, 'Use colored output', default: true
         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 :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 :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 :verbose, 'Display each repository and the git output to screen', default: false, short: 'V'
+        opt :quiet, 'Run completely silent, with no output to the terminal (except fatal errors).', default: false
         # opt :silent, 'Completely silent, no output to terminal at all.', default: false
       end
     end

data/lib/update_repo/console_output.rb

@@ -16,7 +16,7 @@ module UpdateRepo
     #   console = ConsoleOutput.new(@log)
     def initialize(logger, metrics, config)
       @summary = { processed: 'green', updated: 'cyan', skipped: 'yellow',
-                   failed: 'red' }
+                   failed: 'red', unchanged: 'white' }
       @metrics = metrics
       @log = logger
       @config = config.getconfig

data/lib/update_repo/git_control.rb

@@ -0,0 +1,83 @@
+require 'update_repo/version'
+require 'update_repo/helpers'
+require 'open3'
+
+module UpdateRepo
+  # Class : GitControl.
+  # This class will update one git repo, and send the output to the logger.
+  # It will also return status of the operation in #status.
+  class GitControl
+    include Helpers
+
+    # @return [hash] Return the status hash
+    attr_reader :status
+
+    # Constructor for the GitControl class.
+    # @param repo [string] Repo name
+    # @param logger [instance] pointer to the Logger class
+    # @param metrics [instance] pointer to the Metrics class
+    # @return [void]
+    # @example
+    #   git = GitControl.new(repo_url, @logger, @metrics)
+    def initialize(repo, logger, metrics)
+      @status = { updated: false, failed: false, unchanged: false }
+      @repo = repo
+      @log = logger
+      @metrics = metrics
+    end
+
+    # Update the git repo that was specified in the initializer.
+    # @param [none]
+    # @return [void]
+    def update
+      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
+      # reset the updated status in the rare case than both update and failed
+      # are set. This does happen!
+      @status[:updated] = false if @status[:updated] && @status[:failed]
+    end
+
+    private
+
+    # 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
+    # @return [void]
+    def do_threads(stdout, stderr)
+      { out: stdout, err: stderr }.each do |key, stream|
+        Thread.new do
+          while (line = stream.gets)
+            handle_err(line) if key == :err
+            handle_output(line) if key == :out
+          end
+        end
+      end
+    end
+
+    # output an error line and update the metrics
+    # @param line [string] The string containing the error message
+    # @return [void]
+    def handle_err(line)
+      return unless line =~ /^fatal:|^error:/
+      print_log '   ', line.red
+      @status[:failed] = true
+      err_loc = Dir.pwd + " (#{@repo})"
+      @metrics[:failed_list].push(loc: err_loc, line: line)
+    end
+
+    # print a git output line and update the metrics if an update has occurred
+    # @param line [string] The string containing the git output line
+    # @return [void]
+    # rubocop:disable Metrics/LineLength
+    def handle_output(line)
+      print_log '   ', line.cyan
+      @status[:updated] = true if line =~ /^Updating\s[0-9a-f]{7}\.\.[0-9a-f]{7}/
+      @status[:unchanged] = true if line =~ /^Already up-to-date./
+    end
+  end
+end

data/lib/update_repo/logger.rb

@@ -10,11 +10,14 @@ module UpdateRepo
     # Constructor for the Logger class.
     # @param enabled [boolean] True if we log to file
     # @param timestamp [boolean] True if we timestamp the filename
+    # @param verbose [boolean] True if verbose flag is set
+    # @param quiet [boolean] True if quiet flag is set
     # @return [void]
     # @example
     #   log = Logger.new(true, false)
-    def initialize(enabled, timestamp)
-      @settings = { enabled: enabled, timestamp: timestamp }
+    def initialize(enabled, timestamp, verbose, quiet)
+      @settings = { enabled: enabled, timestamp: timestamp, verbose: verbose,
+                    quiet: quiet }
       # don't prepare a logfile unless it's been requested.
       return unless @settings[:enabled]
       # generate a filename depending on 'timestamp' setting.
@@ -40,13 +43,50 @@ module UpdateRepo
     # @param string [array] Array of strings for print formatting
     # @return [void]
     def output(*string)
-      # log to screen regardless
-      print(*string)
+      # nothing to screen if we want to be --quiet
+      unless @settings[:quiet]
+        # log header and footer to screen regardless
+        print(*string) if @settings[:verbose] || !repo_text?
+      end
       # log to file if that has been enabled
       return unless @settings[:enabled]
       @logfile.write(string.join('').gsub(/\e\[(\d+)(;\d+)*m/, ''))
     end
 
+    # function repostat - outputs the passed char at the passed color,
+    # only if we are not in quiet nor verbose mode.
+    # @param status [hash] pointer to GitControl.status hash
+    # @return [void]
+    def repostat(status)
+      # only print if not quiet and not verbose!
+      return if @settings[:quiet] || @settings[:verbose]
+      if status[:failed]
+        print 'x'.red
+      elsif status[:updated]
+        print '^'.green
+      elsif status[:unchanged]
+        print '.'
+      elsif status[:skipped]
+        print 's'.yellow
+      end
+    end
+
+    # returns non nil if we have been called originally by one of the Repo
+    # update output functions.
+    # @param [none]
+    # @return [boolean] True if we have been called during repo update
+    def repo_text?
+      # get calling function - need to skip first 2, also remove 'block in '
+      # prefix if exists
+      calling_fn = caller_locations[2].label.gsub(/block in /, '')
+
+      # array with the functions we want to skip
+      repo_output = %w(do_update handle_output handle_err skip_repo update)
+
+      # return the name in string if DOES match.
+      calling_fn if repo_output.include?(calling_fn)
+    end
+
     # close the logfile, if it exists
     # @param [none]
     # @return [void]

data/lib/update_repo/metrics.rb

@@ -13,7 +13,7 @@ module UpdateRepo
     def initialize(logger)
       @log = logger
       @metrics = { processed: 0, skipped: 0, failed: 0, updated: 0,
-                   start_time: 0, failed_list: [] }
+                   unchanged: 0, start_time: 0, failed_list: [] }
     end
 
     # Read the metric 'key'
@@ -30,24 +30,5 @@ module UpdateRepo
     def []=(key, value)
       @metrics[key] = value
     end
-
-    # output an error line and update the metrics
-    # @param line [string] The string containing the error message
-    # @return [void]
-    def handle_err(line)
-      return unless line =~ /^fatal:|^error:/
-      print_log '   ', line.red
-      @metrics[:failed] += 1
-      err_loc = Dir.pwd + " (#{repo_url})"
-      @metrics[:failed_list].push(loc: err_loc, line: line)
-    end
-
-    # print a git output line and update the metrics if an update has occurred
-    # @param line [string] The string containing the git output line
-    # @return [void]
-    def handle_output(line)
-      print_log '   ', line.cyan
-      @metrics[:updated] += 1 if line =~ %r{^From\s(?:https?|git)://}
-    end
   end
 end

data/lib/update_repo/version.rb

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

data/lib/update_repo.rb

@@ -4,11 +4,11 @@ require 'update_repo/cmd_config'
 require 'update_repo/logger'
 require 'update_repo/console_output'
 require 'update_repo/metrics'
+require 'update_repo/git_control'
 require 'yaml'
 require 'colorize'
 require 'confoog'
 require 'trollop'
-require 'open3'
 
 # Overall module with classes performing the functionality
 # Contains Class UpdateRepo::WalkRepo
@@ -26,7 +26,7 @@ module UpdateRepo
       # create a new instance of the CmdConfig class then read the config var
       @cmd = CmdConfig.new
       # set up the output and logging class
-      @log = Logger.new(cmd(:log), cmd(:timestamp))
+      @log = Logger.new(cmd(:log), cmd(:timestamp), cmd(:verbose), cmd(:quiet))
       # create instance of the Metrics class
       @metrics = Metrics.new(@log)
       # instantiate the console output class for header, footer etc
@@ -107,6 +107,8 @@ module UpdateRepo
         repo_url = `git config remote.origin.url`.chomp
         print_log '* Skipping ', Dir.pwd.yellow, " (#{repo_url})\n"
         @metrics[:skipped] += 1
+        @log.repostat(skipped: true)
+        @metrics[:processed] += 1
       end
     end
 
@@ -118,38 +120,15 @@ module UpdateRepo
     #   update_repo('/Repo/linux/stable')
     def update_repo(dirname)
       Dir.chdir(dirname.chomp!('/')) do
-        do_update
+        # create the git instance and then perform the update
+        git = GitControl.new(repo_url, @log, @metrics)
+        git.update
         @metrics[:processed] += 1
-      end
-    end
-
-    # 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)
-        thread.join
-      end
-    end
-
-    # 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
-    # @return [void]
-    def do_threads(stdout, stderr)
-      { out: stdout, err: stderr }.each do |key, stream|
-        Thread.new do
-          while (line = stream.gets)
-            @metrics.handle_err(line) if key == :err
-            @metrics.handle_output(line) if key == :out
-          end
+        # update the metrics
+        [:failed, :updated, :unchanged].each do |metric|
+          @metrics[metric] += 1 if git.status[metric]
         end
+        @log.repostat(git.status)
       end
     end
 

data/update_repo.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
 # rubocop:disable LineLength
+# rubocop:disable Metrics/BlockLength
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'update_repo/version'
@@ -36,7 +37,7 @@ Gem::Specification.new do |spec|
   # Below this we fix to the last working versions to keep Ruby 1.9.3 compat or
   # we ignore completely - Reek and Rubocop working in the latest versions is
   # enough since the code base is common.
-  spec.add_development_dependency 'reek', '~> 4.4' if RUBY_VERSION >= '2.1'
+  spec.add_development_dependency 'reek', '~> 4.5' if RUBY_VERSION >= '2.1'
   spec.add_development_dependency 'rubocop' if RUBY_VERSION >= '2.0'
 
   if RUBY_VERSION < '2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.0
 platform: ruby
 authors:
 - Grant Ramsay
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -259,6 +259,7 @@ files:
 - lib/update_repo.rb
 - lib/update_repo/cmd_config.rb
 - lib/update_repo/console_output.rb
+- lib/update_repo/git_control.rb
 - lib/update_repo/helpers.rb
 - lib/update_repo/logger.rb
 - lib/update_repo/metrics.rb