update_repo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8306af42ee0918611be90bb7d383edd58b01809
-  data.tar.gz: 0044b4e45d04bf1d7e453f4d2186507c4ff93742
+  metadata.gz: 3c8f69a7896ee9033c3795a0f5fb64bdc4ad203b
+  data.tar.gz: 5e2d5e0e24ce6832a86c86aff898207dff696f46
 SHA512:
-  metadata.gz: 48dcd4bc4e2333d0ba99b885d632b9c13e8b88c657b1a47ff501b1289cb3d7e8ba7289027a253c14f48af34a1725819c49df3de63170b039dc5605b23411eac9
-  data.tar.gz: 5751e8889ff7c22b04a06d8ff6b1bca976ab3536d513dda738f7461b542c5679a53322c1876e006d2a2c323ca4c3050471564be2c4e0f37b61fb62b2042be169
+  metadata.gz: eef4c5f91858e5122667332b6bde79ee23565fd93231c4e6af0ba7d9beba7b8fc28b8c229f4ad3a695f90b4456517909c94707b5174a6a9dcd4fcea3b6c56dd4
+  data.tar.gz: 3edc6e7429277294ddc163a541aa7ca9c85f606e15a78a5813e3ea49cf82bf40713c7f1e7e687bfbf6654a982659c41b840d5379648f10577e654fc5fed86be0

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.1
-  - 2.2.3
+  - 2.2.4
+  - 2.3.0
 before_install: gem install bundler -v 1.11.2

data/README.md

@@ -1,4 +1,10 @@
-# update_repo
+# update_repo [![Gem Version](https://badge.fury.io/rb/update_repo.svg)](https://badge.fury.io/rb/update_repo) [![Build Status](https://travis-ci.org/seapagan/update_repo.svg?branch=master)](https://travis-ci.org/seapagan/update_repo)
+
+[![Dependency Status](https://gemnasium.com/seapagan/update_repo.svg)](https://gemnasium.com/seapagan/update_repo)
+[![Coverage Status](https://coveralls.io/repos/seapagan/update_repo/badge.svg?branch=master&service=github)](https://coveralls.io/github/seapagan/update_repo?branch=master)
+[![Code Climate](https://codeclimate.com/github/seapagan/update_repo/badges/gpa.svg)](https://codeclimate.com/github/seapagan/update_repo)
+[![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.
 
@@ -8,9 +14,10 @@ This is the conversion to a Gem of one of my standalone Ruby scripts. Still very
 
 #### Pre-requirements
 
-It goes without saying that at the very least a working copy of [Git][git] needs to be installed on your machine. Also, the script has only been tested under Linux, not windows.
+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 only been tested under Linux, not windows.
 
 [git]: http://git-scm.com
+[ruby]: http://www.ruby-lang.org
 
 #### Quick start
 Create a [YAML](http://yaml.org/)-formatted configuration file `.updatereporc` **in your home directory** that contains at least a 'location' tag pointing to the directory containing the git repositories you wish to have updated :
@@ -40,6 +47,8 @@ To be added.
 Not in any specific order :
 
 - Improve error-checking and recovery while parsing the configuration file (convert to using my '[Confoog][confoog]' gem for example)
+  * Ignore and report invalid or missing directories
+  * Expand eg '~/' to full valid path.
 - 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 :
@@ -55,6 +64,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
 - Document configuration file format and options.
 - Add testing!
 

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 require 'inch/rake'
 
@@ -28,4 +28,4 @@ else
 end
 
 # task default: [:rubocop, :inch, :reek, :spec, :build]
-task default: [ :spec, :build] # leave the others off until we are more advanced.
+task default: [:rubocop, :inch, :spec, :build] # leave the others off for now.

data/bin/console

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "update_repo"
+require 'bundler/setup'
+require 'update_repo'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
+require 'pry'
 Pry.start
 
 # require "irb"

data/bin/update_repo

@@ -6,11 +6,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("update_repo", "update_repo")
+load Gem.bin_path('update_repo', 'update_repo')

data/exe/update_repo

@@ -1,20 +1,8 @@
 #!/usr/bin/env ruby
 
-require "update_repo"
-include UpdateRepo
+require 'update_repo'
 
-# start the process...
-configs, location = check_config
-
-show_header(configs, location)
-
-# save the current time
-start_time = Time.now
-configs['location'].each do |loc|
-  recurse_dir(loc, configs['exceptions'])
-end
-
-# get duration since we saved the time
-duration = Time.now - start_time
-
-puts "\nUpdates completed - #{$counter} repositories processed in #{Time.at(duration).utc.strftime("%H:%M:%S")}\n".underline
+# create a new instance of the class...
+walk_repo = UpdateRepo::WalkRepo.new
+# then start the process...
+walk_repo.start

data/lib/update_repo/version.rb

@@ -1,3 +1,4 @@
 module UpdateRepo
-  VERSION = "0.1.0"
+  # constant, current version of this Gem
+  VERSION = '0.2.0'.freeze
 end

data/lib/update_repo.rb

@@ -1,73 +1,144 @@
-require "update_repo/version"
+require 'update_repo/version'
 require 'yaml'
 require 'colorize'
+require 'update_repo/version'
 
+# Overall module with classes performing the functionality
+# Contains Class UpdateRepo::WalkRepo
 module UpdateRepo
+  # This constant holds the name to the config file, located in ~/
+  CONFIG_FILE = '.updatereporc'.freeze
 
-  CONFIG_FILE = '.updatereporc'
-  $counter = 0
+  # 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
 
-  def recurse_dir(dirname, exceptions)
-    Dir.foreach(dirname) do |dir|
-      dirpath= dirname + '/' + dir
-      if File.directory?(dirpath) && dir != '.' && dir != '..' then
-        gitpath = dirpath + '/.git'
-        if File.exists?(gitpath) && File.directory?(gitpath) then
-            if exceptions.nil? || !exceptions.include?(dir.chomp)
-              update_repo(dirpath)
-              $counter += 1
-            else
-              Dir.chdir(gitpath) do
-                repo_url = `git config remote.origin.url`.chomp
-                print "* Skipping #{dirpath}".yellow, " (#{repo_url})\n"
-              end
-            end
+    # Class constructor. No parameters required.
+    # @return [void]
+    def initialize
+      @counter = 0
+      @start_time = 0
+    end
+
+    # This function will perform the required actions to traverse the Repo.
+    # @example
+    #   walk_repo = UpdateRepo::WalkRepo.new
+    #   walk_repo.start
+    def start
+      configs, location = check_config
+      show_header(configs, location)
+      configs['location'].each do |loc|
+        recurse_dir(loc, configs['exceptions'])
+      end
+      # print out an informative footer...
+      footer
+    end
+
+    private
+
+    # take each directory contained in the Repo directory, and if it is detected
+    # as a Git repository then update it.
+    # @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)
+          dir.chomp!
+          !exceptions.include?(dir) ? update_repo(dirpath) : skip_dir(dirpath)
         else
           recurse_dir(dirpath, exceptions)
         end
       end
     end
-  end
 
-  def show_header(configs, location)
-    # print an informative header before starting
-    print "\nGit Repo update utility (v.0.1.0)".underline, " \u00A9 Grant Ramsay <seapagan@gmail.com>\n"
-    puts "Using Configuration from #{location}"
-    puts "\nRepo location(s):".underline
-    configs['location'].each do |loc|
-      print "-> ", loc.cyan, "\n"
+    # locate the configuration file and return this data.
+    # Note that this will be re-written later to use my 'confoog' gem.
+    # @return [hash] Hash containing all the configuration parameters.
+    # @return [string] Location of the configuration file.
+    def check_config
+      # locate the configuration file.
+      # first we check in this script location and if present then we ignore any
+      # further files.
+      dev_config = File.join '.', CONFIG_FILE
+      user_config = File.join Gem.user_home, CONFIG_FILE
+
+      if File.exist? dev_config
+        # configuration exists in script directory so we ignore any others.
+        return YAML.load_file(dev_config), File.expand_path(dev_config)
+      elsif File.exist? user_config
+        # configuration exists in user home directory so we use that.
+        return YAML.load_file(user_config), File.expand_path(user_config)
+      end
+      # otherwise return error
+      print 'Error : Cannot find configuration file'.red, user_config.red,
+            'aborting'.red
+      exit 1
     end
-    if !configs['exceptions'].nil? then
-      print "\nExclusions:".underline, " ", configs['exceptions'].join(', ').yellow, "\n"
+
+    # Display a simple header to the console
+    # @param configs [hash] Configuration hash, used here to list exceptions.
+    # @param location [string] location of config file.
+    # @example
+    #   show_header
+    # @return []
+    def show_header(configs, location)
+      # print an informative header before starting
+      print "\nGit Repo update utility (v", VERSION, ')',
+            " \u00A9 Grant Ramsay <seapagan@gmail.com>\n"
+      print "Using Configuration from #{location}\n"
+      list_locations(configs)
+      if configs['exceptions']
+        print "\nExclusions:".underline, ' ',
+              configs['exceptions'].join(', ').yellow, "\n"
+      end
+      # save the start time for later display in the footer...
+      @start_time = Time.now
+      print "\n" # blank line before processing starts
     end
-    puts # blank line before processing starts
-  end
 
-  def update_repo(dirname)
-    Dir.chdir(dirname) do
-      repo_url = `git config remote.origin.url`.chomp
-      print "* ", "Checking ", dirname.green, " (#{repo_url})\n"
-      print "  -> "
-      system "git pull"
+    # print out a brief footer. This will be expanded later.
+    # @return [void]
+    def footer
+      duration = Time.now - @start_time
+      print "\nUpdates completed - #{@counter} repositories processed in ",
+            "#{Time.at(duration).utc.strftime('%H:%M:%S')}\n\n".cyan
+    end
+
+    def list_locations(configs)
+      print "\nRepo location(s):\n".underline
+      configs['location'].each do |loc|
+        print '-> ', loc.cyan, "\n"
+      end
     end
-  end
 
-  def check_config
-    # locate the configuration file.
-    # first we check in this script location and if present then we ignore any
-    # further files.
-    dev_config = File.join '.', CONFIG_FILE
-    user_config = File.join Gem.user_home, CONFIG_FILE
+    def skip_dir(dirpath)
+      Dir.chdir(dirpath) do
+        repo_url = `git config remote.origin.url`.chomp
+        print "* Skipping #{dirpath}".yellow, " (#{repo_url})\n"
+      end
+    end
+
+    def update_repo(dirname)
+      Dir.chdir(dirname) do
+        repo_url = `git config remote.origin.url`.chomp
+        print '* ', 'Checking ', dirname.green, " (#{repo_url})\n", '  -> '
+        system 'git pull'
+        @counter += 1
+      end
+    end
+
+    def gitdir?(dirpath)
+      gitpath = dirpath + '/.git'
+      File.exist?(gitpath) && File.directory?(gitpath)
+    end
 
-    if File.exist? dev_config
-      # configuration exists in script directory so we ignore any others.
-      return YAML.load_file(dev_config), File.expand_path(dev_config)
-    elsif File.exist? user_config
-      # configuration exists in user home directory so we use that.
-      return YAML.load_file(user_config), File.expand_path(user_config)
+    def notdot?(dir)
+      (dir != '.' && dir != '..')
     end
-    # otherwise return error
-    puts "Error : Cannot find configuration file '#{user_config}', aborting".red
-    exit 1
   end
 end

data/update_repo.gemspec

@@ -5,24 +5,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'update_repo/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "update_repo"
+  spec.name          = 'update_repo'
   spec.version       = UpdateRepo::VERSION
   spec.required_ruby_version = '>= 1.9.3'
-  spec.authors       = ["Grant Ramsay"]
-  spec.email         = ["seapagan@gmail.com"]
+  spec.authors       = ['Grant Ramsay']
+  spec.email         = ['seapagan@gmail.com']
 
   spec.summary       = 'A Simple Gem to keep multiple cloned Git Repositories up to date'
-  spec.homepage      = "http://opensource.seapagan.net"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://opensource.seapagan.net'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'fakefs'
   spec.add_development_dependency 'coveralls'
@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.10'
   spec.add_development_dependency 'pullreview-coverage'
   spec.add_development_dependency 'should_not'
+  spec.add_development_dependency 'wwtd'
 
   spec.add_dependency 'colorize'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  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'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement