rake_commit 0.1.0

data/README.rdoc

@@ -0,0 +1,69 @@
+= rake_commit_tasks
+
+This plugin contains a set of rake tasks for checking your project into source control (git or subversion).  The most important is:
+
+  rake commit
+
+which does the following, depending on source control:
+
+==== git
+
+  1. Resets soft back to origin/branch (in order to collapse changes into one commit)
+  2. Adds new files to git and removes deleted files
+  3. Prompts for a commit message
+  4. Commits to git
+  5. Pulls changes from origin (and does a rebase to keep a linear history)
+  6. Runs the default rake task (which should run the tests)
+  7. Checks cruisecontrol.rb to see if the build is passing
+  8. Pushes the commit to origin
+
+==== git-svn
+
+  1. Adds new files to git and removes deleted files
+  2. Prompts for a commit message
+  3. Commits to local git
+  4. Pulls changes from SVN
+  5. Runs the default rake task (which should run the tests)
+  6. Checks cruisecontrol.rb to see if the build is passing
+  7. Pushes the commit to SVN
+
+==== subversion
+
+  1. Prompts for a commit message
+  2. Adds new files to subversion
+  3. Deletes missing files from subversion
+  4. svn update
+  5. Runs the default rake task (which should run the tests)
+  6. Checks cruisecontrol.rb to see if the build is passing
+  7. Checks in the code
+
+
+The first version started with the code posted at Jay Field's Blog: http://blog.jayfields.com/2006/12/ruby-rake-commit.html.
+Improvements have been added in from several more projects.
+
+== Installation
+
+  git clone git://github.com/pgr0ss/rake_commit_tasks.git vendor/plugins/rake_commit_tasks
+  rake commit
+
+== Customization
+
+=== Preventing checkins on broken builds
+
+If you want the build to check your cruisecontrol.rb instance and prompt you 
+before checking in on a broken build, set CCRB_RSS to the location of the RSS feed.
+
+For example, in your Rakefile:
+
+  CCRB_RSS = 'http://example.com:3333/projects.rss'
+
+=== Automatically merging from branch to trunk (subversion)
+
+If you want the build to automatically merge changes to the trunk when checking in on the branch, set PATH_TO_TRUNK_WORKING_COPY to the location of the checked out trunk working copy.
+
+For example, in your Rakefile:
+
+  PATH_TO_TRUNK_WORKING_COPY = "/Users/someone/my_project_trunk"
+
+Now, if you have a branch checked out into /Users/someone/my_project_1.1 and you do a rake commit, the checkin will be merged into the trunk after the change is committed to the branch.  Then, you can "cd /Users/someone/my_project_trunk" and check in the merged changes in the trunk.  This behavior is described in more depth at http://www.pgrs.net/2007/10/16/automatically-merge-changes-from-branch-to-trunk
+

data/Rakefile

@@ -0,0 +1,19 @@
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+desc "clean"
+task :clean do
+  rm_f Dir.glob("*.gem")
+end
+
+namespace :gem do
+  desc "build the gem"
+  task :build => :clean do
+    sh "gem build rake_commit.gemspec"
+  end
+end

data/bin/rake_commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + "/../lib/commit"
+
+Commit.new.commit

data/lib/commit.rb

@@ -0,0 +1,58 @@
+require 'rexml/document'
+
+Dir.glob(File.expand_path(File.dirname(__FILE__) + '/*.rb')) do |file|
+  require file
+end
+
+class Commit
+  def git?
+    `git symbolic-ref HEAD 2>/dev/null`
+    $?.success?
+  end
+
+  def git_svn?
+    `git svn info 2> /dev/null`
+    $?.success?
+  end
+
+  def commit
+    if git_svn?
+      GitSvn.new.commit
+    elsif git?
+      Git.new.commit
+    else
+      Svn.new.commit
+    end
+  end
+end
+
+
+def ok_to_check_in?
+  return true unless self.class.const_defined?(:CCRB_RSS)
+  cruise_status = CruiseStatus.new(CCRB_RSS)
+  cruise_status.pass? ? true : are_you_sure?( "Build FAILURES: #{cruise_status.failures.join(', ')}" )
+end
+
+def git_commit_with_message
+  commit_message = CommitMessage.new
+  sh_with_output("git config user.name #{commit_message.pair.inspect}")
+  message = "#{commit_message.feature} - #{commit_message.message}"
+  sh_with_output("git commit -m #{message.inspect}")
+end
+
+def are_you_sure?(message)
+  puts "\n", message
+  input = ""
+  while (input.strip.empty?)
+    input = Readline.readline("Are you sure you want to check in? (y/n): ")
+  end
+  return input.strip.downcase[0,1] == "y"
+end
+
+def sh_with_output(command)
+  puts command
+  output = `#{command}`
+  puts output
+  raise unless $?.success?
+  output
+end

