update_repo 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54b552a96cddc68af766238152689994aafe1bb6
-  data.tar.gz: 747b8dbf6ff74ca6c9269d0f6bcf8b29407a8069
+  metadata.gz: 6783e0c8c887cd196fea92efa147a7d258f9ad1a
+  data.tar.gz: 7f89ca19fc25897a196e4fe3bcc6a286a6f7c01c
 SHA512:
-  metadata.gz: 2c58773f1dcb1f4c1116cfed2961cdebb20e23384b91c563113267ff70c969a76fbc0f5e5d31dbd78bccb37e9cb2df20d4c9ba4a74a3ebe9d703410ee1180a2f
-  data.tar.gz: 440ec4e0c252ab6670a00816c501e0b1b51567870406babe2587b8d2365484ba3744c29ce286c7a9743b3455a3d4431f3e896d45052469be4ea622cd09d7c950
+  metadata.gz: dec5a5aa2174265b867e33721f0270055e9a39054e1bc164201c061ad8051415c5d1e4baf8a0ec9dfd4af0198f154fa8f758a1b9e6b35be737737419d6580803
+  data.tar.gz: ada430198bdf7ca638dab031ee2d138c35a5e1a3c16427c0af79ff6af1ce66c68cfdfeb3f5db6f970f779578e77fdf77148d41b46d82e4522a378d259a895142

data/.reek

@@ -12,3 +12,6 @@ RepeatedConditional:
 
 DuplicateMethodCall:
  max_calls: 3
+
+NestedIterators:
+  max_allowed_nesting: 2

data/README.md

@@ -8,7 +8,7 @@
 
 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.
+This is the conversion to a Gem of one of my standalone Ruby scripts. Still a work in progress but the required base 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.
@@ -17,7 +17,7 @@ __Note:__ From version 0.9.0 onwards, the default mode of operation is non-verbo
 
 #### Pre-requirements
 
-It goes without saying that at the very least a working copy of both [`Git`][git] and [`Ruby`][ruby] need to be installed on your machine. Also, the script has currently only been tested under Linux, not windows.
+It goes without saying that at the very least a working copy of both [`Git`][git] (version 1.8.5 or greater, the script will not run with an older version) and [`Ruby`][ruby] need to be installed on your machine. Also, the script has currently only been tested under Linux, not windows.
 
 [git]: http://git-scm.com
 [ruby]: http://www.ruby-lang.org
@@ -38,7 +38,7 @@ location:
 - /media/myuser/git-repos
 - /data/RepoDir
 ```
-This is the most basic example of a configuration file and there are other options that can be added to fine-tune the operation - see the description of configuration options below.
+This is the most basic example of a configuration file and there are other options that can be added to fine-tune the operation - see the description of configuration options below and the [Website](http://updaterepo.seapagan.net) for more information.
 
 This file should be located in the users home directory (`~/.updaterepo`).
 
@@ -48,6 +48,7 @@ $ update_repo
 ```
 
 ## Configuration
+The below is a summary of the most common configuration options, see the [Website](http://updaterepo.seapagan.net) for complete details and usage.
 #### Configuration file
 The configuration file defaults to `~/.updaterepo` and is a standard [YAML](http://yaml.org/)-formatted text file. If this configuration file is not found, the script will terminate with an error.  
 The first line must contain the YAML frontmatter of 3 dashes (`---`). After that, the following sections can follow in any order. Only the `location:` section is compulsory, and that must contain at least one entry.
@@ -77,8 +78,18 @@ log: true
 timestamp: true
 ```
 
+`verbose:` - display the output of the git command for each repo, defaults to FALSE (optional)
+```yaml
+verbose: true
+```
+
+`quiet:` - no output at all, not even the header and footer, defaults to FALSE (optional)
+```yaml
+quiet: true
+```
+
 #### Command line switches
-Options are not required. If none are specified then the program will read from the standard configuration file (~/.updaterepo) and automatically update the specified Repositories.
+Options are not required. If none are specified then the program will read from the standard configuration file (~/.updaterepo) and automatically update the specified Repositories. Command line options will take preference over those specified in the configuration file.
 
 Enter `update_repo --help` at the command prompt to get a list of available options :
 ```
@@ -93,6 +104,8 @@ Options:
                              --log option is also specified.
   -r, --dump-remote          Create a dump to screen or log listing all the git remote URLS found in
                              the specified directories.
+  -V, --verbose              Display each repository and the git output to screen
+  -q, --quiet                Run completely silent, with no output to the terminal (except fatal errors).
   -v, --version              Print version and exit
   -h, --help                 Show this message
 ```
@@ -101,8 +114,7 @@ Options:
 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.
-- 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.
+- Add command line option to specify an alternate config file.
 - 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.
@@ -140,7 +152,7 @@ Run `rake` to run the RSpec tests, which also runs `RuboCop`, `Reek` and `inch -
 5. Create new Pull Request
 
 Please note - This Gem currently aims to pass 100% on [RuboCop][rubocop], [Reek][reek] and [Inch-CI][inch] (on pedantic mode), so all pull requests should do likewise. Ask for guidance if needed.
-Running `rake` will automatically test all 3 of those along with the RSpec tests. Note that Failures of Rubocop will cause the CI (Travis) to fail, however 'Reek' failures will not.
+Running `rake` will automatically test all 3 of those along with the RSpec tests.
 
 [rubocop]: https://github.com/bbatsov/rubocop
 [reek]: https://github.com/troessner/reek

data/lib/update_repo/cmd_config.rb

@@ -110,7 +110,6 @@ EOS
         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 :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
     # rubocop:enable Metrics/MethodLength

data/lib/update_repo/console_output.rb

@@ -70,14 +70,25 @@ module UpdateRepo
     # @param [none]
     # @return [void]
     def list_failures
+      # ensure we don't have duplicate errors from the same repo
+      remove_dups
       print_log "\n\n!! Note : The following #{@metrics[:failed_list].count}",
                 ' repositories ', 'FAILED'.red.underline, ' during this run :'
+      # print out any and all errors into a nice list
       @metrics[:failed_list].each do |failed|
         print_log "\n  [", 'x'.red, "] #{failed[:loc]}"
         print_log "\n    -> ", "\"#{failed[:line].chomp}\"".red
       end
     end
 
+    # removes any duplications in the list of failed repos.
+    # @param [none]
+    # @return [void] modifies the @metrics[:failed_list] in place
+    def remove_dups
+      # removes duplicate ':loc' values from the Failed list.
+      @metrics[:failed_list].uniq! { |error| error[:loc] }
+    end
+
     # Print a list of any defined expections that will not be updated.
     # @return [void]
     # @param [none]

data/lib/update_repo/git_control.rb

@@ -13,15 +13,15 @@ module UpdateRepo
     attr_reader :status
 
     # Constructor for the GitControl class.
-    # @param repo [string] Repo name
+    # @param dir [string] The directory location of this local repo.
     # @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)
+    def initialize(dir, logger, metrics)
       @status = { updated: false, failed: false, unchanged: false }
-      @repo = repo
+      @dir = dir
       @log = logger
       @metrics = metrics
     end
@@ -30,11 +30,9 @@ module UpdateRepo
     # @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
+      print_log '* Checking ', @dir.green, " (#{repo_url})\n"
+      Open3.popen2e("git -C #{@dir} pull") do |_stdin, stdout_err, _thread|
+        stdout_err.each { |line| handle_output(line) }
       end
       # reset the updated status in the rare case than both update and failed
       # are set. This does happen!
@@ -43,31 +41,11 @@ module UpdateRepo
 
     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)
+    # Returns the repo remote url for the repo in @dir
+    # @param [none]
+    # @return [string]
+    def repo_url
+      `git -C #{@dir} config remote.origin.url`.chomp
     end
 
     # print a git output line and update the metrics if an update has occurred
@@ -75,9 +53,17 @@ module UpdateRepo
     # @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./
+      if line.chomp =~ /^fatal:|^error:/
+        print_log '   ', line.red
+        @status[:failed] = true
+        err_loc = "#{@dir} (#{repo_url})"
+        @metrics[:failed_list].push(loc: err_loc, line: line)
+      else
+        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
+    # rubocop:enable Metrics/LineLength
   end
 end

data/lib/update_repo/helpers.rb

@@ -34,7 +34,18 @@ module Helpers
     @log.output(*string)
   end
 
-  def repo_url
-    `git config remote.origin.url`.chomp
+  # Cross-platform way of finding an executable in the $PATH.
+  # From : http://stackoverflow.com/a/5471032/6641755
+  #
+  #   which('ruby') #=> /usr/bin/ruby
+  def which(cmd)
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.each do |ext|
+        exe = File.join(path, "#{cmd}#{ext}")
+        return exe if File.executable?(exe) && !File.directory?(exe)
+      end
+    end
+    # return nil
   end
 end

data/lib/update_repo/logger.rb

@@ -25,6 +25,10 @@ module UpdateRepo
       # open the logfile and set sync mode.
       @logfile = File.open(filename, 'w')
       @logfile.sync = true
+      @legend = { failed: { char: 'x', color: 'red' },
+                  updated: { char: '^', color: 'green' },
+                  unchanged: { char: '.', color: 'white' },
+                  skipped: { char: 's', color: 'yellow' } }
     end
 
     # generate a filename for the log, with or without a timestamp
@@ -53,21 +57,15 @@ module UpdateRepo
       @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.
+    # function repostat - outputs a coloured char depending on the status hash,
+    # but not if we are in quiet or 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
+      @legend.each do |key, value|
+        print value[:char].send(value[:color].to_sym) if status[key]
       end
     end
 
@@ -79,10 +77,8 @@ module UpdateRepo
       # 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)
-
+      repo_output = %w(do_update handle_output skip_repo update)
       # return the name in string if DOES match.
       calling_fn if repo_output.include?(calling_fn)
     end

data/lib/update_repo/version.rb

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

data/lib/update_repo.rb

@@ -9,6 +9,7 @@ require 'yaml'
 require 'colorize'
 require 'confoog'
 require 'trollop'
+require 'versionomy'
 
 # Overall module with classes performing the functionality
 # Contains Class UpdateRepo::WalkRepo
@@ -39,6 +40,8 @@ module UpdateRepo
     #   walk_repo.start
     def start
       String.disable_colorization = !cmd(:color)
+      # check for existence of 'Git' and exit otherwise...
+      checkgit
       # print out our header unless we are dumping / importing ...
       @cons.show_header unless dumping?
       config['location'].each do |loc|
@@ -50,6 +53,19 @@ module UpdateRepo
 
     private
 
+    def checkgit
+      unless which('git')
+        print 'Git is not installed on this machine, script cannot '.red,
+              "continue.\n".red
+        exit 1
+      end
+      gitver = `git --version`.gsub(/git version /, '').chomp
+      return if Versionomy.parse(gitver) >= '1.8.5'
+      print 'Git version 1.8.5 or greater must be installed, you have '.red,
+            "version #{gitver}!\n".red
+      exit 1
+    end
+
     def dumping?
       cmd(:dump) || cmd(:dump_remote) || cmd(:dump_tree)
     end
@@ -76,17 +92,30 @@ module UpdateRepo
     # a Git repository then update it (or as directed by command line)
     # @param dirname [string] Contains the directory to search for Git repos.]
     # @return [void]
+    # rubocop:disable LineLength
     def recurse_dir(dirname)
+      walk_tree(dirname).each do |repo|
+        if dumping?
+          dump_repo(repo[:path])
+        else
+          notexception?(repo[:name]) ? update_repo(repo[:path]) : skip_repo(repo[:path])
+        end
+      end
+    end
+    # rubocop:enable LineLength
+
+    # walk the specified tree, return an array of hashes holding valid repos
+    # @param dirname [string] Directory to use as the base of the search
+    # @return [array] Array of hashes {:path, :name} for discovered Git repos
+    def walk_tree(dirname)
+      repo_list = []
       Dir.chdir(dirname) do
         Dir['**/'].each do |dir|
           next unless gitdir?(dir)
-          if dumping?
-            dump_repo(File.join(dirname, dir))
-          else
-            notexception?(dir) ? update_repo(dir) : skip_repo(dir)
-          end
+          repo_list.push(path: File.join(dirname, dir), name: dir)
         end
       end
+      repo_list
     end
 
     # tests to see if the given directory is an exception and should be skipped
@@ -103,13 +132,11 @@ module UpdateRepo
     # @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
-        print_log '* Skipping ', Dir.pwd.yellow, " (#{repo_url})\n"
-        @metrics[:skipped] += 1
-        @log.repostat(skipped: true)
-        @metrics[:processed] += 1
-      end
+      repo_url = `git -C #{dirpath} config remote.origin.url`.chomp
+      print_log '* Skipping ', dirpath.yellow, " (#{repo_url})\n"
+      @metrics[:skipped] += 1
+      @log.repostat(skipped: true)
+      @metrics[:processed] += 1
     end
 
     # Takes the specified Repo outputs information and the repo URL then calls
@@ -118,18 +145,16 @@ module UpdateRepo
     # @return [void]
     # @example
     #   update_repo('/Repo/linux/stable')
-    def update_repo(dirname)
-      Dir.chdir(dirname.chomp!('/')) do
-        # create the git instance and then perform the update
-        git = GitControl.new(repo_url, @log, @metrics)
-        git.update
-        @metrics[:processed] += 1
-        # update the metrics
-        [:failed, :updated, :unchanged].each do |metric|
-          @metrics[metric] += 1 if git.status[metric]
-        end
-        @log.repostat(git.status)
+    def update_repo(dirpath)
+      # create the git instance and then perform the update
+      git = GitControl.new(dirpath, @log, @metrics)
+      git.update
+      @metrics[:processed] += 1
+      # update the metrics
+      [:failed, :updated, :unchanged].each do |metric|
+        @metrics[metric] += 1 if git.status[metric]
       end
+      @log.repostat(git.status)
     end
 
     # this function will either dump out a CSV with the directory and remote,
@@ -139,7 +164,7 @@ module UpdateRepo
     def dump_repo(dir)
       Dir.chdir(dir.chomp!('/')) do
         print_log "#{trunc_dir(dir, config['cmd'][:prune])}," if cmd(:dump)
-        print_log "#{get_repo_url}\n"
+        print_log `git -C #{dir} config remote.origin.url`
       end
     end
 

data/update_repo.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'colorize'
   spec.add_dependency 'confoog'
   spec.add_dependency 'trollop'
+  spec.add_dependency 'versionomy'
   # on Ruby 1.9.3 we lock the 'term-ansicolor' gem to version 1.3.2
   spec.add_dependency 'term-ansicolor', '= 1.3.2' if RUBY_VERSION < '2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -234,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: versionomy
+  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'
 description: 
 email:
 - seapagan@gmail.com