svnauto 1.0.2 → 1.1.0

data/bin/sc

@@ -23,13 +23,5 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-require 'rubygems'
-require 'sc'
-
-begin
-  SC::Dispatcher.new.run
-rescue RuntimeError => e
-  $stderr.puts "#{SC::Constants::TERMINAL.color(SC::Constants::ME, :red)}: #{e}"
-  exit 1
-end
-################################################################################
+puts "The 'sc' command has been renamed to 'sva', please use 'sva' instead."
+exit 1

data/{lib/sc/constants.rb → bin/sva}

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 ################################################################################
 #
 # Copyright (C) 2006 Peter J Jones (pjones@pmade.com)
@@ -22,19 +23,13 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
-  module Constants
-    ################################################################################
-    # The version number for this copy of SC
-    VERSION = '1.0.2'
+require 'rubygems'
+require 'svnauto'
 
-    ################################################################################
-    # What to call myself
-    ME = 'sc'
-
-    ################################################################################
-    TERMINAL = HighLine.new
-
-  end
+begin
+  SvnAuto::Dispatcher.new.run
+rescue RuntimeError => e
+  $stderr.puts "#{SvnAuto::Constants::TERMINAL.color(SvnAuto::Constants::ME, :red)}: #{e}"
+  exit 1
 end
 ################################################################################

data/lib/{sc.rb → svnauto.rb}

@@ -25,15 +25,19 @@
 require 'rubygems'
 require 'highline'
 require 'uri'
+require 'set'
 require 'pathname'
+require 'tempfile'
 ################################################################################
-require 'sc/constants'
-require 'sc/version'
-require 'sc/config_file'
-require 'sc/svn'
-require 'sc/path'
-require 'sc/project'
-require 'sc/repository'
-require 'sc/command'
-require 'sc/dispatcher'
+require 'svnauto/constants'
+require 'svnauto/version'
+require 'svnauto/config_file'
+require 'svnauto/svn'
+require 'svnauto/svn_info'
+require 'svnauto/svn_externals'
+require 'svnauto/path'
+require 'svnauto/project'
+require 'svnauto/repository'
+require 'svnauto/command'
+require 'svnauto/dispatcher'
 ################################################################################

data/lib/{sc → svnauto}/command.rb

