svn-command 0.0.3 → 0.0.4

data/Readme

@@ -1,14 +1,14 @@
 = <i>Enhanced Subversion command</i> -- an +svn+ command wrapper
 
 [*Environment*:]           Command line 
+[<b>Home page</b>:]        http://svncommand.rubyforge.org/
 [<b>Project site</b>:]     http://rubyforge.org/projects/svncommand
-[<b>Documentation</b>:]    http://svncommand.rubyforge.org/
 [<b>Wiki</b>:]             http://wiki.qualitysmith.com/svn-command
 [<b>Author</b>:]           Tyler Rick
 
 == Introduction
 
-This is a replacement <tt>svn</tt> <b>command-line client</b> meant to be used instead of the standard +svn+ command.
+This is a replacement <tt>svn</tt> <b>command-line client</b> meant to be used instead of the standard +svn+ command. Actually, it's a /wrapper/, not a replacement, because it still uses <tt>/usr/bin/svn</tt> to do all the dirty work.
 
 == Installation
 
@@ -18,25 +18,29 @@ Currently a _patched_ version of Console::Command is required. The patched vesio
 
   /usr/lib/ruby/gems/1.8/gems/facets-1.8.51/lib/facets/more/command.rb
 
-(These changes will hopefully be absorbed into the next release.)
+(These changes will hopefully be absorbed into the next release of facets. I apologize for the inconvenience.)
 
 === Installation: Per system
 
   sudo gem install svn-command 
 
