rake_commit 0.10.0 → 0.11.0

data/README.rdoc

@@ -11,8 +11,7 @@ This gem automates a pretty standard workflow when committing code to git, svn,
   5. Commits to git
   6. Pulls changes from origin (and does a rebase to keep a linear history)
   7. Runs the default rake task (which should run the tests)
-  8. Checks cruisecontrol.rb to see if the build is passing
-  9. Pushes the commit to origin
+  8. Pushes the commit to origin
 
 ==== git-svn
 
@@ -21,8 +20,7 @@ This gem automates a pretty standard workflow when committing code to git, svn,
   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
+  6. Pushes the commit to SVN
 
 ==== subversion
 
@@ -31,8 +29,7 @@ This gem automates a pretty standard workflow when committing code to git, svn,
   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
+  6. 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.
@@ -40,31 +37,27 @@ Improvements have been added in from several more projects.
 
 == Installation
 
-  sudo gem install rake_commit
+  gem install rake_commit
 
 == Usage
 
   cd /path/to/project
   rake_commit
 
-== Customization - these currently do not work in gem version yet
+=== Command line arguments
 
-=== Preventing checkins on broken builds
+  --help
 
-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.
+Print help information.
 
-For example, in your Rakefile:
+  --incremental
 
-  CCRB_RSS = 'http://example.com:3333/projects.rss'
+This will prompt as normal and then commit without running tests or pushing. This is useful for make incremental commits while working.
 
-=== Automatically merging from branch to trunk (subversion)
+  --no-collapse
 
-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.
+This tells rake_commit not to prompt and make a new commit. This is useful when you've done a merge by hand and want to preserve the commit. It will stil run rake and then push if rake succeeds.
 
-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
+  --without-prompt <prompt>
 
+This will cause rake_commit to skip the named prompt. For example, if you are working by yourself and do not need to prompt for a pair, you can use --without-prompt pair.

data/bin/rake_commit

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

data/lib/commit.rb

@@ -19,30 +19,34 @@ class Commit
   def commit
     collapse_commits = true
     incremental = false
+    prompt_exclusions = []
 
     opts = GetoptLong.new(
       [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
       [ '--no-collapse', '-n', GetoptLong::NO_ARGUMENT ],
-      [ '--incremental', '-i', GetoptLong::NO_ARGUMENT ]
+      [ '--incremental', '-i', GetoptLong::NO_ARGUMENT ],
+      [ '--without-prompt', '-w', GetoptLong::REQUIRED_ARGUMENT]
     )
     opts.each do |opt, arg|
       case opt
       when '--help'
         usage
         return
-      when '--no-collapse'
-        collapse_commits = false
       when '--incremental'
         incremental = true
+      when '--no-collapse'
+        collapse_commits = false
+      when '--without-prompt'
+        prompt_exclusions << arg
       end
     end
 
     if git_svn?
-      GitSvn.new.commit
+      GitSvn.new(prompt_exclusions).commit
     elsif git?
-      Git.new(collapse_commits, incremental).commit
+      Git.new(collapse_commits, incremental, prompt_exclusions).commit
     else
-      Svn.new.commit
+      Svn.new(prompt_exclusions).commit
     end
   end
 
@@ -56,19 +60,3 @@ Usage: rake_commit [OPTION]
     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 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

data/lib/commit_message.rb

@@ -2,13 +2,13 @@ class CommitMessage
 
   attr_reader :pair, :feature, :message
 
-  def initialize
-    @pair = PromptLine.new("pair").prompt
-    @feature = PromptLine.new("feature").prompt
-    @message = PromptLine.new("message").prompt
+  def initialize(prompt_exclusions = [])
+    @pair = PromptLine.new("pair", prompt_exclusions).prompt
+    @feature = PromptLine.new("feature", prompt_exclusions).prompt
+    @message = PromptLine.new("message", prompt_exclusions).prompt
   end
 
   def joined_message
-    [@pair, @feature, @message].join(' - ')
+    [@pair, @feature, @message].compact.join(' - ')
   end
 end

data/lib/git.rb

@@ -1,22 +1,18 @@
 class Git
 
-  def initialize(collapse_commits = true, incremental = false)
+  def initialize(collapse_commits = true, incremental = false, prompt_exclusions = [])
     @collapse_commits = collapse_commits
     @incremental = incremental
+    @prompt_exclusions = prompt_exclusions
   end
 
   def commit
     if @incremental
-      add
       incremental_commit
     else
       collapse_git_commits if @collapse_commits && collapse_git_commits?
-
       Shell.system("rake")
-
-      if ok_to_check_in?
-        push
-      end
+      push
     end
   end
 
@@ -46,9 +42,11 @@ class Git
   end
 
   def incremental_commit
-    commit_message = CommitMessage.new
-    Shell.system("git config user.name #{commit_message.pair.inspect}")
-    message = "#{commit_message.feature} - #{commit_message.message}"
+    commit_message = CommitMessage.new(@prompt_exclusions)
+    unless commit_message.pair.nil?
+      Shell.system("git config user.name #{commit_message.pair.inspect}")
+    end
+    message = [commit_message.feature, commit_message.message].compact.join(" - ")
     Shell.system("git commit -m #{message.inspect}")
   end
 

data/lib/git_svn.rb

@@ -1,4 +1,8 @@
 class GitSvn
+  def initialize(prompt_exclusions = [])
+    @prompt_exclusions = prompt_exclusions
+  end
+
   def commit
     git = Git.new
     git.add
@@ -6,14 +10,11 @@ class GitSvn
     git_svn_commit_with_message
     rebase
     Shell.system "rake"
-    if ok_to_check_in?
-      dcommit
-    end
+    dcommit
   end
 
   def git_svn_commit_with_message
-    commit_message = CommitMessage.new
-    message = "#{commit_message.pair} - #{commit_message.feature} - #{commit_message.message}"
+    message = CommitMessage.new(@prompt_exclusions).joined_message
     Shell.system "git commit -m #{message.inspect}"
   end
 

data/lib/prompt_line.rb

@@ -3,11 +3,13 @@ require 'tmpdir'
 
 class PromptLine
 
-  def initialize(attribute)
+  def initialize(attribute, prompt_exclusions = [])
     @attribute = attribute
+    @prompt_exclusions = prompt_exclusions
   end
 
   def prompt
+    return nil if @prompt_exclusions.include?(@attribute)
     input = nil
     loop do
       input = Readline.readline(message).chomp

data/lib/svn.rb

@@ -1,20 +1,21 @@
 require 'fileutils'
 
 class Svn
+
+  def initialize(prompt_exclusions = [])
+    @prompt_exclusions = prompt_exclusions
+  end
+
   def commit
     if files_to_check_in?
-      message = CommitMessage.new.joined_message
+      message = CommitMessage.new(@prompt_exclusions).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
+      output = Shell.backtick "#{commit_command(message)}"
+      puts output
+      revision = output.match(/Committed revision (\d+)\./)[1]
     else
       puts "Nothing to commit"
     end
@@ -76,10 +77,4 @@ class Svn
       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

@@ -2,7 +2,7 @@
 name: rake_commit
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors: 
 - Paul Gross
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 -05:00
+date: 2011-05-21 00:00:00 -05:00
 default_executable: 
 dependencies: []