update_repo 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a080f8609ce70eb45fff70594285629a1cfb0b5f
-  data.tar.gz: 96ad0f42a220b62a3c80b0f959c0cb74d1e75dac
+  metadata.gz: 6c32900e76a1fff5d6255a88a76e112d9bccc429
+  data.tar.gz: 2ad9941848464e5d357d51c5a40f22fd216802c1
 SHA512:
-  metadata.gz: b11a82b7ac40c2d5f34076305aac53b86b705e6871c14d54c6b5e3f38383b4f6f0556620e8db4ae475164c59209c66950bf524af4d53a0a6be644703e8249e94
-  data.tar.gz: 731d8e699a24980854c41ab45c88623499985e53b5f7e210cfd01973f2412d7b6ba75e3582ab5d1e46ac35c30844f81b31a28f03191b6ca88f396337537a0f1e
+  metadata.gz: eb996cd83661f0b90fa12cd4b3db7ead977303df79317a9827ce6cad19ff3d129bc284920836bd10f52043fa202f59fc1a87f8839e6350fb07134fd202fab89d
+  data.tar.gz: 7c0b28d67cc2134d5979f835ea048c7f90e61ae2c372e7fe2f8724ef55bc306e8728e88e6c0d6fe8c88a0ba44737fa98c82ebb8e3507f9cfea55b54f1588dbf4

data/README.md