-You also need to make those files executable (once per _system_):
+You also need to make those files *executable* (once per _system_):
 
   sudo chmod a+x /usr/lib/ruby/gems/1.8/gems/svn-command-0.0.3/bin/*
 
-(We can't just set <tt>executables = "svn"</tt> because that would cause it to wipe out the existing executable at <tt>/usr/bin/svn</tt>! If you know of a better, more automatic solution to this, please let the developers know!)
+(We can't just set <tt>executables = "svn"</tt> and have it automatically install it to /usr/bin because that would cause it to <b>wipe out</b> the existing executable at <tt>/usr/bin/svn</tt>! If you know of a better, more automatic solution to this, please let the developers know!)
 
 And for some reason I seem to have to restart my terminal after doing the chmod step for bash to detect the svn command in that new location.
 
 === Installation: Per user
 
-*Important*: You need the gem's +bin+ directory to be added to the <b><i>front</i></b> of your path. This requires adding/editing a <tt>PATH=</tt> command in your <tt>~/.bash_profile</tt>. For example:
+*Important*: You need the gem's +bin+ directory to be added to the <b><i>front</i></b> of your path. This requires adding/editing a <tt>PATH=</tt> command in your <tt>~/.bash_profile</tt> (or equivalent). For example:
 
-  export PATH=/usr/lib/ruby/gems/1.8/gems/svn-command-0.0.3/bin:$PATH
+  export PATH=`ls -d /usr/lib/ruby/gems/1.8/gems/svn-command* | tail -n1`/bin:$PATH
+ 
+Or hard-code the path, if you really want to:
+
+  export PATH=/usr/lib/ruby/gems/1.8/gems/svn-command-0.0.4/bin:$PATH
 
 (I'm not sure if this is possible to automate with the <tt>gem install</tt> process or not. But in the meantime you need to do it manually.)
 
@@ -48,18 +52,22 @@ You'll know it's working by way of two signs:
 == Features
 
 Changes to existing subcommands:
-* <tt>svn diff</tt> output is in _color_ (requires +colordiff+, see below)
+* <tt>svn diff</tt> output is in _color_* (requires +colordiff+, see below)
 * <tt>svn diff</tt> includes the differences from your *externals* too (consistent with how <tt>svn status</tt> includes them) so that you don't forget to commit those changes too!
-* <tt>svn status</tt> output filters out distracting, useless output about externals (if you want a list of externals, use <tt>svn externals</tt>
+* <tt>svn status</tt>
+** filters out distracting, useless output about externals (don't worry -- it still shows which files were _modified_)
+** the flags (?, M, C, etc.) are in *color*!
+
+(* You can pass --no-color to disable colors for a single command...useful if you want to pipe the output to another command or something. Eventually maybe we could make this a per-user option via .svn-command?)
 
 New subcommands:
-* <tt>svn each_unadded</tt> (+eu+) -- goes through each unadded (<tt>?</tt>) file reported by <tt>svn status</tt> and asks you what to do with them (add, delete, ignore).
-* <tt>svn externals</tt>
+* <tt>svn each_unadded</tt> (+eu+, +unadded+) -- goes through each unadded (<tt>?</tt>) file reported by <tt>svn status</tt> and asks you what to do with them (add, delete, ignore).
+* <tt>svn externals</tt> -- lists all externals
 * <tt>svn edit_externals</tt> (+ee+)
 * <tt>svn externalize</tt>
-* <tt>svn set_message</tt> / <tt>svn get_message</tt> / <tt>svn edit_message</tt>
-* <tt>svn ignore</tt>
-* <tt>svn view_commits</tt> (gives you output from both svn log and from svn diff for the given changesets)
+* <tt>svn set_message</tt> / <tt>svn get_message</tt> / <tt>svn edit_message</tt> -- shortcuts for accessing <tt>--revprop svn:log</tt>
+* <tt>svn ignore</tt> -- shortcut for accessing <tt>svn:ignore</tt> property
+* <tt>svn view_commits</tt> -- gives you output from both <tt>svn log</tt> and from <tt>svn diff</tt> for the given changesets (useful for code reviews)
 
 (RDoc question: how do I make the identifiers like Subversion::SvnCommand#externalize into links??)
 
@@ -129,7 +137,7 @@ It simply goes through each "unadded" file (each file reporting a status of <tt>
   Are you pretty much *SURE* you want to 'rm -rf applications/underlord/vendor/plugins/exception_notification'? (y)es, (n)o > y
   Deleting...
 
-For *files*, it will show a preview of the _contents_ of that file (limited to the first 3000 characters); for *directories*, it will show a _directory_ _listing_. By looking at the preview, you should hopefully be able to decide whether you want to keep the file or junk it.
+For *files*, it will show a preview of the _contents_ of that file (limited to the first 3000 characters); for *directories*, it will show a _directory_ _listing_. By looking at the preview, you should hopefully be able to decide whether you want to _keep_ the file or _junk_ it.
 
 ===externalize / externals / edit_externals
 
@@ -194,6 +202,7 @@ You can, of course, get a lits of the custom commands that have been added by us
 
 * --no-color (since color is on by default)
 * --dry-run  (see what /usr/bin/svn command it _would_ have executed if you weren't just doing a dry run -- useful for debugging if nothing else)
+* --show-commands (prints out the /usr/bin/svn commands before executing them)
 * --debug    (sets $debug = true)
 
 ==colordiff

data/lib/subversion.rb

@@ -295,9 +295,29 @@ protected
         #Kernel.exec *args
         Kernel.exec command
       when :popen
-        # To do: rather than `...`, which waits until command is finished before you get any output, maybe do popen and output the output in realtime!
+        # This is just an idea of how maybe we could speed up the performance a bit. Rather than waiting until the command completes
+        # (which can take quite a while for svn status sometimes since it has to walk the entire directory tree), why not process
+        # the output from /usr/bin/svn *in real-time*??
+        #
+        # Unfortunately, it looks like /usr/bin/svn itself might make that impossible. It seems that if it detects that its output is
+        # being redirected to a pipe, it will not yield any output until the command is finished!
+        #
+        # So even though this command gives you output in real-time:
+        #   find / | grep .
+        # as does this:
+        #   IO.popen('find /', 'r') {|p| line = ""; ( puts line; $stdout.flush ) until !(line = p.gets) }
+        # as does this:
+        #   /usr/bin/svn st
+        #
+        # ... as soon as you redirect svn to a *pipe*, it seems to automatically (annoyingly) buffer its output until it's finished:
+        #   /usr/bin/svn st | grep .
+        # So when I tried this: 
+        #   IO.popen('/usr/bin/svn st', 'r') {|p| line = ""; ( puts line; $stdout.flush ) until !(line = p.gets) }
+        # it didn't seem any more responsive than a plain puts `/usr/bin/svn st` ! Frustrating!
+        #
         IO.popen(command, 'r') do |pipe|
-          pipe.read
+          line = ""
+          ( puts line; $stdout.flush ) until !(line = pipe.gets)
         end
       else
         raise ArgumentError.new(":method option must be one of #{valid_options.inspect}")

data/lib/subversion_extensions.rb

@@ -1,11 +1,30 @@
 # Tested by: ../test/subversion_extensions_test.rb
 
+require_gem 'colored'
+require 'colored'
+
 class Array
   def to_regexp_char_class
     "[#{join('')}]"
   end
 end
 
+class String
+  def colorize_svn_status_lines
+    if Subversion.color
+      self.gsub(/^ *\?/) { $&.yellow.bold}.
+           gsub(/^ *A/) { $&.green.bold}.
+           gsub(/^ *M/) { $&.green.bold}.
+           gsub(/^ *C/) { $&.red.bold}.
+           gsub(/^ *~/) { $&.red.bold}.
+           gsub(/^ *!/) { $&.red.bold}
+    else
+      self
+    end
+  end
+end
+
+
 # These are methods used by the SvnCommand for filtering and whatever else it needs...
 # It could probably be moved into SvnCommand, but I thought it might be good to at least make it *possible* to use them apart from SvnCommand.
 # Rename to Subversion::Filters ? Then would each_unadded fit?
@@ -16,13 +35,28 @@ module Subversion
     Status_flags = Interesting_status_flags | Uninteresting_status_flags
 
     def self.status_lines_filter(input)
-      (input || "").reject { |line|
+      input = (input || "").reject { |line|
         line =~ /^$/    # Blank lines
-      }.reject { |line|
-        line =~ /^Performing status on external item at/
       }.reject { |line|
         line =~ /^#{Uninteresting_status_flags.to_regexp_char_class}/
       }.join
+
+      before_externals, *externals = input.split(/^Performing status on external item at.*$/)
+
+      before_externals ||= ''
+      before_externals = before_externals.strip.colorize_svn_status_lines + "\n" if before_externals != ""
+
+      externals = externals.join
+      externals = 
+        '_'*40 + ' externals '.underline + '_'*40 + "\n" +
+        externals.reject { |line|
+          line =~ /^Performing status on external item at/
+        }.reject { |line|
+          line =~ /^$/    # Blank lines
+        }.join.strip.colorize_svn_status_lines + "\n" if externals != ""
+        
+      before_externals +
+             externals
     end
 
     def self.update_lines_filter(input)

data/lib/svn_command.rb

@@ -15,6 +15,10 @@ require 'extensions/symbol'   # to_proc
 require 'pp'
 require 'termios'
 require 'stringio'
+require_gem 'colored'
+require 'colored'
+                    # Lets us do "(a)".white.bold instead of "(\033[1ma\033[0m)"
+#- Warning: Make sure you have the *right* color gem! gem install color --source require.errtheblog.com
 require_local '../lib/subversion'
 require_local '../lib/subversion_extensions'
 
@@ -76,7 +80,7 @@ module Subversion
     def __dry_run
       Subversion::dry_run = true
     end
-    def __print
+    def __show_commands
       Subversion::print_commands = true
     end
 
@@ -95,6 +99,10 @@ module Subversion
       #puts "method_missing(#{subcommand}, #{args.inspect})"
       svn :exec, subcommand, *args
     end
+    # This is here solely to allow subcommandless commands like `svn --version`
+    def default()
+      svn :exec
+    end
 
     def option_missing(option_name, args)
       #puts "#{@subcommand} defined? #{@subcommand_is_defined}"
@@ -183,14 +191,14 @@ module Subversion
       )
     end
 
-    #def diff(*args)
-    def diff(directory = "./")
-      print Subversion.diff(*([directory] + @passthrough_options))
+    def diff(*directories)
+      directories = ["./"] if directories.empty?
+      print Subversion.diff(*(directories + @passthrough_options))
 
       # Show diff for externals (if there are any)
       output = StringIO.new
       #paths = args.reject{|arg| arg =~ /^-/} || ['./']
-      [directory].each do |path|
+      directories.each do |path|
         (Subversion.externals_containers(path) || []).each do |external|
           #puts external.to_s
           external.entries.each do |entry|
@@ -391,8 +399,8 @@ End
           begin
             response = ""
             loop do
-              puts '-'*100
-              puts "What do you want to do with '#{file}'?"
+              puts( ('-'*100).green )
+              puts "What do you want to do with '#{file.white.underline}'?".white.bold
               begin
                 if File.file?(file)
                   # Only show the first x bytes so that we don't accidentally dump the contens of some 20 GB log file to screen...
@@ -406,9 +414,15 @@ End
                   raise "#{file} is not a file or directory -- what *is* it??"
                 end
               end
-              print "(a)dd, (d)elete, add to svn:(i)ignore property, or [Enter] to do nothing > "
+              print(
+                "" + "A".green.bold.underline + "dd, ".green +
+                "".red + "D".red.bold.underline + "elete".red + ", " +
+                "add to " + "svn:".yellow + "I".yellow.bold.underline + "gnore".yellow + " property, " + 
+                "or [" + "Enter".white.bold + "] to do nothing > "
+              )
               response = ""
               response = $stdin.getc.chr while !['a', 'd', 'i', "\n"].include?(begin response.downcase!; response end)
+
               break
             end
 
@@ -445,6 +459,7 @@ End
       end # catch :exit
     end
     alias_subcommand :eu => :each_unadded
+    alias_subcommand :unadded => :each_unadded
 
 
 
@@ -611,7 +626,11 @@ End
   private
     def svn(method, *args)
       subcommand = args[0]
-      args = ([subcommand] + prepare_args(args[1..-1]) + [:method => method])
+      args = (
+        [subcommand] + 
+        prepare_args(args[1..-1] || []) + 
+        [:method => method]
+      )
       # puts "in svn(): about to call Subversion#execute(#{args.inspect})"
       Subversion.send :execute, *args
     end

data/test/shared/test_helpers/test_colorizer.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
-require 'color'     # Warning: Make sure you have the *right* color gem! gem install color --source require.errtheblog.com
+require_gem 'colored'
+require 'colored'
+
 module Test::Unit
   
   class Error

data/test/subversion_extensions_test.rb

@@ -1,12 +1,17 @@
 require File.dirname(__FILE__) + '/test_helper'
 require 'subversion_extensions'
 
+Subversion.color = false    # Makes testing simpler. We can just test that the *colorization* features are working via *manual* tests.
 
 class SubversionExtensionsTest < Test::Unit::TestCase
   def setup
   end
 
   def test_status_lines_filter
+    
+    #String.any_instance.stubs(:underline).returns(lambda {|a| a})  # Doesn't work! Lame! So we can't make the return value depend on the input?
+    String.any_instance.stubs(:underline).returns(lambda {' externals '})
+
     input = <<End
 M      gemables/calculator/test/calculator_test.rb
 X      gemables/calculator/tasks/shared
@@ -24,6 +29,7 @@ End
     expected = <<End
 M      gemables/calculator/test/calculator_test.rb
 ?      gemables/calculator/lib/calculator_extensions.rb
+________________________________________ externals ________________________________________
 M      applications/underlord/vendor/plugins/nifty/tasks/shared/base.rake
 End
     

data/test/svn_command_test.rb

@@ -4,7 +4,7 @@ require_local '../lib/svn_command.rb'
 require 'facets/core/string/to_re'
 require 'yaml'
 
-
+Subversion.color = false    # Makes testing simpler. We can just test that the *colorization* features are working via *manual* tests.
 
 module Subversion
 class BaseSvnCommandTest < Test::Unit::TestCase
@@ -104,7 +104,7 @@ class SvnDiffTest < BaseSvnCommandTest
   def test_1
     SvnCommand.execute("diff -r 123:125") 
     assert_equal [
-      "svn diff --diff-cmd colordiff ./ -r 123:125",
+      "svn diff  ./ -r 123:125",
       "svn status ./"
     ], Subversion.executed
   end
@@ -112,8 +112,8 @@ class SvnDiffTest < BaseSvnCommandTest
     #:fixme:
     #capture_output { SvnCommand.execute("diff -r { 2006-07-01 }") }
     #p Subversion.executed
-    # Currently does this, since it thinks the arity is 1: --diff-cmd colordiff 2006-07-01 } -r '{'
-    #assert_equal "svn diff --diff-cmd colordiff -r { 2006-07-01 }", Subversion.executed.join
+    # Currently does this, since it thinks the arity is 1: 2006-07-01 } -r '{'
+    #assert_equal "svn diff -r { 2006-07-01 }", Subversion.executed.join
   end
 end
 
@@ -150,10 +150,12 @@ X      applications/underlord/vendor/plugins/nifty/doc_include/template
 Performing status on external item at 'applications/underlord/vendor/plugins/nifty/tasks/shared'
 M      applications/underlord/vendor/plugins/nifty/tasks/shared/base.rake
 ")
+    String.any_instance.stubs(:underline).returns(lambda {' externals '})
     
     expected = <<End
 M      gemables/calculator/test/calculator_test.rb
 ?      gemables/calculator/lib/calculator_extensions.rb
+________________________________________ externals ________________________________________
 M      applications/underlord/vendor/plugins/nifty/tasks/shared/base.rake
 End
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: svn-command
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 date: 2007-03-15 00:00:00 -07:00
 summary: A nifty wrapper command for Subversion's command-line svn client
 require_paths: 
@@ -73,3 +73,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: colored
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: