update_repo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8306af42ee0918611be90bb7d383edd58b01809
+  data.tar.gz: 0044b4e45d04bf1d7e453f4d2186507c4ff93742
+SHA512:
+  metadata.gz: 48dcd4bc4e2333d0ba99b885d632b9c13e8b88c657b1a47ff501b1289cb3d7e8ba7289027a253c14f48af34a1725819c49df3de63170b039dc5605b23411eac9
+  data.tar.gz: 5751e8889ff7c22b04a06d8ff6b1bca976ab3536d513dda738f7461b542c5679a53322c1876e006d2a2c323ca4c3050471564be2c4e0f37b61fb62b2042be169

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.remote-sync.json
+.token
+.updatereporc

data/.pullreview.yml

@@ -0,0 +1,4 @@
+---
+notifications:
+  pullrequest:
+    comment: verbose

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in update_repo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Grant Ramsay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# update_repo
+
+A Simple Gem to keep multiple cloned Git Repositories up to date.
+
+This is the conversion to a Gem of one of my standalone Ruby scripts. Still very much work in progress, but functions as required.
+
+## Usage
+
+#### 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.
+
+[git]: http://git-scm.com
+
+#### 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 :
+```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.
+
+This file should be located in the users home directory (`~/.updatereporc`).
+
+Run the script :
+```
+$ update_repo
+```
+
+## Configuration
+#### Configuration file
+To be added.
+
+#### Command line switches
+To be added.
+
+## To-Do
+Not in any specific order :
+
+- Improve error-checking and recovery while parsing the configuration file (convert to using my '[Confoog][confoog]' gem for example)
+- 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 :
+    * number of repos updated
+    * number of repos skipped
+    * list of changed repos
+    * errors or connection problems
+    * _more..._
+- Add command line options to override configuration, and even specify an alternate config file. Any options so specified will have precedence over settings specified in the configuration file.
+- Add command line options for verbose or quiet, with same options in config file.
+- Add ability to specify a new directory (containing Git repos) to search from the command line, and optionally save this to the standard configuration.
+- Add new repo from the command line that will be cloned to the default repo directory and then updated as usual. Extra flag added for "add only, clone later" for offline use.
+- 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.
+- Document configuration file format and options.
+- Add testing!
+
+[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.
+
+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.
+
+## 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`)
+5. Create new Pull Request
+
+<del>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. Note that Failures of Rubocop will cause the CI (Travis) to fail, however 'Reek' failures will not.</del>  
+This is still currently a messy conversion to Gem from a standalone script, so the RSpec tests are non-existent and it will fail all [RuboCop][rubocop], [Reek][reek] and [Inch-CI][inch]. This will be quickly fixed though. Once that is done this message will be removed and the above comment reinstated.
+
+[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
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+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!
+
+[semver]: http://semver.org/
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rubocop/rake_task'
+require 'inch/rake'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new do |task|
+  task.options << 'lib'
+end
+
+Inch::Rake::Suggest.new do |suggest|
+  suggest.args << '--pedantic'
+end
+
+# reek is not compatible with Ruby < 2.0]
+if RUBY_VERSION > '2.0'
+  require 'reek/rake/task'
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = false
+    t.verbose       = true
+    t.reek_opts     = '-U'
+  end
+else
+  task :reek do
+    # Empty task
+  end
+end
+
+# task default: [:rubocop, :inch, :reek, :spec, :build]
+task default: [ :spec, :build] # leave the others off until we are more advanced.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/update_repo

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'update_repo' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("update_repo", "update_repo")

data/exe/update_repo

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "update_repo"
+include UpdateRepo
+
+# 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

data/lib/update_repo.rb

@@ -0,0 +1,73 @@
+require "update_repo/version"
+require 'yaml'
+require 'colorize'
+
+module UpdateRepo
+
+  CONFIG_FILE = '.updatereporc'
+  $counter = 0
+
+  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
+        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"
+    end
+    if !configs['exceptions'].nil? then
+      print "\nExclusions:".underline, " ", configs['exceptions'].join(', ').yellow, "\n"
+    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"
+    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
+
+    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
+    puts "Error : Cannot find configuration file '#{user_config}', aborting".red
+    exit 1
+  end
+end

data/lib/update_repo/version.rb

@@ -0,0 +1,3 @@
+module UpdateRepo
+  VERSION = "0.1.0"
+end

data/update_repo.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+# rubocop:disable LineLength
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'update_repo/version'
+
+Gem::Specification.new do |spec|
+  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.summary       = 'A Simple Gem to keep multiple cloned Git Repositories up to date'
+  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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 'pry'
+  spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'inch'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'pullreview-coverage'
+  spec.add_development_dependency 'should_not'
+
+  spec.add_dependency 'colorize'
+
+  # Depends on Ruby version if we can use 'Reek'
+  spec.add_development_dependency 'reek', '~> 3.3' if RUBY_VERSION > '2.0'
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: update_repo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grant Ramsay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: fakefs
+  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: coveralls
+  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: rubocop
+  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: inch
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pullreview-coverage
+  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: should_not
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- seapagan@gmail.com
+executables:
+- update_repo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pullreview.yml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/update_repo
+- exe/update_repo
+- lib/update_repo.rb
+- lib/update_repo/version.rb
+- update_repo.gemspec
+homepage: http://opensource.seapagan.net
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: A Simple Gem to keep multiple cloned Git Repositories up to date
+test_files: []
+has_rdoc: