sub 0.3.0 → 0.4.0

data/History.txt

@@ -1,3 +1,13 @@
+== 0.4.0
+
+* "sub ext" command to deal with svn:externals property (see "sub help")
+* "sub ignore" command to either print or add to a directory's svn:ignore
+  property
+* If you replace an external with a "real" directory, then use "sub up" in
+  another workspace, it will now do the right thing and remove the external
+  before updating the directory. (This solves what is, IMHO, a bug in svn --
+  it gets confused and attempts to grab its own lock and aborts.)
+
 == 0.3.0 2007-10-02
 
 * Bugfix: checks out externals that were added since last update

data/Manifest.txt

@@ -10,5 +10,6 @@ lib/sub/array.rb
 lib/sub/external.rb
 lib/sub/root.rb
 lib/sub/status.rb
+lib/sub/sys.rb
 lib/sub/version.rb
 tasks/environment.rake

data/lib/sub.rb

@@ -1,5 +1,6 @@
-require 'sub/app'
 require 'sub/array'
+require 'sub/sys'
+require 'sub/app'
 require 'sub/external'
 require 'sub/status'
 require 'sub/version'

data/lib/sub/app.rb

@@ -1,23 +1,29 @@
 #!/usr/local/bin/ruby
 require 'benchmark'
 require 'fileutils'
-
-QUIET = 0
-NORMAL = 1
-VERBOSE = 2
+require 'sub/sys'
 
 class Sub
+  include Sys::Client
+
   DEFAULT_BASE_URL = "svn+ssh://rubyforge.org/var/svn"
 
   def self.from_args(args)
-    verbosity = NORMAL
     still_parsing_options = true
-    command = :up
+    command = defaults[:command]
     options = {}
-    while still_parsing_options
+    real_args = []
+    while !args.empty?
       case args[0]
-      when 'up', 'co', 'help'
+
+      # commands
+      when 'up', 'co', 'help', 'ext', 'ignore'
         options[:command] = args[0]
+
+      # no-param options
+      when '--version'
+        puts "Sub version #{Sub::VERSION::STRING}"
+        exit 0
       when '-v', '--verbose'
         options[:verbosity] = VERBOSE
       when '-q', '--quiet'
@@ -27,34 +33,41 @@ class Sub
         still_parsing_options = false
       when '-c', '--clean'
         options[:clean] = true
+
+      # one-param options
       when '--url'
         args.shift
         options[:url] = args[0]
-      when '--version'
-        puts "Sub version #{Sub::VERSION::STRING}"
-        exit 0
+      when '--revision', '-r'
+        args.shift
+        options[:revision] = args[0]
+      when '--directory', '--dir', '-d'
+        args.shift
+        options[:dir] = args[0]
+
       else
-        still_parsing_options = false
+        real_args << args[0]
       end
-      args.shift if still_parsing_options
+      args.shift
     end
 
-    Sub.new(options, args)
+    Sub.new(options, real_args)
   end
 
-  attr_reader :clean, :command, :args, :url
-  attr_accessor :verbosity
+  attr_reader :clean, :command, :args, :url, :revision, :dir
 
   def initialize(options = {:verbosity => NORMAL}, args = [])
-    options = defaults.merge(options)
-    @verbosity = options[:verbosity]
+    options = Sub.defaults.merge(options)
+    sys.verbosity = options[:verbosity]
     @clean = options[:clean]
     @command = options[:command]
-    @url = options[:url] || ENV['SUB_BASE_URL'] || ENV['SVN'] || DEFAULT_BASE_URL
+    @url = options[:url]
+    @revision = options[:revision]
+    @dir = options[:dir] || '.'
     @args = args
   end
 
-  def defaults
+  def self.defaults
     {
       :verbosity => NORMAL,
       :command => :up,
@@ -62,7 +75,7 @@ class Sub
   end
 
   def execute
-    self.send(@command)
+    puts self.send(@command)
   end
 
   # commands
@@ -71,6 +84,7 @@ class Sub
       @args = [`pwd`.chomp]
     end
     update_many(@args)
+    "Update complete."
   end
 
   def co
@@ -80,7 +94,37 @@ class Sub
 
     project = args.shift
     dir_name = args.shift || project
-    svn("co #{url}/#{project}/trunk #{dir_name}")
+    svn("co #{base}/#{project}/trunk #{dir_name}")
+    "Checkout complete."
+  end
+
+  def base
+    url || ENV['SUB_BASE_URL'] || ENV['SVN'] || DEFAULT_BASE_URL    
+  end
+
+  #todo: test
+  def ext
+    external_name = args.shift
+    if external_name.nil?
+      External.externals_of(dir).join("\n")
+    else
+      old_external = get_external(dir, external_name)
+      if url || revision
+        revision_to_set = revision == 'HEAD' ? nil : revision
+        set_external(dir, external_name, url || old_external.url, revision_to_set)
+      else
+        old_external
+      end
+    end
+  end
+
+  def ignore
+    if args.empty?
+      svn("propget svn:ignore #{dir}", true).strip
+    else
+      svn("propset svn:ignore '#{args.join("\n")}' #{dir}")
+      "#{dir} now ignoring #{args.join(", ")}"
+    end
   end
 
   def help
@@ -90,13 +134,31 @@ sub - Alex's wrapper for subversion
 Version: #{Sub::VERSION::STRING}
 
 Usage:
-  sub co project_name [dir_name]
-    checks out [base_url]/project_name/trunk into ./project_name (or dir_name if specified)
-  sub up [dir]*
+
+  sub co [--url base_url] project [dir]
+    checks out [base_url]/project/trunk into ./project (or dir if specified)
+    default base_url is ENV['SUB_BASE_URL'] or ENV['SVN']
+      or #{DEFAULT_BASE_URL}
+
+  sub up [--clean] [dir]*
     fast update (default command, so 'sub dir...' or just 'sub' work too)
+    if --clean is specified, removes all unversioned files and directories
+
   sub help
     prints this message
 
+  sub ext [--dir directory] [external_name [--revision rev] [--url url]]]
+    prints the value of the named svn:external property for directory dir
+    if no dir is specified, uses '.'
+    if no external_name is specified, prints all externals in that directory
+    if --url or --revision is specified, sets the value and commits the change
+    if rev is HEAD then the revision is removed from that external
+
+  sub ignore [--dir directory] [pattern]
+    prints the value of the svn:ignore property for directory dir
+    if pattern is specified, ignores that pattern
+    if no dir is specified, uses '.'
+
 Options:
   --verbose, -v
       lots of output
@@ -104,15 +166,11 @@ Options:
       no output at all except for errors
   --help, -h
       prints this message
-  --clean, -c
-      'up' command removes all unversioned files and directories
-  --url [base_url]
-      sets base repository url for 'co' command
-      (default is ENV['SUB_BASE_URL'] or ENV['SVN'] or #{DEFAULT_BASE_URL})
   --version
       prints release version
   """
   end
+  
 
   # methods
 
@@ -125,47 +183,38 @@ Options:
   end
 
   def update(root)
-    Root.new(root, self, clean).update
+    Root.new(root, clean).update
   end
 
-  def externals(root)
-    Root.new(root, self, clean).externals
+  def all_externals(root)
+    Root.new(root, clean).all_externals
+  end
+  
+  def get_external(dir, external_name)
+    External.externals_of(dir).select do |external|
+      external.name == external_name
+    end.first
   end
 
-  def parse_externals(st)
-    exts = []
-    st.split("\n").select do |line|
-      line =~ /^X/
-    end.collect do |line|
-      line.gsub(/^X */, '').gsub(/\/[^\/]*$/, '')
-    end.uniq.collect do |parent|
-      prop = `svn propget svn:externals #{parent}`
-      prop.split("\n").each do |external|
-        next if external.strip.empty?
-        exts << External.new(parent, external, self)
-      end
+  def set_external(dir, external_name, url, revision = nil)
+    if get_external(dir, external_name)
+      remove_external(dir, external_name)
     end
-    exts
+    new_external = External.new(dir, external_name, url, revision)
+    externals = External.externals_of(dir) << new_external
+    set_externals(dir, externals)
+    new_external
   end
-
-  def say(msg)
-    puts msg if verbosity > QUIET
+  
+  def set_externals(externals_path, externals)
+    property_lines = externals.collect { |x| x.to_s }
+    svn "propset svn:externals '#{property_lines.join("\n")}' #{externals_path}"
   end
-
-  def svn(cmd)
-    svncmd = "svn"
-    svncmd += " --quiet" if (cmd =~ /^(up|co)/ && verbosity == QUIET)
-    run("#{svncmd} #{cmd}")
+  
+  def remove_external(dir, name)
+    set_externals(dir, External.externals_of(dir).select { |x| x.name != name })
+    svn("ci --non-recursive -m 'removing external #{name}' #{dir}")
+    FileUtils.rm_rf("#{dir}/#{name}") # TODO: unless modified
   end
 
-  def run(cmd, return_output = false)
-    say("\t#{cmd}") if verbosity == VERBOSE
-    if (return_output)
-      `#{cmd}`
-    else
-      cmd += ">/dev/null"if verbosity == QUIET
-      system(cmd)
-    end
-  end
 end
-

data/lib/sub/external.rb

@@ -1,36 +1,31 @@
 class External
+  include Sys::Client
 
-  def self.externals_in_directory(parent, app)
+  def self.externals_of(parent, prop = `svn propget svn:externals #{parent}`)
     exts = []
-    prop = `svn propget svn:externals #{parent}`
     prop.split("\n").each do |prop_line|
       next if prop_line.strip.empty?
-      exts << External.new(parent, prop_line, app)
+      exts << External.from_property_line(parent, prop_line)
     end
     exts
   end
 
-  attr_reader :name, :path, :url, :revision, :app
+  attr_reader :name, :path, :url, :revision
 
-  def initialize(parent, property, app = nil)
-    match =  /^(\S+)\s+(-r\s*\d*\s+)?(\S+)\s*$/.match(property)
-    @name = match[1]
-    @revision = match[2] ? match[2].gsub(/\D/,'').to_i : nil
-    @url = match[3]
-    @path = "#{parent}/#{@name}"
-    @app = app
-  end
-
-  def say(msg)
-    app.say(msg)
+  def self.from_property_line(parent, property_line)
+    match =  /^(\S+)\s+(-r\s*\d*\s+)?(\S+)\s*$/.match(property_line)
+    name = match[1]
+    revision = match[2] ? match[2].gsub(/\D/,'').to_i : nil
+    url = match[3]
+    raise "no url found for '#{property_line}'" if url.nil?
+    new(parent, name, url, revision)
   end
-
-  def svn(cmd)
-    app.svn(cmd)
-  end
-
-  def run(cmd, return_output = false)
-    app.run(cmd, return_output)
+  
+  def initialize(parent, name, url, revision = nil)
+    @name = name
+    @revision = revision
+    @url = url
+    @path = "#{parent}/#{@name}"
   end
 
   def ==(other)
@@ -38,7 +33,9 @@ class External
   end
 
   def to_s
-    "External[name=#{name}, path=#{path}, url=#{url}, revision=#{revision}]"
+    "#{name} " + 
+    (revision ? "-r #{revision} " : "") + 
+    url
   end
 
   def revision_actual
@@ -52,10 +49,11 @@ class External
 
   #todo: test? (indirectly tested via root.rb)
   def update
+    raise "path is nil" if path.nil?
     say "Updating external #{path}"
     run("svn cleanup #{path}")
     rev = revision.nil? ? '' : "-r#{revision}"
-    svn("up #{rev} #{path} | grep -v 'At revision'")
+    svn("up #{rev} #{path}", true)
   end
 
   def checkout

data/lib/sub/root.rb

@@ -1,25 +1,14 @@
 class Root
-  attr_reader :app, :root_path
+  include Sys::Client
+  
+  attr_reader :root_path
 
-  def initialize(root_path, app, clean = false)
+  def initialize(root_path, clean = false)
     @root_path = root_path
-    @app = app
     @clean = clean
     @status = nil
   end
 
-  def say(msg)
-    app.say(msg)
-  end
-
-  def svn(cmd)
-    app.svn(cmd)
-  end
-
-  def run(cmd, return_output = false)
-    app.run(cmd, return_output)
-  end
-
   class Processes < Array
     def initialize
     end
@@ -43,12 +32,14 @@ class Root
       remove_unversioned
     end
 
-    externals_before = externals
+    remove_deleted_externals
+
+    externals_before = all_externals
 
     svn("up --ignore-externals #{root_path}")
     # for some reason (array - array) doesn't work right here
     # so i had to write my own subtract method
-    removed_externals = externals_before.subtract(externals)
+    removed_externals = externals_before.subtract(all_externals)
     removed_externals.each do |ext|
       say "Removed external #{ext}"
       FileUtils.rm_rf(ext.path)
@@ -57,7 +48,7 @@ class Root
     @processes = Processes.new
 
     already_up_to_date = []
-    externals.each do |external|
+    all_externals.each do |external|
       if external.should_update?
         if File.exists?(external.path)
           update_external(external)
@@ -90,6 +81,37 @@ class Root
     end
   end
 
+  def remove_deleted_externals
+    directories_containing_externals.each do |dir|
+      deleted_something = false
+      workspace_externals = External.externals_of(dir)
+      Dir.chdir(root_path) do
+        head_property = svn("propget -r HEAD svn:externals #{dir}", true)
+        head_externals = External.externals_of(dir, head_property)
+        deleted_externals = workspace_externals.select do |workspace_external|
+          head_externals.select { |head_external| head_external.name == workspace_external.name }.empty?
+        end
+        unless deleted_externals.empty?
+          deleted_externals.each do |external|
+            # todo: check for local changes
+            say("Deleting external #{external.path}")
+            FileUtils.rm_rf(external.path)
+          end
+          # update the property first
+          svn("up -N #{dir}")
+          # then update all the deleted former externals
+          svn("up " + deleted_externals.map{|external| "#{external.path}"}.join(" "))
+        end
+      end
+      if deleted_something
+        svn("up -N #{dir}")
+        svn("up --ignore-externals #{dir}")
+        puts "pausing"
+        sleep(9999)
+      end
+    end
+  end
+
   def remove_unversioned
     status.unversioned.each do |path|
       if File.directory?(path)
@@ -102,13 +124,13 @@ class Root
   end
 
   def status
-    @status ||= Status.new(run("svn st #{root_path}", true))
+    @status ||= Status.new(svn("st #{root_path}", true))
   end
 
-  def externals
+  def all_externals
     exts = []
     directories_containing_externals.collect do |parent|
-      exts += External.externals_in_directory(parent, app)
+      exts += External.externals_of(parent)
     end
     exts
   end
@@ -116,7 +138,7 @@ class Root
   def directories_containing_externals
     status.externals.collect do |path|
       if (path !~ /\//)
-        "."
+        root_path
       else
         path.gsub(/\/[^\/]*$/, '')
       end

data/lib/sub/status.rb

@@ -25,7 +25,6 @@ class Status
     end
   end
 
-
   def initialize(text)
     @lines = text.split("\n").collect do |line|
       Status::Line.new(line)

data/lib/sub/sys.rb

@@ -0,0 +1,73 @@
+QUIET = 0
+NORMAL = 1
+VERBOSE = 2
+
+class Sys
+
+  module Client
+    def sys
+      Sys.instance
+    end
+
+    #todo: look up ruby dynamic proxy
+    def say(msg)
+      sys.say(msg)
+    end
+
+    def svn(cmd, return_output = false)
+      sys.svn(cmd, return_output)
+    end
+
+    def run(cmd, return_output = false)
+      sys.run(cmd, return_output)
+    end
+
+    def verbosity=(level)
+      sys.verbosity = level
+    end
+
+    def verbosity
+      sys.verbosity
+    end
+  end
+
+  @@instance = Sys.new
+
+  def self.instance
+    @@instance
+  end
+
+  attr_accessor :verbosity
+
+  def initialize(verbosity = NORMAL)
+    @verbosity = verbosity
+  end
+
+  def say(msg)
+    puts msg if verbosity > QUIET
+  end
+
+  def svn(cmd, return_output = false)
+    svncmd = "svn"
+    svncmd += " --quiet" if (cmd =~ /^(up|co)/ && verbosity == QUIET)
+    output = run("#{svncmd} #{cmd}", return_output)
+    puts output if output && verbosity == VERBOSE
+    output
+  end
+
+  def run(cmd, return_output = false)
+    val = nil
+    say("\t#{cmd}") if verbosity == VERBOSE
+    if (return_output)
+      val = `#{cmd}`
+    else
+      cmd += ">/dev/null"if verbosity == QUIET
+      system(cmd)
+    end
+    unless $?.success?
+      puts caller.join("\n\t")
+      raise "Failure: '#{cmd}' returned #{$?.exitstatus}"
+    end
+    val
+  end
+end

data/lib/sub/version.rb

@@ -1,7 +1,7 @@
 class Sub #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.0
 specification_version: 1
 name: sub
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-10-02 00:00:00 -07:00
+  version: 0.4.0
+date: 2007-11-18 00:00:00 -08:00
 summary: sub is a wrapper for svn that adds faster/safer updates, easy trunk checkout, etc.
 require_paths: 
 - lib
@@ -41,6 +41,7 @@ files:
 - lib/sub/external.rb
 - lib/sub/root.rb
 - lib/sub/status.rb
+- lib/sub/sys.rb
 - lib/sub/version.rb
 - tasks/environment.rake
 test_files: []