update_repo 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3926de9bbf9ba13b8bebedaede82c6e90fccb4b7
-  data.tar.gz: e942798a0c3515517b299f8c06699ac4b347fe84
+  metadata.gz: 83505a5c407a8a9b4b1d83270037dd9bea6bad1b
+  data.tar.gz: 367640e56d880c7aa011fb499748d4544c96c1fd
 SHA512:
-  metadata.gz: 4866838796629cffeaa336039303abb5b7588254e7f8038b2d323203f667ccd0b4d648c15bc24faf8f51838b66b147635b784f7cfcae660468d4eeabe68b7506
-  data.tar.gz: 88c0782ce18314e1320c68b287daddcdbfd9d89bd45e755473642f7e9f03baf0b17345333da63e2e52405bce95a304171e7bc232c9373416cb6cb93503433ec1
+  metadata.gz: a22861bff02f7e0ef0dfa0920256f506d33a951448a988cb4ef0e05f4ff6babfb57125225eb0c1d117fa879aa428ea6d5354d8ab539bb218af77bc4f346ba883
+  data.tar.gz: c341cd60fd33e4692b948309caadd7d44b0a1866b2c4ea3764891c1a3b38235aa08d7255bbfd96c1e36bbe36a9bafc13078b7601d08f40770292fc96097da9e8

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.9.3-p551
   - 2.0.0-p648
   - 2.1.10
-  - 2.2.5
-  - 2.3.1
-before_install: gem install bundler -v 1.13.6
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/README.md

@@ -17,10 +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] (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
+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] (version 1.9.3 and newer) need to be installed on your machine. Also, the script has currently only been tested under Linux, not windows.
 
 Install this from the shell prompt as you would any other Ruby Gem
 
@@ -31,14 +28,14 @@ $ 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 :
+Create a [YAML][yaml]-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
 ---
 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 and the [Website](http://updaterepo.seapagan.net) for more information.
+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][website] for more information.
 
 This file should be located in the users home directory (`~/.updaterepo`).
 
@@ -48,9 +45,9 @@ $ 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.
+The below is a summary of the most common configuration options, see the [Website][website] 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 configuration file defaults to `~/.updaterepo` and is a standard [YAML][yaml]-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.
 
 `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 :
@@ -89,7 +86,7 @@ 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. Command line options will take preference over those specified in the configuration file.
+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. Again, see the [Website][website] for complete details and usage.
 
 Enter `update_repo --help` at the command prompt to get a list of available options :
 ```
@@ -123,6 +120,8 @@ Add functionality, not in any specific order :
   * ability to export a text dump of each repo location and remote as a CSV file. `[DONE]`
   * re-import the above dump on a different machine or after reinstall. Modify the '--prune' command to apply to this function also, removing the required number of directory levels before importing.
 - 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.
+- Implement the option `--log-local` to put log file into the local directory.
+- Add option to specify a completely different directory for the log file other than the 2 current (planned, local not yet implemented) options (home dir and local)
 - Document configuration file format and options. `[IN PROGRESS]`
 
 Internal Changes and refactoring :
@@ -133,8 +132,6 @@ Internal Changes and refactoring :
   * Add more failure cases, there may be more git errors than "fatal:" or "error:"
 - Retry for connection issues etc (config setting).
 
-[confoog]: http://confoog.seapagan.net
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests (or simply `rake`). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -154,10 +151,6 @@ Run `rake` to run the RSpec tests, which also runs `RuboCop`, `Reek` and `inch -
 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.
 
-[rubocop]: https://github.com/bbatsov/rubocop
-[reek]: https://github.com/troessner/reek
-[inch]: https://inch-ci.org
-
 ## Versioning
 
 This Gem aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
@@ -169,9 +162,19 @@ introduced with new major versions.
 
 Of course, currently we have not even reached version 1, so leave off the version requirement completely. Expect any and all of the API and interface to change!
 
+## License
+
+The gem is available as open source under the terms of the [MIT License][mit].
+
+[website]: http://updaterepo.seapagan.net
+[git]: http://git-scm.com
+[ruby]: http://www.ruby-lang.org
+[yaml]:  http://yaml.org
+[rubocop]: https://github.com/bbatsov/rubocop
+[reek]: https://github.com/troessner/reek
+[inch]: https://inch-ci.org
 [semver]: http://semver.org/
 [pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[confoog]: http://confoog.seapagan.net
+[mit]: http://opensource.org/licenses/MIT
 
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/update_repo/cmd_config.rb

@@ -12,12 +12,18 @@ module UpdateRepo
   class CmdConfig
     include Helpers
 
+    # This constant holds the path to the config file, default to home dir.
+    CONFIG_PATH = '~/'.freeze
+    # This constant holds the filename of the config file.
+    CONFIG_FILE = '.updaterepo'.freeze
+
     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,
+                                    location: CONFIG_PATH,
                                     prefix: 'update_repo',
                                     autoload: true, autosave: false)
       config_error unless @conf.status[:errors] == Status::INFO_FILE_LOADED
@@ -34,6 +40,15 @@ module UpdateRepo
       @conf
     end
 
+    # return the specified TRUE configuration variable, using '[]' notation
+    # @param key [string] Which cmd variable to return
+    # @return [various] The value of the specified cmd variable
+    # @example
+    #   quiet = @cmd[quiet]
+    def [](key)
+      true_cmd(key.to_sym)
+    end
+
     # This will return the 'true' version of a command, taking into account
     # both command line (given preference) and the configuration file.
     # @param command [symbol] The symbol of the defined command

data/lib/update_repo/console_output.rb

@@ -10,16 +10,16 @@ module UpdateRepo
     # Constructor for the ConsoleOutput class.
     # @param logger [class] Pointer to the Logger class
     # @param metrics [class] Pointer to the Metrics class
-    # @param config [class] Pointer to the Confoog class
+    # @param cmd [class] Pointer to the CmdConfig class
     # @return [void]
     # @example
     #   console = ConsoleOutput.new(@log)
-    def initialize(logger, metrics, config)
+    def initialize(logger, metrics, cmd)
       @summary = { processed: 'green', updated: 'cyan', skipped: 'yellow',
                    failed: 'red', unchanged: 'white' }
       @metrics = metrics
       @log = logger
-      @config = config.getconfig
+      @cmd = cmd
     end
 
     # Display a simple header to the console
@@ -31,7 +31,9 @@ module UpdateRepo
       # print an informative header before starting
       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 "Using Configuration from '#{@cmd.getconfig.config_path}'\n"
+      # show the logfile location, but only if it is enabled
+      show_logfile
       # list out the locations that will be searched
       list_locations
       # list any exceptions that we have from the config file
@@ -93,7 +95,7 @@ module UpdateRepo
     # @return [void]
     # @param [none]
     def list_exceptions
-      exceptions = @config['exceptions']
+      exceptions = @cmd['exceptions']
       return unless exceptions
       print_log "\nExclusions:".underline, ' ',
                 exceptions.join(', ').yellow, "\n"
@@ -104,9 +106,16 @@ module UpdateRepo
     # @return [void]
     def list_locations
       print_log "\nRepo location(s):\n".underline
-      @config['location'].each do |loc|
+      @cmd['location'].each do |loc|
         print_log '-> ', loc.cyan, "\n"
       end
     end
+
+    # print out the logfile name and location, if we are logging to file
+    # @return [void]
+    def show_logfile
+      return unless @cmd[:log]
+      print_log "\nLogging to file:".underline, " #{@log.logfile}\n".cyan
+    end
   end
 end

data/lib/update_repo/logger.rb

@@ -8,22 +8,18 @@ module UpdateRepo
     include Helpers
 
     # Constructor for the Logger class.
-    # @param enabled [boolean] True if we log to file
-    # @param timestamp [boolean] True if we timestamp the filename
-    # @param verbose [boolean] True if verbose flag is set
-    # @param quiet [boolean] True if quiet flag is set
+    # @param cmd [instance] - pointer to the CmdConfig class
     # @return [void]
     # @example
-    #   log = Logger.new(true, false)
-    def initialize(enabled, timestamp, verbose, quiet)
-      @settings = { enabled: enabled, timestamp: timestamp, verbose: verbose,
-                    quiet: quiet }
+    #   log = Logger.new(@cmd)
+    def initialize(cmd)
+      @cmd = cmd
       @legend = { failed: { char: 'x', color: 'red' },
                   updated: { char: '^', color: 'green' },
                   unchanged: { char: '.', color: 'white' },
                   skipped: { char: 's', color: 'yellow' } }
       # don't prepare a logfile unless it's been requested.
-      return unless @settings[:enabled]
+      return unless @cmd[:log]
       # generate a filename depending on 'timestamp' setting.
       filename = generate_filename
       # open the logfile and set sync mode.
@@ -35,7 +31,7 @@ module UpdateRepo
     # @param [none]
     # @return [string] Filename for the logfile.
     def generate_filename
-      if @settings[:timestamp]
+      if @cmd[:timestamp]
         name = 'updaterepo-' + Time.new.strftime('%y%m%d-%H%M%S') + '.log'
       else
         name = 'updaterepo.log'
@@ -49,12 +45,12 @@ module UpdateRepo
     # @return [void]
     def output(*string)
       # nothing to screen if we want to be --quiet
-      unless @settings[:quiet]
+      unless @cmd[:quiet]
         # log header and footer to screen regardless
-        print(*string) if @settings[:verbose] || !repo_text?
+        print(*string) if @cmd[:verbose] || !repo_text?
       end
       # log to file if that has been enabled
-      return unless @settings[:enabled]
+      return unless @cmd[:log]
       @logfile.write(string.join('').gsub(/\e\[(\d+)(;\d+)*m/, ''))
     end
 
@@ -64,12 +60,18 @@ module UpdateRepo
     # @return [void]
     def repostat(status)
       # only print if not quiet and not verbose!
-      return if @settings[:quiet] || @settings[:verbose]
+      return if @cmd[:quiet] || @cmd[:verbose]
       @legend.each do |key, value|
         print value[:char].send(value[:color].to_sym) if status[key]
       end
     end
 
+    # Return a string containing the logfile name and full path.
+    # @return [string]
+    def logfile
+      @logfile.path
+    end
+
     # returns non nil if we have been called originally by one of the Repo
     # update output functions.
     # @param [none]
@@ -80,8 +82,8 @@ module UpdateRepo
       calling_fn = caller_locations[2].label.gsub(/block in /, '')
       # array with the functions we want to skip
       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)
+      # return TRUE if DOES match, FALSE otherwise.
+      repo_output.include?(calling_fn) ? true : false
     end
 
     # close the logfile, if it exists

data/lib/update_repo/version.rb

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

data/lib/update_repo.rb

@@ -14,9 +14,6 @@ require 'versionomy'
 # 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 = '.updaterepo'.freeze
-
   # An encapsulated class to walk the repo directories and update all Git
   # repositories found therein.
   class WalkRepo
@@ -27,7 +24,7 @@ module UpdateRepo
       # create a new instance of the CmdConfig class then read the config var
       @cmd = CmdConfig.new
       # set up the output and logging class
-      @log = Logger.new(cmd(:log), cmd(:timestamp), cmd(:verbose), cmd(:quiet))
+      @log = Logger.new(@cmd)
       # create instance of the Metrics class
       @metrics = Metrics.new(@log)
       # instantiate the console output class for header, footer etc
@@ -39,13 +36,13 @@ module UpdateRepo
     #   walk_repo = UpdateRepo::WalkRepo.new
     #   walk_repo.start
     def start
-      String.disable_colorization = !cmd(:color)
+      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|
-        cmd(:dump_tree) ? dump_tree(File.join(loc)) : recurse_dir(loc)
+        @cmd[:dump_tree] ? dump_tree(File.join(loc)) : recurse_dir(loc)
       end
       # print out an informative footer unless dump / import ...
       @cons.show_footer unless dumping?
@@ -67,7 +64,7 @@ module UpdateRepo
     end
 
     def dumping?
-      cmd(:dump) || cmd(:dump_remote) || cmd(:dump_tree)
+      @cmd[:dump] || @cmd[:dump_remote] || @cmd[:dump_tree]
     end
 
     # returns the Confoog class which can then be used to access any config var
@@ -77,17 +74,6 @@ module UpdateRepo
       @cmd.getconfig
     end
 
-    # Return the true value of the specified configuration parameter. This is a
-    # helper function that simply calls the 'true_cmd' function in the @cmd
-    # class
-    # @param command [symbol] The defined command symbol that is to be returned
-    # @return [various] The value of the requested command option
-    # @example
-    #   logging = cmd(:log)
-    def cmd(command)
-      @cmd.true_cmd(command.to_sym)
-    end
-
     # 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.]
@@ -163,7 +149,7 @@ module UpdateRepo
     # @return [void]
     def dump_repo(dir)
       Dir.chdir(dir.chomp!('/')) do
-        print_log "#{trunc_dir(dir, config['cmd'][:prune])}," if cmd(:dump)
+        print_log "#{trunc_dir(dir, @cmd[:prune])}," if @cmd[:dump]
         print_log `git -C #{dir} config remote.origin.url`
       end
     end

data/update_repo.gemspec

@@ -43,12 +43,11 @@ Gem::Specification.new do |spec|
   if RUBY_VERSION < '2.0'
     spec.add_development_dependency 'json', '= 1.8.3'
     spec.add_development_dependency 'tins', '= 1.6.0'
+    spec.add_dependency 'term-ansicolor', '= 1.3.2'
   end
 
   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.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler