update_repo 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5696a783dc964f8496706cda7909c28774600530
-  data.tar.gz: 7b6b09f1fb471211674ed5bd83cfb48529ecf35f
+  metadata.gz: 44621b4533c533361926fcd49d0fbf15ed1e955a
+  data.tar.gz: 54fcddbea0dd35ad28c6e4e8570c4db69dc510a1
 SHA512:
-  metadata.gz: b6c19d51e5929e3ce20d1dd8381229366d0951724a7655632c5dd60247d7336cc3660fd0d658e4d949072e6bca4025e5361ca725720b54b1fc23df61d69369d1
-  data.tar.gz: 35ebc0cee27d2d64a95c98613f98aac5d161b28a3c50c519c1f4bb30625c2d132eae021748468f71deb19eddc5a318f4c64f6ffd8a9a9266f202d42c458f7d73
+  metadata.gz: d1c18bbe70b0868857cb0ea47c0b8eb025b95b2b5aa3d845bb08fdcd8be034b550915835d11f0267f144a5b5f4da515ff60fb259d2db1f66740b4cf818bd360a
+  data.tar.gz: 042b68c8b069a2be01303bb91f5b6ba86c569f0e792ee3c7f814266e000014ebe024523f47b1df60634dab385f6c4cdd0a0e631c1d37a79da342f9d06c1751e1

data/.codeclimate.yml

@@ -0,0 +1,31 @@
+---
+engines:
+  csslint:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  eslint:
+    enabled: true
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.css"
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/
+- docs/

data/.csslintrc

@@ -0,0 +1,2 @@
+--exclude-exts=.min.css
+--ignore=adjoining-classes,box-model,ids,order-alphabetical,unqualified-attributes

data/.eslintignore

@@ -0,0 +1 @@
+**/*{.,-}min.js

data/.eslintrc.yml

@@ -0,0 +1,277 @@
+---
+parserOptions:
+  sourceType: module
+  ecmaFeatures:
+    jsx: true
+
+env:
+  amd: true
+  browser: true
+  es6: true
+  jquery: true
+  node: true
+
+# http://eslint.org/docs/rules/
+rules:
+  # Possible Errors
+  no-await-in-loop: off
+  no-cond-assign: error
+  no-console: off
+  no-constant-condition: error
+  no-control-regex: error
+  no-debugger: error
+  no-dupe-args: error
+  no-dupe-keys: error
+  no-duplicate-case: error
+  no-empty-character-class: error
+  no-empty: error
+  no-ex-assign: error
+  no-extra-boolean-cast: error
+  no-extra-parens: off
+  no-extra-semi: error
+  no-func-assign: error
+  no-inner-declarations:
+    - error
+    - functions
+  no-invalid-regexp: error
+  no-irregular-whitespace: error
+  no-negated-in-lhs: error
+  no-obj-calls: error
+  no-prototype-builtins: off
+  no-regex-spaces: error
+  no-sparse-arrays: error
+  no-template-curly-in-string: off
+  no-unexpected-multiline: error
+  no-unreachable: error
+  no-unsafe-finally: off
+  no-unsafe-negation: off
+  use-isnan: error
+  valid-jsdoc: off
+  valid-typeof: error
+
+  # Best Practices
+  accessor-pairs: error
+  array-callback-return: off
+  block-scoped-var: off
+  class-methods-use-this: off
+  complexity:
+    - error
+    - 6
+  consistent-return: off
+  curly: off
+  default-case: off
+  dot-location: off
+  dot-notation: off
+  eqeqeq: error
+  guard-for-in: error
+  no-alert: error
+  no-caller: error
+  no-case-declarations: error
+  no-div-regex: error
+  no-else-return: off
+  no-empty-function: off
+  no-empty-pattern: error
+  no-eq-null: error
+  no-eval: error
+  no-extend-native: error
+  no-extra-bind: error
+  no-extra-label: off
+  no-fallthrough: error
+  no-floating-decimal: off
+  no-global-assign: off
+  no-implicit-coercion: off
+  no-implied-eval: error
+  no-invalid-this: off
+  no-iterator: error
+  no-labels:
+    - error
+    - allowLoop: true
+      allowSwitch: true
+  no-lone-blocks: error
+  no-loop-func: error
+  no-magic-number: off
+  no-multi-spaces: off
+  no-multi-str: off
+  no-native-reassign: error
+  no-new-func: error
+  no-new-wrappers: error
+  no-new: error
+  no-octal-escape: error
+  no-octal: error
+  no-param-reassign: off
+  no-proto: error
+  no-redeclare: error
+  no-restricted-properties: off
+  no-return-assign: error
+  no-return-await: off
+  no-script-url: error
+  no-self-assign: off
+  no-self-compare: error
+  no-sequences: off
+  no-throw-literal: off
+  no-unmodified-loop-condition: off
+  no-unused-expressions: error
+  no-unused-labels: off
+  no-useless-call: error
+  no-useless-concat: error
+  no-useless-escape: off
+  no-useless-return: off
+  no-void: error
+  no-warning-comments: off
+  no-with: error
+  prefer-promise-reject-errors: off
+  radix: error
+  require-await: off
+  vars-on-top: off
+  wrap-iife: error
+  yoda: off
+
+  # Strict
+  strict: off
+
+  # Variables
+  init-declarations: off
+  no-catch-shadow: error
+  no-delete-var: error
+  no-label-var: error
+  no-restricted-globals: off
+  no-shadow-restricted-names: error
+  no-shadow: off
+  no-undef-init: error
+  no-undef: off
+  no-undefined: off
+  no-unused-vars: off
+  no-use-before-define: off
+
+  # Node.js and CommonJS
+  callback-return: error
+  global-require: error
+  handle-callback-err: error
+  no-mixed-requires: off
+  no-new-require: off
+  no-path-concat: error
+  no-process-env: off
+  no-process-exit: error
+  no-restricted-modules: off
+  no-sync: off
+
+  # Stylistic Issues
+  array-bracket-spacing: off
+  block-spacing: off
+  brace-style: off
+  camelcase: off
+  capitalized-comments: off
+  comma-dangle:
+    - error
+    - never
+  comma-spacing: off
+  comma-style: off
+  computed-property-spacing: off
+  consistent-this: off
+  eol-last: off
+  func-call-spacing: off
+  func-name-matching: off
+  func-names: off
+  func-style: off
+  id-length: off
+  id-match: off
+  indent: off
+  jsx-quotes: off
+  key-spacing: off
+  keyword-spacing: off
+  line-comment-position: off
+  linebreak-style: off
+  lines-around-comment: off
+  lines-around-directive: off
+  max-depth: off
+  max-len: off
+  max-nested-callbacks: off
+  max-params: off
+  max-statements-per-line: off
+  max-statements:
+    - error
+    - 30
+  multiline-ternary: off
+  new-cap: off
+  new-parens: off
+  newline-after-var: off
+  newline-before-return: off
+  newline-per-chained-call: off
+  no-array-constructor: off
+  no-bitwise: off
+  no-continue: off
+  no-inline-comments: off
+  no-lonely-if: off
+  no-mixed-operators: off
+  no-mixed-spaces-and-tabs: off
+  no-multi-assign: off
+  no-multiple-empty-lines: off
+  no-negated-condition: off
+  no-nested-ternary: off
+  no-new-object: off
+  no-plusplus: off
+  no-restricted-syntax: off
+  no-spaced-func: off
+  no-tabs: off
+  no-ternary: off
+  no-trailing-spaces: off
+  no-underscore-dangle: off
+  no-unneeded-ternary: off
+  object-curly-newline: off
+  object-curly-spacing: off
+  object-property-newline: off
+  one-var-declaration-per-line: off
+  one-var: off
+  operator-assignment: off
+  operator-linebreak: off
+  padded-blocks: off
+  quote-props: off
+  quotes: off
+  require-jsdoc: off
+  semi-spacing: off
+  semi: off
+  sort-keys: off
+  sort-vars: off
+  space-before-blocks: off
+  space-before-function-paren: off
+  space-in-parens: off
+  space-infix-ops: off
+  space-unary-ops: off
+  spaced-comment: off
+  template-tag-spacing: off
+  unicode-bom: off
+  wrap-regex: off
+
+  # ECMAScript 6
+  arrow-body-style: off
+  arrow-parens: off
+  arrow-spacing: off
+  constructor-super: off
+  generator-star-spacing: off
+  no-class-assign: off
+  no-confusing-arrow: off
+  no-const-assign: off
+  no-dupe-class-members: off
+  no-duplicate-imports: off
+  no-new-symbol: off
+  no-restricted-imports: off
+  no-this-before-super: off
+  no-useless-computed-key: off
+  no-useless-constructor: off
+  no-useless-rename: off
+  no-var: off
+  object-shorthand: off
+  prefer-arrow-callback: off
+  prefer-const: off
+  prefer-destructuring: off
+  prefer-numeric-literals: off
+  prefer-rest-params: off
+  prefer-reflect: off
+  prefer-spread: off
+  prefer-template: off
+  require-yield: off
+  rest-spread-spacing: off
+  sort-imports: off
+  symbol-description: off
+  template-curly-spacing: off
+  yield-star-spacing: off

data/.gitignore

@@ -12,3 +12,5 @@
 .updatereporc
 *.log
 *.sublime*
+node_modules
+.vagrant

data/.reek

@@ -15,3 +15,6 @@ DuplicateMethodCall:
 
 NestedIterators:
   max_allowed_nesting: 2
+
+TooManyInstanceVariables:
+  max_instance_variables: 5

data/.rubocop.yml

@@ -2,3 +2,10 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   ExtraDetails: true
+  Exclude:
+    - 'web/node_modules/**/*'
+    - 'Vagrantfile'
+    - 'update_repo.gemspec'
+
+Style/SymbolArray:
+  Enabled: false

