update_repo 0.9.10 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3387caba12fdfb2f594ebb155b0fef824878b18233d158951d8cd34518eeead8
-  data.tar.gz: 534954a429c276739f657bd33625d21f0b1df3aa30bf1406f3abb490ea4cf0b1
+  metadata.gz: ab7dd33a2bc0ca3e8081a27838556804ef0c6902f2ecd551af20f3e8408d1af7
+  data.tar.gz: 27c6fe165be5697b08fbf270bd212d43e1311828b97a9d044bd4e6e8a2f86aee
 SHA512:
-  metadata.gz: 0c3718e9e1ee0c204b2642ead7952700c248ce48fcc2894821b7f6c2944e55858d9fabc292a99054cf29b9c5fb8c45c18cf3e33f6056fb8cf56ad180d150a614
-  data.tar.gz: 67dcce3bed7b9a547d4349cdf86194fbea3f513b448f434cdf020c20ec070567b2aad375c616ae705ba66c453303c03c67567ba4259fb3a4867119b96361c25c
+  metadata.gz: 319b49c40bbc2bbb44f450a69ea1b42b2061024c31b02b0574e596453be0b388db9cb316d65bf62dc5cb583ae238d6245d99ed44e40d833d27ed389cb21abc2c
+  data.tar.gz: b30306f7fbfa425c1f8db2258754fa25bb574f16965cc7d810ec925d99c9f9761e29b1b5a0a93bef89c5c253f13c756262a52edf66c7c9a0e7599c29fcf43417

data/.reek.yml

@@ -0,0 +1,21 @@
+---
+detectors:
+  TooManyStatements:
+    max_statements: 8
+    exclude:
+    - set_options
+
+  UtilityFunction:
+    public_methods_only: true
+
+  RepeatedConditional:
+    max_ifs: 3
+
+  DuplicateMethodCall:
+   max_calls: 3
+
+  NestedIterators:
+    max_allowed_nesting: 2
+
+  TooManyInstanceVariables:
+    max_instance_variables: 5

data/.rubocop.yml

@@ -1,3 +1,5 @@
+require: rubocop-performance
+
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
@@ -6,6 +8,7 @@ AllCops:
     - 'web/node_modules/**/*'
     - 'Vagrantfile'
     - 'update_repo.gemspec'
+    - 'bin/**/*'
 
 Style/SymbolArray:
   Enabled: false
@@ -13,4 +16,4 @@ Style/SymbolArray:
 Metrics/BlockLength:
   Enabled: true
   Exclude:
-    - spec/**/*
+    - spec/**/*

data/.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 
 rvm:
   - 2.3.8
-  - 2.4.5
-  - 2.5.3
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 
 before_install:
   - gem update --system

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in update_repo.gemspec

data/README.md

@@ -94,6 +94,11 @@ brief: true
 quiet: true
 ```
 
+`save_errors:` - Save any Git error messages from the last run for future display, defaults to FALSE (optional)
+```yaml
+save_errors: 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. Again, see the [Website][website] for complete details and usage.
 
@@ -116,6 +121,8 @@ Options:
   -E, --verbose-errors       List all the error output from a failing command in the summary, not just the first line
   -b, --brief                Do not print the header, footer or summary
   -q, --quiet                Run completely silent, with no output to the terminal (except fatal errors)
+  -s, --save-errors          Save any Git error messages from the last run for future display
+  -S, --show-errors          Show any Git error messages from the last run of the script
   -v, --version              Print version and exit
   -h, --help                 Show this message
 ```
@@ -136,6 +143,8 @@ Add functionality, not in any specific order :
 - 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.
 - Add option to specify a completely different directory for the log file other than the 2 current options of home dir and local dir
 - Document configuration file format and options. `[IN PROGRESS]`
+- Add option to display the active config options, including those on command line and config file.
+- Add option to create the config file with options from existing config and command line
 
 Internal Changes and refactoring :
 - Add testing!

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'inch/rake'
@@ -9,6 +11,7 @@ if RUBY_VERSION >= '2.0'
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new do |task|
     # task.options << 'lib' << 'exe'
+    task.requires << 'rubocop-performance'
     task.fail_on_error = false
   end
 else

data/bin/update_repo

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -6,11 +8,22 @@
 # 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)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
 
-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,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'update_repo'
 
 # Catch ctrl-c and abort gracefully without Ruby back trace...

data/lib/update_repo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'update_repo/version'
 require 'update_repo/helpers'
 require 'update_repo/cmd_config'
@@ -42,11 +44,15 @@ module UpdateRepo
       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)
+      if !@cmd[:show_errors]
+        config['location'].each do |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?
+      else
+        @cons.show_last_errors
       end
-      # print out an informative footer unless dump / import ...
-      @cons.show_footer unless dumping?
     end
 
     private

data/lib/update_repo/cmd_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'update_repo/version'
 require 'update_repo/helpers'
 require 'confoog'
@@ -13,9 +15,9 @@ module UpdateRepo
     include Helpers
 
     # This constant holds the path to the config file, default to home dir.
-    CONFIG_PATH = '~/'.freeze
+    CONFIG_PATH = '~/'
     # This constant holds the filename of the config file.
-    CONFIG_FILE = '.updaterepo'.freeze
+    CONFIG_FILE = '.updaterepo'
 
     def initialize
       # read the options from Trollop and store in temp variable.
@@ -100,6 +102,7 @@ module UpdateRepo
     # @return [void]
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/LineLength
+    # rubocop:disable Metrics/AbcSize
     def set_options
       Optimist.options do
         version "update_repo version #{VERSION} (C)2019 G. Ramsay\n"
@@ -130,9 +133,12 @@ module UpdateRepo
         opt :verbose_errors, 'List all the error output from a failing command in the summary, not just the first line', default: false, short: 'E'
         opt :brief, 'Do not print the header, footer or summary', default: false, short: 'b'
         opt :quiet, 'Run completely silent, with no output to the terminal (except fatal errors)', default: false
+        opt :save_errors, 'Save any Git error messages from the last run for future display', default: false, short: 's'
+        opt :show_errors, 'Show any Git error messages from the last run of the script', default: false, short: 'S'
       end
     end
     # rubocop:enable Metrics/MethodLength
-    # rubocop:enable  Metrics/LineLength
+    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/update_repo/console_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'update_repo/version'
 require 'update_repo/helpers'
 
@@ -70,6 +72,7 @@ module UpdateRepo
       end
       print_log ' |'
       list_failures unless @metrics[:failed_list].empty?
+      @metrics.save_errors(@cmd.getconfig) if @cmd[:save_errors]
     end
 
     # List any repositories that failed their update, and the error.
@@ -78,13 +81,15 @@ module UpdateRepo
     def list_failures
       # ensure we don't have duplicate errors from the same repo
       remove_dups
-      print_log "\n\n!! Note : The following #{@metrics[:failed_list].count}",
+      puts "\n" unless @cmd[:show_errors]
+      print_log "\n!! Note : The following #{@metrics[:failed_list].count}",
                 ' repositories ', 'FAILED'.red.underline, ' during this run :'
       # print out any and all errors into a nice list
       @metrics[:failed_list].each do |failed|
         print_log "\n  [", 'x'.red, "] #{failed[:loc]}"
         print_log "\n    -> ", failed[:line].chomp.red
       end
+      print_log " \n\n"
     end
 
     # removes any duplications in the list of failed repos.
@@ -123,5 +128,17 @@ module UpdateRepo
 
       print_log "\nLogging to file:".underline, " #{@log.logfile}\n".cyan
     end
+
+    # just print out errors from the last run, if any
+    # @return [void]
+    def show_last_errors
+      @metrics.load_errors(@cmd.getconfig)
+      if !@metrics[:failed_list].empty?
+        puts 'Showing ' + 'ERRORS'.red.underline + ' from last full run :'
+        list_failures
+      else
+        puts 'There are' + ' No Errors'.green + " from last full run.\n\n"
+      end
+    end
   end
 end

data/lib/update_repo/git_control.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'update_repo/version'
 require 'update_repo/helpers'
 require 'open3'

data/lib/update_repo/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Module 'Helpers' containing assorted helper functions required elsewhere
 module Helpers
   # will remove the FIRST 'how_many' root levels from a directory path 'dir'..

data/lib/update_repo/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'update_repo/version'
 require 'update_repo/helpers'
 
@@ -99,7 +101,7 @@ module UpdateRepo
     # @param [none]
     # @return [void]
     def close
-      @logfile.close if @logfile
+      @logfile&.close # if @logfile
     end
   end
 end

data/lib/update_repo/metrics.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'update_repo/version'
 require 'update_repo/helpers'
+require 'yaml'
 
 module UpdateRepo
   # Class : Metrics.
@@ -30,5 +33,31 @@ module UpdateRepo
     def []=(key, value)
       @metrics[key] = value
     end
+
+    # This will save any (git) errors encountered to a file,
+    # so they can be reprinted again at a later date.
+    # If no errors, then delete any previously existing error file.
+    # @param config [instance] of Config class
+    # @return [void]
+    def save_errors(config)
+      # get the location of the config file, we'll use the same dir
+      # and base name
+      path = config.config_path + '.errors'
+      if @metrics[:failed_list].empty?
+        # delete any existing  file if we have no errors
+        File.delete(path) if File.exist?(path)
+      else
+        # otherwise save  the errors to file
+        File.open(path, 'w') { |file| file.write @metrics[:failed_list].to_yaml }
+      end
+    end
+
+    # loads an error file (if exists) into the @metrics[:failed_list].
+    # @param config [instance] of Config class
+    # @return [void]
+    def load_errors(config)
+      path = config.config_path + '.errors'
+      @metrics[:failed_list] = YAML.load_file(path) if File.exist?(path)
+    end
   end
 end

data/lib/update_repo/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module UpdateRepo
   # constant, current version of this Gem
-  VERSION = '0.9.10'.freeze
+  VERSION = '0.10.1'
 end

data/update_repo.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'fakefs'
@@ -38,8 +38,9 @@ Gem::Specification.new do |spec|
   # Below this we fix to the last working versions to keep Ruby 1.9.3 compat or
   # we ignore completely - Reek and Rubocop working in the latest versions is
   # enough since the code base is common.
-  spec.add_development_dependency 'reek', '~> 4.5' if RUBY_VERSION >= '2.1'
+  spec.add_development_dependency 'reek' if RUBY_VERSION >= '2.1'
   spec.add_development_dependency 'rubocop' if RUBY_VERSION >= '2.0'
+  spec.add_development_dependency 'rubocop-performance' if RUBY_VERSION >= '2.0'
 
   if RUBY_VERSION < '2.0'
     spec.add_development_dependency 'json', '= 1.8.3'
@@ -51,4 +52,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'confoog'
   spec.add_dependency 'optimist'
   spec.add_dependency 'versionomy'
+  # fix issue in Ruby < 2.5.5
+  spec.add_dependency "bigdecimal", "1.3.5" if RUBY_VERSION < '2.5.5'
 end

data/web/index.html

@@ -187,6 +187,15 @@
             </pre>
           </div><!-- col -->
 
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">save_errors:</span> - Enable or disable the option to save any Git errors from a previous run of the script, defaults to FALSE (optional). If this is specified then there will be nothing printed to the terminal except for fatal errors. Equivalent to <span class="cmdline">--save-errors</span> on the command line. Once saved, errors can be displayed using the <span class="cmdline">--show-errors</span> command line option.</p>
+            <pre>
+              <code class="language-yaml">
+                save-errors: true
+              </code>
+            </pre>
+          </div><!-- col -->
+
           <div class="col-lg-12 col-md-12">
             <p>Putting these together, below is an example <span class="filename">.updaterepo</span> file :</p>
             <pre>
@@ -227,6 +236,8 @@
                   -E, --verbose-errors       List all the error output from a failing command in the summary, not just the first line
                   -b, --brief                Do not print the header, footer or summary
                   -q, --quiet                Run completely silent, with no output to the terminal (except fatal errors)
+                  -s, --save-errors          Save any Git error messages from the last run for future display
+                  -S, --show-errors          Show any Git error messages from the last run of the script
                   -v, --version              Print version and exit
                   -h, --help                 Show this message
               </code>

data/web/webdata.json

@@ -99,6 +99,24 @@
       "negative"   : "",
       "default"    : "false"
     },
+    {
+      "title"      : "Save Errors",
+      "text"       : "Save any Git error messages from the last run for future display. These can be displayed using the Show Errors command below, which will display previous errors then exit without running another pass.",
+      "equivalent" : "save_errors",
+      "long-form"  : "--save-errors",
+      "short-form" : "-s",
+      "negative"   : "",
+      "default"    : "false"
+    },
+    {
+      "title"      : "Show Errors",
+      "text"       : "Prints any errors detected in the previous run then exits. This needs the 'Save Errors' option above to be enabled.",
+      "equivalent" : "",
+      "long-form"  : "--show-errors",
+      "short-form" : "-S",
+      "negative"   : "",
+      "default"    : "false"
+    },
     {
       "title"      : "Version",
       "text"       : "Displays the current version number then terminates. All other options will be ignored.",

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: update_repo
 version: !ruby/object:Gem::Version
-  version: 0.9.10
+  version: 0.10.1
 platform: ruby
 authors:
 - Grant Ramsay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +168,16 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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
@@ -262,7 +276,7 @@ files:
 - ".eslintrc.yml"
 - ".gitignore"
 - ".pullreview.yml"
-- ".reek"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -341,8 +355,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A Simple Gem to keep multiple locally-cloned Git Repositories up to date

data/.reek

@@ -1,20 +0,0 @@
----
-TooManyStatements:
-  max_statements: 8
-  exclude:
-  - set_options
-
-UtilityFunction:
-  public_methods_only: true
-
-RepeatedConditional:
-  max_ifs: 3
-
-DuplicateMethodCall:
- max_calls: 3
-
-NestedIterators:
-  max_allowed_nesting: 2
-
-TooManyInstanceVariables:
-  max_instance_variables: 5