update_repo 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 216483b2ac26f98ccf9b4b7712059f8876de2d9d
-  data.tar.gz: 5fd33a763737cfb1ad7410bf7703b7650e27ddd7
+  metadata.gz: 4b02b9ed1895164abe441378e107c240e0d0884a
+  data.tar.gz: 4b78e9cb4620576e1cca044ee2c617b0e25bb9b9
 SHA512:
-  metadata.gz: 0d4698880b1584aeab7f6f7fd9400fdfe41953cfa1446a2bafcd70f912b73d66dc5ba598fd1671770a509614ed26b794b12300107ed369a10ac36e7546a1d518
-  data.tar.gz: 03fadd911508d1b51dbd3ffa5b8adf5fd6b3bd25d6fc1309c7d69ff55d2105d536d4df6ec636440cd4a74b9f8bc1ac6309f6d627baf7f646dda470094ae9b4ff
+  metadata.gz: 9f2fc8b75b84ff8db5c18949150b3a209d6341fbfda3e07a4fc6ca3900453297425479d8d1d10bb50057579e07a35ef7eec438bc78b24d2cdbf80126a6e8abb7
+  data.tar.gz: 270140f7a98ba431a88a87e1c93ec191f0206ca157e058b52cfbd8a669e3ea42c444bb791c59e0273c7ba2d04e807ef144d572d04bd6400a0979f74bcce2a981

data/.reek

@@ -4,3 +4,6 @@ TooManyStatements:
 
 UtilityFunction:
   public_methods_only: true
+
+RepeatedConditional:
+  max_ifs: 3

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  DisplayCopNames: true

data/.travis.yml

@@ -3,5 +3,5 @@ rvm:
   - 1.9.3
   - 2.1
   - 2.2.4
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/README.md

@@ -38,7 +38,22 @@ $ update_repo
 
 ## Configuration
 #### Configuration file
-To be added.
+The configuration file defaults to `~/.updaterepo` and is a standard [YAML](http://yaml.org/)-formatted text file. 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.
+
+`location:` - at least one directory which contains the locally cloned repository(s) to update. There is no limit on how many directories can be listed :
+```yaml
+---
+location:
+- /media/myuser/git-repos
+- /data/RepoDir
+```
+
+`exceptions:` - an (optional) list of repositories that will NOT be updated automatically. Use this for repositories that need special handling, or should only be manually updated. Note that the name specified is that of the __directory__ holding the repository (has the `.git` directory inside)
+```yaml
+exceptions:
+- ubuntu-trusty
+- update_repo
+```
 
 #### 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.
@@ -47,6 +62,11 @@ Enter `update_repo --help` at the command prompt to get a list of available opti
 ```
 Options:
   -c, --color, --no-color    Use colored output (default: true)
+  -d, --dump                 Dump a list of Directories and Git URL's to STDOUT in CSV format
+  -p, --prune=<i>            Number of directory levels to remove from the --dump output.
+                             Only valid when --dump or -d specified (Default: 0)
+  -i, --import               Import a previous dump of directories and Git repository URL's,
+                             (created using --dump) then proceed to clone them locally.
   -v, --version              Print version and exit
   -h, --help                 Show this message
 ```
@@ -57,11 +77,13 @@ Not in any specific order :
 - Improve error-checking and recovery while parsing the configuration file
   * Ignore and report invalid or missing directories
 - 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.
-- Error checking and reporting for the git processes - retry for connection issues etc (config setting).
+- 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
-    * errors or connection problems
-    * _more..._
+  * list of changed repos
+  * 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.
 - Add command line options for verbose or quiet, with same options in 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.
@@ -69,7 +91,7 @@ Not in any specific order :
 - 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 and then re-import this on a different machine or after reinstall
+- 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]`
 - Document configuration file format and options.
 - Add testing!
 

data/Rakefile

@@ -1,20 +1,28 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
 require 'inch/rake'
 
 RSpec::Core::RakeTask.new(:spec)
 
-RuboCop::RakeTask.new do |task|
-  task.options << 'lib' << 'exe'
+# rubocop is not compatible with Ruby < 2.0
+if RUBY_VERSION >= '2.0'
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new do |task|
+    task.options << 'lib' << 'exe'
+    task.fail_on_error = false
+  end
+else
+  task :rubocop do
+    # Empty task
+  end
 end
 
 Inch::Rake::Suggest.new do |suggest|
   suggest.args << '--pedantic'
 end
 
-# reek is not compatible with Ruby < 2.0]
-if RUBY_VERSION > '2.0'
+# reek is not compatible with Ruby < 2.0
+if RUBY_VERSION >= '2.0'
   require 'reek/rake/task'
   Reek::Rake::Task.new do |t|
     t.fail_on_error = false

data/lib/update_repo/helpers.rb

@@ -0,0 +1,50 @@
+# Module 'Helpers' containing assorted helper functions required elsewhere
+module Helpers
+  # will remove the FIRST 'how_many' root levels from a directory path 'dir'..
+  # @param dir [string] Path to be truncated
+  # @param how_many [integer] How many levels to be dropped from path.
+  # @return [string] the properly truncated path
+  def trunc_dir(dir, how_many)
+    # make sure we don't lose any root slash if '--prune' is NOT specified
+    return dir if how_many.zero?
+    # convert to array then lose the first 'how_many' parts
+    path_array = Pathname(dir).each_filename.to_a
+    path_array = path_array.drop(how_many)
+    # join it all back up again and return it
+    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')
+  end
+
+  # true if we are importing a previously dumped list of Git repos.
+  def importing?
+    param_set('import')
+  end
+
+  def gitdir?(dirpath)
+    gitpath = dirpath + '/.git'
+    File.exist?(gitpath) && File.directory?(gitpath)
+  end
+
+  def show_time(duration)
+    time_taken = Time.at(duration).utc
+    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.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/update_repo.rb

@@ -1,8 +1,10 @@
 require 'update_repo/version'
+require 'update_repo/helpers'
 require 'yaml'
 require 'colorize'
 require 'confoog'
 require 'trollop'
+require 'open3'
 
 # Overall module with classes performing the functionality
 # Contains Class UpdateRepo::WalkRepo
@@ -14,15 +16,11 @@ module UpdateRepo
   # repositories found therein.
   # rubocop:disable Metrics/ClassLength
   class WalkRepo
+    include Helpers
     # Class constructor. No parameters required.
     # @return [void]
     def initialize
-      # @counter - this will be incremented with each repo updated.
-      @counter = 0
-      # @skip_counter - will count all repos deliberately skipped
-      @skip_count = 0
-      # @ start_time - will be used to get elapsed time
-      @start_time = 0
+      @metrics = { count: 0, skipped: 0, failed: 0, updated: 0, start_time: 0 }
       # 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'
@@ -43,10 +41,15 @@ module UpdateRepo
     #   walk_repo = UpdateRepo::WalkRepo.new
     #   walk_repo.start
     def start
-      String.disable_colorization = true unless @config['cmd'][:color]
-      show_header(@config['exceptions'])
-      @config['location'].each do |loc|
-        recurse_dir(loc)
+      String.disable_colorization = true unless param_set('color')
+      no_import_export if dumping? && importing?
+      show_header
+      if importing?
+
+      else
+        @config['location'].each do |loc|
+          recurse_dir(loc)
+        end
       end
       # print out an informative footer...
       footer
@@ -54,6 +57,12 @@ module UpdateRepo
 
     private
 
+    # Determine options from the command line and configuration file. Command
+    # line takes precedence
+    def param_set(option)
+      @config['cmd'][option.to_sym] || @config[option]
+    end
+
     def config_error
       if @config.status[:errors] == Status::ERR_CANT_LOAD
         print 'Note that the the default configuration file was '.red,
@@ -63,6 +72,7 @@ module UpdateRepo
     end
 
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/LineLength
     def set_options
       Trollop.options do
         version "update_repo version #{VERSION} (C)2016 G. Ramsay\n"
@@ -80,12 +90,16 @@ specified Repositories.
 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 :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 :quiet, 'Only minimal output to the terminal', default: false
         # opt :silent, 'Completely silent, no output to terminal at all.',
         #    default: false
       end
     end
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable  Metrics/LineLength
 
     # 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)
@@ -93,7 +107,14 @@ EOS
     def recurse_dir(dirname)
       Dir.chdir(dirname) do
         Dir['**/'].each do |dir|
-          notexception?(dir) ? update_repo(dir) : skip_repo(dir) if gitdir?(dir)
+          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
         end
       end
     end
@@ -107,31 +128,45 @@ EOS
 
     # Display a simple header to the console
     # @example
-    #   show_header(exceptions)
+    #   show_header
     # @return [void]
-    def show_header(exceptions)
+    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"
+      # list out the locations that will be searched
       list_locations
-      if exceptions
-        print "\nExclusions:".underline, ' ',
-              exceptions.join(', ').yellow, "\n"
-      end
+      # list any exceptions that we have from the config file
+      list_exceptions
       # save the start time for later display in the footer...
-      @start_time = Time.now
+      @metrics[:start_time] = Time.now
       print "\n" # blank line before processing starts
     end
 
     # print out a brief footer. This will be expanded later.
     # @return [void]
     def footer
-      duration = Time.now - @start_time
-      print "\nUpdates completed : ", @counter.to_s.green,
-            ' repositories processed'
-      print ' / ', @skip_count.to_s.yellow, ' skipped' unless @skip_count == 0
-      print ' in ', show_time(duration), "\n\n"
+      # 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"
+    end
+
+    def list_exceptions
+      exceptions = @config['exceptions']
+      if exceptions
+        print "\nExclusions:".underline, ' ',
+              exceptions.join(', ').yellow, "\n"
+      end
     end
 
     def list_locations
@@ -145,27 +180,43 @@ EOS
       Dir.chdir(dirpath.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
         print '* Skipping ', Dir.pwd.yellow, " (#{repo_url})\n"
-        @skip_count += 1
+        @metrics[:skipped] += 1
       end
     end
 
     def update_repo(dirname)
       Dir.chdir(dirname.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
-        print '* Checking ', Dir.pwd.green, " (#{repo_url})\n", '  -> '
-        system 'git pull'
-        @counter += 1
+        do_update(repo_url)
+        @metrics[:count] += 1
       end
     end
 
-    def gitdir?(dirpath)
-      gitpath = dirpath + '/.git'
-      File.exist?(gitpath) && File.directory?(gitpath)
+    def do_update(repo_url)
+      print '* Checking ', Dir.pwd.green, " (#{repo_url})\n"
+      Open3.popen3('git pull') do |_stdin, stdout, stderr, thread|
+        { out: stdout, err: stderr }.each do |key, stream|
+          Thread.new do
+            until (line = stream.gets).nil?
+              if key == :err && line =~ /^fatal:/
+                print '   ', line.red
+                @metrics[:failed] += 1
+              else
+                print '   ', line.cyan
+                @metrics[:updated] += 1 if line =~ /files?\schanged/
+              end
+            end
+          end
+        end
+        thread.join
+      end
     end
 
-    def show_time(duration)
-      time_taken = Time.at(duration).utc
-      time_taken.strftime('%-H hours, %-M Minutes and %-S seconds.').cyan
+    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"
+      end
     end
   end
 end

data/update_repo.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'json', '= 1.8.3'
   spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'inch'
   spec.add_development_dependency 'simplecov', '~> 0.10'
   spec.add_development_dependency 'pullreview-coverage'
@@ -38,5 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'trollop'
 
   # Depends on Ruby version if we can use 'Reek'
-  spec.add_development_dependency 'reek', '~> 3.3' if RUBY_VERSION > '2.0'
+  spec.add_development_dependency 'reek', '~> 3.3' if RUBY_VERSION >= '2.0'
+  # Depends on Ruby version if we can use 'rubocop'
+  spec.add_development_dependency 'rubocop' 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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -234,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - seapagan@gmail.com
@@ -246,6 +260,7 @@ files:
 - ".pullreview.yml"
 - ".reek"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -256,6 +271,7 @@ files:
 - bin/update_repo
 - exe/update_repo
 - lib/update_repo.rb
+- lib/update_repo/helpers.rb
 - lib/update_repo/version.rb
 - update_repo.gemspec
 homepage: http://opensource.seapagan.net
@@ -278,9 +294,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A Simple Gem to keep multiple locally-cloned Git Repositories up to date
 test_files: []
-has_rdoc: