update_repo 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf4845833185e2067044f7580d23908be0d37348
-  data.tar.gz: 77f8f8759f3935e8b05554b6ad9b0ccf2d3812da
+  metadata.gz: e3822c75393026d76642b13ef90987f7cfbf19d7
+  data.tar.gz: d09ea3b9e447eac5b1e0db00ad0535a09702f804
 SHA512:
-  metadata.gz: 950adcd0cf990f8db0d05c1ca868ae331d17a87c4a406754ba3972ea78863c84346d2cae93cdc1dcbb2f3b787e2211122391ca1bbcb6ce9d8c7d09117d6fb476
-  data.tar.gz: 595ff551349993782849041945d28d6a4a49b38f4cfe50aa58ab77ccd231f842f4abeb85be0321932e7fc4f114541ce1e58c14d1a23bfe93144bc892183a46dd
+  metadata.gz: 9f59a14c1b0639a846520f1283c13d6e5f6eb2b98ca271a65f48089ea3d49481286b79f61866858bc7e60aa750552aad4db97384d75e42c235eff1d022409298
+  data.tar.gz: 2a16193e25d7b68e13520b8cd6bfa83452de675b372f2d7864f900142fa72bcd5b8a917c66571855e29145adc33d95f5f5bdb7d0ea54ef4fe3dbea3fa829c81c

data/.reek

@@ -7,3 +7,6 @@ UtilityFunction:
 
 RepeatedConditional:
   max_ifs: 3
+
+DuplicateMethodCall:
+ max_calls: 3

data/README.md

@@ -11,15 +11,23 @@ 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.
 
-## Usage
+## Installation
 
 #### 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 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 currently only been tested under Linux, not windows.
 
 [git]: http://git-scm.com
 [ruby]: http://www.ruby-lang.org
 
+Install this from the shell prompt as you would any other Ruby Gem
+
+```
+ $ gem install update_repo
+```
+
+## Usage
+
 #### Quick start
 Create a [YAML](http://yaml.org/)-formatted configuration file `.updaterepo` **in your home directory** that contains at least a 'location' tag pointing to the directory containing the git repositories you wish to have updated :
 ```yaml
@@ -57,6 +65,16 @@ exceptions:
 - update_repo
 ```
 
+`log:` - Log all output to the file `./.updaterepo`, defaults to FALSE (optional)
+```yaml
+log: true
+```
+
+`timestamp:` - timestamp the output files instead of overwriting them, defaults to FALSE (optional)
+```yaml
+timestamp: 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.
 
@@ -67,8 +85,6 @@ Options:
   -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.
   -l, --log                  Create a logfile of all program output to './update_repo.log'.
                              Any older logs will be overwritten.
   -t, --timestamp            Timestamp the logfile instead of overwriting. Does nothing unless the
@@ -78,14 +94,9 @@ Options:
 ```
 
 ## To-Do
-Not in any specific order :
+Add functionality, 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 `[IN PROGRESS]`
-  * Add more failure cases, not all git errors fail with "fatal:"
-- retry for connection issues etc (config setting).
 - Improve the stats / info at end-of-job :
   * errors or connection problems `[IN PROGRESS]`
   * _more..._
@@ -100,7 +111,16 @@ Not in any specific order :
   * re-import the above dump on a different machine or after reinstall
 - Add option to use alternative git command if required, either globally or on a case-by-case basis (see also comments on 'variants' above). Currently the script just uses a blanket `git pull` command on all repositories.
 - Document configuration file format and options.
+
+Internal Changes and refactoring :
 - Add testing!
+- Refactor all command-line handling into a separate class and file
+- Error checking and reporting for the git processes `[IN PROGRESS]`
+- Improve error-checking and recovery while parsing the configuration file
+  * Ignore and report invalid or missing directories
+  * Add more failure cases, not all git errors fail with "fatal:"
+- Retry for connection issues etc (config setting).
+- Fix functionality so that command line options will override those in the config file
 
 [confoog]: http://confoog.seapagan.net
 

data/lib/update_repo.rb

@@ -1,5 +1,6 @@
 require 'update_repo/version'
 require 'update_repo/helpers'
+require 'update_repo/cmd_config'
 require 'yaml'
 require 'colorize'
 require 'confoog'
@@ -24,18 +25,10 @@ module UpdateRepo
                    start_time: 0 }
       @summary = { processed: 'green', updated: 'cyan', skipped: 'yellow',
                    failed: 'red' }
-      # 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'
-      temp_opt = set_options
-      # @config - Class. Reads the configuration from a file in YAML format and
-      # allows easy access to the configuration data
-      @config = Confoog::Settings.new(filename: CONFIG_FILE,
-                                      prefix: 'update_repo',
-                                      autoload: true, autosave: false)
-      # store the command line variables in a configuration variable
-      @config['cmd'] = temp_opt
-      config_error unless @config.status[:errors] == Status::INFO_FILE_LOADED
+      # create a new instance of the CmdConfig class then read the config var
+      @cmd = CmdConfig.new
+      # set up the logfile if needed
+      setup_logfile if cmd(:log)
     end
 
     # This function will perform the required actions to traverse the Repo.
@@ -43,86 +36,40 @@ module UpdateRepo
     #   walk_repo = UpdateRepo::WalkRepo.new
     #   walk_repo.start
     def start
-      String.disable_colorization = true unless param_set('color')
+      String.disable_colorization = !cmd(:color)
       # make sure we dont have bad cmd-line parameter combinations ...
-      check_params
-      # print out our header ...
-      show_header unless dumping? || importing?
-      @config['location'].each do |loc|
+      @cmd.check_params
+      # print out our header unless we are dumping / importing ...
+      no_header = cmd(:dump) || cmd(:import)
+      show_header unless no_header
+      config['location'].each do |loc|
         recurse_dir(loc)
       end
-      # print out an informative footer ...
-      footer unless dumping? || importing?
+      # print out an informative footer unless dump / import ...
+      footer unless no_header
     end
 
-    private
+    # private
 
-    def check_params
-      setup_logfile if logging?
-      if dumping? && importing?
-        Trollop.die 'Sorry, you cannot specify both --dump and --import '.red
-      end
-      if importing?
-        Trollop.die "Sorry 'Import' functionality is not implemented yet".red
-      end
+    # returns the Confoog class which can then be used to access any config var
+    def config
+      @cmd.getconfig
+    end
+
+    def cmd(command)
+      @cmd.true_cmd(command.to_sym)
     end
 
     def setup_logfile
-      filename = if param_set('timestamp')
+      filename = if cmd(:timestamp)
                    'updaterepo-' + Time.new.strftime('%y%m%d-%H%M%S') + '.log'
                  else
                    'updaterepo.log'
                  end
-      # filename = 'updaterepo' + prefix + '.log'
       @logfile = File.open(filename, 'w')
       @logfile.sync = true
     end
 
-    # 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_log 'Note that the the default configuration file was '.red,
-                  "changed to ~/#{CONFIG_FILE} from v0.4.0 onwards\n\n".red
-      end
-      exit 1
-    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"
-        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 (~/#{CONFIG_FILE}) and automatically update the
-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 :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 :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)
     # @param dirname [string] Contains the directory to search for Git repos.
@@ -130,7 +77,7 @@ EOS
       Dir.chdir(dirname) do
         Dir['**/'].each do |dir|
           next unless gitdir?(dir)
-          if dumping?
+          if cmd(:dump)
             dump_repo(File.join(dirname, dir))
           else
             notexception?(dir) ? update_repo(dir) : skip_repo(dir)
@@ -143,7 +90,7 @@ EOS
     # @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))
+      !config['exceptions'].include?(File.basename(dir))
     end
 
     # Display a simple header to the console
@@ -152,11 +99,10 @@ EOS
     # @return [void]
     def show_header
       # print an informative header before starting
-      # unless we are dumping the repo information
       print_log "\nGit Repo update utility (v", VERSION, ')',
                 " \u00A9 Grant Ramsay <seapagan@gmail.com>\n"
-      print_log "Using Configuration from '#{@config.config_path}'\n"
-      # print_log "Command line is : #{@config['cmd']}\n"
+      print_log "Using Configuration from '#{config.config_path}'\n"
+      print_log "Command line is : #{config['cmd']}\n"
       # list out the locations that will be searched
       list_locations
       # list any exceptions that we have from the config file
@@ -186,7 +132,7 @@ EOS
     end
 
     def list_exceptions
