git-trac 0.0.20080206 → 0.1.0

data/README

@@ -1,24 +1,39 @@
-Run git-trac help for usage information.
-
-Example for usage on the Ruby on Rails repository:
-
-  # Export the repository if you haven't already (start it and go to lunch)
-  $ git-svn clone --stdlayout http://dev.rubyonrails.org/svn/rails rails
-  $ cd rails
-
-  # This next step is optional but compresses the repository by a factor of 10
-  $ git gc
-
-  # Setup git-trac (only URL is mandatory)
-  $ git config trac.url http://dev.rubyonrails.org
-  $ git config trac.username myaccount
-  $ git config trac.password mypassword
-
-  # Have fun
-  $ git-trac download 1234567
-  $ git branch
-  $ git checkout some_attached_patch
-  $ git rebase trunk # if it's out of date
-  # EDIT EDIT EDIT
-  $ git commit -a
-  $ git-trac upload-patch 1234567
+= git-trac
+
+git-trac takes the repetition out of working with trac and git-svn.  Easily
+download a patch, apply it at the right point in time, turn it into a commit
+with useful metadata, and check it out into a branch, all in one command.
+Created for (but not limited to) work on the Ruby on Rails core.
+
+== Usage
+
+Running `git-trac help` gives you access to usage information, including
+information about how to use the help command to get more help.
+
+== Examples
+
+Run `git-trac help rails` for a quick start guide for the Ruby on Rails core.
+
+== License
+
+git-trac is available under an MIT-style license.
+
+:include: MIT-LICENSE
+
+== History
+
+See the NEWS file for a version history.
+
+== About
+
+Author::     Tim Pope <ruby at tpope. info>
+Home Page::  http://git-trac.rubyforge.org
+
+== Feedback
+
+Feedback welcome and appreciated.  While I intend for git-trac to be
+applicable to a wide variety of projects and setups, in practice it has been
+tested primarily on a git-svn clone of the Rails core and the official Rails
+trac while running Debian with one of a few recent versions of git.  If
+altering any combination of these variables does not work for you, please
+report it.

data/Rakefile

@@ -13,7 +13,7 @@ require File.join(File.dirname(__FILE__), 'lib', 'git', 'trac')
 
 PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
 PKG_NAME      = 'git-trac'
-PKG_VERSION   = Time.now.strftime("0.0.%Y%m%d")
+PKG_VERSION   = Git::Trac::VERSION::STRING
 PKG_FILE_NAME   = "#{PKG_NAME}-#{PKG_VERSION}"
 # PKG_DESTINATION = ENV["PKG_DESTINATION"] || "../#{PKG_NAME}"
 