@@ -6,9 +6,9 @@
 [![Inline docs](http://inch-ci.org/github/seapagan/update_repo.svg?branch=master)](http://inch-ci.org/github/seapagan/update_repo)
 [![PullReview stats](https://www.pullreview.com/github/seapagan/update_repo/badges/master.svg?)](https://www.pullreview.com/github/seapagan/update_repo/reviews/master)
 
-A Simple Gem to keep multiple cloned Git Repositories up to date.
+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 work in progress, but functions as required.
+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.
 
 ## Usage
 
@@ -51,8 +51,6 @@ 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.
 - Error checking and reporting for the git processes - retry for connection issues etc (config setting).
 - Add extra (optional) stats / info at end-of-job :
-    * number of repos updated
-    * number of repos skipped
     * list of changed repos
     * errors or connection problems
     * _more..._
@@ -62,6 +60,7 @@ Not in any specific order :
 - 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.
+- Option to disable the coloured output
 - 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
 - Document configuration file format and options.
@@ -85,9 +84,8 @@ Run `rake` to run the RSpec tests, which also runs `RuboCop`, `Reek` and `inch -
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-<del>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.</del>  
-This is still currently a messy conversion to Gem from a standalone script, so the RSpec tests are non-existent and it will fail all [RuboCop][rubocop], [Reek][reek] and [Inch-CI][inch]. This will be quickly fixed though. Once that is done this message will be removed and the above comment reinstated.
+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.
 
 [rubocop]: https://github.com/bbatsov/rubocop
 [reek]: https://github.com/troessner/reek

data/lib/update_repo.rb

@@ -2,6 +2,7 @@ require 'update_repo/version'
 require 'yaml'
 require 'colorize'
 require 'confoog'
+require 'trollop'
 
 # Overall module with classes performing the functionality
 # Contains Class UpdateRepo::WalkRepo
@@ -12,25 +13,24 @@ module UpdateRepo
   # An encapsulated class to walk the repo directories and update all Git
   # repositories found therein.
   class WalkRepo
-    # Read-only attribute holding the total number of traversed repositories
-    # @attr_reader :counter [fixnum] total number of traversed repositories
-    attr_reader :counter
-
     # 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_counter = 0
+      @skip_count = 0
       # @ start_time - will be used to get elapsed time
       @start_time = 0
       # @config - Class. Reads the configuration from a file in YAML format and
       # allows easy access to the configuration data
       @config = Confoog::Settings.new(filename: '.updatereporc',
                                       prefix: 'update_repo',
-                                      autoload: true)
+                                      autoload: true,
+                                      autosave: false)
       exit 1 unless @config.status[:errors] == Status::INFO_FILE_LOADED
+      # store the command line variables in a configuration variable
+      @config['cmd'] = set_options
     end
 
     # This function will perform the required actions to traverse the Repo.
@@ -38,10 +38,9 @@ module UpdateRepo
     #   walk_repo = UpdateRepo::WalkRepo.new
     #   walk_repo.start
     def start
-      exceptions = @config['exceptions']
-      show_header(exceptions)
+      show_header(@config['exceptions'])
       @config['location'].each do |loc|
-        recurse_dir(loc, exceptions)
+        recurse_dir(loc)
       end
       # print out an informative footer...
       footer
@@ -49,22 +48,48 @@ module UpdateRepo
 
     private
 
-    # take each directory contained in the Repo directory, and if it is detected
-    # as a Git repository then update it.
+    # rubocop:disable Metrics//MethodLength
+    def set_options
+      Trollop.options do
+        version "\nupdate_repo version #{VERSION} (C)2016 G. Ramsay\n"
+        banner <<-EOS
+Keep multiple local Git-Cloned Repositories up to date with one command.
+
+Usage:
+      update_repo [options]
+
+Options are not required. If none are specified then the program will read from
+the standard configuration file (~/.updatereporc) and automatically update the
+specified Repositories.
+
+Options:
+EOS
+        # opt :color, 'Use colored output', default: true
+        # 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
+
+    # 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 exceptions [array] Each repo matching one of these will be ignored.
-    def recurse_dir(dirname, exceptions)
-      Dir.foreach(dirname) do |dir|
-        dirpath = dirname + '/' + dir
-        next unless File.directory?(dirpath) && notdot?(dir)
-        if gitdir?(dirpath)
-          !exceptions.include?(dir) ? update_repo(dirpath) : skip_dir(dirpath)
-        else
-          recurse_dir(dirpath, exceptions)
+    def recurse_dir(dirname)
+      Dir.chdir(dirname) do
+        Dir['**/'].each do |dir|
+          notexception?(dir) ? update_repo(dir) : skip_repo(dir) if gitdir?(dir)
         end
       end
     end
 
+    # tests to see if the given directory is an exception and should be skipped
+    # @param dir [string] Directory to be checked
+    # @return [boolean] True if this is NOT an exception, False otherwise
+    def notexception?(dir)
+      !@config['exceptions'].include?(File.basename(dir))
+    end
+
     # Display a simple header to the console
     # @example
     #   show_header(exceptions)
@@ -88,9 +113,10 @@ module UpdateRepo
     # @return [void]
     def footer
       duration = Time.now - @start_time
-      print "\nUpdates completed : ", @counter.to_s.yellow, ' repositories '
-      print "processed (and #{@skip_counter} skipped)" unless @skip_counter == 0
-      print ' in ', show_time(duration)
+      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"
     end
 
     def list_locations
@@ -100,18 +126,18 @@ module UpdateRepo
       end
     end
 
-    def skip_dir(dirpath)
-      Dir.chdir(dirpath) do
+    def skip_repo(dirpath)
+      Dir.chdir(dirpath.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
-        print "* Skipping #{dirpath}".yellow, " (#{repo_url})\n"
-        @skip_counter += 1
+        print '* Skipping ', Dir.pwd.yellow, " (#{repo_url})\n"
+        @skip_count += 1
       end
     end
 
     def update_repo(dirname)
-      Dir.chdir(dirname) do
+      Dir.chdir(dirname.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
-        print '* ', 'Checking ', dirname.green, " (#{repo_url})\n", '  -> '
+        print '* Checking ', Dir.pwd.green, " (#{repo_url})\n", '  -> '
         system 'git pull'
         @counter += 1
       end
@@ -122,12 +148,9 @@ module UpdateRepo
       File.exist?(gitpath) && File.directory?(gitpath)
     end
 
-    def notdot?(dir)
-      (dir != '.' && dir != '..')
-    end
-
     def show_time(duration)
-      "#{Time.at(duration).utc.strftime('%H:%M:%S')}\n\n".cyan
+      time_taken = Time.at(duration).utc
+      time_taken.strftime('%-H hours, %-M Minutes and %-S seconds.').cyan
     end
   end
 end

data/lib/update_repo/version.rb

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

data/update_repo.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Grant Ramsay']
   spec.email         = ['seapagan@gmail.com']
 
-  spec.summary       = 'A Simple Gem to keep multiple cloned Git Repositories up to date'
+  spec.summary       = 'A Simple Gem to keep multiple locally-cloned Git Repositories up to date'
   spec.homepage      = 'http://opensource.seapagan.net'
   spec.license       = 'MIT'
 
@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'colorize'
   spec.add_dependency 'confoog'
+  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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  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'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +281,6 @@ rubyforge_project:
 rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
-summary: A Simple Gem to keep multiple cloned Git Repositories up to date
+summary: A Simple Gem to keep multiple locally-cloned Git Repositories up to date
 test_files: []
 has_rdoc: