redmine_stagecoach 0.5.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.2-p290@stagecoach

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'ghi'
+gem 'trollop'
+gem 'capistrano'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capistrano (2.9.0)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    ghi (0.3.0)
+    git (1.2.5)
+    highline (1.6.9)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.3.0)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  capistrano
+  ghi
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda
+  trollop

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Oli Barnett
+
+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.rdoc

@@ -0,0 +1,69 @@
+= Stagecoach
+stagecoach works in two stages, init and deploy. The init stage creates a branch based on a redmine/planio issue, and the deploy stage pushes, merges and (yes!) deploys it. 
+
+*You should always run stagecoach from the root directory of your repo*
+Otherwise it may (will) break.
+
+The first time you run stagecoach it will ask you for some information, namely your redmine/planio repo URL and your API key for this repo.
+It will also install a custom commit-msg git hook (if you ask it to) - for more information, see below.  
+
+All stagecoach config is saved in /path/to/your/repo/.stagecoach which is created at initial setup and added to your global .gitignore.  This is a yaml file with fairly obvious syntax
+so if you need to remove a branch or edit the issue number that a branch points to, it is possible (although not necessarily recommended) to edit it.
+
+Init Stage
+==========
+stagecoach -p[lanio] 4115 (OR) -g[ithub] 525 -b[ranch] my_new_branch
+
+You can also just run stagecoach without any flags and it will allow you to enter this stuff manually.
+
+To get started, all stagecoach needs from you is the issue number you are working on (redmine/planio or github) and a new branch name.  You /can/ use an existing branch if it 
+is up to date with your master branch. If it is not, stagecoach will squawk and die and you will have to bring the branch up to date, or use a new one.
+  
+If you are working from a redmine/planio issue, stagecoach sets the issue to 'In Progress'.  Currently it does not assign the issue to you, but you have the option to view the issue
+in your browser and do this manually.  It also sets up a git issue for you to reference in your commits (see commit-msg githook).
+
+If you are working from a github issue, we can all get on with our lives.
+
+Coding Stage
+============
+Future versions of stagecoach may do the coding for you, but at the moment you have to do this part manually.
+Just code and commit, code and commit until your feature or fix is ready.
+
+Commit-msg githook
+------------------
+If you opt to install the commit-msg githook during initial setup (stagecoach -s) then your commit messages will be automatically referenced to the github issue of the branch you are in 
+(this only applies to branches created or registered in Stagecoach).
+
+  - to reference a different issue from a commit, simply refer to it as normal with #xxx in the commit message. The git-hook will leave your message alone.
+  - to make no reference at all, you can use the #noref tag in the commit message. The git-hook
+  - to close an issue with a commit, use the #closes tag.
+
+For more information, see 
+  - the githook itself at /path/to/your/repo/.git/hooks/commit-msg
+  - http://book.git-scm.com/5_git_hooks.html
+
+Deploy Stage
+============
+stagecoach -d[eploy]
+
+This automates the entire deploy workflow for you as follows:
+
+  git push origin new_branch_name
+  git checkout staging
+  git pull
+  git merge task_name
+  git push origin staging
+  cap staging deploy
+  set redmine/planio ticket to 'feedback' status (if applicable)
+ 
+Sample usage:
+  stagecoach -p 4115 -b new_branch_name
+  [code, commit until feature or fix is complete]
+  stagecoach -d
+
+Flags
+        --branch, -b: Enter your new branch name here, eg. stagecoach -b new_branch (optional)
+        --planio, -p: Enter your planio issue number here, eg. stagecoach -p 1234 (optional)
+        --github, -g: Enter your github issue number here, eg. stagecoach -g 1234 (optional)
+        --deploy, -d: Use this option to skip straight to push & deploy if you have already pulled from master and created your new branch
+        --setup,  -s: Use this the first time you run stagecoach to save your redmine repository/api key and install the commit-msg githook if desired

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "redmine_stagecoach"
+  gem.homepage = "http://github.com/omnikron/stagecoach"
+  gem.license = "MIT"
+  gem.summary = %Q{Stagecoach is in ur Redmine, automating ur Git workflow.}
+  gem.description = %Q{Git/capistrano workflow automation script with Redmine & Github issue integration}
+  gem.email = "o.barnett@digitaleseiten.de"
+  gem.authors = ["Oli Barnett"]
+  gem.executables = ['stagecoach']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stagecoach #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/bin/stagecoach

@@ -0,0 +1,270 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../lib/stagecoach.rb'
+
+CONFIG_FILE = `pwd`.chomp + '/.stagecoach'
+
+module Stagecoach
+  staging = 'staging'
+  master  = 'master'
+
+  # Command line options courtesy of the Trollop gem.
+  opts = CommandLine.trollop
+
+  # Initial setup with -s flag.
+  if opts[:setup]
+    Config.setup
+  end
+
+  # Initial setup without -s flag.
+  unless File.exist?(CONFIG_FILE)
+    Config.setup
+  end
+
+  # Load config file to a hash.
+  config = Config.yaml_to_hash
+
+  # Checks validity of argument variables.
+  # Ignore these checks with -t flag.
+  unless opts[:testing_given] 
+    Config.setup if config["redmine_site"] == "none"
+    Config.setup if config["redmine_api"]  == "none"
+
+    # Checks that command-line args are present and correct.
+    Trollop::die :planio, "issue number can only contain digits" if opts[:planio] && opts[:planio][/\D/]
+    Trollop::die :github, "issue number can only contain digits" if opts[:github] && opts[:github][/\D/]
+    Trollop::die :branch, "name must be longer than 1 character" if opts[:branch] && opts[:branch].length <= 1
+
+    # You can't give a planio and a github issue number (for the moment)
+    if opts[:github] && opts[:planio]
+      puts "You can't enter a github issue at the same time as a planio issue at the moment.  Make up your mind!\nExiting..."
+      exit
+    end
+  end
+
+  # Set up redmine client config.
+  RedmineApi::Client.instance_eval do
+    self.site = config["redmine_site"]
+    self.user = config["redmine_api_key"]
+  end
+
+  # Checks for uncommitted/unstashed changes and aborts if present.
+  if Git.changes != ''
+    puts "You have uncommitted changes:".red
+    puts Git.changes
+    puts "Please commit or stash these changes before running Stagecoach. -h for help."
+    puts "Exiting..."
+    exit
+  end 
+
+  # Initial stage - set up branch and git issue.
+
+  unless opts[:deploy]
+
+    # If no issue argument has been given.
+    if opts[:github].nil? && opts[:planio].nil?
+      print "Are you working on a [P]lanio or a [G]ithub issue:  "
+      case STDIN.gets.chomp
+      when 'P'
+        print "Please enter your Planio issue number:  "
+        opts[:planio] = gets.chomp
+      when 'G'
+        print "Please enter your Github issue number:  "
+        opts[:github] = gets.chomp
+      end
+    end
+
+    # Check that the planio issue is not already assigned.
+    if opts[:planio]
+      planio_issue_number = opts[:planio]
+      planio_issue = Redmine.issue(planio_issue_number)
+      if planio_issue.status.id != '1'
+        puts "Warning!".red
+        puts "This issue is in status '#{planio_issue.status.name}'"
+        begin 
+        puts "It is assigned to #{planio_issue.assigned_to.name}"
+        rescue
+        puts "But it is not assigned to anybody yet." 
+        end
+        print "Continue? [Y]es or [Q]uit:  "
+        case STDIN.gets.chomp
+        when 'Y'
+        when 'Q'  
+          exit
+        end
+      end
+
+      # Set the planio issue status to 'In Bearbeitung'
+      planio_issue.status_id = 2
+      planio_issue.save
+    end
+
+    # TODO: Check that the github issue is not already assigned.
+
+    CommandLine.line_break
+    puts "Stagecoach: initial stage"
+
+    # Change to master, pull changes, and create a new branch.
+    CommandLine.line_break  
+    puts "Switching to master branch"
+    #
+    # TODO if there is a file that has been git added but not git committed, it
+    # will pop up at this point looking confusing (eg. "A     test_file").
+    # Handle this better?
+    #
+    Git.checkout(master)
+    puts "Pulling changes:"
+    Git.pull
+    if opts[:branch]
+      new_branch = opts[:branch]
+    else  
+      print "Please enter a new git branch name for your changes (branch will be created):  "
+      new_branch = STDIN.gets.chomp
+    end
+
+    # Check that the new branch isn't master, because that would be silly
+    case new_branch
+    when 'master', 'Master' 
+      puts "You can't use stagecoach to deploy your master branch.\nExiting..."
+      exit
+    end
+
+    # Make sure new local branch does not already exist.
+    if Git.branch_exist?(new_branch)
+      puts "There is already a local branch called #{new_branch}."
+      if Git.diff(master, new_branch) == ""
+        print "#{new_branch} is up to date with master.  [U]se or [Q]uit:  "
+      else 
+        puts "#{new_branch} is not up to date with master. Please use a different branch or update this one.".red
+        puts "Exiting..."
+        CommandLine.line_break
+        puts "The following files in branch '#{new_branch}' differ from their master branch versions:"
+        puts Git.diff(master, new_branch)
+        CommandLine.line_break
+        exit
+      end
+      case STDIN.gets.chomp
+      when 'U'
+        Git.change_to_branch(new_branch)
+      when 'Q'
+        exit
+      end
+    else
+      Git.new_branch(new_branch)
+    end
+    
+    # Ugly code, pretty output...
+    CommandLine.line_break
+
+    # Issue handling.
+    if opts[:github]
+      config[Git.current_branch] = {:github_issue => opts[:github]}
+      #TODO check that github issue is not assigned to somebody already
+    elsif opts[:planio]
+      config[Git.current_branch] = {:planio_issue => planio_issue_number}
+    end
+
+    issue = config[Git.current_branch]
+
+    # Set up the related issue for this branch.
+    if planio_issue = issue[:planio_issue]
+      begin
+        puts "Searching for issue number #{planio_issue}..."
+        redmine_issue = Redmine.issue(planio_issue)
+      rescue ActiveResource::ResourceNotFound => e
+        puts e.message
+        exit
+      end
+        puts "Issue found: #{redmine_issue.subject}\n" 
+
+      # Create a Github issue referencing the planio issue.
+      puts "Creating Git issue with subject: " + redmine_issue.subject
+      body = "Planio issue: #{Redmine.issue_url(redmine_issue)} \n\n #{redmine_issue.description}"
+
+      # Create a Git issue.
+      github_issue =  Git.new_issue(redmine_issue.subject, body)
+      github_issue_id = github_issue[/\d+/]
+
+      # Save it so we can reference it in commits using the magic of git hooks!
+      config[Git.current_branch] = {:github_issue => github_issue_id, :planio_issue => planio_issue}
+
+      print "Would you like to edit the issue on Github? [Y]es or anything else to continue:  "
+      
+      if STDIN.gets.chomp == 'Y'
+        Git.view_issue(github_issue_id) 
+      else
+      end
+    end
+
+    # Github issues are easier.
+    if issue[:github]
+      #TODO what happens if no github issue is found?
+      puts "Searching for github issue number #{issue[:number]}..."
+      github_issue = Git.issue(issue[:number])
+      puts "Issue found: #{github_issue} \n" 
+    end
+
+    # Saves the branch-specific details for later.
+    Config.save(config)
+    puts "Happy coding! Run stagecoach -d when you're ready to deploy."
+  end
+
+  # ------------------------------------------------------------------
+  # Deploy stage.
+  if opts[:deploy]
+
+    # Get the current git branch
+    branch = Git.current_branch
+
+    # There's no point in deploying without any commits
+    unless Git.branch_has_commits?(branch)
+      puts "You don't have any uncommitted changes on branch #{branch}.  Please make some commits before running stagecoach!\nExiting..."
+      exit
+    end
+
+    # You never know!  Display git status in case there are any nasty surprises.
+    unless Git.status =~ /nothing to commit/
+      CommandLine.line_break
+      puts "You have a dirty git branch:\n".red
+      puts Git.status
+      CommandLine.line_break
+      print "[D]eploy anyway".red
+      print " or "
+      print "[anything else] to cancel:  ".green
+      case STDIN.gets.chomp
+      when "D"
+        CommandLine.line_break
+        puts "DEPLOYING:"
+        CommandLine.line_break
+      else 
+        puts "Exiting..."
+        exit
+      end
+    end
+
+
+    # Stop anybody deploying master to staging...
+    case branch
+    when 'master', 'Master' 
+      puts "You can't use stagecoach to deploy your master branch.\nExiting..."
+      exit
+    end
+
+    # Finally, push, merge and deploy!
+    Git.push(branch)
+    Git.merge(staging, branch)
+    Git.push(staging)
+    Capistrano.deploy(staging)
+    Git.change_to_branch(master)
+
+    # Planio issue to feedback status
+    if planio_issue_number =  config[branch][:planio_issue]
+      CommandLine.line_break
+      puts "Attempting to change Planio ticket status to 'Feedback' for you:"
+      issue = Redmine.issue(planio_issue_number)
+      issue.status_id = 4
+      issue.save
+      Redmine.view_issue(issue)
+    end
+  end
+end

