mavenlink-git-scripts 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a793b24f0f684d1cc498443ac36dce26a51c13d
+  data.tar.gz: 0c3b8bca0d67edeaa31cc67e13fa246cfa176128
+SHA512:
+  metadata.gz: ecd299a5ffbe08de9c5bc84bcef12a635551827822ff45c9f615caf516c709ab876d3afe630509c6311aeb7a798f8692e034f8cb18f415b43d6a65f214d215de
+  data.tar.gz: d0b70f876ca927b7a5d70397b06b6f4e49d397719cb792bc087a6d4bb911d140abb75b86efd7a49f9dd073f848e64ba8933ef2305b766dc75fada76433cfe123

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+spec/tmp
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2.5
+  - 2.1.9
+  - 2.0.0-p648
+# Fix weird issues from this Travis build:
+# https://travis-ci.org/pivotal/git_scripts/jobs/5501358
+# https://git.wiki.kernel.org/index.php/Git_FAQ#Git_commit_is_dying_telling_me_.22fatal:_empty_ident_.3Cuser.40myhost.3E_not_allowed.22.2C_what.27s_wrong.3F
+env:
+  global:
+    - GIT_AUTHOR_NAME="Travis CI"
+before_script:
+  - git config --global user.email "travis-ci@example.com"
+  - git config --global user.name "Travis CI"

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# CHANGELOG
+
+## 1.4.0 - released 2015-01-15
+
+### `git pair-commit` explicitly sets the author name
+    
+Before this change, git's user.name setting would override. In
+repositories where the user had previously run `git duet`, this meant
+that after a `git pair --global ...` the email was set correctly by `git
+pair-commit`, but the author name was not.
+
+[#62606550]
+
+### `git pair-commit` sets committer name and email
+    
+[Finishes #62606550]
+
+### Add ability to use a custom email address per user
+
+    # include the following section to set custom email addresses for users
+    email_addresses:
+      zr: zach.robinson@example.com
+
+### Include the $HOME directory if it's not in the list of pwd ancestors.
+
+This fixes the actual behavior to match the documentation, which states that the `.pairs` file may be in the user's home directory.

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/MIT.LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Pivotal Labs
+
+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,125 @@
+# Git Scripts
+
+These scripts are helpers for managing developer workflow when using git repositories hosted on GitHub.  Install as a RubyGem and they can be run as standard git commands, eg: `git about`.
+
+[![Build Status](https://img.shields.io/travis/pivotal/git_scripts.svg)](https://travis-ci.org/pivotal/git_scripts)
+
+## Gem Installation
+
+```shell
+gem install pivotal_git_scripts
+```
+
+## System Wide Installation
+
+```shell
+cd /usr/local/bin && curl -L http://github.com/pivotal/git_scripts/tarball/master | gunzip | tar xvf - --strip=2
+```
+
+## git-about
+
+`git about` shows settings set by `git pair` and `git project`
+
+## git-pair
+
+Configures git authors when pair programming.
+
+```shell
+$ git pair sp js
+user.name=Josh Susser & Sam Pierson
+user.email=pair+jsusser+sam@pivotallabs.com
+```
+
+Create a `.pairs` config file in project root or your home folder.
+
+```yaml
+# .pairs - configuration for 'git pair'
+pairs:
+  # <initials>: <Firstname> <Lastname>[; <email-id>]
+  eh: Edward Hieatt
+  js: Josh Susser; jsusser
+  sf: Serguei Filimonov; serguei
+email:
+  prefix: pair
+  domain: pivotallabs.com
+  no_solo_prefix: true
+global: false  # Set to true for git-pair to change git configuration for all your projects
+```
+
+
+By default this affects the current project (`.git/config`).
+Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (`~/.gitconfig`).
+
+Options are:
+
+    -g, --global                     Modify global git options instead of local
+    -v, --version                    Show Version
+    -h, --help                       Show this.
+
+When you're done pairing, change git's configuration to use your personal details.
+
+```shell
+git pair <your-initials>
+```
+
+## git-pair-commit
+
+Makes a git commit as normal, but chooses one of the pair members randomly to get credit for the commit on github (by setting the author email to that member's email address). The author name on the commit will list all members of the pair, as usual.
+
+If pair members have email addresses on different domains, you can specify them separately in the optional `email_addresses:` key in your `.pairs` file.
+
+If pair members would like to sign commits with a GPG key, you can specifiy them in the optional `gpg_keys:` sections in your `.pairs` file.
+
+```yaml
+pairs:
+  jd: Jane Doe
+  fb: Frances Bar
+email_addresses:
+  jd: jane@awesome.local
+  fb: frances@foo.bar
+gpg_keys:
+  jd: A1B2C3D4
+  fb: E5F6G7H8
+```
+
+### Using git-pair-commit in RubyMine
+RubyMine already supports pointing at a custom location for your git executable in the Preferences -> Version Control -> Git
+![RubyMine Git Configuration](http://i.imgur.com/hTHkdeA.png)
+The trick then is that `pair-commit` doesn't encompass all git functionality, so you can't just point RubyMine directly at it, you need something in the middle that will use `pair-commit` if the first arg is `commit`, otherwise just pass through. Here's a ruby script to do just that:
+
+```ruby
+#!/usr/bin/env ruby
+
+exit_code = if ARGV[1] == "commit"
+  system "git pair-commit #{ARGV[1..-1].join(" ")}"
+else
+  system "git #{ARGV.join(" ")}"
+end
+
+exit exit_code
+```
+
+Make sure it's executable.
+
+
+## git-project
+
+```shell
+git project pivots
+```
+
+This script sets the user account you will use to access repos hosted on github.com.  It creates a symlink from `id_github_current` to `id_github_pivotal<project>`, which switches the SSH key you are currently using to access GitHub repos.  Make sure you have the following lines in your .ssh/config file:
+
+    Host github.com
+      User git
+      IdentityFile /Users/pivotal/.ssh/id_github_current
+
+Authors
+====
+Copyright (c) 2010 [Pivotal Labs](http://pivotallabs.com). This software is licensed under the MIT License.
+
+### [Contributors](https://github.com/pivotal/git_scripts/contributors)
+ - git-pair original author [Bryan Helmkamp](http://brynary.com)
+ - lots of pivots :)
+ - [James Sanders](https://github.com/jsanders)
+ - [Todd Persen](https://github.com/toddboom)

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+task :default do
+  sh "bundle exec rspec spec"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/pivotal_git_scripts/version.rb'
+
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
+
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end

data/bin/git-about

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+user_name = `git config --get user.name`
+user_name = "NONE" if user_name.strip.empty?
+
+user_email = `git config --get user.email`
+user_email = "NONE" if user_email.strip.empty?
+
+begin
+  key_file = File.readlink(File.expand_path("~/.ssh/id_github_current"))
+  project = (key_file =~ %r{id_github_(\w+)} ? $1 : "NONE")
+rescue Errno::ENOENT
+  project = "NONE"
+end
+
+puts "git user:       #{user_name}"
+puts "git email:      #{user_email}"
+puts "GitHub project: #{project}"

data/bin/git-pair

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.dirname(__FILE__)) # this is required when running from /usr/local/bin
+require 'pivotal_git_scripts/git_pair'
+
+PivotalGitScripts::GitPair.main(ARGV)

data/bin/git-pair-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.dirname(__FILE__)) # this is required when running from /usr/local/bin
+require 'pivotal_git_scripts/git_pair'
+
+PivotalGitScripts::GitPair.commit(ARGV)

data/bin/git-project

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require 'socket'
+
+def check_ssh_config
+  if `grep -c id_github_current config`.to_i == 0
+    puts <<-WARNING
+    You must edit your .ssh/config file to include:
+      Host github.com
+        User git
+        IdentityFile /Users/pivotal/.ssh/id_github_current
+    WARNING
+  end
+end
+
+project = ARGV[0] || Dir.pwd.split('/').last
+hostname = Socket.gethostname.split('.').first
+possible_id_files = [
+  "id_#{hostname}_github_pivotal#{project}",
+  "id_github_pivotal#{project}",
+  "id_github_#{project}"
+]
+
+Dir.chdir(File.expand_path('~/.ssh')) do
+  possible_id_files.each do |id_file|
+    if File.exists?(id_file)
+      `ln -sf #{id_file} id_github_current`
+      puts "Now using key #{id_file}"
+      check_ssh_config
+      exit 0
+    end
+  end
+  puts "Key not found. You must create a ssh key in ~/.ssh/ called " +
+    possible_id_files[0..-2].join(", ") +
+    " or #{possible_id_files[-1]}"
+end

data/bin/git-superpull

@@ -0,0 +1,2 @@
+#!/bin/sh
+git pull && git submodule init && git submodule update

data/lib/pivotal_git_scripts/git_pair.rb

@@ -0,0 +1,271 @@
+require "pivotal_git_scripts/version"
+require 'yaml'
+require 'optparse'
+require 'pathname'
+
+module PivotalGitScripts
+  module GitPair
+    def self.main(argv)
+      runner = Runner.new
+      runner.main(argv)
+    end
+
+    def self.commit(argv)
+      runner = Runner.new
+      runner.commit(argv)
+    end
+
+    class GitPairException < Exception; end
+
+    class Runner
+      def main(argv)
+        git_dir = `git rev-parse --git-dir`.chomp
+        exit 1 if git_dir.empty?
+
+        options = parse_cli_options(argv)
+        initials = argv
+        config = read_pairs_config
+        global = !!(options[:global] || config["global"])
+
+        if initials.any?
+          author_names, email_ids = extract_author_names_and_email_ids_from_config(config, initials)
+          authors = pair_names(author_names)
+          git_config = {:name => authors,  :initials => initials.sort.join(" ")}
+          git_config[:email] = build_email(email_ids, config["email"]) unless no_email(config)
+          set_git_config global,  git_config
+        else
+          git_config = {:name => nil,  :initials => nil}
+          git_config[:email] = nil unless no_email(config)
+          set_git_config global, git_config
+          puts "Unset#{' global' if global} user.name, #{'user.email, ' unless no_email(config)}user.initials"
+        end
+
+        [:name, :email, :initials].each do |key|
+          report_git_settings(git_dir, key)
+        end
+      rescue GitPairException => e
+        puts e.message
+        exit 1
+      end
+
+      def commit(argv)
+        if argv[0] == '-h'
+          puts 'Usage: git pair-commit [options_for_git_commit]'
+          puts ''
+          puts 'Commits changes to the repository using `git commit`, but randomly chooses the author email from the'
+          puts 'members of the pair. In order for GitHub to assign credit for the commit activity, the user\'s email'
+          puts 'must be linked in their GitHub account.'
+          exit 0
+        end
+
+        config = read_pairs_config
+        author_details = extract_author_details_from_config(config, current_pair_initials)
+        author_names = author_details.keys.map { |i| author_details[i][:name] }
+        authors = pair_names(author_names)
+        author_details = random_author_details(author_details)
+        author_email = author_details[:email]
+        author_key = author_details[:key]
+        env_variables = "GIT_AUTHOR_NAME='#{authors}' GIT_AUTHOR_EMAIL='#{author_email}' GIT_COMMITTER_NAME='#{authors}' GIT_COMMITTER_EMAIL='#{author_email}'"
+
+        puts "Committing under #{author_email}"
+
+        unless author_key.nil?
+          argv << "--gpg-sign=#{author_key}"
+          puts "Signing with key #{author_key}"
+        end
+
+        args = argv.map{|arg| "'#{arg}'"}.join(' ')
+
+        system "#{env_variables} git commit #{args}"
+      rescue GitPairException => e
+        puts e.message
+        exit 1
+      end
+
+      def current_pair_initials
+        initials = `git config user.initials`.strip.split(' ')
+        raise GitPairException, 'Error: No pair set. Please set your pair with `git pair ...`' if initials.empty?
+        initials
+      end
+
+      def parse_cli_options(argv)
+        options = {}
+        OptionParser.new do |opts|
+          # copy-paste from readme
+          opts.banner = <<BANNER.sub('<br/>','')
+      Configures git authors when pair programming.
+
+          git pair sp js
+          user.name=Josh Susser and Sam Pierson
+          user.email=pair+jsusser+sam@pivotallabs.com
+
+
+      Create a `.pairs` config file in project root or your home folder.
+
+          # .pairs - configuration for 'git pair'
+          pairs:
+            # <initials>: <Firstname> <Lastname>[; <email-id>]
+            eh: Edward Hieatt
+            js: Josh Susser; jsusser
+            sf: Serguei Filimonov; serguei
+          # if email section is present, email will be set
+          # if you leave out the email config section, email will not be set
+          email:
+            prefix: pair
+            domain: pivotallabs.com
+            # no_solo_prefix: true
+          #global: true
+          # include the following section to set custom email addresses for users
+          #email_addresses:
+          #  zr: zach.robinson@example.com
+          #gpg_keys:
+          #  zr: 1A2B3C4D
+
+
+      By default this affects the current project (.git/config).<br/>
+      Use the `--global` option or add `global: true` to your `.pairs` file to set the global git configuration for all projects (~/.gitconfig).
+
+      Options are:
+BANNER
+          opts.on("-g", "--global", "Modify global git options instead of local") { options[:global] = true }
+          opts.on("-v", "--version", "Show Version") do
+            puts PivotalGitScripts::VERSION
+            exit
+          end
+          opts.on("-h", "--help", "Show this.") { puts opts; exit }
+        end.parse!(argv)
+
+        options
+      end
+
+      def read_pairs_config
+        pairs_file_name = '.pairs'
+
+        directory = File.absolute_path(Dir.pwd)
+        candidate_directories = [directory]
+        while ! Pathname.new(directory).root? do
+          directory = File.absolute_path(File.join(directory, ".."))
+          candidate_directories << directory
+        end
+        home = File.absolute_path(ENV["HOME"])
+        candidate_directories << home unless candidate_directories.include? home
+
+        pairs_file_path = candidate_directories.
+          map { |d| File.join(d, ".pairs") }.
+          find { |f| File.exists? f }
+
+        unless pairs_file_path
+          raise GitPairException, <<-INSTRUCTIONS
+      Could not find a .pairs file. Create a YAML file in your project or home directory.
+      Format: <initials>: <name>[; <email>]
+      Example:
+      # .pairs - configuration for 'git pair'
+      # place in project or home directory
+      pairs:
+        eh: Edward Hieatt
+        js: Josh Susser; jsusser
+        sf: Serguei Filimonov; serguei
+      email:
+        prefix: pair
+        domain: pivotallabs.com
+      INSTRUCTIONS
+        end
+
+        YAML.load_file(pairs_file_path)
+      end
+
+      def read_author_info_from_config(config, initials_ary)
+        initials_ary.map do |initials|
+          config['pairs'][initials.downcase] or
+            raise GitPairException, "Couldn't find author name for initials: #{initials}. Add this person to the .pairs file in your project or home directory."
+        end
+      end
+
+      def build_email(emails, config)
+        if config.is_a?(Hash)
+          prefix = config['prefix'] if !config['no_solo_prefix'] or emails.size > 1
+          "#{([prefix] + emails).compact.join('+')}@#{config['domain']}"
+        else
+          config
+        end
+      end
+
+      def random_author_details(author_details)
+        author_id = author_details.keys.sample
+        author_details[author_id]
+      end
+
+      def set_git_config(global, options)
+        options.each do |key,value|
+          config_key = "user.#{key}"
+          arg = value ? %Q{#{config_key} "#{value}"} : "--unset #{config_key}"
+          system(%Q{git config#{' --global' if global} #{arg}})
+        end
+      end
+
+      def report_git_settings(git_dir, key)
+        global = `git config --global --get-regexp '^user\.#{key}'`
+        local = `git config -f #{git_dir}/config --get-regexp '^user\.#{key}'`
+        if global.length > 0 && local.length > 0
+          puts "NOTE: Overriding global user.#{key} setting with local."
+        end
+        puts "global: #{global}" if global.length > 0
+        puts "local:  #{local}" if local.length > 0
+      end
+
+      def extract_author_names_and_email_ids_from_config(config, initials)
+        authors = read_author_info_from_config(config, initials)
+        authors.sort!.uniq! # FIXME
+        authors.map do |a|
+          full_name, email_id = a.split(";").map(&:strip)
+          email_id ||= full_name.split(' ').first.downcase
+          [full_name, email_id]
+        end.transpose
+      end
+
+      def no_email(config)
+        !config.key? 'email'
+      end
+
+      def extract_author_details_from_config(config, initials)
+        details = {}
+
+        initials.each do |i|
+          info = read_author_info_from_config(config, [i]).first
+
+          full_name, email_id = info.split(";").map(&:strip)
+          email_id ||= full_name.split(' ').first.downcase
+
+          email = read_custom_email_address_from_config(config, i)
+          email ||= "#{email_id}@#{config['email']['domain']}"
+
+          key = read_gpg_keys_from_config(config, i)
+
+          details[i] = {
+            :name => full_name,
+            :email => email,
+            :key => key
+          }
+        end
+
+        details
+      end
+
+      def read_custom_email_address_from_config(config, initial)
+        return nil unless config['email_addresses']
+        return config['email_addresses'][initial.downcase]
+      end
+
+      def read_gpg_keys_from_config(config, initial)
+        return nil unless config['gpg_keys']
+        return config['gpg_keys'][initial.downcase]
+      end
+
+      private
+
+      def pair_names(author_names)
+        [author_names[0..-2].join(", "), author_names.last].reject(&:empty?).join(" and ")
+      end
+    end
+  end
+end