git-scripts 0.2.0 → 0.3.0

data/README.md

@@ -124,18 +124,3 @@ Merges the hotfix branch back into `stable` with `--no-ff`. Also does a
 merge back into `master`.
 
 [gitflow]: http://nvie.com/posts/a-successful-git-branching-model/
-
-## Hacking
-
-We (obviously) use the same method on this repo as the tools contained within
-encourage.  Unfortunately, `feature finish` will create a pull request within
-your own forked repo.  Thus, if you do not have write privileges to this
-repository, you have to create the pull request manually - bummer.
-
-Please include any necessary changes to the documentation.  The man files are
-written in [ronn], so the only manual change you need make are to the
-man/*.ronn files.  After you've done that, run `rake man` to generate the HTML
-and roff files.
-
-[ronn]: http://rtomayko.github.io/ronn/ronn-format.7.html
-

data/bin/feature

@@ -8,6 +8,12 @@ command=ARGV.first
 
 $0 = ARGV.join(" ")
 
+unless command == '--help' or command == '-h'
+   unless Git::in_a_repo
+      die("\nSwitch to a git repo. If you need help, use --help or -h.")
+   end
+end
+
 case command
 when 'github-test'
    octokit = Github::api
@@ -99,20 +105,70 @@ when 'finish'
    puts "Successfully created pull-request ##{response[:number]}"
    puts "   " + response[:html_url]
 
+when 'finish-issue'
+   require_argument(:feature, :'finish-issue')
+   issue = ARGV[1]
+   feature = Git::current_branch
+   # Push commits to origin
+   Git::run_safe(["git push origin #{feature}:#{feature}"])
+
+   exit 1 unless confirm("Convert issue ##{issue} into a pull-request using " +
+    "feature branch named '#{feature}' ?")
+   octokit = Github::api
+
+   pull = octokit.create_pull_request_for_issue(
+      Github::get_github_repo,
+      Git::development_branch,
+      feature,
+      issue
+   )
+
+   # We've converted the issue to a pull request, now lets change the
+   # description to include the last commit message and prompt the user to
+   # confirm it.
+
+   last_commit_message = Git::commit_message(feature)
+
+   original_title = pull[:title].gsub("\r","")
+   original_body = pull[:body].gsub("\r","")
+
+   initial_message = <<-MESSAGE
+#{last_commit_message}
+
+----
+
+Original issue: #{original_title}
+----
+
+#{original_body}
+   MESSAGE
+
+   description = Github::open_title_body_editor(initial_message)
+
+   updated_pull = octokit.update_pull_request(
+      Github::get_github_repo,
+      issue,
+      description[:title],
+      description[:body]
+   )
+
+   puts "Successfully converted issue ##{issue} to a pull-request"
+   puts "   " + updated_pull[:html_url]
+
 when 'merge'
    dev_branch = Git::development_branch
    fail_on_local_changes
 
-   Git::run_safe(["git fetch"])
-
    feature = ARGV[1] || Git::current_branch
 
    exit 1 unless confirm("Merge feature branch named: '#{feature}' ?")
 
    description = Github::get_pull_request_description_from_api(feature, dev_branch)
+   update = Git::submodules_update("get")
 
-   # Checkout the branch first to make sure we have it locally.
    Git::run_safe([
+      "git fetch",
+      # Checkout the branch first to make sure we have it locally.
       "git checkout \"#{feature}\"",
       "git rebase --preserve-merges origin/#{feature}",
       # pull the latest changes from master
@@ -121,19 +177,12 @@ when 'merge'
       "git rebase --preserve-merges origin/#{dev_branch}",
       # merge the feature branch into master
       "git merge --no-ff --edit -m #{description.shellescape} \"#{feature}\"",
+      # init any submodules in the master branch
+      "#{update}",
+      # delete the local feature-branch
+      "git branch -d \"#{feature}\""
    ])
 
-   # init any submodules in the master branch
-   Git::submodules_update
-
-   # delete the local feature-branch
-   Git::run_safe(["git branch -d \"#{feature}\""])
-
-   # delete the remote branch we'll leave this off for now
-   # Git::run_safe("git push origin :\"#{feature}\"")
-   # push the the merge to our origin
-   # Git::run_safe("git push origin")
-
    puts
    puts "Successfully merged feature-branch: #{feature} into #{dev_branch}"
    puts "If you are satisfied with the result, do this:\n" + <<CMDS
@@ -141,9 +190,15 @@ when 'merge'
 CMDS
 
 when 'switch'
-   require_argument(:feature, :switch, min=2, max=3)
+
+   require_argument(:feature, :switch, min=2, max=4)
+
    feature = ARGV[1]
 
+   if ARGV[1] == '-n'
+       feature = get_branch_name_from_number(ARGV[2])
+   end
+
    Git::switch_branch(feature)
 
 when 'prune'

data/bin/hotfix

@@ -8,6 +8,12 @@ command=ARGV.first
 
 $0 = ARGV.join(" ")
 
+unless command == '--help' or command == '-h'
+   unless Git::in_a_repo
+      die("\nSwitch to a git repo. If you need help, use --help or -h.")
+   end
+end
+
 case command
 when 'start'
    require_argument(:hotfix, :start)
@@ -63,6 +69,57 @@ when 'finish'
    puts "Successfully created pull-request ##{response[:number]}"
    puts "   " + response[:html_url]
 
+when 'finish-issue'
+   require_argument(:hotfix, :'finish-issue')
+   issue = ARGV[1]
+   hotfix = Git::current_branch
+
+   # Push commits to origin
+   Git::run_safe(["git push origin #{hotfix}:#{hotfix}"])
+
+   exit 1 unless confirm("Convert issue ##{issue} into a pull-request using " +
+    "hotfix branch named '#{hotfix}' ?")
+   octokit = Github::api
+
+   pull = octokit.create_pull_request_for_issue(
+      Github::get_github_repo,
+      'stable',
+      hotfix,
+      issue
+   )
+
+   # We've converted the issue to a pull request, now lets change the
+   # description to include the last commit message and prompt the user to
+   # confirm it.
+
+   last_commit_message = Git::commit_message(hotfix)
+
+   original_title = pull[:title].gsub("\r","")
+   original_body = pull[:body].gsub("\r","")
+
+   initial_message = <<-MESSAGE
+#{last_commit_message}
+
+----
+
+Original issue: #{original_title}
+----
+
+#{original_body}
+   MESSAGE
+
+   description = Github::open_title_body_editor(initial_message)
+
+   updated_pull = octokit.update_pull_request(
+      Github::get_github_repo,
+      issue,
+      description[:title],
+      description[:body]
+   )
+
+   puts "Successfully converted issue ##{issue} to a pull-request"
+   puts "   " + updated_pull[:html_url]
+
 when 'merge'
    fail_on_local_changes
    dev_branch = Git::development_branch
@@ -73,40 +130,38 @@ when 'merge'
    exit 1 unless confirm("Merge hotfix named: '#{hotfix}' ?")
 
    description = Github::get_pull_request_description_from_api(hotfix, 'stable')
-   descriptionDev = Github::get_pull_request_description_from_api(hotfix, dev_branch)
-   # init any submodules in the stable branch
+
+   commit_message = Git::get_description_from_user(description)
+   # The first instance of stable should be in the pull request title.
+   dev_commit_message = commit_message.sub('stable', dev_branch)
+
+   # Get command to init any submodules in the stable branch.
    update = Git::submodules_update("get")
 
    Git::run_safe([
       # Checkout the branch to make sure we have it locally.
-      "git checkout \"#{hotfix}\"",
-      "git rebase --preserve-merges origin/#{hotfix}",
-      # Merge into stable
+      "git checkout #{hotfix.shellescape}",
+      "git rebase --preserve-merges origin/#{hotfix.shellescape}",
+      # Merge into stable.
       "git checkout stable",
-      # pull the latest changes and rebase the unpushed commits if any.
+      # Pull the latest changes and rebase the unpushed commits if any.
       "git rebase --preserve-merges origin/stable",
-      # merge the hotfix branch into stable
-      "git merge --no-ff --edit -m #{description.shellescape} \"#{hotfix}\"",
+      # Merge the hotfix branch into stable.
+      "git merge --no-ff --no-edit -m #{commit_message.shellescape} #{hotfix.shellescape}",
       "#{update}",
-      # push the the merge to our origin
-      # Git::run_safe("git push origin")
-      # Merge into master
+      # Merge into master.
       "git checkout #{dev_branch}",
-      # pull the latest changes and rebase the unpushed master commits if any.
+      # Pull the latest changes and rebase the unpushed master commits if any.
       "git rebase origin/#{dev_branch}",
-      # merge the hotfix branch into master
-      "git merge --no-ff --edit -m #{descriptionDev.shellescape} \"#{hotfix}\"",
-      # init any submodules in the master branch. Note: no need to change
+      # Merge the hotfix branch into master.
+      "git merge --no-ff --no-edit -m #{dev_commit_message.shellescape} #{hotfix.shellescape}",
+      # Init any submodules in the master branch. Note: no need to change
       # directories before calling git submodule since we are already in the
-      # projects top-level directory
+      # projects top-level directory.
       "#{update}",
-      # push the the merge to our origin
-      # Git::run_safe("git push origin")
-      # delete the local hotfix branch
-      "git branch -d \"#{hotfix}\"",
-      # delete the remote hotfix branch -- we'll leave this off for now
-      # Git::run_safe("git push origin :\"#{hotfix}\"")
-      # checkout stable branch
+      # Delete the local hotfix branch.
+      "git branch -d #{hotfix.shellescape}",
+      # Checkout stable branch.
       "git checkout stable"
    ])
 

data/completion/_feature

@@ -0,0 +1,38 @@
+#compdef feature
+
+_feature() {
+   local curcontext="$curcontext" state line
+   typeset -A opt_args
+
+   _arguments \
+      '1: :->commands'\
+      '2: :->params'\
+      '3: :->choice'
+
+   case $state in
+      commands)
+         _arguments '1:Commands:(list start switch finish finish-issue merge pull prune status stashes clean github-test)'
+      ;;
+      params)
+         if [[ "$words[2]" == "prune" ]]; then
+            _arguments '2:Location:(local origin)'
+         fi
+         if [[ "$words[2]" == "switch" ||
+               "$words[2]" == "merge"  ||
+               "$words[2]" == "finish" ]]; then
+           local -a featureBranches args
+           featureBranches="$(git branch -a | tr -d ' *' | grep -v 'hotfix-' | sed 's|remotes/origin/||')"
+           args="$(echo ${featureBranches} | tr "\$\'\\n\'" " ")"
+           _arguments '2:Branches:($(echo ${args}))'
+         fi
+      ;;
+      choice)
+         if [[ "$words[3]" == "local" || "$words[3]" == "origin" ]]; then
+            _arguments '3:Commands:(preview clean)'
+         fi
+      ;;
+      *)
+   esac
+}
+
+_feature "$@"

data/completion/_hotfix

@@ -0,0 +1,28 @@
+#compdef hotfix
+
+_hotfix() {
+   local curcontext="$curcontext" state line
+   typeset -A opt_args
+
+   _arguments \
+      '1: :->commands'\
+      '2: :->params'
+   case $state in
+      commands)
+         _arguments '1:Commands:(list start switch finish finish-issue merge)'
+      ;;
+   params)
+      if [[ "$words[2]" != 'list' ||
+            "$words[2]" != 'finish-issue' ]]; then
+         local -a hotfixBranches args
+         hotfixBranches="$(git branch -a | tr -d ' *' | grep 'hotfix-' | sed -e 's|remotes/origin/||' -e 's|hotfix-||')"
+
+         args="$(echo ${hotfixBranches} | tr "\$\'\\n\'" " ")"
+         _arguments '2:Branches:($(echo ${args}))'
+      fi
+      ;;
+      *)
+   esac
+}
+
+_hotfix "$@"

data/{bash_completion.sh → completion/bash_completion.sh}

@@ -10,7 +10,7 @@ _git-scripts()
    case "$cmd" in
    feature)
       if [ "$line" = "$cmd $cur" ]; then
-         words="switch start finish stashes list merge pull status clean"
+         words="switch start finish finish-issue stashes list merge pull status clean prune"
       else
          # get branch names minus hotfixes
          words="$(git branch -a | tr -d ' *' | grep -v 'hotfix-' | sed 's|remotes/origin/||')"
@@ -18,7 +18,7 @@ _git-scripts()
       ;;
    hotfix)
       if [ "$line" = "$cmd $cur" ]; then
-         words="switch start finish merge list clean"
+         words="switch start finish finish-issue merge list clean"
       else
          # get hotfix branch names
          words="$(git branch -a | tr -d ' *' | grep 'hotfix-' | sed -e 's|remotes/origin/||' -e 's|hotfix-||')"

data/lib/git.rb

@@ -4,18 +4,57 @@ module Git
       return !clean
    end
 
+   def self.in_a_repo
+      return system("git rev-parse")
+   end
+
    # Return the development branch specified by the
    # feature.development-branch git config value
    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;
+         die("No development branch specified; set it with: " +
+          "git config feature.development-branch master")
       end
       dev_branch
    end
 
+   # Returns the editor specified in the user's gitconfig.
+   def self.editor
+      editor = `git var GIT_EDITOR`.strip
+      unless editor
+         abort "Configure an editor for git:\n" +
+               "git config --global core.editor vim"
+      end
+      return editor
+   end
+
+   # Starts an editor with a file. Returns a string with the contents of that
+   # file.
+   def self.get_description_from_user(initial_message = '')
+      require 'tempfile'
+      editor = self::editor
+
+      file = Tempfile.new('merge-msg')
+      file.print(initial_message)
+      file.flush
+
+      if editor == 'vim'
+         params = "'+set ft=gitcommit' '+set textwidth=72'" +
+          " '+setlocal spell spelllang=en_us'"
+      else
+         params = ''
+      end
+      pid = spawn("#{editor} #{params} #{file.path}")
+      Process.wait pid
+
+      file.rewind
+      commit = file.read
+      file.unlink
+
+      return commit
+   end
+
    # Returns an array of branches that aren't merged into the specified branch
    def self.branches_not_merged_into(branch)
       self::all_branches - self::merged_branches(branch)
@@ -27,6 +66,8 @@ module Git
          self.branches_not_merged_into('stable')
       elsif type == :merged
          self.merged_branches('stable')
+      else
+         raise ArgumentError, 'Must specify :merged or :unmerged in hotfix_branches.'
       end
 
       branches.select {|branch| branch.include?('hotfix-') }
@@ -34,10 +75,14 @@ module Git
 
    # Returns an array of unmerged feature branches
    def self.feature_branches(type)
+      devBranch = development_branch()
+
       branches = if type == :unmerged
-         self.branches_not_merged_into('master')
+         self.branches_not_merged_into(devBranch)
       elsif type == :merged
-         self.merged_branches('master')
+         self.merged_branches(devBranch)
+      else
+         raise ArgumentError, 'Must specify :merged or :unmerged in feature_branches.'
       end
 
       branches.reject {|branch| branch.include?('hotfix-') }
@@ -88,12 +133,12 @@ module Git
       while command = commands.shift
          puts "> " + command
          unless system(command)
-            puts "\tFailed on \`#{command}\`"
-            puts "\tWould have run:"
-            commands.each do |a|
-               puts "\t" + a
-            exit
+            puts highlight("\n\tERROR: failed on \`#{command}\`.")
+            puts "\n\tWould have run:"
+            commands.each do |command|
+               puts "\t# " + command
             end
+            abort
          end
       end
    end
@@ -163,7 +208,7 @@ module Git
    ##
    # Switch to the specified branch.
    # Because we use submodules, we have to check for updates to those
-   # submodules when we checkout a branch 
+   # submodules when we checkout a branch.
    #
    # args: --clean - remove every unstaged file, including non-existant
    # submodules
@@ -177,9 +222,10 @@ module Git
    end
 
    ##
-   # Update / initialize submodules from the TLD
+   # Update / initialize submodules from the TLD or return the command that
+   # would do so as a string.
    #
-   def self.submodules_update(mode = nil)
+   def self.submodules_update(mode = "")
       # capture only the path, not the newline
       basedir = `git rev-parse --show-toplevel`.split("\n").first
       command = "cd #{basedir} && git submodule --quiet update --init --recursive"

data/lib/github.rb

@@ -78,8 +78,7 @@ module Github
          system("git config --global github.token #{auth[:token]}")
 
       unless success
-         puts "Couldn't set git config"
-         exit
+         die("Couldn't set git config")
       end
 
       return {:login => username, :oauth_token => auth[:token]}
@@ -108,8 +107,6 @@ module Github
    # 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
@@ -120,8 +117,20 @@ Body of pull-request
          MESSAGE
       end
 
+      return self::open_title_body_editor(initial_message)
+   end
+
+   ##
+   # Prompts the user (using $EDITOR) to confirm the title and body
+   # in the provided message.
+   #
+   # Returns a hash containing a :title and :body
+   ##
+   def self.open_title_body_editor(message)
+      require 'tempfile'
+
       msg = Tempfile.new('pull-message')
-      msg.write(initial_message)
+      msg.write(message)
       msg.close
 
       # -c blah only works for vim
@@ -181,10 +190,7 @@ class OctokitWrapper
       begin
          return @client.send(meth,*args)
       rescue Octokit::Error => e
-         $stderr.puts "=" * 80
-         $stderr.puts "Github API Error"
-         $stderr.puts e
-         exit(1)
+         die("=" * 80 + "\nGithub API Error\n" + e.to_s)
       end
    end
 end

data/lib/helpers.rb

@@ -12,10 +12,11 @@ def display_feature_help(command = nil, message = nil)
    display_help(
       :script_name => "Git Feature Branch Helper",
       :commands => {
-         :list    => "feature list",
+         :list    => "feature list [-v]",
          :start   => "feature start name-of-feature",
-         :switch  => "feature switch name-of-feature [--clean]",
-         :finish  => "feature finish name-of-feature",
+         :switch  => "feature switch (name-of-feature | -n number-of-feature) [--clean]",
+         :finish  => "feature finish [name-of-feature]",
+         :'finish-issue'  => "feature finish-issue issue-number",
          :merge   => "feature merge [name-of-feature]",
          :pull    => "feature pull",
          :prune   => "feature prune <local | origin> <preview | clean>",
@@ -34,10 +35,11 @@ def display_hotfix_help(command = nil, message = nil)
    display_help(
       :script_name => "Git Hotfix Helper",
       :commands => {
-         :list    => "hotfix list",
+         :list    => "hotfix list [-v]",
          :start   => "hotfix start name-of-hotfix",
-         :switch  => "hotfix switch name-of-hotfix",
+         :switch  => "hotfix switch (name-of-hotfix | -n number-of-hotfix)",
          :finish  => "hotfix finish [name-of-hotfix]",
+         :'finish-issue'  => "hotfix finish-issue issue-number",
          :merge   => "hotfix merge [name-of-hotfix]"
       },
       :command_name => 'hotfix',
@@ -113,7 +115,7 @@ end
 def confirm(question)
    loop do
       print(question)
-      print(" (y/n):")
+      print(" (y/n): ")
       STDOUT.flush
       s = STDIN.gets
       exit if s == nil
@@ -124,13 +126,18 @@ def confirm(question)
    end
 end
 
-def die(message = nil)
-   puts wrap_text(message) if message
-   exit 1
+def die(message = '')
+   abort wrap_text(message)
 end
 
 def highlight(str)
-   return HIGHLIGHT + str + HIGHLIGHT_OFF;
+   return HIGHLIGHT + str + HIGHLIGHT_OFF
+end
+
+def get_branch_name_from_number(num)
+   octokit = Github::api
+
+   return octokit.pull_request(Github::get_github_repo, num).head.ref
 end
 
 def hotfix_branch(name)
@@ -142,7 +149,9 @@ def hotfix_branch(name)
 end
 
 def current_hotfix_branch()
-   if ARGV[1]
+   if ARGV[1] == '-n'
+      branch = get_branch_name_from_number(ARGV[2])
+   elsif ARGV[1]
       branch = hotfix_branch(ARGV[1])
    else
       branch = Git::current_branch

data/man/feature-finish-issue.1

@@ -0,0 +1,22 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "FEATURE\-FINISH\-ISSUE" "1" "August 2013" "iFixit" ""
+.
+.SH "NAME"
+\fBfeature\-finish\-issue\fR \- Finish this feature branch and attach it to an issue\.
+.
+.SH "SYNOPSIS"
+\fBfeature finish\fR \fIissue\-number\fR
+.
+.SH "DESCRIPTION"
+Finish the current feature branch and optionally convert an existing issue into a pull request\. The pull\'s description defaults to the commit message from the last commit on the branch with the issue\'s original title and description underneath\.
+.
+.SH "COPYRIGHT"
+Copyright (c) 2012\-2013 iFixit\.
+.
+.SH "SEE ALSO"
+feature(1), feature\-finish(1), hotfix\-finish(1), hotfix\-finish\-issue(1)
+.
+.SH "WWW"
+https://github\.com/iFixit/git\-scripts

data/man/feature-finish-issue.1.ronn

@@ -0,0 +1,26 @@
+feature-finish-issue(1) - Finish this feature branch and attach it to an issue.
+===============================================
+
+## SYNOPSIS
+
+`feature finish` <issue-number>
+
+## DESCRIPTION
+
+Finish the current feature branch and optionally convert an existing issue
+into a pull request.  The pull's description defaults to the commit message
+from the last commit on the branch with the issue's original title and
+description underneath.
+
+## COPYRIGHT
+
+Copyright (c) 2012-2013 iFixit.
+
+## SEE ALSO
+
+feature(1), feature-finish(1), hotfix-finish(1), hotfix-finish-issue(1)
+
+## WWW
+
+https://github.com/iFixit/git-scripts
+