data/.travis.yml

@@ -4,10 +4,10 @@ rvm:
   - 1.9.3-p551
   - 2.0.0-p648
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
 
 before_install:
   - gem update --system
-  - gem install bundler -v 1.13.7
+  - gem install bundler -v 1.14.6

data/README.md

@@ -79,6 +79,11 @@ timestamp: true
 verbose: true
 ```
 
+`verbose_errors:` - List all the error output from a failing command in the summary, not just the first line, defaults to FALSE (optional)
+```yaml
+verbose_errors: true
+```
+
 `quiet:` - no output at all, not even the header and footer, defaults to FALSE (optional)
 ```yaml
 quiet: true
@@ -98,9 +103,12 @@ Options:
                              Any older logs will be overwritten.
   -t, --timestamp            Timestamp the logfile instead of overwriting. Does nothing unless the
                              --log option is also specified.
+  -g, --log-local            Create the logfile in the current directory instead of in the users home
+                             directory.
   -r, --dump-remote          Create a dump to screen or log listing all the git remote URLS found in
                              the specified directories.
   -V, --verbose              Display each repository and the git output to screen
+  -E, --verbose-errors       List all the error output from a failing command in the summary, not just the first line
   -q, --quiet                Run completely silent, with no output to the terminal (except fatal errors).
   -v, --version              Print version and exit
   -h, --help                 Show this message
@@ -119,8 +127,7 @@ 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)
+- 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]`
 
 Internal Changes and refactoring :
@@ -130,18 +137,55 @@ Internal Changes and refactoring :
   * Ignore and report invalid or missing directories
   * Add more failure cases, there may be more git errors than "fatal:" or "error:"
 - Retry for connection issues etc (config setting).
+- Fail gracefully with warning and useful information if there are no `location:` entries or that tag is missing completely
 
 ## Development
 
+### Developing for the Gem
+
 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.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 Run `rake` to run the RSpec tests, which also runs `RuboCop`, `Reek` and `inch --pedantic` too.
 
+### Developing for the Website
+
+The source for the Gem’s website is also included in this repository. In fact, there are 2 main folders related to the website :
+
+- [/web/](web/) folder - this is the SOURCE of the website, and all modifications should be performed here.
+- [/docs/](docs/) folder - this is the GENERATED OUTPUT for the website, and this folder is served up directly and live to the web using GitHub Pages. Do not make any modifications to the files in this folder directly, your changes will be overwritten when the website is generated. Alway make changes in the `/web/` folder.
+
+There are also a few support files to configure Node and Gulp which are used for the build process.
+
+For full details on how to update the website properly, please see the [WEBSITE.md](WEBSITE.md) file in the root of this repository.
+
+Any modifications that implement new functionality or user-facing API should also come with the relevant update to the website documenting the new options or modified functionality. Generally a Pull Request will not be accepted without the related additions to the website, however help can be given on that side if the process is unclear.
+
+### Using the provided Vagrant Box
+
+To ease the setup of a consistent development environment under both Linux and Windows, we have provided a [Vagrantfile](Vagrantfile) with the project. This will provide a virtual machine (running Ubuntu 16.04) that is already set up with the required version of [Ruby][ruby], [Node.js][node] and the associated development deps. It will already have all the needed node packages and Ruby gems installed locally. The root of this project repository will be available under the `/vagrant/` directory on this VM for ease of development. This means that all the editing can be carried out on your normal system be it Windows, Linux or OSX, while the git control, testing, Gem building and Website generation (with Gulp) happens on the VM.
+
+#### Setting up Vagrant and VirtalBox
+
+The easiest VM to use for both Windows, Linux and Mac is [VirtualBox][virtualbox] which is Free and Open Source.
+- Download and install Vagrant from their download pages [here][vagrantdl]. Follow the installation instructions depending on your operating system.
+- Download and install VirtualBox from their download pages [here][virtualboxdl]. Follow the installation instructions depending on your operating system.
+- Open a terminal (or Command Prompt in Windows) in the root directory of your checked-out copy of this project, the one containing the [Vagrantfile](Vagrantfile).
+- We need to install one Vagrant plugin, otherwise the VM Guest Additions will be out of date and the `/vagrant/` share will not work. for this we install the `vagrant-vbguest` plugin. To do this run the following at the terminal prompt : `vagrant plugin install vagrant-vbguest`
+- Run `vagrant up` at the terminal prompt. This will proceed to download, install and then provision an Ubuntu 16.04 Virtual Machine. For the first run, this will take some time but thereafter it will be quicker.
+- Run `vagrant ssh` at the terminal prompt to ssh into the VM. Note that for the first time, it will probably say that a reboot is required, simply type `sudo reboot` at the prompt - the VM will reboot and you will be disconnected. Wait a few minutes and then run `vagrant ssh` again.
+- Change to the `/vagrant` subdirectory which will contain the source for this project and then develop away as normal.
+- For the first use only, if you change to `/vargrant` and there are no files listed, this is generally because the VM Guest Additions have been updated when bringing the VM up, but have not properly activated. In this case simply `exit` the VM, run `vagrant halt` then `vagrant up` again which should fix it.
+
+#### Special comments for Windows users
+
+There is no default ssh client installed in any version of windows, so `vagrant ssh` will fail, giving you the settings required to use a third-party ssh client (for example my preferred windows SSH client is [MobaXterm][mobaxterm]). If you prefer that `vagrant ssh` actually works from the command line, it is possible to install the ssh command line programs if you also install the [Git for Windows][git4windows] software. Install this, ensuring that you choose the option 'Use Git and optional Unix tools from the Windows Command Prompt'. After this, the ssh executable will be available from any windows Command Shell and so `vagrant ssh` will work as expected. *Please note the warning given by the installer related to this option though!*
+
 ## Contributing
 
 1. Fork it
+
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -176,4 +220,11 @@ The gem is available as open source under the terms of the [MIT License][mit].
 [pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
 [confoog]: http://confoog.seapagan.net
 [mit]: http://opensource.org/licenses/MIT
+[vagrant]: https://www.vagrantup.com/
+[vagrantdl]: https://www.vagrantup.com/downloads.html
+[virtualbox]: https://www.virtualbox.org
+[virtualboxdl]: https://www.virtualbox.org/wiki/Downloads
+[node]: http://nodejs.org
+[mobaxterm]: http://mobaxterm.mobatek.net/
+[git4windows]: https://git-scm.com/download/win