git-scripts 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a2d6d6518dbc7ecc8f65e1d05f2d726198bbd74
-  data.tar.gz: 676e53c8cc96c98d13745280205c74108d7aa281
+  metadata.gz: af70a37bea46ed2bb2c96555972ca8a4be70a0a2
+  data.tar.gz: c9398a71ddcfb1b623c12fbf08db5ffabb465fa1
 SHA512:
-  metadata.gz: 4d8177e27268f8eb876a17936a196364c7bb633c2ded649e4a715fa22fd6a8d8f6895e7dbe8d57122f03bab8d1ff75291bb46744b0ede02568fa1766c80efeab
-  data.tar.gz: 05cb8fd81e03130a108f45be0d1802cbc5d1bf2ef5faf2250958f2714a87c69a8f3f8c05838cbef976fc727c6cd2b5d9615394cd99f6ad4ace0bc6b9ade6c5d9
+  metadata.gz: b3a9bc18372e11269d784c3f60ddced3853e286ee4bf13ae4586f08ce17831098f5f00b6039f8b94294871c89fcab912991f462cd76126bd4da1e2532f59feb8
+  data.tar.gz: fb056a372806a58a188d6e6418486d71903f3c3d9372dbcf30109c9741f32ee8ce08b9e45c085b38f8c94c88fff0ce374360c3c302197d67c5d11a6289830c19

data/README.md

@@ -124,3 +124,11 @@ 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/
+
+## Plugins
+
+Any files matching `plugins/*.rb` will be loaded as plugins. The plugin
+architecture is *very* simple. There are a few hooks scattered over the
+code-base of the form: `Plugins.invoke :before_start, :feature`. If a plugin
+has a method of the same name `before_start` it will be called, passing along
+any arguments passed to `Plugins.invoke`.

data/bin/feature

@@ -3,6 +3,7 @@ require_relative '../lib/signal_handlers.rb'
 require_relative '../lib/github.rb'
 require_relative '../lib/git.rb'
 require_relative '../lib/helpers.rb'
+require_relative '../lib/plugins.rb'
 
 command=ARGV.first
 
@@ -16,21 +17,22 @@ end
 
 case command
 when 'github-test'
-   octokit = Github::api
    # Should succeed if authentication is setup.
-   octokit.pulls(Github::get_github_repo)
+   Github.pulls
    puts "[Successfully Authenticated]"
 
 when 'start'
    require_argument(:feature, :start)
    feature = ARGV[1]
 
-   exit unless confirm("Create feature branch named: '#{feature}' ?")
    development_branch = Git::get_branch('development')
 
+   Plugins.invoke :before_start, :feature, feature
+
    Git::run_safe([
       "git checkout #{development_branch}",
-      "git pull --rebase",
+      "git fetch",
+      "git rebase --preserve-merges origin/#{development_branch}",
       "git branch \"#{feature}\" #{development_branch}",
       "git checkout \"#{feature}\"",
    ])
@@ -83,12 +85,19 @@ when 'status'
 
 when 'finish'
    feature = ARGV[1] || Git::current_branch
+
+   if is_hotfix_branch feature
+      abort "This is a hotfix branch.  Please use hotfix-finish."
+   end
+
    # Push commits to origin
    Git::run_safe(["git push origin #{feature}:#{feature}"])
 
    exit 1 unless confirm("Create a pull-request for feature branch named: '#{feature}' ?")
    octokit = Github::api
 
+   Plugins.invoke :before_finish, :feature, feature
+
    description = Github::get_pull_request_description(feature)
    puts "Pull-request description:"
    puts description[:title]
@@ -103,6 +112,7 @@ when 'finish'
       description[:body]
    )
 
+   Plugins.invoke :after_finish, :feature, feature, response
    puts "Successfully created pull-request ##{response[:number]}"
    puts "   " + response[:html_url]
 
@@ -110,6 +120,11 @@ when 'finish-issue'
    require_argument(:feature, :'finish-issue')
    issue = ARGV[1]
    feature = Git::current_branch
+
+   if is_hotfix_branch feature
+      abort "This is a hotfix branch.  Please use hotfix-finish-issue."
+   end
+
    # Push commits to origin
    Git::run_safe(["git push origin #{feature}:#{feature}"])
 
@@ -166,6 +181,9 @@ when 'merge'
       feature = ARGV[1] || Git::current_branch
    end
 
+   if is_hotfix_branch feature
+      exit 1 unless confirm("It looks like this is a hotfix branch.  Are you sure you want to merge it into only #{dev_branch}?")
+   end
 
    pull_info = Github::get_pull_request_info_from_api(feature, dev_branch)
 
@@ -174,6 +192,8 @@ when 'merge'
       puts highlight(warning)
    end
 
+   Plugins.invoke :before_merge, :feature, feature
+
    exit 1 unless confirm("Merge feature branch named: '#{feature}' ?")
 
    update = Git::submodules_update("get")
@@ -195,6 +215,8 @@ when 'merge'
       "git branch -d \"#{feature}\""
    ])
 
+   Plugins.invoke :after_merge, :feature, feature
+
    puts
    puts "Successfully merged feature-branch: #{feature} into #{dev_branch}"
    puts "If you are satisfied with the result, do this:\n" + <<CMDS
@@ -203,7 +225,7 @@ CMDS
 
 when 'switch'
 
-   require_argument(:feature, :switch, min=2, max=4)
+   require_argument(:feature, :switch, min=2, max=5)
 
    feature = ARGV[1]
 
@@ -213,6 +235,20 @@ when 'switch'
 
    Git::switch_branch(feature)
 
+   optional_pull
+
+when 'url'
+   require_argument(:feature, :url, min=1, max=2)
+   feature = ARGV[1] || Git::current_branch
+
+   url = Github::get_url(feature)
+   if url
+      puts url
+   else
+      abort "There is no pull request available for #{feature}.\n" +
+            'You can make one by using `feature finish`.'
+   end
+
 when 'prune'
    require_argument(:feature, :prune, min=3, max=3)
    location = ARGV[1]
@@ -227,52 +263,65 @@ when 'prune'
       abort("Valid options: preview, clean.")
    end
 
-   currentBranch = Git::current_branch()
+   current_branch = Git::current_branch()
    development_branch = Git::get_branch('development')
    stable_branch = Git::get_branch('stable')
 
-   def branches_cmd(location, currentBranch)
-      branch = location == 'origin' ? "origin/#{development_branch}" : development_branch
-      return "git branch --merged #{branch} |
-         grep -v #{development_branch} |
-         grep -v #{stable_branch} |
-         grep -v #{currentBranch}"
+   # Returns a shell command that will output a list of branches that can be
+   # safely pruned (are merged into the development_branch).
+   # Note: if location != 'local' this will return remote branches
+   branches_cmd = lambda do
+      if location == 'local'
+         branch = development_branch
+         options = ''
+         prefix=''
+      else
+         branch = "#{location}/#{development_branch}"
+         options = '--remotes'
+         prefix='origin/'
+      end
+      return "git branch #{options} --merged #{esc branch} |
+              sed 's/^* //g' | sed 's/^\s*//' |
+              grep --invert-match --line-regexp \
+                 --regexp=#{esc (prefix + development_branch)} \
+                 --regexp=#{esc (prefix + stable_branch)} \
+                 --regexp=#{esc (prefix + current_branch)}"
    end
 
-   def preview(location, currentBranch)
+   preview = lambda do
       puts "Would delete the following..."
-      commands = branches_cmd(location, currentBranch)
 
-      if location == "local"
-         system(commands)
-      elsif location == "origin"
-         message = `git remote prune -n origin && #{commands}`
-         puts message.gsub(" * [would prune] origin/",'')
+      system(branches_cmd.call)
+
+      if location != "local"
+         system("git remote prune --dry-run #{esc location}")
       end
    end
 
-   def delete(location, currentBranch)
+   delete = lambda do |preview = true|
       puts "Deleting..."
-      commands = branches_cmd(location, currentBranch)
 
       if location == "local"
-         system("#{commands} | xargs git branch -d")
-      elsif location == "origin"
-          system("git remote prune origin &&
-                git branch -r --merged origin/#{development_branch} |
-                grep -v #{development_branch} |
-                grep -v #{stable_branch} |
-                grep -v #{currentBranch} |
-                sed -n 's| origin/|:|p' |
-                xargs git push origin")
+         action_command = "xargs git branch -d"
+      else
+         sed_str = "s|^#{location}/|:|p"
+         action_command = "sed -n #{esc sed_str} | xargs git push origin &&
+                           git remote prune #{esc location}"
       end
+
+      if `#{branches_cmd.call}`.empty?
+         puts "No branches need to be pruned"
+         return
+      end
+
+      system("#{branches_cmd.call} | #{action_command}")
    end
 
    if option == 'preview'
-      preview(location, currentBranch)
+      preview.call
    elsif option == 'clean'
       exit unless confirm("Are you sure you want to prune branches?")
-      delete(location, currentBranch)
+      delete.call
    end
 
 when 'clean'

data/bin/hotfix

@@ -3,6 +3,7 @@ require_relative '../lib/signal_handlers.rb'
 require_relative '../lib/github.rb'
 require_relative '../lib/git.rb'
 require_relative '../lib/helpers.rb'
+require_relative '../lib/plugins.rb'
 
 command=ARGV.first
 
@@ -20,11 +21,12 @@ when 'start'
    hotfix = hotfix_branch(ARGV[1])
    stable_branch = Git::get_branch('stable')
 
-   exit unless confirm("Create hotfix branch named: '#{hotfix}' ?")
+   Plugins.invoke :before_start, :hotfix, hotfix
 
    Git::run_safe([
       "git checkout #{stable_branch}",
-      "git pull --rebase",
+      "git fetch",
+      "git rebase --preserve-merges origin/#{stable_branch}",
       "git branch \"#{hotfix}\" #{stable_branch}",
       "git checkout \"#{hotfix}\""
    ])
@@ -38,21 +40,42 @@ when 'start'
       "git config branch.#{hotfix}.rebase true"
    ])
 
+when 'url'
+   require_argument(:hotfix, :url, min=1, max=2)
+   hotfix = ARGV[1] || Git::current_branch
+
+   url = Github::get_url(hotfix)
+   if url
+      puts url
+   else
+      abort "There is no pull request available for #{hotfix}.\n" +
+            'You can make one by using `hotfix finish`.'
+   end
+
+
 when 'switch'
-   require_argument(:hotfix, :switch, min=2, max=3)
+   require_argument(:hotfix, :switch, min=2, max=5)
    hotfix = current_hotfix_branch
 
    Git::switch_branch(hotfix)
 
+   optional_pull
+
 when 'finish'
    hotfix = current_hotfix_branch
 
+   if !is_hotfix_branch hotfix
+      abort "This is a feature branch.  Please use feature-finish."
+   end
+
    # Push commits to origin
    Git::run_safe(["git push origin #{hotfix}:#{hotfix}"])
 
    exit 1 unless confirm("Create a pull-request for hotfix branch named: '#{hotfix}' ?")
    octokit = Github::api
 
+   Plugins.invoke :before_finish, :hotfix, hotfix
+
    description = Github::get_pull_request_description(hotfix)
    puts "Pull-request description:"
    puts description[:title]
@@ -67,6 +90,7 @@ when 'finish'
       description[:body]
    )
 
+   Plugins.invoke :after_finish, :hotfix, hotfix, response
    puts "Successfully created pull-request ##{response[:number]}"
    puts "   " + response[:html_url]
 
@@ -75,6 +99,10 @@ when 'finish-issue'
    issue = ARGV[1]
    hotfix = Git::current_branch
 
+   if !is_hotfix_branch hotfix
+      abort "This is a feature branch.  Please use feature-finish-issue."
+   end
+
    # Push commits to origin
    Git::run_safe(["git push origin #{hotfix}:#{hotfix}"])
 
@@ -127,6 +155,10 @@ when 'merge'
    stable_branch = Git::get_branch('stable')
    hotfix = current_hotfix_branch
 
+   if !is_hotfix_branch hotfix
+      exit 1 unless confirm("It looks like this is a feature branch.  Are you sure you want to merge it into #{stable_branch}?")
+   end
+
    Git::run_safe(["git fetch"])
 
    pull_info = Github::get_pull_request_info_from_api(hotfix, stable_branch)
@@ -136,6 +168,8 @@ when 'merge'
       puts highlight(warning)
    end
 
+   Plugins.invoke :before_merge, :hotfix, hotfix
+
    exit 1 unless confirm("Merge hotfix named: '#{hotfix}' ?")
 
    commit_message = Git::get_description_from_user(pull_info[:description])
@@ -157,7 +191,7 @@ when 'merge'
       # Merge into master.
       "git checkout #{dev_branch}",
       # Pull the latest changes and rebase the unpushed master commits if any.
-      "git rebase origin/#{dev_branch}",
+      "git rebase --preserve-merges origin/#{dev_branch}",
       # Merge the hotfix branch into master.
       "git merge --no-ff --no-edit -m #{commit_message_dev.shellescape} \"#{hotfix}\"",
       # Init any submodules in the master branch. Note: no need to change.
@@ -170,6 +204,8 @@ when 'merge'
       "git checkout #{stable_branch}"
    ])
 
+   Plugins.invoke :after_merge, :hotfix, hotfix
+
    puts "Successfully merged hotfix branch: #{hotfix} into #{stable_branch} and #{dev_branch}"
    puts "If you are satisfied with the result, do this:\n" + <<CMDS
       git push

data/completion/_feature

@@ -11,7 +11,7 @@ _feature() {
 
    case $state in
       commands)
-         _arguments '1:Commands:(list start switch finish finish-issue merge pull prune status stashes clean github-test)'
+         _arguments '1:Commands:(list start switch finish finish-issue merge pull prune status stashes clean github-test url)'
       ;;
       params)
          if [[ "$words[2]" == "prune" ]]; then
@@ -19,6 +19,7 @@ _feature() {
          fi
          if [[ "$words[2]" == "switch" ||
                "$words[2]" == "merge"  ||
+               "$words[2]" == "url"    ||
                "$words[2]" == "finish" ]]; then
            local -a featureBranches args
            featureBranches="$(git branch -a | tr -d ' *' | grep -v 'hotfix-' | sed 's|remotes/origin/||')"

data/completion/bash_completion.sh

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

data/lib/github.rb

@@ -34,6 +34,8 @@ module Github
    # }
    ##
    def self.api(authorization_info = {})
+      # Let Octokit handle pagination automagically for us.
+      Octokit.auto_traversal = true
       # Defaults
       authorization_info = {
          :scopes => ['repo'],
@@ -120,6 +122,13 @@ Body of pull-request
       return self::open_title_body_editor(initial_message)
    end
 
+   ##
+   # Returns the most recent github commit status for a given commit
+   ##
+   def self.get_most_recent_commit_status(repo, sha)
+      api.statuses(repo, sha).sort_by {|status| status['id'] }.last
+   end
+
    ##
    # Prompts the user (using $EDITOR) to confirm the title and body
    # in the provided message.
@@ -133,6 +142,8 @@ Body of pull-request
       msg.write(message)
       msg.close
 
+      Plugins.invoke :pre_message_edit, msg.path
+
       editor = Git::editor
       if (editor == 'vim')
          opts = "'+set ft=gitcommit' '+set textwidth=72'" +
@@ -162,17 +173,19 @@ Body of pull-request
       }
    end
 
+   # Returns a URL based off the branch name.
+   def self.get_url(branch_name)
+      pull = self.pull_for_branch(branch_name)
+      return pull && pull[:html_url]
+   end
+
    def self.get_pull_request_info_from_api(branch_name, into_branch)
-      octokit = Github::api
-      # Should succeed if authentication is set up.
-      repo = Github::get_github_repo
-      pulls = octokit.pulls(repo)
-      pull = pulls.find {|pull| branch_name == pull[:head][:ref] }
+      pull = self.pull_for_branch(branch_name)
 
       if pull
          # This will grab the latest commit and retrieve the state from it.
          sha = pull[:head][:sha]
-         state = octokit.statuses(repo, sha).shift
+         state = self.get_most_recent_commit_status(get_github_repo, sha)
          state = state ? state[:state] : 'none'
 
          desc = <<-MSG
@@ -189,6 +202,19 @@ Merge #{branch_name} (##{pull[:number]}) into #{into_branch}
       end
    end
 
+   @@pulls = nil
+   def self.pulls
+      if !@@pulls
+         repo = get_github_repo
+         @@pulls = api.pulls(repo)
+      end
+      return @@pulls 
+   end
+
+   def self.pull_for_branch(branch_name)
+      pull = self.pulls.find {|pull| branch_name == pull[:head][:ref] }
+   end
+
    def self.get_commit_status_warning(status)
       warning = 'Merge with caution.'
       case status