@@ -25,13 +25,14 @@
 require 'optparse'
 require 'set'
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Command
     ################################################################################
     VALID_SET_KEYS = Set.new([
      :name, 
      :description, 
+     :example,
      :without_project, 
      :without_repository,
      :usage,
@@ -104,7 +105,11 @@ module SC
         raise "invalid set key #{name}, wanted one of #{VALID_SET_KEYS.join(', ')}"
       end
 
-      instance_eval { @attributes[name] = value }
+      if name == :example
+        instance_eval { (@attributes[name] ||= []) << value }
+      else
+        instance_eval { @attributes[name] = value }
+      end
     end
 
     ################################################################################
@@ -120,5 +125,5 @@ end
 # load all commands
 Dir.foreach(File.join(File.dirname(__FILE__), 'commands')) do |file|
   next unless file.match(/\.rb$/)
-  require 'sc/commands/' + file
+  require 'svnauto/commands/' + file
 end

data/lib/{sc → svnauto}/commands/bug.rb

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Bug < Command
     ################################################################################
@@ -34,6 +34,9 @@ module SC
     set(:usage, "[options] unique-bug-id")
     set(:args_min, 1)
     set(:args_max, 1)
+    set(:example, "12 # create bug fix branch for bug ID 12")
+    set(:example, "--close 12 # close and merge changes")
+    set(:example, "--diff 12 # show diff for changes in bug 12")
 
     option('-r', '--release VER', "Create branch off VER rel branch instead of latest rel") do |val, opthash|
       opthash[:release] = val
@@ -103,7 +106,7 @@ module SC
 
       # record the release branch so we can get back to it later
       Svn.propset(REL_BRN_PROP, @version.to_s, dir) {|line|}
-      Svn.commit('-m', "'#{Constants::ME}: recording release branch for bug fix #@bug_id'", dir)
+      Svn.commit('-m', "#{Constants::ME}: recording release branch for bug fix #@bug_id", dir)
 
       Constants::TERMINAL.say("Created bug fix branch and checked out to: " + 
         Constants::TERMINAL.color(Path.relative_to_home(dir), :green))

data/lib/{sc → svnauto}/commands/checkout.rb

@@ -22,13 +22,15 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Checkout < Command
     ################################################################################
     set(:name, [:checkout, :co])
     set(:description, "Checkout a project from the repository")
     set(:args_max, 0)
+    set(:example, "# check out the trunk")
+    set(:example, "--bug 12 # check out bug fix branch for bug ID 12")
 
     option('-r', '--release VER', 'Checkout a release instead of the trunk') do |val, opts|
       opts[:co_release] = Version.new(val)

data/lib/{sc → svnauto}/commands/config.rb

@@ -22,12 +22,12 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Config < Command
     ################################################################################
     set(:name, :config)
-    set(:description, "Manage sc Configuration")
+    set(:description, "Manage the sva configuration file")
     set(:args_max, 0)
     set(:without_repository)
     set(:without_project)
@@ -53,6 +53,22 @@ module SC
       config.save
     end
 
+    ################################################################################
+    option('--update', 'Update the config file for this version of sva') do |val, hash|
+      old_name = File.join(ENV['HOME'], '.sc')
+
+      if File.exist?(old_name)
+        File.open(old_name) do |old_file|
+          File.open(ConfigFile::FILENAME, 'w') do |new_file|
+            old_file.each_line {|l| new_file << l.gsub(/SC::/, 'SvnAuto::')}
+          end
+        end
+
+        FileUtils::rm(old_name)
+        puts "#{Constants::ME}: moved sc config file to sva location"
+      end
+    end
+
   end
   ################################################################################
 end

data/lib/{sc → svnauto}/commands/create.rb

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Create < Command
     ################################################################################
@@ -32,6 +32,7 @@ module SC
     set(:usage, "[options] project-name")
     set(:args_min, 1)
     set(:args_max, 1)
+    set(:example, "hello-world # create a new project called hello-world")
 
     option('-C', '--no-checkout', "Don't checkout the new project") do |val, opthash|
       opthash[:no_checkout] = true

data/lib/{sc → svnauto}/commands/experimental.rb

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Experimental < Command
     ################################################################################
@@ -31,6 +31,13 @@ module SC
     set(:usage, "[options] branch-name")
     set(:args_min, 1)
     set(:args_max, 1)
+    set(:example, "crazy # create an experimental branch called crazy")
+    set(:example, "--up crazy # merge the trunk onto crazy")
+    set(:example, "--down crazy # merge crazy to the trunk")
+
+    option('-r', '--revision REV', 'Branch at REV instead of trunk/HEAD') do |val, opts|
+      opts[:revision] = val
+    end
 
     option('-p', '--prefix PATH', 'Use branch prefix PATH instead of exp') do |val, opts|
       opts[:prefix] = val
@@ -88,12 +95,19 @@ module SC
         name = @branch_name
         name = @path if @prefix != 'exp'
 
-        exit unless Constants::TERMINAL.agree("Create experimental branch " + 
-                      Constants::TERMINAL.color(name, :green) + " off " +
-                      Constants::TERMINAL.color(@project.to_s, :green) + "/trunk? ")
+        question = "Create experimental branch "
+        question << Constants::TERMINAL.color(name, :green) + " off "
+        question << Constants::TERMINAL.color(@project.to_s, :green) + "/trunk"
+        question << Constants::TERMINAL.color(":#{opthash[:revision]}", :red) if opthash[:revision]
+        question << "? "
+
+        exit unless Constants::TERMINAL.agree(question)
       end
 
-      Svn.branch(@project, @project.trunk, @project.branches(@path))
+      branch_options = {}
+      branch_options[:revision] = opthash[:revision] if opthash[:revision]
+
+      Svn.branch(@project, @project.trunk, @project.branches(@path), branch_options)
       Svn.branch(@project, @project.branches(@path), @project.tags("#{@prefix}/PRE-#{@branch_name}"))
 
       unless opthash[:no_checkout]

data/lib/svnauto/commands/externals.rb

@@ -0,0 +1,128 @@
+################################################################################
+#
+# Copyright (C) 2006 Peter J Jones (pjones@pmade.com)
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+################################################################################
+module SvnAuto
+  ################################################################################
+  class Externals < Command
+    ################################################################################
+    set(:name, :externals)
+    set(:description, "Lock/Unlock svn:externals at specific revisions")
+    set(:usage, "[options] [directory ...]")
+    set(:without_repository)
+    set(:without_project)
+    set(:example, "--lock --revision 1218 vendor/rails")
+    set(:example, "--unlock vendor/rails")
+    set(:example, "--info vendor/rails")
+
+    option('-r', '--revision REV', "Lock at REV instead of the current one") do |val, opthash|
+      raise "invalid format for revision: #{val}" unless val.match(/^\d+$/)
+      opthash[:revision] = val
+    end
+
+    option('-N', '--non-recursive', "Don't recurse into given directories") do |val, opthash|
+      opthash[:nonrecursive] = true
+    end
+
+    option('-l', '--lock', "Lock an external at a specific revision") do |val, opthash|
+      opthash[:lock] = true
+    end
+
+    option('-u', '--unlock', "Unlock externals so they track commits again") do |val, opthash|
+      opthash[:unlock] = true
+    end
+
+    option('-i', '--info', "Get info about locked/unlocked externals") do |val, opthash|
+      opthash[:info] = true
+    end
+
+    ################################################################################
+    def run (project, args)
+      @externals = SvnExternals.new(args, !opthash[:nonrecursive])
+
+      if opthash[:info]
+        info
+      elsif opthash[:lock] or opthash[:unlock]
+        if opthash[:lock] and opthash[:unlock]
+          raise "--lock and --unlock are mutually exclusive, you may only use one at a time"
+        end
+
+        uncommitted_check
+        lock if opthash[:lock]
+        unlock if opthash[:unlock]
+      end
+    end
+
+    ################################################################################
+    def info
+      show_info_for(:locked)
+      show_info_for(:unlocked)
+    end
+
+    ################################################################################
+    def lock
+      locking = @externals.unlocked.dup
+      @externals.lock
+      show_info_for(:locked, locking)
+    end
+
+    ################################################################################
+    def unlock
+      unlocking = @externals.locked.dup
+      @externals.unlock
+      show_info_for(:unlocked, unlocking)
+    end
+
+    ################################################################################
+    def show_info_for (state, collection=nil)
+      title = 'unlocked'
+      color = :green
+
+      if state == :locked
+        title = '  locked'
+        color = :red
+      end
+
+      collection ||= @externals.send(state)
+      collection.each do |external|
+        status  = Constants::TERMINAL.color(title, color) + ' '
+        status << Constants::TERMINAL.color(external.revision.rjust(6), :red) + ' '
+        status << Constants::TERMINAL.color(external.path, :green) + ' '
+        status << Constants::TERMINAL.color(external.url, :cyan)
+        Constants::TERMINAL.say(status)
+      end
+    end
+
+    ################################################################################
+    # make sure we can't run if there are uncomitted changes
+    def uncommitted_check
+      Svn.status do |line|
+        next if line.match(/^\s*X/) or line.match(/^\s*$/)
+        next if line.match(/^\s*Performing/)
+        raise "you have uncommitted changes, you must commit first: #{line}"
+      end
+    end
+
+  end
+end
+################################################################################

data/lib/{sc → svnauto}/commands/info.rb

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Info < Command
     set(:name, :info)

data/lib/{sc → svnauto}/commands/list.rb

@@ -22,13 +22,15 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class List < Command
     ################################################################################
     set(:name, [:list, :ls])
     set(:description, "List directory contents, projects, releases, etc.")
     set(:without_project)
+    set(:example, "# list projects")
+    set(:example, "hello-world/trunk # list the contents of the hello-world trunk")
 
     ################################################################################
     def run (project, args)

data/lib/{sc → svnauto}/commands/release.rb

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Release < Command
     set(:name, :release)
@@ -30,11 +30,21 @@ module SC
     set(:usage, "[options] major.minor[.macro]")
     set(:args_min, 1)
     set(:args_max, 1)
+    set(:example, "1.0 # create a release branch")
+    set(:example, "1.0.0 # create a branch if necessary, and tag it")
+
+    option('-r', '--revision REV', 'Branch at REV instead of trunk/HEAD') do |val, opts|
+      opts[:revision] = val
+    end
 
     option('-C', '--no-checkout', "Don't checkout the rel branch") do |val, opts|
       opts[:no_checkout] = true
     end
 
+    option('-l', '--lock-all', "Lock all svn:externals after release") do |val, opts|
+      opts[:lock_all] = true
+    end
+
     ################################################################################
     def run (project, args)
       @version = Version.new(args.first)
@@ -50,13 +60,23 @@ module SC
 
     ################################################################################
     def make_release_branch
+      if opthash[:no_checkout] and opthash[:lock_all]
+        raise "you can't use --lock-all with --no-checkout"
+      end
+
       unless opthash[:force]
-        question = "Create " + Constants::TERMINAL.color(@project.to_s, :green)
-        question << " release branch " + Constants::TERMINAL.color(@version.major_minor, :red) + "? "
+        question  = "Create " + Constants::TERMINAL.color(@project.to_s, :green)
+        question << " release branch " + Constants::TERMINAL.color(@version.major_minor, :red)
+        question << " off the trunk"
+        question << " at revision #{opthash[:revision]}" if opthash[:revision]
+        question << "? "
+
         exit unless Constants::TERMINAL.agree(question)
       end
 
-      Svn.branch(@project, @project.trunk, @project.branches("rel/#{@version.major_minor}"))
+      branch_options = {}
+      branch_options[:revision] = opthash[:revision] if opthash[:revision]
+      Svn.branch(@project, @project.trunk, @project.branches("rel/#{@version.major_minor}"), branch_options)
 
       if @version.macro.nil?
         question = "Tag release branch as "
@@ -70,9 +90,21 @@ module SC
       tag_release_branch unless @version.macro.nil?
 
       unless opthash[:no_checkout]
-        Constants::TERMINAL.say("Checked out to: " + 
-          Constants::TERMINAL.color(Path.relative_to_home(
-            @project.checkout(@project.branches("rel/#{@version.major_minor}"))), :green))
+        checkout_location = @project.checkout(@project.branches("rel/#{@version.major_minor}"))
+        from_home = Path.relative_to_home(checkout_location)
+        Constants::TERMINAL.say("Checked out to: " + Constants::TERMINAL.color(from_home, :green))
+
+        if opthash[:lock_all]
+          Dir.chdir(checkout_location) do
+            externals = SvnExternals.new
+            locked = externals.unlocked.size
+            externals.lock
+
+            message = "Locked " + Constants::TERMINAL.color(locked.to_s, :red)
+            message += locked == 1 ? "external" : "externals"
+            Constants::TERMINAL.say(message)
+          end
+        end
       end
     end