git-scripts 0.1.0

data/lib/git.rb

@@ -0,0 +1,170 @@
+module Git
+   def self.has_uncommitted_changes()
+      clean = system("git diff --quiet 2>/dev/null >&2")
+      return !clean
+   end
+
+   def self.development_branch
+      dev_branch = `git config feature.development-branch`.strip
+      if !dev_branch || $? != 0
+         $stderr.puts "No development branch specified"
+         $stderr.puts "  set it with: git config feature.development-branch master"
+         exit 1;
+      end
+      dev_branch
+   end
+
+   # Returns an array of branches that aren't merged into the specifeid branch
+   def self.branches_not_merged_into(branch)
+      self::all_branches - self::merged_branches(branch)
+   end
+
+   # Returns an array of unmerged hotfix branches
+   def self.hotfix_branches(type)
+      branches = if type == :unmerged
+         self.branches_not_merged_into('stable')
+      elsif type == :merged
+         self.merged_branches('stable')
+      end
+
+      branches.select {|branch| branch.include?('hotfix-') }
+   end
+
+   # Returns an array of unmerged feature branches
+   def self.feature_branches(type)
+      branches = if type == :unmerged
+         self.branches_not_merged_into('master')
+      elsif type == :merged
+         self.merged_branches('master')
+      end
+
+      branches.reject {|branch| branch.include?('hotfix-') }
+   end
+
+   # Returns an array of all branch names that have have been merged into the
+   # specified branch
+   def self.merged_branches(into_branch='master')
+      `git branch --merged #{into_branch} -a`.
+         split("\n").
+         map {|branch| branch.gsub('*','').strip.sub('remotes/','')}
+   end
+
+   # Returns an array of all local branch names
+   def self.all_branches()
+      `git for-each-ref --sort=-committerdate --format='%(refname)' refs/heads refs/remotes`.
+      split("\n").
+      map {|branch| branch.sub(/refs\/\w+\//, '') }.uniq
+   end
+
+   # returns the name of th currently checked out brnach, or nil if detached.
+   def self.current_branch()
+      ref = `git symbolic-ref -q HEAD`.strip
+      ref.split('/').last
+   end
+
+   # returns the SHA1 hash that the specified branch or symbol points to
+   def self.branch_hash(branch)
+      `git rev-parse --verify --quiet "#{branch}" 2>/dev/null`.strip
+   end
+
+   # Return formatted string containing:
+   #  commit_hash Authoe Name (relative date)
+   # for the specifeid branch or commit
+   def self.branch_info(branch)
+      # branch info format: hash author (relative date)
+      format = "%h %an %Cgreen(%ar)%Creset"
+      branch_info = `git show -s --pretty="#{format}" #{branch}`.strip
+      simple_branch = branch.sub('origin/', '')
+      sprintf "%-30s %s", simple_branch, branch_info
+   end
+
+   def self.run_safe(command)
+      puts "> #{command}"
+      result = system(command)
+      raise "Git command failed, aborting." if (!result)
+   end
+
+   def self.show_stashes_saved_on(branch = nil)
+      self.stashes.each do |stash|
+         if !branch || stash[:branch] == branch
+            puts "=" * 40
+            puts highlight(
+               "There is a stash saved from #{branch} #{stash[:date]}")
+            puts wrap_text(stash[:subject])
+            puts "see it with >\n git stash show -p " + stash[:ref]
+            puts "apply it with >\n git stash apply " + stash[:ref]
+         end
+      end
+   end
+
+   def self.show_branch_list(options = {})
+      puts "\nCurrent Branch:"
+      puts "--" * 30
+      current = Git::current_branch
+      print HIGHLIGHT
+      if current
+         print Git::branch_info(current)
+      else
+         print "(not on any branch!)"
+      end
+      puts HIGHLIGHT_OFF
+
+      options.each do |branch_type, branches|
+         puts "\nAvailable #{branch_type} branches:"
+         puts "--" * 30
+         if branches && !branches.empty?
+            shown_branches = {}
+            branches.each do |branch|
+               simple_branch = branch.sub('origin/', '')
+               next if shown_branches.has_key?(simple_branch)
+               puts Git::branch_info(branch)
+               shown_branches[simple_branch] = true
+            end
+         else
+            puts "(none)"
+         end
+      end
+   end
+
+   def self.stashes
+      # Do we even have a stash?
+      if ! File.exist? '.git/refs/stash'
+         return []
+      end
+
+      # format = "relative date|stash ref|commit message"
+      `git log --format="%ar|%gd|%s" -g "refs/stash"`.lines.map do |line|
+         fields = line.split '|', 3
+         # All stashes have commit messages like "WIP on branch_name: ..."
+         branch = line[/\S+:/]
+         {
+            :date => fields[0],
+            :ref => fields[1],
+            :branch => branch && branch.chop,
+            :subject =>fields[2]
+         }
+      end
+   end
+
+   def self.switch_branch(branch)
+      self.run_safe("git checkout \"#{branch}\"")
+      self.submodules_update
+      self.run_safe("git clean -ffd") if ARGV.include?('--clean')
+
+      self.show_stashes_saved_on(branch)
+   end
+
+   def self.submodules_update
+      # capture only the path, not the newline
+      basedir = `git rev-parse --show-toplevel`.split("\n").first
+
+      Git::run_safe("cd #{basedir} && git submodule --quiet update --init --rebase --recursive")
+   end
+
+   ##
+   # Returns the commit message from the given commit hash or branch name
+   #
+   def self.commit_message(ref)
+      `git log -1 --format="%B" #{ref}`.strip
+   end
+end

data/lib/github.rb

@@ -0,0 +1,190 @@
+require "rubygems"
+require "bundler/setup"
+require 'octokit'
+require 'shellwords'
+require 'readline'
+require 'highline/import'
+
+module Github
+   ##
+   # Get a global git config property
+   ##
+   def self.config(property)
+      `git config --global #{property.to_s.shellescape}`.strip
+   end
+
+   ##
+   # Get a local (to the repo) git config property
+   ##
+   def self.local_config(property)
+      `git config #{property.to_s.shellescape}`.strip
+   end
+
+   ##
+   # Get an instance of the Octokit API class
+   #
+   # Authorization info is the structure from here:
+   # http://developer.github.com/v3/oauth/#create-a-new-authorization
+   #
+   # something like this:
+   # {
+   #     :scopes => ['repo'],
+   #     :note => "git-scripts command line interface",
+   #     :note_url => "https://github.com/ifixit/git-scripts"
+   # }
+   ##
+   def self.api(authorization_info = {})
+      # Defaults
+      authorization_info = {
+         :scopes => ['repo'],
+         :note => "ifixit git-scripts command line interface",
+         :note_url => "https://github.com/ifixit/git-scripts"
+      }.merge(authorization_info)
+      OctokitWrapper.new(self::get_authentication(authorization_info))
+   end
+
+   def self.get_authentication(authorization_info)
+      username = self::config("github.user")
+      token    = self::config("github.token")
+      if !username.empty? && !token.empty?
+         return {:login => username, :oauth_token => token}
+      else
+         return self::request_authorization(authorization_info)
+      end
+   end
+
+   ##
+   # Returns a hash containing username and github oauth token
+   #
+   # Prompts the user for credentials if the token isn't stored in git config
+   ##
+   def self.request_authorization(authorization_info)
+      puts "Authorizing..."
+
+      username ||= Readline.readline("github username: ", true)
+      password   = ask("github password: ") { |q| q.echo = false }
+
+      octokit = OctokitWrapper.new(:login => username, :password => password)
+
+      auth = octokit.authorizations.find {|auth|
+         note = auth['note']
+         note && note.include?(authorization_info[:note])
+      }
+
+      auth = auth || octokit.create_authorization(authorization_info)
+
+      success = 
+         system("git config --global github.user #{username}") &&
+         system("git config --global github.token #{auth[:token]}")
+
+      if !success
+         puts "Couldn't set git config"
+         exit
+      end
+
+      return {:login => username, :oauth_token => auth[:token]}
+   end
+
+   ##
+   # Returns the github repo identifier in the form that the API likes:
+   # "someuser/theirrepo"
+   #
+   # Requires the "origin" remote to be set to a github url
+   ##
+   def self.get_github_repo()
+      url = self::local_config("remote.origin.url")
+      m = /github\.com.(.*?)\/(.*)/.match(url)
+      if m
+        return [m[1], m[2].sub(/\.git\Z/, "")].join("/")
+      else
+         raise "remote.origin.url in git config but be a github url"
+      end
+   end
+
+   ##
+   # Prompts the user (using $EDITOR) to provide a title and body
+   # for this pull-request
+   #
+   # Returns a hash containing a :title and :body
+   ##
+   def self.get_pull_request_description(branch_name = nil)
+      require 'tempfile'
+
+      if branch_name
+         initial_message = Git::commit_message(branch_name).gsub("\r","")
+      else
+         initial_message = <<-MESSAGE
+Title of pull-request
+#  Second line is ignored (do no edit)
+Body of pull-request
+         MESSAGE
+      end
+
+      msg = Tempfile.new('pull-message')
+      msg.write(initial_message)
+      msg.close
+
+      # -c blah only works for vim
+      if (ENV['EDITOR'].include?('vim'))
+         opts = "-c \":set filetype=gitcommit\""
+      else
+         opts = ""
+      end
+
+      system("$EDITOR #{opts} #{msg.path.shellescape}")
+      full_message = File.open(msg.path, "r").read
+      lines = full_message.split("\n")
+      lines = lines.reject {|line| line =~ /^\s*#/ }
+      title = lines.shift
+      body  = lines.join("\n").strip
+
+      if title.empty? || body.empty?
+         puts "You must provide a title and a body:\n"
+         puts title
+         puts
+         puts body
+         exit 1
+      end
+
+      return {
+         :title => title,
+         :body => body
+      }
+   end
+
+   def self.get_pull_request_description_from_api(branch_name, into_branch)
+      octokit = Github::api
+      # Should succeed if authentication is setup.
+      pulls = octokit.pulls(Github::get_github_repo)
+      pull = pulls.find {|pull| branch_name == pull[:head][:ref] }
+
+      if pull
+         return <<-MSG
+Merge #{branch_name} (##{pull[:number]}) into #{into_branch}
+
+#{pull[:title].gsub("\r", '')}
+
+#{pull[:body].gsub("\r", '')}
+      MSG
+      else
+         return "Merge #{branch_name} into #{into_branch}"
+      end
+   end
+end
+
+class OctokitWrapper
+   def initialize(*args)
+      @client = Octokit::Client.new(*args)
+   end
+
+   def method_missing(meth,*args)
+      begin
+         return @client.send(meth,*args)
+      rescue Octokit::Error => e
+         $stderr.puts "=" * 80
+         $stderr.puts "Github API Error"
+         $stderr.puts e
+         exit(1)
+      end
+   end
+end

data/lib/helpers.rb

@@ -0,0 +1,137 @@
+HIGHLIGHT="\033[31m"
+HIGHLIGHT_OFF="\033[0m"
+
+def fail_on_local_changes
+   if Git::has_uncommitted_changes
+      die "Cannot perform this action with a dirty working tree, " +
+          "please stash your changes with 'git stash save \"Some message\"'."
+   end
+end
+
+def display_feature_help(command = nil, message = nil)
+   display_help(
+      :script_name => "Git Feature Branch Helper",
+      :commands => {
+         :list    => "feature list",
+         :start   => "feature start name-of-feature",
+         :switch  => "feature switch name-of-feature [--clean]",
+         :finish  => "feature finish name-of-feature",
+         :merge   => "feature merge [name-of-feature]",
+         :pull    => "feature pull",
+         :status  => "feature status",
+         :stashes => "feature stashes [-v]",
+         :clean   => "feature clean [--all]",
+         :'github-test' => "feature github-test"
+      },
+      :command_name => 'feature',
+      :command => command,
+      :message => message
+   )
+end
+
+def display_hotfix_help(command = nil, message = nil)
+   display_help(
+      :script_name => "Git Hotfix Helper",
+      :commands => {
+         :list    => "hotfix list",
+         :start   => "hotfix start name-of-hotfix",
+         :switch  => "hotfix switch name-of-hotfix",
+         :finish  => "hotfix finish [name-of-hotfix]",
+         :merge   => "hotfix merge [name-of-hotfix]"
+      },
+      :command_name => 'hotfix',
+      :command => command,
+      :message => message
+   )
+end
+
+def display_help(args)
+   command = args[:command]
+   message = args[:message]
+   script_name = args[:script_name]
+
+   highlighted_commands = args[:commands].map do |name, desc|
+      help_line = "    #{name.to_s.ljust(8)} #{desc}"
+
+      if name == command
+         HIGHLIGHT + help_line + HIGHLIGHT_OFF
+      else
+         help_line
+      end
+   end
+
+   if message
+      puts HIGHLIGHT + "Error: " + HIGHLIGHT_OFF + message
+      puts
+      puts
+   end
+
+   die <<HELP
+#{script_name}
+
+usage:
+#{highlighted_commands.join("\n")}
+
+arguments:
+   name-of-#{args[:command_name]}: letters, numbers, and dashes
+
+Look at the source to discover what each of these commands does.
+
+HELP
+end
+
+
+# prints out an error and the approprite help if there is not exactly one
+# commandline argument
+def require_argument(program, command = nil, min = 2, max = 2)
+   help = lambda do |msg|
+      if program == :hotfix
+         display_hotfix_help(command, msg)
+      else
+         display_feature_help(command, msg)
+      end
+   end
+
+   if (ARGV.length > max)
+      help.call "Too many arguments. This command accepts only one argument."
+   end
+
+   if (ARGV.length < min)
+      help.call "Missing argument. This command requires exactly one argument."
+   end
+
+   if (ARGV.last !~ /^[a-zA-z0-9-]+$/)
+      help.call "Invalid branch name: '#{ARGV.last}'"
+   end
+end
+
+##
+# Repeatedly prints out a y/n question until a y or n is input
+def confirm(question)
+   loop do
+      print(question)
+      print(" (y/n):")
+      STDOUT.flush
+      s = STDIN.gets
+      exit if s == nil
+      s.chomp!
+
+      return true if s == 'y'
+      return false if s == 'n'
+   end
+end
+
+def die(message = nil)
+   puts wrap_text(message) if message
+   exit 1
+end
+
+def highlight(str)
+   return HIGHLIGHT + str + HIGHLIGHT_OFF;
+end
+
+def wrap_text(txt, col = 80)
+   txt.gsub(
+    /(.{1,#{col}})(?: +|$)\n?|(.{#{col}})/,
+    "\\1\\3\n")
+end

data/man/feature-clean.1

@@ -0,0 +1,28 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "FEATURE\-CLEAN" "1" "February 2013" "iFixit" ""
+.
+.SH "NAME"
+\fBfeature\-clean\fR \- Remove untracked files and submodules\.
+.
+.SH "SYNOPSIS"
+\fBfeature clean\fR [\-\-all]
+.
+.SH "DESCRIPTION"
+Remove untracked files and submodules\.
+.
+.P
+Compatible with hotfix branches\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-clean\fR
+Remove all untracked \.gitignored files as well\.
+.
+.SH "COPYRIGHT"
+Copyright (c) 2012\-2013 iFixit\.
+.
+.SH "SEE ALSO"
+feature(1)

data/man/feature-clean.1.html

@@ -0,0 +1,115 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>feature-clean(1) - Remove untracked files and submodules.</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+  <style type='text/css' media='all'>
+  /* style: toc */
+  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
+  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
+  .man-navigation a:hover {color:#111;text-decoration:underline}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#COPYRIGHT">COPYRIGHT</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>feature-clean(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>feature-clean(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>feature-clean</code> - <span class="man-whatis">Remove untracked files and submodules.</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>feature clean</code> [--all]</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Remove untracked files and submodules.</p>
+
+<p>Compatible with hotfix branches.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<dl>
+<dt> <code>--clean</code></dt><dd>  Remove all untracked .gitignored files as well.</dd>
+</dl>
+
+
+<h2 id="COPYRIGHT">COPYRIGHT</h2>
+
+<p>Copyright (c) 2012-2013 iFixit.</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><a class="man-ref" href="feature.1.html">feature<span class="s">(1)</span></a></p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'>iFixit</li>
+    <li class='tc'>February 2013</li>
+    <li class='tr'>feature-clean(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/feature-clean.1.markdown

@@ -0,0 +1,53 @@
+feature-clean(1) - Remove untracked files and submodules.
+=========================================================
+
+## SYNOPSIS
+
+`feature clean` [--all]
+
+## DESCRIPTION
+
+Remove untracked files and submodules.
+
+Compatible with hotfix branches.
+
+## OPTIONS
+
+   * `--clean`:
+      Remove all untracked .gitignored files as well.
+
+## COPYRIGHT
+
+Copyright (c) 2012-2013 iFixit.
+
+## SEE ALSO
+
+feature(1)
+
+
+
+[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
+[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
+[OPTIONS]: #OPTIONS "OPTIONS"
+[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
+[SEE ALSO]: #SEE-ALSO "SEE ALSO"
+
+
+[feature(1)]: feature.1.html
+[feature-list(1)]: feature-list.1.html
+[feature-start(1)]: feature-start.1.html
+[feature-switch(1)]: feature-switch.1.html
+[feature-finish(1)]: feature-finish.1.html
+[feature-merge(1)]: feature-merge.1.html
+[feature-pull(1)]: feature-pull.1.html
+[feature-status(1)]: feature-status.1.html
+[feature-stashes(1)]: feature-stashes.1.html
+[feature-clean(1)]: feature-clean.1.html
+[feature-github-test(1)]: feature-github-test.1.html
+[hotfix(1)]: hotfix.1.html
+[hotfix-list(1)]: hotfix-list.1.html
+[hotfix-start(1)]: hotfix-start.1.html
+[hotfix-switch(1)]: hotfix-switch.1.html
+[hotfix-finish(1)]: hotfix-finish.1.html
+[hotfix-merge(1)]: hotfix-merge.1.html
+[git(1)]: https://www.kernel.org/pub/software/scm/git/docs/