data/lib/commit_message.rb

@@ -0,0 +1,14 @@
+class CommitMessage
+
+  attr_reader :pair, :feature, :message
+
+  def initialize
+    @pair = PromptLine.new("pair").prompt
+    @feature = PromptLine.new("feature").prompt
+    @message = PromptLine.new("message").prompt
+  end
+
+  def joined_message
+    [@pair, @feature, @message].join(' - ')
+  end
+end

data/lib/cruise_status.rb

@@ -0,0 +1,25 @@
+require 'rexml/document'
+require "open-uri"
+
+class CruiseStatus
+
+  def initialize(feed_url)
+    project_feed = open(feed_url).read
+    @doc = REXML::Document.new(project_feed)
+  rescue Exception => e
+    @failures = [e.message]
+    @doc = REXML::Document.new("")
+  end
+
+  def pass?
+    failures.empty?
+  end
+
+  def failures
+    @failures ||= REXML::XPath.match(@doc, "//item/title").select { |element|
+      element.text =~ /failed$/
+    }.map do |element|
+      element.text.gsub( /(.*) build (.+) failed$/, '\1' )
+    end
+  end
+end

data/lib/git.rb

@@ -0,0 +1,70 @@
+class Git
+  def commit
+    collapse_git_commits if collapse_git_commits?
+
+    Shell.system("rake")
+
+    if ok_to_check_in?
+      push
+    end
+  end
+
+  def collapse_git_commits?
+    return true unless merge_commits?
+    status
+    input = Readline.readline("Do you want to collapse merge commits? (y/n): ").chomp
+    input == "y"
+  end
+
+  def collapse_git_commits
+    add
+    temp_commit
+    reset_soft
+    status
+    commit_message = CommitMessage.new
+    Shell.system("git config user.name #{commit_message.pair.inspect}")
+    message = "#{commit_message.feature} - #{commit_message.message}"
+    Shell.system("git commit -m #{message.inspect}")
+    pull_rebase
+  end
+
+  def status
+    Shell.system "git status"
+  end
+
+  def add
+    Shell.system "git add -A ."
+  end
+
+  def reset_soft
+    raise "Could not determine branch" unless git_branch
+    Shell.system "git reset --soft #{merge_base}"
+  end
+
+  def pull_rebase
+    Shell.system "git pull --rebase"
+  end
+
+  def push
+    Shell.system "git push origin #{git_branch}"
+  end
+
+  def temp_commit
+    Shell.system "git commit -m 'rake_commit backup commit'"
+  end
+
+  def git_branch
+    @git_branch ||= begin
+      output = Shell.backtick("git symbolic-ref HEAD")
+      output.gsub('refs/heads/', '').strip
+    end
+  end
+
+  def merge_commits?
+    Shell.backtick("git log --merges #{merge_base}..HEAD").any?
+  end
+
+  def merge_base
+    @merge_base ||= Shell.backtick("git merge-base #{git_branch} origin/#{git_branch}").strip
+  end
+end

data/lib/git_svn.rb

@@ -0,0 +1,27 @@
+class GitSvn
+  def commit
+    git = Git.new
+    git.add
+    git.status
+    git_svn_commit_with_message
+    rebase
+    Shell.system "rake"
+    if ok_to_check_in?
+      dcommit
+    end
+  end
+
+  def git_svn_commit_with_message
+    commit_message = CommitMessage.new
+    message = "#{commit_message.pair} - #{commit_message.feature} - #{commit_message.message}"
+    Shell.system "git commit -m #{message.inspect}"
+  end
+
+  def rebase
+    Shell.system "git svn rebase"
+  end
+
+  def dcommit
+    Shell.system "git svn dcommit"
+  end
+end

data/lib/prompt_line.rb

@@ -0,0 +1,46 @@
+require 'readline'
+require 'tmpdir'
+
+class PromptLine
+
+  def initialize(attribute)
+    @attribute = attribute
+  end
+
+  def prompt
+    input = nil
+    loop do
+      input = Readline.readline(message).chomp
+      break unless (input.empty? && saved_data.empty?)
+    end
+
+    if input.any?
+      save(input)
+      return input
+    end
+
+    puts "using: #{saved_data}"
+    return saved_data
+  end
+
+  def message
+    previous = saved_data
+    message = "\n"
+    message += "previous #{@attribute}: #{previous}\n" if previous.any?
+    message + "#{@attribute}: "
+  end
+
+  def save(input)
+    File.open(path(@attribute), "w") {|f| f.write(input) }
+  end
+
+  private
+  def saved_data
+    @saved_data ||= File.exists?(path(@attribute)) ? File.read(path(@attribute)) : ""
+  end
+
+  def path(attribute)
+    File.expand_path(Dir.tmpdir + "/#{attribute}.data")
+  end
+
+end

data/lib/shell.rb

@@ -0,0 +1,11 @@
+class Shell
+  def self.system(cmd)
+    Kernel.system(cmd) or raise
+  end
+
+  def self.backtick(cmd)
+    output = `#{cmd}`
+    raise unless $?.success?
+    output
+  end
+end

data/lib/svn.rb

@@ -0,0 +1,85 @@
+require 'fileutils'
+
+class Svn
+  def commit
+    if files_to_check_in?
+      message = CommitMessage.new.joined_message
+      add
+      delete
+      up
+      Shell.system "rake"
+
+      if ok_to_check_in?
+        output = Shell.backtick "#{commit_command(message)}"
+        puts output
+        revision = output.match(/Committed revision (\d+)\./)[1]
+        merge_to_trunk(revision) if Shell.backtick("svn info").include?("branches") && self.class.const_defined?(:PATH_TO_TRUNK_WORKING_COPY)
+      end
+    else
+      puts "Nothing to commit"
+    end
+  end
+
+  def commit_command(message)
+    "svn ci -m #{message.inspect}"
+  end
+
+  def files_to_check_in?
+    Shell.backtick("svn st --ignore-externals").split("\n").reject {|line| line[0,1] == "X"}.any?
+  end
+
+  def status
+    Shell.system "svn st"
+  end
+
+  def up
+    output = Shell.backtick "svn up"
+    puts output
+    output.each do |line|
+      raise "SVN conflict detected. Please resolve conflicts before proceeding." if line[0,1] == "C"
+    end
+  end
+
+  def add
+    Shell.backtick("svn st").split("\n").each do |line|
+      if new_file?(line) && !svn_conflict_file?(line)
+        file = line[7..-1].strip
+        Shell.system "svn add #{file.inspect}"
+      end
+    end
+  end
+
+  def new_file?(line)
+    line[0,1] == "?"
+  end
+
+  def svn_conflict_file?(line)
+    line =~ /\.r\d+$/ || line =~ /\.mine$/
+  end
+
+  def delete
+    Shell.backtick("svn st").split("\n").each do |line|
+      if line[0,1] == "!"
+        file = line[7..-1].strip
+        Shell.backtick "svn up #{file.inspect} && svn rm #{file.inspect}"
+        puts %[removed #{file}]
+      end
+    end
+  end
+
+  def revert_all
+    Shell.system "svn revert -R ."
+    Shell.backtick("svn st").split("\n").each do |line|
+      next unless line[0,1] == '?'
+      filename = line[1..-1].strip
+      puts "removed #{filename}"
+      FileUtils.rm_r filename
+    end
+  end
+
+  def merge_to_trunk(revision)
+    puts "Merging changes into trunk.  Don't forget to check these in."
+    Shell.system "svn up #{PATH_TO_TRUNK_WORKING_COPY.inspect}"
+    Shell.system "svn merge -c #{revision} . #{PATH_TO_TRUNK_WORKING_COPY.inspect}"
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: rake_commit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Paul Gross
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-09 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: See http://github.com/pgr0ss/rake_commit_tasks
+email: pgross@gmail.com
+executables: 
+- rake_commit
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- Rakefile
+- lib/commit.rb
+- lib/commit_message.rb
+- lib/cruise_status.rb
+- lib/git.rb
+- lib/git_svn.rb
+- lib/prompt_line.rb
+- lib/shell.rb
+- lib/svn.rb
+has_rdoc: true
+homepage: http://github.com/pgr0ss/rake_commit_tasks
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rake_commit
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A gem which helps with checking in code
+test_files: []
+