@@ -39,6 +39,7 @@ Rake::RDocTask.new { |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.rdoc_files.add('lib')
   rdoc.rdoc_files.add('README')
+  rdoc.rdoc_files.add('NEWS')
   rdoc.main     = "README"
   rdoc.title    = "git-trac"
   rdoc.options << '--inline-source'
@@ -50,7 +51,7 @@ spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = PKG_NAME
   s.summary = 'Interact with trac from a git repository pulled from svn'
-  s.description = 'git-trac takes the repetition out of working with trac and git-svn.  Among other features is the ability to easily attach a patch to a ticket and to pull all patches from a ticket and turn them into git branches.  Created for (but not limited to) work on the Ruby on Rails core.'
+  s.description = 'git-trac takes the repetition out of working with trac and git-svn.  Easily download a patch, apply it at the right point in time, turn it into a commit with useful metadata, and check it out into a branch, all in one command.  Created for (but not limited to) work on the Ruby on Rails core.'
   s.version = PKG_VERSION
 
   s.author = 'Tim Pope'

data/lib/git/trac.rb

@@ -14,3 +14,4 @@ require 'git/trac/ticket'
 require 'git/trac/attachment'
 require 'git/trac/patch'
 require 'git/trac/runner'
+require 'git/trac/version'

data/lib/git/trac/attachment.rb

@@ -39,10 +39,10 @@ module Git
       end
 
       def email
-        if user =~ /\S*@\S*/
-          return user
-        elsif user =~ /<(\S*@\S*)>/
+        if user =~ /<(\S*@\S*)>/
           return $1
+        elsif user =~ /\S*@\S*/
+          return user
         else
           [user, repository.url[%r{://([^/]*)},1]].compact.join("@")
         end
@@ -52,8 +52,9 @@ module Git
         time.utc.strftime("%Y-%m-%d_%H:%M:%S_+0000")
       end
 
-      def url
-        "#{ticket.repository.url}/attachment/ticket/#{ticket.number}/#{filename}?format=raw"
+      def url(format = :raw)
+        query = "?format=#{format}" if format
+        "#{ticket.repository.url}/attachment/ticket/#{ticket.number}/#{filename}#{query}"
       end
 
       def tag_name
@@ -65,7 +66,7 @@ module Git
       end
 
       def body
-        @body ||= repository.agent.get_file(url)
+        @body ||= repository.agent.get_file(url(:raw))
       end
 
       def repository
@@ -78,8 +79,8 @@ module Git
 
       def cleanup(options = {})
         repository.each_ref("refs/remotes/#{tag_name}") do |object, ref|
-          repository.exec("git","update-ref","-d",ref,object)
-          repository.cleanup_branches(object)
+          repository.exec("git","update-ref","-d",ref,object) unless options[:only_branches]
+          repository.cleanup_branches(options, object)
           return object
         end
       end
@@ -88,9 +89,13 @@ module Git
         cleanup(options)
         FileUtils.mkdir_p(ticket.trac_dir)
         repository.with_index("tracindex#{$$}") do
-          parent = repository.exec("git","rev-list","--max-count=1","--before=#{timestamp}",options[:branch] || 'trunk').chomp
+          parent = repository.exec("git","rev-list","--max-count=1","--before=#{timestamp}",options[:upstream] || 'refs/remotes/trunk').chomp
           repository.exec("git","read-tree",parent)
-          applied = patch.apply(options.merge(:cached => true)) or return [nil,applied]
+          applied = patch.apply(options.merge(:cached => true))
+          unless applied
+            yield self, nil, nil
+            return
+          end
           tree = repository.exec("git","write-tree").chomp
           ENV["GIT_AUTHOR_NAME"] = ENV["GIT_COMMITTER_NAME"] = username
           ENV["GIT_AUTHOR_EMAIL"] = ENV["GIT_COMMITTER_EMAIL"] = email
@@ -104,7 +109,8 @@ module Git
           File.open(tag_path,"w") do |f|
             f.puts commit
           end
-          return [commit, applied]
+          yield self, applied, commit
+          return commit
         end
       ensure
         %w(GIT_AUTHOR_NAME GIT_COMMITTER_NAME GIT_AUTHOR_EMAIL GIT_COMMITTER_EMAIL GIT_AUTHOR_DATE GIT_COMMITTER_DATE).each {|e| ENV[e] = nil}

data/lib/git/trac/pager.rb

@@ -2,6 +2,18 @@ module Git
   module Trac
 
     class Repository
+      def pager(body, diff = false)
+        pager = Pager.new(ENV["GIT_PAGER"] || config("core","pager"))
+        if pager.command
+          diff &&= !%w(false no 0).include?(config("color","pager").to_s.downcase)
+        end
+        diff &&= %w(true yes 1 always auto).include?(config("color","diff").to_s.downcase)
+        pager.page(body, diff)
+      end
+
+    end
+
+    class Pager
 
       DIFF_COLORS = {
         :reset      => "\033[m",
@@ -14,27 +26,37 @@ module Git
         :whitespace => "\033[41m"
       }
 
-      def pager(body, diff = false)
-        pager = ENV["GIT_PAGER"] || config("core","pager") || ENV["PAGER"] || "less"
-        return colorize_diff_output($stdout, body) if pager.empty? && diff
-        return $stdout.puts(body) if !$stdout.tty? || pager.empty?
+      attr_reader :command
+
+      def initialize(command = nil)
+        @command = command || ENV["PAGER"] || "less"
+        @command = nil if @command.empty?
+      end
+
+      def page(body, diff = false)
+        less = ENV["LESS"]
         ENV["LESS"] ||= "FRSX"
 
-        IO.popen(pager, "w") do |io|
-          if diff && !%w(false no 0).include?(config("color","pager").to_s.downcase)
-            colorize_diff_output(io, body)
-          else
-            io.puts body
+        return $stdout.puts(body) unless $stdout.tty?
+
+        if command.nil?
+          output_to_io($stdout, body, diff)
+        else
+          IO.popen(command, "w") do |io|
+            output_to_io(io, body, diff)
           end
         end
+
       rescue Errno::EPIPE
         # Pager was terminated
+      ensure
+        ENV["LESS"] = less
       end
 
       private
 
-      def colorize_diff_output(io, body)
-        if %w(true yes 1 always auto).include?(config("color","diff").to_s.downcase)
+      def output_to_io(io, body, diff)
+        if diff
           state = nil
           body.each_line do |line|
             if state.nil? && line !~ /^(diff|Index:) /

data/lib/git/trac/repository.rb

@@ -138,6 +138,12 @@ module Git
         options[:url] || config("svn-remote.svn",:url).to_s[%r{(http://.*)/svn},1]
       end
 
+      def get_response(uri)
+        require 'net/http'
+        require 'uri'
+        Net::HTTP.get_response(URI.parse(uri))
+      end
+
       def agent
         unless defined?(@agent)
           unless url
@@ -192,15 +198,32 @@ module Git
         hash
       end
 
-      def cleanup_branches(*revs)
+      def cleanup_branches(options, *revs)
         return if revs.empty?
+        diff_hashes = revs.map {|r| diff_hash(r)}.compact if options[:rebased]
+        current = current_checkout
         each_ref("refs/heads") do |object, ref|
-          if revs.include?(object) && current_checkout != File.basename(ref)
-            exec("git","branch","-D",File.basename(ref))
+          if current != File.basename(ref)
+            if revs.include?(object)
+              exec("git","branch","-D",File.basename(ref))
+            elsif diff_hashes && diff_hashes.include?(dh = diff_hash(ref))
+              p "wooo!"
+              exec("git","branch","-D",File.basename(ref))
+            end
           end
         end
       end
 
+      def diff_hash(head)
+        require 'digest/sha1'
+        guess = guess_upstream(head)
+        return unless guess
+        diff = exec("git","diff","#{guess}...#{head}")
+        diff.gsub!(/^(?:index |@@ -).*\n/,'')
+        diff.gsub!(/[[:space:]]/,'')
+        Digest::SHA1.digest(diff)
+      end
+
       # See if the current commit or an ancestor was previously tagged as a
       # trac ticket.  Also check git config branch.branchname.tracticket
       def guess_current_ticket_number
@@ -215,6 +238,34 @@ module Git
         end
       end
 
+      def guess_upstream(head = "HEAD")
+        svn = config("svn-remote.svn")
+        return unless (svn||{})[:url]
+        branch = popen3("git","log","--no-color",head) do |i,o,e|
+          o.each_line do |line|
+            next unless line.gsub!(/^\s*git-svn-id:\s*/,'')
+            url, uuid = line.chomp.split(" ")
+            url.sub!(/^#{Regexp.escape(svn[:url])}\/*/,'')
+            branch, revision = url.split("@")
+            break branch
+          end
+        end
+        if branch
+          trunk = svn[:trunk] || "trunk:refs/remotes/trunk"
+          branches = svn[:branches] || "branches/*:refs/remotes/*"
+          tags = svn[:tags] || "tags/*:refs/remotes/tags/*"
+          [trunk, branches, tags].each do |pair|
+            remote, local = pair.split(":",2)
+            next if local.to_s.empty?
+            before, after = remote.split("*",2)
+            if branch =~ /^#{Regexp.escape(before)}(.*)#{Regexp.escape(after.to_s)}/
+              return local.sub(/\*/,$1)
+            end
+          end
+          svn["branches"].to_s
+        end
+      end
+
       # Fetch a ticket object by number.
       def ticket(number)
         Ticket.new(self, number)

data/lib/git/trac/runner.rb

@@ -10,7 +10,50 @@ module Git
 
     class Runner #:nodoc:
 
-      attr_reader :options
+      def self.for_command(command)
+        klass_name = command.to_s.capitalize.gsub(/-(.)/) { $1.upcase }
+        if klass_name =~ /^[A-Z]\w*$/ && const_defined?(klass_name)
+          klass = const_get(klass_name)
+          if klass < Base
+            return klass
+          end
+        end
+      end
+
+      def self.commands
+        Runner.constants.map {|c| Runner.const_get(c)}.select {|c| c < Runner::Base}.sort_by {|r| r.command}.uniq
+      end
+
+      module Fetchable #:nodoc:
+
+        def add_options(opts)
+          super
+          opts.on("--against BRANCH","apply against branch BRANCH") do |b|
+            options[:upstream] = b
+          end
+          opts.on("--depth NUM","search depth (see git-trac help apply)") do |n|
+            options[:depth] = n
+          end
+          opts.on("--root DIR","apply patches relative to DIR") do |dir|
+            options[:root] = dir
+          end
+          add_local_option(opts)
+        end
+
+        def run
+          options[:upstream] ||= repository.guess_upstream || "refs/remotes/trunk"
+          fetch_unless_local
+          attachment = one_attachment
+          fetch_or_abort(attachment)
+          repository.in_work_tree do
+            after_fetch(attachment)
+          end
+        end
+
+        def after_fetch(attachment)
+        end
+
+      end
 
       def initialize(argv)
         @argv = argv.dup
@@ -18,6 +61,8 @@ module Git
       rescue Git::Trac::Error
         $stderr.puts "Error: " + $!.message
         exit 1
+      rescue Interrupt
+        $stderr.puts "Interrupted!"
       end
 
       def abort(message)
@@ -27,43 +72,22 @@ module Git
       def general_usage
         $stderr.puts <<-EOS
 Usage: git-trac <command> [options] [arguments]
-
-Available commands:
-        apply           Apply a patch directly to the work tree
-        cleanup         Remove old branches for a ticket
-        download        Download all patches for a ticket to the cwd
-        fetch           Create brances for all patches of a ticket
-        show            Show a summary of a ticket
-        upload-patch    Upload the current diff against trunk to a ticket
+See `git-trac help` for details.
         EOS
         exit 1
       end
 
       def run
 
-        command = @argv.shift
+        command = @argv.shift unless %w(-v --version).include?(@argv.first)
         repo = nil
         if command == "--repository"
           repo, command = @argv.shift, @argv.shift
         end
+        command = "help" if %w(-h --help).include?(command)
 
-        if command == "help"
-          command = @argv.shift
-          @argv.unshift "--help"
-        end
-        general_usage unless command
-
-        @repository = Git::Trac::Repository.new(repo)
-        unless @repository.url || @argv.first == "--help"
-          abort "no URL.  Try `git config trac.url http://trac-url`"
-        end
-
-        klass_name = command.capitalize.gsub(/-(.)/) { $1.upcase }
-        if klass_name =~ /^[A-Z]\w*$/ && self.class.const_defined?(klass_name)
-          klass = self.class.const_get(klass_name)
-          if klass < Base
-            return klass.new(@argv, @repository)
-          end
+        if klass = Runner.for_command(command || "help")
+          return klass.new(@argv, repo)
         end
 
         general_usage
@@ -72,13 +96,17 @@ Available commands:
 
       class Base #:nodoc:
 
-        attr_reader :options
-
         def initialize(argv, repo)
-          @argv, @repository = argv, repo
-          @options = repo.config("trac") || {}
+          @argv, @repository_option = argv, repo
           @opts = OptionParser.new
-          @opts.banner = "Usage: git-trac #{command} #{banner_arguments}\n#{"\n" if description}#{description}"
+          @opts.banner = "Usage: git-trac #{self.class.command} #{banner_arguments}"
+          @opts.version = Git::Trac::VERSION::STRING
+          @opts.base.long["help"] = OptionParser::Switch::NoArgument.new do
+            help = @opts.help.chomp.chomp + "\n"
+            help += "\n#{description}" if description
+            Pager.new.page(help)
+            exit
+          end
           @opts.separator("")
           add_options(@opts)
           begin
@@ -89,35 +117,63 @@ Available commands:
           run
         end
 
+        def repository
+          @repository ||= Git::Trac::Repository.new(@repository_option)
+          unless @repository.url
+            abort "no URL.  Try `git config trac.url http://trac-url`"
+          end
+          @repository
+        end
+
+        def options
+          @options ||= repository.config("trac") || {}
+        end
+
         def description
         end
 
-        def get_ticket_number
-          if @argv.first =~ /^\d+$/
-            Integer(@argv.shift)
-          elsif number = @repository.guess_current_ticket_number
-            number
-          elsif block_given?
-            yield
-          else
-            abort "ticket number required"
+        def system(*args)
+          repository.in_work_tree do
+            Kernel.system(*args) or exit $?.exitstatus
           end
         end
 
-        def each_ticket_argument
-          if @argv.empty?
-            yield get_ticket_number, nil
-          elsif @argv.any? {|a| a !~ /\b\d+\b/}
-            abort "ticket number required"
+        def parse_attachment(arg)
+          if match_data = arg.to_s.match(/\b(\d+)\b(?:\/([^?\/]+))?/)
+            return Integer(match_data[1]), match_data[2]
+          else
+            abort "invalid argument '#{arg}'"
           end
-          @argv.each do |arg|
-            match_data = arg.match(/\b(\d+)\b(?:\/([^?\/]+))?/)
-            yield Integer(match_data[1]), match_data[2]
+        end
+
+        def one_attachment(abort_when_extra = true)
+          missing_argument if @argv.empty?
+          number, filename = parse_attachment(@argv.shift)
+          too_many_arguments if abort_when_extra && @argv.any?
+          return repository.ticket(number).attachment(filename)
+        end
+
+        def each_ticket_or_attachment(abort_when_missing = true)
+          missing_argument if abort_when_missing && @argv.empty?
+          until @argv.empty?
+            number, filename = parse_attachment(@argv.shift)
+            ticket = repository.ticket(number)
+            if filename
+              yield ticket.attachment(filename)
+            else
+              yield ticket
+            end
           end
         end
 
-        def require_ticket_number
-          @opts.separator("Ticket number is required unless it can be derived from the current branch.\n")
+        def each_attachment(abort_when_missing = true)
+          each_ticket_or_attachment(abort_when_missing) do |object|
+            if object.respond_to?(:attachments)
+              object.attachments.each {|a| yield a}
+            else
+              yield attachment
+            end
+          end
         end
 
         def abort(message)
@@ -125,6 +181,24 @@ Available commands:
           exit(1)
         end
 
+        def too_many_arguments
+          abort "too many arguments"
+        end
+
+        def missing_argument(label = "attachment")
+          abort "#{label} expected but none given"
+        end
+
+        def fetch_or_abort(attachment)
+          branch = options[:upstream] || repository.guess_upstream || "refs/remotes/trunk"
+          attachment.fetch(options) do |a, dir, commit|
+            unless dir
+              abort "failed to apply #{attachment.tag_name} to #{branch.sub(/^refs\/(?:remotes\/)?/,'')}"
+            end
+          end
+          attachment
+        end
+
         def add_options(opts)
         end
 
@@ -132,8 +206,12 @@ Available commands:
           "[options]"
         end
 
+        def self.command
+          name[/[^:]*$/].gsub(/(.)([A-Z])/) { $1+"-"+$2 }.downcase
+        end
+
         def command
-          self.class.name[/[^:]*$/].gsub(/(.)([A-Z])/) { $1+"-"+$2 }.downcase
+          self.class.command
         end
 
         def add_local_option(opts)
@@ -144,17 +222,12 @@ Available commands:
 
         def fetch_unless_local
           unless options[:local]
-            if @repository.config("svn-remote.svn")
-              command = "git svn fetch"
-            elsif @repository.config("origin")
-              command = "git fetch origin"
-            else
-              return
-            end
-            @repository.in_work_tree do
-              unless system(command)
-                abort "#{command} failed (use --local to skip)"
-              end
+            if options[:fetch_command]
+              system(options[:fetch_command])
+            elsif repository.config("svn-remote.svn")
+              system("git svn fetch")
+            elsif repository.config("origin")
+              system("git fetch origin")
             end
           end
         end
@@ -166,8 +239,9 @@ Available commands:
 end
 
 require 'git/trac/runner/apply'
+require 'git/trac/runner/checkout'
 require 'git/trac/runner/cleanup'
-require 'git/trac/runner/download'
 require 'git/trac/runner/fetch'
+require 'git/trac/runner/help'
+require 'git/trac/runner/push'
 require 'git/trac/runner/show'
-require 'git/trac/runner/upload_patch'