data/lib/githooks/commit-msg

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+#
+# Git commit-msg hook. If your branch name is in the form "t123", automatically
+# adds "Refs #123." to commit messages unless they mention "#123" already.
+# Include "#close" or "#finish" to add "Closes #123."
+#
+# For Pivotal Tracker, branch names like "s123" adds "[#123]".
+# Include "#close" or "#finish" to add "[Finishes #123]".
+#
+# If you include "#noref" in the commit message, nothing will be added to
+# the commit message, and the "#noref" itself will be stripped.
+#
+# By Henrik Nyh <http://henrik.nyh.se> 2009-09-10 under the MIT License.
+#
+#
+# Install:
+#
+# cd your_project
+# stick it in .git/hooks/commit-msg && chmod u+x .git/hooks/commit-msg
+#
+# Or store it centrally and symlink in your projects:
+# TODO Replace ~./.githooks etc with the file location in the gem
+#  ~/.githooks/commit-msg && chmod u+x ~/.githooks/commit-msg
+# cd your_project
+#  ~/.githooks/commit-msg .git/hooks
+
+require 'yaml'
+
+# Custom method to check for installed redmine_stagecoach gem
+def gem_available?(name)
+   Gem::Specification.find_by_name(name)
+rescue Gem::LoadError
+   false
+rescue
+   Gem.available?(name)
+end
+
+if gem_available?('redmine_stagecoach') == false
+  exit
+else
+  config = YAML::load(File.open(File.dirname(__FILE__) + '/../../.stagecoach', 'r'))
+end
+
+# Find out what branch we are on
+def branches
+  `git branch`.split("\n")
+end
+
+def current_branch
+  branches.each do |b|
+    if b =~ /\*/
+      return b[1..-1].strip
+    end
+  end
+end
+
+
+# And now the git hook stuff
+
+FLAGS = [
+  NOREF  = "noref",
+  UP_NOREF = "Noref",
+  CAPS_NOREF = "NOREF",
+  CLOSE  = "close",
+  UP_CLOSE= "Close",
+  CAPS_CLOSE= "CLOSE"
+]
+
+NO_REFERENCE_FLAGS = [ NOREF, UP_NOREF, CAPS_NOREF  ]
+CLOSING_FLAGS = [ CLOSE, UP_CLOSE, CAPS_CLOSE ]
+
+begin
+ticket_number = config[current_branch][:github_issue]
+rescue
+  exit
+end
+finish    = "Closes #%s" % ticket_number
+reference = "#%s"   % ticket_number
+
+message_file = ARGV[0]
+message = File.read(message_file).strip
+exit if message.include?("##{ticket_number}")
+exit if message =~ /#\d+/
+
+# Determine if any of the flags are included. Make a note of which and then remove it.
+message.sub!(/(?:^|\s)#(#{Regexp.union(*FLAGS)})\b/, '')
+flag = $1
+
+message =
+  case flag
+  when *NO_REFERENCE_FLAGS
+    message
+  when *CLOSING_FLAGS
+    [ message, finish ].join(" ")
+  else
+    [ message, reference ].join(" ")
+  end
+
+File.open(message_file, 'w') {|f| f.write message }

data/lib/stagecoach.rb

@@ -0,0 +1,7 @@
+lib = File.dirname(__FILE__)
+
+require lib + '/stagecoach/config'
+require lib + '/stagecoach/git'
+require lib + '/stagecoach/redmine'
+require lib + '/stagecoach/command_line.rb'
+require lib + '/stagecoach/capistrano.rb'

data/lib/stagecoach/capistrano.rb

@@ -0,0 +1,11 @@
+module Stagecoach
+  class Capistrano
+    class << self
+      def deploy(branch)
+        CommandLine.line_break
+        puts "Deploying staging"
+        puts `bundle exec cap #{branch} deploy`
+      end
+    end
+  end
+end

data/lib/stagecoach/command_line.rb

@@ -0,0 +1,84 @@
+module Stagecoach
+  class CommandLine
+    def self.line_break
+      puts  "\n"
+    end
+
+    def self.trollop
+      require 'trollop'
+      # Command line options using Trollop.
+      Trollop::options do
+        banner <<-EOS
+stagecoach works in two stages, init and deploy. The init stage creates a branch based on a redmine/planio issue, and the deploy stage pushes, merges and (yes!) deploys it. 
+
+#{"You should always run stagecoach from the root directory of your repo".red}
+Otherwise it may (will) break.
+
+The first time you run stagecoach it will ask you for some information, namely your redmine/planio repo URL and your API key for this repo.
+It will also install a custom commit-msg git hook (if you ask it to) - for more information, see below.  
+
+All stagecoach config is saved in /path/to/your/repo/.stagecoach which is created at initial setup and added to your global .gitignore.  This is a yaml file with fairly obvious syntax
+so if you need to remove a branch or edit the issue number that a branch points to, it is possible (although not necessarily recommended) to edit it.
+
+Init Stage
+----------
+stagecoach -p[lanio] 4115 (OR) -g[ithub] 525 -b[ranch] my_new_branch
+
+You can also just run stagecoach without any flags and it will allow you to enter this stuff manually.
+
+To get started, all stagecoach needs from you is the issue number you are working on (redmine/planio or github) and a new branch name.  You /can/ use an existing branch if it 
+is up to date with your master branch. If it is not, stagecoach will squawk and die and you will have to bring the branch up to date, or use a new one.
+  
+If you are working from a redmine/planio issue, stagecoach sets the issue to 'In Progress'.  Currently it does not assign the issue to you, but you have the option to view the issue
+in your browser and do this manually.  It also sets up a git issue for you to reference in your commits (see commit-msg githook).
+
+If you are working from a github issue, we can all get on with our lives.
+
+Coding Stage
+------------
+Future versions of stagecoach may do the coding for you, but at the moment you have to do this part manually.
+Just code and commit, code and commit until your feature or fix is ready.
+
+#{"commit-msg githook".green}
+If you opt to install the commit-msg githook during initial setup (stagecoach -s) then your commit messages will be automatically referenced to the github issue of the branch you are in 
+(this only applies to branches created or registered in Stagecoach).
+
+  - to reference a different issue from a commit, simply refer to it as normal with #xxx in the commit message. The git-hook will leave your message alone.
+  - to make no reference at all, you can use the #noref tag in the commit message. The git-hook
+  - to close an issue with a commit, use the #closes tag.
+
+For more information, see 
+  - the githook itself at /path/to/your/repo/.git/hooks/commit-msg
+  - http://book.git-scm.com/5_git_hooks.html
+
+Deploy Stage
+------------
+stagecoach -d[eploy]
+
+This automates the entire deploy workflow for you as follows:
+
+  git push origin new_branch_name
+  git checkout staging
+  git pull
+  git merge task_name
+  git push origin staging
+  cap staging deploy
+  set redmine/planio ticket to 'feedback' status (if applicable)
+ 
+#{"Sample usage:".green}
+  stagecoach -p 4115 -b new_branch_name
+  [code, commit until feature or fix is complete]
+  stagecoach -d
+
+#{"Flags".red}
+        EOS
+        opt :branch, "Enter your new branch name here, eg. stagecoach -b new_branch (optional)", :type => :string
+        opt :planio, "Enter your planio issue number here, eg. stagecoach -p 1234 (optional)", :type  => :string
+        opt :github, "Enter your github issue number here, eg. stagecoach -g 1234 (optional)", :type => :string
+        opt :deploy, "Use this option to skip straight to push & deploy if you have already pulled from master and created your new branch"
+        opt :setup, "Use this the first time you run stagecoach to save your redmine repository and api key"
+        opt :testing, "Dev testing tool"
+      end
+    end
+  end
+end

data/lib/stagecoach/config.rb

@@ -0,0 +1,125 @@
+require 'yaml'
+require 'FileUtils'
+
+module Stagecoach
+  class Config
+    class << self
+      def new
+        File.open(CONFIG_FILE, 'w') { |f| f.write("---\nredmine_site: none\nredmine_api_key: none")}
+      end
+
+      def open
+        File.open(CONFIG_FILE, 'r+')
+      end
+
+      def yaml_to_hash 
+        YAML::load(Config.open)
+      end
+
+      def save(hash, config_file = Config.open)
+        config_file.write(hash.to_yaml)
+      end
+
+      def githook_install(source_dir, install_dir, file)
+        FileUtils.cp(source_dir + file, install_dir + file)
+        puts 'OK!'
+        puts 'Making githook executable (may require admin password)'
+        FileUtils.chmod(0711, ( install_dir + file ))
+        puts 'OK!'
+      end
+
+      def setup
+        # Say hello
+        CommandLine.line_break
+        puts "Stagecoach Initial Setup"
+        CommandLine.line_break
+
+        # Now scare everybody away again
+        puts "You are running stagecoach from #{FileUtils.pwd.green}. Is this the root directory of your repository?" 
+        puts "Stagecoach may not work properly anywhere else! So proceed with caution"
+        CommandLine.line_break
+        print "[C]ontinue or [Q]uit:  "
+
+        # Create a config file if necessary 
+        case STDIN.gets.chomp
+        when 'C'
+        Config.new unless File.exist?(CONFIG_FILE) 
+        when 'Q'
+          puts "Exiting..."
+          exit
+        end
+
+        # Tell git to ignore the stagecoach config file
+        Git.global_ignore('.stagecoach')
+
+        # Install the commit-msg githook if it is not already there:
+        source_dir = (File.dirname(__FILE__) + '/../githooks/')
+        install_dir = FileUtils.pwd + '/.git/hooks/'
+        git_hook = 'commit-msg'  
+
+        CommandLine.line_break
+        puts "Would you like to install the stagecoach #{"commit-msg githook".green}?"
+        puts "This automatically references stagecoach-created github issues from each commit you make"
+        puts "Note that this will only affect branches created in stagecoach.  For more information run stagecoach -h"
+        CommandLine.line_break
+        print "[I]nstall or [S]kip this step:  "
+        loop do
+          case STDIN.gets.chomp
+          when 'I'
+            if File.exist?(install_dir + git_hook)
+              case FileUtils.compare_file(source_dir + git_hook, install_dir + git_hook) 
+              when true
+                puts 'The stagecoach githook is already installed in this repo. Skipping this step...'
+                break
+              when false
+                puts "You have a commit-msg githook already.  Are you sure you want to install?  This will #{'overwrite'.red} your current commit-msg githook."
+                print "Type [overwrite] to continue or anything else to skip installation:  "
+                case STDIN.gets.chomp
+                when 'overwrite'
+                  Config.githook_install(source_dir, install_dir, git_hook)
+                  break
+                else
+                  break
+                end
+              end
+            else
+              puts "Installing..."
+              Config.githook_install(source_dir, install_dir, git_hook)
+              break
+            end
+          when 'S'
+            puts 'Skipping Installation.'
+            break
+          end
+        end
+
+        # TODO Some verification of the input at this stage, for example test the
+        # connection and have the user re-enter the details if necessary 
+        # http://api.rubyonrails.org/classes/ActiveResource/Connection.html#method-i-head
+        loop do 
+          CommandLine.line_break
+          print "Enter your redmine/planio repository, eg. https://digitaleseiten.plan.io:  "
+          redmine_repo = STDIN.gets.chomp
+          print "Enter your API key for that repo:  "
+          redmine_api_key = STDIN.gets.chomp
+
+          Config.save({"redmine_site" => redmine_repo, "redmine_api_key"  => redmine_api_key})
+
+          CommandLine.line_break
+          puts "Settings saved OK:"
+          puts "Repository: " + redmine_repo
+          puts "API Key:    " + redmine_api_key
+          CommandLine.line_break
+          puts "Exiting..."
+          exit
+        end 
+      end 
+    end
+  end
+end
+
+class String
+  def red; colorize(self, "\e[1m\e[31m"); end
+  def green; colorize(self, "\e[32m"); end
+  def colorize(text, color_code)  "#{color_code}#{text}\e[0m" end
+end

data/lib/stagecoach/git.rb

@@ -0,0 +1,123 @@
+module Stagecoach
+  class Git
+    class << self
+      def branches
+        `git branch`.split("\n")
+      end
+
+      def global_ignore(filename)
+        gitignore = File.open(Dir.home + '/.gitignore', 'a+')
+
+        # Check if filename is ignored already and ignores it if not
+          unless File.read(gitignore) =~ /\.stagecoach/
+            gitignore.puts(filename)
+          end
+      end
+
+      def changes
+        `git diff-files --name-status -r --ignore-submodules`
+      end
+      
+      def status
+        `git status`
+      end
+
+      def current_branch
+        branches.each do |b| 
+          if b =~ /\*/
+            return b[1..-1].strip
+          end
+        end
+      end
+
+      def correct_branch?
+        CommandLine.line_break
+        print "You are currently in local branch: #{Git.current_branch.red} \nAre these details correct? ([Y]es or [Q]uit):  "
+        case STDIN.gets.chomp
+        when "Y"
+        when "Q"
+          exit
+        else
+          puts "Please enter Y to continue or Q to quit."
+        end
+      end
+
+      def new_branch(branch)
+        CommandLine.line_break
+        `git checkout -b #{branch}`
+      end
+
+      def change_to_branch(branch)
+        CommandLine.line_break
+        puts "Changing to branch '#{branch}'"
+        if branch_exist?(branch)
+          `git checkout #{branch}`
+        else
+          print "Branch '#{branch}' does not exist. [C]reate or [Q]uit:  "
+          case STDIN.gets.chomp
+          when 'C'
+            new_branch(branch)
+          when 'Q'     
+            exit
+          end
+        end
+      end
+
+      def diff(branch1, branch2)
+        diff = `git diff --name-status #{branch1}..#{branch2}`
+        return diff
+      end
+
+
+      def merge(to_branch, from_branch)
+        CommandLine.line_break
+        puts "Merging into #{to_branch} (after pulling updates)"
+        Git.change_to_branch(to_branch)
+        puts `git pull origin #{to_branch}`
+        puts `git merge #{from_branch}`
+        raise 'merge failed' if $?.exitstatus != 0
+      end
+
+      def push(branch)
+        CommandLine.line_break
+        puts "Pushing your changes to branch '#{branch}'"
+        puts `git push origin #{branch}`
+      end
+
+
+      def checkout(branch) 
+        puts `git checkout #{branch}`
+      end
+
+      def pull
+        puts `git pull`
+      end
+
+      def branch_exist?(branch)
+        branches.find { |e| /#{branch}/ =~ e }
+      end
+
+      def new_issue(title, description)
+        `ghi -o "#{title}" -m "#{description}"`
+      end
+
+      def branch_has_commits?(branch)
+        log = `git log --branches --not --remotes --simplify-by-decoration --decorate --oneline`
+        if log.include? branch
+          return true
+        else
+          return false
+        end
+      end
+
+      def view_issue(github_issue)
+        issue_url = `ghi -u#{github_issue}`
+        `open #{issue_url}`
+      end
+
+      def issue(id)
+        `ghi -l #{id}`
+      end
+    end
+  end
+end

data/lib/stagecoach/redmine.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'active_resource'
+
+module RedmineApi
+  class Client < ActiveResource::Base; end
+  class Issue < RedmineApi::Client; end
+end
+
+module Stagecoach
+  class Redmine
+    def self.issue(issue_number)
+      return RedmineApi::Issue.find(issue_number)
+    end
+
+    def self.issue_url(issue)
+      RedmineApi::Client.site + "/issues/" + issue.id
+    end
+
+    # Open the issue in a browser.
+    def self.view_issue(issue)
+      issue_url = Redmine.issue_url(issue)
+        print "Open planio issue in browser? [Y]es or anything else to exit:  "
+        `open #{issue_url.to_s}` if gets.chomp == "Y"
+        puts "Staging completed!  Exiting..."
+    end
+  end
+end

data/redmine_stagecoach.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "redmine_stagecoach"
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Oli Barnett"]
+  s.date = "2012-01-24"
+  s.description = "Git/capistrano workflow automation script with Redmine & Github issue integration"
+  s.email = "o.barnett@digitaleseiten.de"
+  s.executables = ["stagecoach"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/stagecoach",
+    "lib/.DS_Store",
+    "lib/githooks/commit-msg",
+    "lib/stagecoach.rb",
+    "lib/stagecoach/capistrano.rb",
+    "lib/stagecoach/command_line.rb",
+    "lib/stagecoach/config.rb",
+    "lib/stagecoach/git.rb",
+    "lib/stagecoach/redmine.rb",
+    "redmine_stagecoach.gemspec",
+    "test/helper.rb",
+    "test/test_stagecoach.rb"
+  ]
+  s.homepage = "http://github.com/omnikron/stagecoach"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Stagecoach is in ur Redmine, automating ur Git workflow."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ghi>, [">= 0"])
+      s.add_runtime_dependency(%q<trollop>, [">= 0"])
+      s.add_runtime_dependency(%q<capistrano>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<ghi>, [">= 0"])
+      s.add_dependency(%q<trollop>, [">= 0"])
+      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ghi>, [">= 0"])
+    s.add_dependency(%q<trollop>, [">= 0"])
+    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'stagecoach'
+
+class Test::Unit::TestCase
+end

data/test/test_stagecoach.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestStagecoach < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: redmine_stagecoach
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Oli Barnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ghi
+  requirement: &70166234091840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70166234091840
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &70166234091360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70166234091360
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &70166234090880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70166234090880
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70166234090400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70166234090400
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70166234089920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70166234089920
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70166234089440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70166234089440
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70166234088960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70166234088960
+description: Git/capistrano workflow automation script with Redmine & Github issue
+  integration
+email: o.barnett@digitaleseiten.de
+executables:
+- stagecoach
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/stagecoach
+- lib/.DS_Store
+- lib/githooks/commit-msg
+- lib/stagecoach.rb
+- lib/stagecoach/capistrano.rb
+- lib/stagecoach/command_line.rb
+- lib/stagecoach/config.rb
+- lib/stagecoach/git.rb
+- lib/stagecoach/redmine.rb
+- redmine_stagecoach.gemspec
+- test/helper.rb
+- test/test_stagecoach.rb
+homepage: http://github.com/omnikron/stagecoach
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2500404004806684746
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Stagecoach is in ur Redmine, automating ur Git workflow.
+test_files: []