-      exceptions = @config['exceptions']
+      exceptions = config['exceptions']
       if exceptions
         print_log "\nExclusions:".underline, ' ',
                   exceptions.join(', ').yellow, "\n"
@@ -195,7 +141,7 @@ EOS
 
     def list_locations
       print_log "\nRepo location(s):\n".underline
-      @config['location'].each do |loc|
+      config['location'].each do |loc|
         print_log '-> ', loc.cyan, "\n"
       end
     end
@@ -244,7 +190,7 @@ EOS
     def dump_repo(dir)
       Dir.chdir(dir.chomp!('/')) do
         repo_url = `git config remote.origin.url`.chomp
-        print_log "#{trunc_dir(dir, @config['cmd'][:prune])},#{repo_url}\n"
+        print_log "#{trunc_dir(dir, config['cmd'][:prune])},#{repo_url}\n"
       end
     end
   end

data/lib/update_repo/cmd_config.rb

@@ -0,0 +1,99 @@
+require 'update_repo/version'
+require 'update_repo/helpers'
+require 'confoog'
+require 'trollop'
+require 'yaml'
+
+# this class will encapsulate the command line fucntionality and processing
+# as well as reading from the config file. It will also merge the 2 sources
+# into the final definitive option hash.
+module UpdateRepo
+  # This class takes care of reading and parsing the command line and conf file
+  class CmdConfig
+    include Helpers
+
+    def initialize
+      # 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'
+      temp_opt = set_options
+      @conf = Confoog::Settings.new(filename: CONFIG_FILE,
+                                    prefix: 'update_repo',
+                                    autoload: true, autosave: false)
+      @conf['cmd'] = temp_opt
+      config_error unless @conf.status[:errors] == Status::INFO_FILE_LOADED
+    end
+
+    # return the configuration hash variable
+    def getconfig
+      @conf
+    end
+
+    # This will return the 'true' version of a command, taking into account
+    # both command line (given preference) and the configuration file.
+    # parameter is a :symbol
+    def true_cmd(command)
+      cmd_given = @conf['cmd'][(command.to_s + '_given').to_sym]
+      cmd_line = @conf['cmd'][command.to_sym]
+
+      if cmd_given
+        # if we specify something on the cmd line, that takes precedence
+        cmd_line
+      elsif !@conf[command.to_s].nil?
+        # if we have a value in the config file we use that.
+        @conf[command.to_s]
+      else
+        # this will catch any 'default' values in the cmd setup.
+        cmd_line
+      end
+    end
+
+    # make sure the parameter combinations are valid
+    def check_params
+      if true_cmd(:dump) && true_cmd(:import)
+        Trollop.die 'Sorry, you cannot specify both --dump and --import '.red
+      end
+    end
+
+    private
+
+    def config_error
+      if @conf.status[:errors] == Status::ERR_CANT_LOAD
+        print_log 'Note that the the default configuration file was '.red,
+                  "changed to ~/#{CONFIG_FILE} from v0.4.0 onwards\n\n".red
+      end
+      exit 1
+    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"
+        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 (~/#{CONFIG_FILE}) and automatically update the
+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 :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 :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
+  end
+end

data/lib/update_repo/helpers.rb

@@ -14,28 +14,13 @@ module Helpers
     File.join(path_array)
   end
 
-  # 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
-
-  # true if we are logging to file.
-  def logging?
-    param_set('log')
-  end
-
   # this function will simply pass the given string to 'print', and also
   # log to file if that is specified.
   def print_log(*string)
     # log to screen regardless
     print(*string)
     # log to file if that has been enabled
-    @logfile.write(string.join('').gsub(/\e\[(\d+)(;\d+)*m/, '')) if logging?
+    @logfile.write(string.join('').gsub(/\e\[(\d+)(;\d+)*m/, '')) if cmd('log')
   end
 
   # mark these as private simply so that 'reek' wont flag as utility function.
@@ -50,9 +35,4 @@ module Helpers
     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
 end

data/lib/update_repo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-30 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -285,6 +285,7 @@ files:
 - bin/update_repo
 - exe/update_repo
 - lib/update_repo.rb
+- lib/update_repo/cmd_config.rb
 - lib/update_repo/helpers.rb
 - lib/update_repo/version.rb
 - update_repo.gemspec