git-scripts 0.1.0 → 0.2.0

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/git-scripts.png)](http://rubygems.org/gems/git-scripts)
+
 # Git Scripts
 
 User scripts for easily managing feature branches and hotfixes.
@@ -122,3 +124,18 @@ 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

@@ -1,10 +1,13 @@
 #!/usr/bin/env ruby
+require_relative '../lib/signal_handlers.rb'
 require_relative '../lib/github.rb'
 require_relative '../lib/git.rb'
 require_relative '../lib/helpers.rb'
 
 command=ARGV.first
 
+$0 = ARGV.join(" ")
+
 case command
 when 'github-test'
    octokit = Github::api
@@ -16,25 +19,29 @@ when 'start'
    require_argument(:feature, :start)
    feature = ARGV[1]
 
-   exit if !confirm("Create feature branch named: '#{feature}' ?")
+   exit unless confirm("Create feature branch named: '#{feature}' ?")
 
-   Git::run_safe("git checkout #{Git::development_branch}")
-   Git::run_safe("git pull --rebase")
-   Git::run_safe("git branch \"#{feature}\" #{Git::development_branch}")
-   Git::run_safe("git checkout \"#{feature}\"")
+   Git::run_safe([
+      "git checkout #{Git::development_branch}",
+      "git pull --rebase",
+      "git branch \"#{feature}\" #{Git::development_branch}",
+      "git checkout \"#{feature}\"",
+   ])
 
    Git::submodules_update
 
    # Automatically setup remote tracking branch
-   Git::run_safe("git config branch.#{feature}.remote origin")
-   Git::run_safe("git config branch.#{feature}.merge refs/heads/#{feature}")
-   Git::run_safe("git config branch.#{feature}.rebase true")
+   Git::run_safe([
+      "git config branch.#{feature}.remote origin",
+      "git config branch.#{feature}.merge refs/heads/#{feature}",
+      "git config branch.#{feature}.rebase true"
+   ])
 
    puts "Successfully created a new feature-branch: #{feature}"
 
 when 'status'
    current = Git::current_branch
-   Git::run_safe("git fetch")
+   Git::run_safe(["git fetch"])
 
    upstream = `git rev-parse --verify --quiet #{current}@{upstream} 2>/dev/null`.strip
    if upstream == ''
@@ -70,9 +77,9 @@ when 'status'
 when 'finish'
    feature = ARGV[1] || Git::current_branch
    # Push commits to origin
-   Git::run_safe("git push origin #{feature}:#{feature}")
+   Git::run_safe(["git push origin #{feature}:#{feature}"])
 
-   exit 1 if !confirm("Create a pull-request for feature branch named: '#{feature}' ?")
+   exit 1 unless confirm("Create a pull-request for feature branch named: '#{feature}' ?")
    octokit = Github::api
 
    description = Github::get_pull_request_description(feature)
@@ -95,34 +102,32 @@ when 'finish'
 when 'merge'
    dev_branch = Git::development_branch
    fail_on_local_changes
-   Git::run_safe("git fetch")
+
+   Git::run_safe(["git fetch"])
 
    feature = ARGV[1] || Git::current_branch
 
-   exit 1 if !confirm("Merge feature branch named: '#{feature}' ?")
+   exit 1 unless confirm("Merge feature branch named: '#{feature}' ?")
 
    description = Github::get_pull_request_description_from_api(feature, dev_branch)
 
    # Checkout the branch first to make sure we have it locally.
-   Git::run_safe("git fetch")
-   Git::run_safe("git checkout \"#{feature}\"")
-
-   Git::run_safe("git rebase --preserve-merges origin/#{feature}")
-
-   # pull the latest changes from master
-   Git::run_safe("git checkout #{dev_branch}")
-
-   # rebase the unpushed master commits if any.
-   Git::run_safe("git rebase --preserve-merges origin/#{dev_branch}")
-
-   # merge the feature branch into master
-   Git::run_safe("git merge --no-ff --edit -m #{description.shellescape} \"#{feature}\"")
+   Git::run_safe([
+      "git checkout \"#{feature}\"",
+      "git rebase --preserve-merges origin/#{feature}",
+      # pull the latest changes from master
+      "git checkout #{dev_branch}",
+      # rebase the unpushed master commits if any.
+      "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
    Git::submodules_update
 
    # delete the local feature-branch
-   Git::run_safe("git branch -d \"#{feature}\"")
+   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}\"")
@@ -131,6 +136,9 @@ when 'merge'
 
    puts
    puts "Successfully merged feature-branch: #{feature} into #{dev_branch}"
+   puts "If you are satisfied with the result, do this:\n" + <<CMDS
+      git push
+CMDS
 
 when 'switch'
    require_argument(:feature, :switch, min=2, max=3)
@@ -138,17 +146,77 @@ when 'switch'
 
    Git::switch_branch(feature)
 
+when 'prune'
+   require_argument(:feature, :prune, min=3, max=3)
+   location = ARGV[1]
+   option = ARGV[2]
+
+   # Check arguments.
+   if location != "local" and location != "origin"
+      abort("Valid locations: local, origin.")
+   end
+
+   if option != "preview" and option != "clean"
+      abort("Valid options: preview, clean.")
+   end
+
+   currentBranch = Git::current_branch()
+
+   def branches_cmd(location, currentBranch)
+      branch = location == 'origin' ? 'origin/master' : 'master'
+      return "git branch --merged #{branch} |
+         grep -v master |
+         grep -v stable |
+         grep -v #{currentBranch}"
+   end
+
+   def preview(location, currentBranch)
+      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/",'')
+      end
+   end
+
+   def delete(location, currentBranch)
+      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/master |
+                grep -v master |
+                grep -v stable |
+                grep -v #{currentBranch} |
+                sed -n 's| origin/|:|p' |
+                xargs git push origin")
+      end
+   end
+
+   if option == 'preview'
+      preview(location, currentBranch)
+   elsif option == 'clean'
+      exit unless confirm("Are you sure you want to prune branches?")
+      delete(location, currentBranch)
+   end
+
 when 'clean'
    args = ''
 
-   # Remove all untracked .gitignored files as well
+   # Remove all untracked .gitignore'd files as well
    args += 'x' if ARGV.include?('--all')
 
    # -fd alone will NOT remove submodule directories, -ffd is required for this
-   Git::run_safe("git clean -ffd#{args}")
+   Git::run_safe(["git clean -ffd#{args}"])
 
 when 'pull'
-   Git::run_safe("git fetch")
+   Git::run_safe(["git fetch"])
 
    current = Git::current_branch
    upstream = "#{current}@{upstream}"
@@ -159,7 +227,7 @@ when 'pull'
    end
 
    old_branch_hash = Git::branch_hash(current)
-   Git::run_safe("git rebase --preserve-merges origin/#{current}")
+   Git::run_safe(["git rebase --preserve-merges origin/#{current}"])
 
    Git::submodules_update
 
@@ -179,7 +247,7 @@ when 'list'
 when 'stashes'
    current_branch = nil
 
-   if !ARGV.include?('-v')
+   unless ARGV.include?('-v')
       current_branch = Git::current_branch
    end
 
@@ -189,3 +257,4 @@ else
    display_feature_help
 end
 
+log_command("feature #{$0}")

data/bin/hotfix

@@ -1,47 +1,49 @@
 #!/usr/bin/env ruby
+require_relative '../lib/signal_handlers.rb'
 require_relative '../lib/github.rb'
 require_relative '../lib/git.rb'
 require_relative '../lib/helpers.rb'
 
 command=ARGV.first
-BRANCH_PREFIX = "hotfix-"
+
+$0 = ARGV.join(" ")
+
 case command
 when 'start'
    require_argument(:hotfix, :start)
-   hotfix = BRANCH_PREFIX + ARGV[1]
+   hotfix = hotfix_branch(ARGV[1])
 
-   exit if !confirm("Create hotfix branch named: '#{hotfix}' ?")
+   exit unless confirm("Create hotfix branch named: '#{hotfix}' ?")
 
-   Git::run_safe("git checkout stable")
-   Git::run_safe("git pull --rebase")
-   Git::run_safe("git branch \"#{hotfix}\" stable")
-   Git::run_safe("git checkout \"#{hotfix}\"")
+   Git::run_safe([
+      "git checkout stable",
+      "git pull --rebase",
+      "git branch \"#{hotfix}\" stable",
+      "git checkout \"#{hotfix}\""
+   ])
 
    Git::submodules_update
 
    # Automatically setup remote tracking branch
-   Git::run_safe("git config branch.#{hotfix}.remote origin")
-   Git::run_safe("git config branch.#{hotfix}.merge refs/heads/#{hotfix}")
-   Git::run_safe("git config branch.#{hotfix}.rebase true")
+   Git::run_safe([
+      "git config branch.#{hotfix}.remote origin",
+      "git config branch.#{hotfix}.merge refs/heads/#{hotfix}",
+      "git config branch.#{hotfix}.rebase true"
+   ])
 
 when 'switch'
    require_argument(:hotfix, :switch, min=2, max=3)
-   hotfix = BRANCH_PREFIX + ARGV[1]
+   hotfix = current_hotfix_branch
 
    Git::switch_branch(hotfix)
 
 when 'finish'
-   hotfix = ARGV[1] || Git::current_branch
-
-   # ensure the hotfix name is the real branch name
-   if (!hotfix.start_with?("hotfix-"))
-       hotfix = "hotfix-" + hotfix
-   end
+   hotfix = current_hotfix_branch
 
    # Push commits to origin
-   Git::run_safe("git push origin #{hotfix}:#{hotfix}")
+   Git::run_safe(["git push origin #{hotfix}:#{hotfix}"])
 
-   exit 1 if !confirm("Create a pull-request for hotfix branch named: '#{hotfix}' ?")
+   exit 1 unless confirm("Create a pull-request for hotfix branch named: '#{hotfix}' ?")
    octokit = Github::api
 
    description = Github::get_pull_request_description(hotfix)
@@ -64,63 +66,49 @@ when 'finish'
 when 'merge'
    fail_on_local_changes
    dev_branch = Git::development_branch
+   hotfix = current_hotfix_branch
 
-   Git::run_safe("git fetch")
-
-   if ARGV[1]
-      hotfix = BRANCH_PREFIX + ARGV[1]
-   else
-      hotfix = Git::current_branch
-   end
+   Git::run_safe(["git fetch"])
 
-   exit 1 if !confirm("Merge hotfix named: '#{hotfix}' ?")
+   exit 1 unless confirm("Merge hotfix named: '#{hotfix}' ?")
 
    description = Github::get_pull_request_description_from_api(hotfix, 'stable')
-
-   # Checkout the branch to make sure we have it locally.
-   Git::run_safe("git checkout \"#{hotfix}\"")
-   Git::run_safe("git rebase --preserve-merges origin/#{hotfix}")
-
-   # Merge into stable
-   Git::run_safe("git checkout stable")
-
-   # pull the latest changes and rebase the unpushed commits if any.
-   Git::run_safe("git rebase --preserve-merges origin/stable")
-
-   # merge the hotfix branch into stable
-   Git::run_safe("git merge --no-ff --edit -m #{description.shellescape} \"#{hotfix}\"")
-
+   descriptionDev = Github::get_pull_request_description_from_api(hotfix, dev_branch)
    # init any submodules in the stable branch
-   Git::submodules_update
-   # push the the merge to our origin
-   # Git::run_safe("git push origin")
-
-   description = Github::get_pull_request_description_from_api(hotfix, dev_branch)
-
-   # Merge into master
-   Git::run_safe("git checkout #{dev_branch}")
-
-   # pull the latest changes and rebase the unpushed master commits if any.
-   Git::run_safe("git rebase origin/#{dev_branch}")
-
-   # merge the hotfix branch into master
-   Git::run_safe("git merge --no-ff --edit -m #{description.shellescape} \"#{hotfix}\"")
-
-   # 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
-   Git::submodules_update
-
-   # push the the merge to our origin
-   # Git::run_safe("git push origin")
-
-   # delete the local hotfix branch
-   Git::run_safe("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
-   Git::run_safe("git checkout stable")
+   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 stable",
+      # 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}\"",
+      "#{update}",
+      # push the the merge to our origin
+      # Git::run_safe("git push origin")
+      # Merge into master
+      "git checkout #{dev_branch}",
+      # 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
+      # directories before calling git submodule since we are already in the
+      # 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
+      "git checkout stable"
+   ])
 
    puts "Successfully merged hotfix branch: #{hotfix} into stable and #{dev_branch}"
    puts "If you are satisfied with the result, do this:\n" + <<CMDS
@@ -140,3 +128,5 @@ when 'list'
 else
    display_hotfix_help
 end
+
+log_command("hotfix #{$0}")

data/lib/git.rb

@@ -4,6 +4,8 @@ module Git
       return !clean
    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
@@ -14,7 +16,7 @@ module Git
       dev_branch
    end
 
-   # Returns an array of branches that aren't merged into the specifeid branch
+   # 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)
    end
@@ -53,23 +55,27 @@ module Git
    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
+      map {|branch| branch.sub(/refs\/\w+\//, '') }.
+      uniq.
+      reject {|branch| branch =~ %r{\w+/HEAD} }
    end
 
-   # returns the name of th currently checked out brnach, or nil if detached.
+   # Returns the name of the currently checked out branch, 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
+   # 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
+   # Returns formatted string containing:
+   #
+   #    commit_hash Author Name (relative date)
+   #
+   # for the specified branch or commit
    def self.branch_info(branch)
       # branch info format: hash author (relative date)
       format = "%h %an %Cgreen(%ar)%Creset"
@@ -78,10 +84,18 @@ module Git
       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)
+   def self.run_safe(commands)
+      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
+            end
+         end
+      end
    end
 
    def self.show_stashes_saved_on(branch = nil)
@@ -128,7 +142,7 @@ module Git
 
    def self.stashes
       # Do we even have a stash?
-      if ! File.exist? '.git/refs/stash'
+      unless File.exist? '.git/refs/stash'
          return []
       end
 
@@ -146,19 +160,35 @@ module Git
       end
    end
 
+   ##
+   # Switch to the specified branch.
+   # Because we use submodules, we have to check for updates to those
+   # submodules when we checkout a branch 
+   #
+   # args: --clean - remove every unstaged file, including non-existant
+   # submodules
+   #
    def self.switch_branch(branch)
-      self.run_safe("git checkout \"#{branch}\"")
+      self.run_safe(["git checkout \"#{branch}\""])
       self.submodules_update
-      self.run_safe("git clean -ffd") if ARGV.include?('--clean')
+      self.run_safe(["git clean -ffd"]) if ARGV.include?('--clean')
 
       self.show_stashes_saved_on(branch)
    end
 
-   def self.submodules_update
+   ##
+   # Update / initialize submodules from the TLD
+   #
+   def self.submodules_update(mode = nil)
       # 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"
 
-      Git::run_safe("cd #{basedir} && git submodule --quiet update --init --rebase --recursive")
+      if mode == "get"
+         return command
+      else
+         Git::run_safe([command])
+      end
    end
 
    ##
@@ -167,4 +197,8 @@ module Git
    def self.commit_message(ref)
       `git log -1 --format="%B" #{ref}`.strip
    end
+
+   def self.git_dir()
+      `git rev-parse --git-dir`.strip
+   end
 end

data/lib/github.rb

@@ -54,7 +54,7 @@ module Github
    end
 
    ##
-   # Returns a hash containing username and github oauth token
+   # Returns a hash containing the username and github oauth token
    #
    # Prompts the user for credentials if the token isn't stored in git config
    ##
@@ -73,11 +73,11 @@ module Github
 
       auth = auth || octokit.create_authorization(authorization_info)
 
-      success = 
+      success =
          system("git config --global github.user #{username}") &&
          system("git config --global github.token #{auth[:token]}")
 
-      if !success
+      unless success
          puts "Couldn't set git config"
          exit
       end
@@ -154,7 +154,7 @@ Body of pull-request
 
    def self.get_pull_request_description_from_api(branch_name, into_branch)
       octokit = Github::api
-      # Should succeed if authentication is setup.
+      # Should succeed if authentication is set up.
       pulls = octokit.pulls(Github::get_github_repo)
       pull = pulls.find {|pull| branch_name == pull[:head][:ref] }