svnauto 1.0.2 → 1.1.0

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

@@ -24,12 +24,12 @@
 ################################################################################
 require 'yaml'
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class ConfigFile
     ################################################################################
-    ENV_OVERRIDE = 'SC_CONFIG_FILE'
-    FILENAME = File.join(ENV['HOME'], '.sc')
+    ENV_OVERRIDE = 'SvnAuto_CONFIG_FILE'
+    FILENAME = File.join(ENV['HOME'], '.sva')
 
     ################################################################################
     # load in the user's configuration file

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

@@ -22,30 +22,36 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
-  ################################################################################
-  module Path
+module SvnAuto
+  module Constants
     ################################################################################
-    # convert a relative path to home to absolute
-    def self.absolute_from_home (path)
-      home = File.expand_path('~')
-      path.strip!
+    # The version number for this copy of SvnAuto
+    VERSION = '1.1.0'
 
-      # path may start with ~
-      path = File.expand_path(path) if path[0, 1] == '~'
+    ################################################################################
+    # What to call myself
+    ME = 'sva'
 
-      # allow path to be relative or absolute
-      path[0, 1] == '/' ? path : File.join(home, path)
-    end
+    ################################################################################
+    # This regex is used to replace special characters in  project/branch
+    # names so that they don't have problems with the file system or shell
+    NAME_RE = /[^\w.,_+:-]/
 
     ################################################################################
-    # make an absolute path relative to home
-    def self.relative_to_home (path)
-      home = File.expand_path('~')
-      path[0, home.length] == home ? path.sub(home, '~') : path
-    end
+    TERMINAL = HighLine.new
 
+    ################################################################################
+    # We use the HOME environment variable all the time, make sure it's set up
+    if ENV['HOME'].nil?
+      if !ENV['HOMEDRIVE'].nil? and !ENV['HOMEPATH'].nil?
+        ENV['HOME'] = ENV['HOMEDRIVE'] + ENV['HOMEPATH']
+      elsif !ENV['USERPROFILE'].nil?
+        ENV['HOME'] = ENV['USERPROFILE']
+      else
+        raise "please set your HOME environment variable"
+      end
+    end
+	
   end
-  ################################################################################
 end
 ################################################################################

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

@@ -25,7 +25,7 @@
 require 'abbrev'
 require 'optparse'
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Dispatcher
     ################################################################################
@@ -124,7 +124,7 @@ module SC
       # make sure the selected repository is in the config file
       if !klass.without_repository and !config.find_repository(@project.repository.name)
         error =  "the selected repository (#{@project.repository.url}) is not in the configuration file, "
-        error << "please use the 'sc config --add' command to add it first."
+        error << "please use the 'sva config --add' command to add it first."
         raise error
       end
 
@@ -163,10 +163,10 @@ module SC
 
       if klass.args_min and command_extras.length < klass.args_min
         puts usage_for(klass)
-        exit 1
+        raise "you did not give enough arguments"
       elsif klass.args_max and command_extras.length > klass.args_max
         puts usage_for(klass)
-        exit 1
+        raise "you gave too many arguments"
       end
 
       klass.new.run(project, command_extras)
@@ -184,6 +184,13 @@ module SC
         lines.first << "\nShortcuts: #{klass.name[1..-1].join(', ')}"
       end
 
+      if klass.example
+        lines.first << "\n\n\nExamples:\n"
+        klass.example.each do |example|
+          lines.first << "    #{Constants::ME} #{name} #{example}\n"
+        end
+      end
+
       lines.first << "\n\nOptions for the #{name} command:"
       lines.join("\n")
     end

data/lib/svnauto/path.rb

@@ -0,0 +1,138 @@
+################################################################################
+#
+# 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
+  ################################################################################
+  module Path
+    ################################################################################
+    # make a relative path to home absolute
+    def self.absolute_from_home (path)
+      home = File.expand_path('~')
+      path.strip!
+
+      # path may start with ~
+      path = File.expand_path(path) if path[0, 1] == '~'
+
+      # allow path to be relative or absolute
+      absolute?(path) ? path : File.join(home, path)
+    end
+
+    ################################################################################
+    # make an absolute path relative to home
+    def self.relative_to_home (path)
+      home = File.expand_path('~')
+      absolute_path = path.dup
+
+      if case_insensitive_filesystem?
+        home.downcase!
+        absolute_path.downcase!
+      end
+
+      absolute_path[0, home.length] == home ? absolute_path.sub(home, '~') : absolute_path
+    end
+
+    ################################################################################
+    # make file:// url from local path.
+    def self.to_url (path)
+      if windows?
+        if unc?(path)
+          return URI.escape("file:#{path}")
+        elsif has_drive?(path)
+          return URI.escape("file:///#{path}")
+        end
+      end
+
+      url?(path) ? path : URI.escape("file://#{path}")
+    end
+
+    ################################################################################
+    # extract local path element from url.
+    def self.to_path (url)
+      unless windows?
+        return url.is_a?(URI) ? url.path : url
+      end
+
+      path = url.to_s
+      return path unless url?(path)
+      return path unless /^file:/ =~ path
+
+      path = path.sub(/^file:/, "")
+      return path unless path =~ /^\//
+
+      if has_drive?(path.sub(/^\/+/, ""))
+        path.sub(/^\/+/, "")
+      elsif unc?(path)
+        path
+      else
+        path.sub(/^\/+/, "/")
+      end
+    end
+
+    ################################################################################
+    # path is URL?
+    def self.url? (path)
+      begin
+        u = URI.parse(path)
+        return (u.scheme and u.scheme.length > 0)
+      rescue URI::InvalidURIError
+        false
+      end
+    end
+
+    ################################################################################
+    # path is absolute?
+    def self.absolute? (path)
+      Pathname.new(path).absolute?
+    end
+
+    ################################################################################
+    # Is this platform running the Windows OS?
+    def self.windows?
+      RUBY_PLATFORM.match(/djgpp|(cyg|ms|bcc)win|mingw/)
+    end
+
+    ################################################################################
+    # path has Windows drive letter?
+    def self.has_drive? (path)
+      path.match(/^[a-z]:/i)
+    end
+
+    ################################################################################
+    # path is UNC?
+    def self.unc? (path)
+      path.match(%r{^//[^/]})
+    end
+
+    ################################################################################
+    # are we running under a case insensitive filesystem? (such as Windows)
+    def self.case_insensitive_filesystem?
+      ruby_version = Version.new(RUBY_VERSION) rescue nil
+      return !File::FNM_SYSCASE.zero? if ruby_version >= Version.new('1.8.5')
+      return windows?
+    end
+
+  end
+  ################################################################################
+end
+################################################################################

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

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Project
     ################################################################################
@@ -40,12 +40,12 @@ module SC
       project  = nil
 
       # see if we're in an svn directory
-      Svn.info do |line|
-        m = line.match(/^Repository\s+Root:\s+(.+)$/) and url = m[1]
-        m = line.match(/^URL:\s+(.+)$/) and project = m[1]
-      end
+      info = SvnInfo.for('.', false)
+
+      if info.status
+        url = info.repository_root
+        project = info.url
 
-      if url and project
         # try to find a matching repository
         repository   = config[:repositories].find {|r| r.url == url}
         repository ||= Repository.new(:url => url)
@@ -62,7 +62,7 @@ module SC
     ################################################################################
     # remove special characters from a project name
     def self.clean_name (non_clean_name)
-      non_clean_name.gsub(/[^\w\d_-]+/, '_')
+      non_clean_name.gsub(Constants::NAME_RE, '_')
     end
 
     ################################################################################
@@ -120,7 +120,7 @@ module SC
     end
 
     ################################################################################
-    # get a list of the directories that sc uses
+    # get a list of the directories that SvnAuto uses
     def directories
       [
         url, 
@@ -141,7 +141,7 @@ module SC
     def create
       directories.each do |dir|
         unless Svn.has_path(dir)
-          Svn.mkdir('-m', "'#{Constants::ME}: creating #{dir} for project #{name}.'", dir)
+          Svn.mkdir('-m', "#{Constants::ME}: creating #{dir} for project #{name}.", dir)
         end
       end
     end
@@ -232,11 +232,16 @@ module SC
           raise message
         end
 
-        Svn.commit('-m', "'#{Constants::ME}: merging branch using tags #{start_tag} and #{end_tag}'")
+        Svn.commit('-m', "#{Constants::ME}: merging branch using tags #{start_tag} and #{end_tag}")
       end
 
       # clean up after merge
-      system('rm', '-rf', dir) or raise "failed to remove tmp merge directory: #{dir}"
+      begin
+        FileUtils.rm_r(dir)
+      rescue
+        # turn the error message into something the user will understand
+        raise "failed to remove tmp merge directory: #{dir}"
+      end
     end
 
 

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

@@ -22,7 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   ################################################################################
   class Repository 
     ################################################################################
@@ -46,7 +46,7 @@ module SC
     def self.ask (config=nil)
       options = {}
 
-      options[:name] = Constants::TERMINAL.ask("Repository Name (used with sc -r): ")
+      options[:name] = Constants::TERMINAL.ask("Repository Name (used with sva -r): ")
 
       options[:url]  = Constants::TERMINAL.ask("Repository URL: ") do |question|
         if config

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

@@ -22,26 +22,24 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 ################################################################################
-module SC
+module SvnAuto
   class Svn
     ################################################################################
     # Since we're using regexes, we can only support one language, so we pick
     # English.  This setting forces svn to output English.
     ENV['LC_MESSAGES'] = 'C'
+    ENV['LC_ALL'] = 'en_US'
 
     ################################################################################
     # Run a svn subcommand
-    def self._svn (*args)
+    def self._svn (*args, &block)
       subcommand =  caller(0)[0].sub(/^.*:in\s`([^']+).*$/, '\1')
-      shell_line = "#{subcommand} #{args.join(' ')}"
 
+      shell_line = "#{subcommand} #{args.join(' ')}"
       Constants::TERMINAL.say(Constants::TERMINAL.color("svn #{shell_line}", :yellow)) if $DEBUG
 
-      if block_given?
-        `svn #{shell_line} 2>&1`.each {|line| yield(line)}
-      else
-        system("svn #{shell_line}") 
-      end
+      block ||= lambda {|line| print(line)}
+      subprocess('svn', subcommand, *args, &block)
 
       if $? != 0 and !['info', 'list', 'merge'].include?(subcommand)
         raise "svn command failed: #{shell_line}"
@@ -60,11 +58,28 @@ module SC
       true
     end
     
+    ################################################################################
+    # get the current revision number from the given path
+    def self.current_revision (path)
+      rev = nil
+
+      Svn.info(path) do |line|
+        m = line.match(/^Revision:\s+(\d+)$/) and rev = m[1].to_i
+      end
+
+      rev
+    end
+
     ################################################################################
     # create a branch using svn copy
-    def self.branch (project, source, dest)
+    def self.branch (project, source, dest, options={})
       return if self.has_path(dest)
 
+      configuration = {
+        :revision => 'HEAD',
+
+      }.update(options)
+
       relative_dest = dest.sub("#{project.url}/", '')
       dest_dirs = relative_dest.split(/\//)
       dest_dirs.pop # don't need the last one
@@ -77,7 +92,8 @@ module SC
         self.mkdir('-m', "'#{Constants::ME}: creating #{branch_or_tag} path #{dest_path}'", dest_path) unless self.has_path(dest_path)
       end
 
-      self.copy('-m', "'#{Constants::ME}: creating #{branch_or_tag} #{relative_dest}'", source, dest)
+      self.copy('-m', "'#{Constants::ME}: creating #{branch_or_tag} #{relative_dest}'", 
+                '-r', configuration[:revision], source, dest)
     end
 
     ################################################################################
@@ -96,6 +112,31 @@ module SC
       end
     end
 
+    ################################################################################
+    private
+
+    ################################################################################
+    def self.subprocess (*args, &block)
+      tmp    = Tempfile.new(Constants::ME)
+      stdout = $stdout.dup
+      stderr = $stderr.dup
+
+      begin
+        $stdout.reopen(tmp)
+        $stderr.reopen(tmp)
+        system(*args)
+      ensure
+        $stdout.reopen(stdout)
+        $stderr.reopen(stderr)
+      end
+
+      tmp.close
+      IO.foreach(tmp.path, &block)
+
+    ensure
+      File.unlink(tmp.path) if tmp
+    end
+
   end
 end
 ################################################################################

data/lib/svnauto/svn_externals.rb

@@ -0,0 +1,187 @@
+################################################################################
+#
+# 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.
+#
+################################################################################
+require 'fileutils'
+################################################################################
+module SvnAuto
+  ################################################################################
+  class SvnExternals
+    ################################################################################
+    SVN_EXT   = 'svn:externals'
+    SVNAUTO_LOCKED = 'sc:locked'
+
+    ################################################################################
+    attr_reader :unlocked
+    attr_reader :locked
+
+    ################################################################################
+    def initialize (directories=[], recursive=true)
+      if directories.empty?
+        Dir.foreach('.') {|f| directories << f if f[0,1] != '.' and File.directory?(f)}
+      end
+
+      fetch_unlocked(directories, recursive)
+      fetch_locked(directories, recursive)
+    end
+
+    ################################################################################
+    def lock
+      affected_parents = Set.new
+
+      @unlocked.each do |external|
+        affected_parents << File.dirname(external.path)
+        @locked << external
+
+        FileUtils.rm_r(external.path)
+        Svn.export('-r', external.revision, external.url, external.path)
+        Svn.add(external.path)
+      end
+
+      @unlocked.clear
+      update_properties_for(affected_parents)
+
+      short_parents = affected_parents.to_a
+      Svn.commit('-m', "#{Constants::ME}: updated lock properties for #{short_parents.join(', ')}", *short_parents)
+    end
+
+    ################################################################################
+    def unlock
+      affected_parents = Set.new
+
+      @locked.each do |external|
+        affected_parents << File.dirname(external.path)
+        @unlocked << external
+        Svn.delete(external.path)
+        Svn.commit('-m', "#{Constants::ME}: switch #{external.path} from locked to unlocked", external.path)
+        FileUtils.rm_rf(external.path)
+      end
+
+      @locked.clear
+      update_properties_for(affected_parents)
+      short_parents = affected_parents.to_a
+
+      Svn.update(*short_parents)
+      Svn.commit('-m', "#{Constants::ME}: updated lock properties for #{short_parents.join(', ')}", *short_parents)
+    end
+
+    ################################################################################
+    private
+
+    ################################################################################
+    def fetch_unlocked (directories, recursive)
+      @unlocked = []
+      directories.each {|d| property_lookup(d, recursive, SVN_EXT) {|e| @unlocked << e}}
+    end
+
+    ################################################################################
+    def fetch_locked (directories, recursive)
+      @locked = []
+      directories.each {|d| property_lookup(d, recursive, SVNAUTO_LOCKED) {|e| @locked << e}}
+    end
+
+    ################################################################################
+    def property_lookup (dir, recursive, property, &block)
+      # properties will be set on the parent directory
+      parent = File.dirname(dir)
+      base   = File.basename(dir)
+
+      @property_cache ||= {}
+      @property_cache[property] ||= {}
+
+      unless @property_cache[property].has_key?(parent)
+        @property_cache[property][parent] = {}
+
+        Svn.propget(property, parent) do |line|
+          next if line.match(/^\s*$/)
+
+          if m = line.match(/^\s*(\S+)\s+-r\s*(\d+)\s+(.+)\s*$/)
+            path = File.join(parent, m[1])
+            @property_cache[property][parent][m[1]] = SvnInfo.new(:path => path, :revision => m[2], :url => m[3])
+          elsif m = line.match(/^\s*(\S+)\s+(.+)\s*$/)
+            path = File.join(parent, m[1])
+            @property_cache[property][parent][m[1]] = SvnInfo.for(path, true)
+          else
+            raise "can't parse #{property} entry from #{parent}: #{line.chomp}"
+          end
+        end
+      end
+
+      if @property_cache[property][parent].has_key?(base)
+        yield(@property_cache[property][parent][base])
+      elsif recursive
+        # we don't recurse into externals because when we lock the parent
+        # external, it will lock any sub directories that are also externals
+        directories = []
+
+        Dir.foreach(dir) do |file|
+          next if file[0,1] == '.'
+          name = File.join(dir, file)
+          directories << name if File.directory?(name)
+        end
+
+        directories.each {|d| property_lookup(d, recursive, property, &block)}
+      end
+    end
+
+    ################################################################################
+    def update_properties_for (parents)
+      parents.each do |dir|
+        set_properties_for(dir, SVN_EXT,   generate_properties_for(dir, SVN_EXT,   false, @unlocked, @locked))
+        set_properties_for(dir, SVNAUTO_LOCKED, generate_properties_for(dir, SVNAUTO_LOCKED, true,  @locked, @unlocked))
+      end
+    end
+
+    ################################################################################
+    def generate_properties_for (dir, property, with_revision, includes, excludes)
+      output_set = includes.select {|i| File.dirname(i.path) == dir}
+      result = ""
+
+      @property_cache[property][dir].values.each do |external|
+        output_set << external unless excludes.include?(external)
+      end
+
+      output_set.uniq.each do |external|
+        result << File.basename(external.path) << " "
+        result << "-r#{external.revision} " if with_revision
+        result << external.url << "\n"
+      end
+
+      result
+    end
+
+    ################################################################################
+    def set_properties_for (dir, property, data)
+      begin
+        file = Tempfile.new('sc-property-setting')
+        file << data
+        file.close
+        Svn.propset('--file', file.path, property, dir)
+      ensure
+        file.unlink
+      end
+    end
+
+  end
+end
+################################################################################