svnauto 1.0.0

data/lib/sc/constants.rb

@@ -0,0 +1,40 @@
+################################################################################
+#
+# 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 SC
+  module Constants
+    ################################################################################
+    # The version number for this copy of SC
+    VERSION = '1.0.0'
+
+    ################################################################################
+    # What to call myself
+    ME = 'sc'
+
+    ################################################################################
+    TERMINAL = HighLine.new
+
+  end
+end
+################################################################################

data/lib/sc/dispatcher.rb

@@ -0,0 +1,189 @@
+################################################################################
+#
+# 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 'abbrev'
+require 'optparse'
+################################################################################
+module SC
+  ################################################################################
+  class Dispatcher
+    ################################################################################
+    def initialize
+      @options       = OptionParser.new
+      @command_names = {}
+      @first_names   = {}
+
+      Command.commands.each do |command|
+        names = []
+
+        case command.name
+        when Array : command.name.each {|n| names << n.to_s}
+        else         names << command.name.to_s
+        end
+
+        @first_names[names.first] = command
+
+        names.each do |name|
+          raise "Duplicate name: #{name}" if @command_names.has_key?(name)
+          @command_names[name] = command
+        end
+      end
+
+      @abbrevations = @command_names.keys.abbrev
+    end
+
+    ################################################################################
+    def run (args=ARGV)
+      @options.on("-h", "--help", 'This message') do |o|
+        list
+      end
+
+      # it's unfortunate that this is a class method
+      HighLine.use_color = false
+
+      config = ConfigFile.new
+      HighLine.use_color = true if config[:color]
+
+      @options.on('--version', "Show #{Constants::ME} version info") do |o|
+        Constants::TERMINAL.say(Constants::TERMINAL.color(Constants::VERSION, :red))
+        exit
+      end
+
+      @options.on('--verbose', 'Show svn commands as they execute') do |o|
+        $DEBUG = true
+      end
+
+      @options.on('--color', 'Use colored output') do |o|
+        HighLine.use_color = true
+      end
+
+      @options.on('--no-color', "Don't use colored output") do |o|
+        HighLine.use_color = false
+      end
+
+      @project = Project.from_cwd(config)
+      ask_for_repository = nil
+      ask_for_project    = nil
+
+      @options.on("-p", "--project NAME", "use project NAME or ':' to prompt") do |name|
+        if name == ':'
+          ask_for_project = true
+        else
+          @project.name = name
+        end
+      end
+
+      @options.on("-r", "--repository NAME", "use repository NAME or ':' to prompt") do |name|
+        if name == ':'
+          ask_for_repository = true
+        elsif (@project.repository = config.find_repository(name)).nil?
+          raise "#{name}: no such repository defined"
+        end
+      end
+
+      subcommand_options = @options.order!(args)
+      klass = klass_from_string(subcommand_options.shift) or list
+
+      if ask_for_repository or (@project.repository.nil? and klass.without_repository.nil?)
+        @project.repository = config.prompt_for_repository
+
+        if @project.repository.nil? 
+          raise "please specify a repository, or run from an existing checkout"
+        end
+      end
+
+      if ask_for_project or (@project.name.nil? and klass.without_project.nil?)
+        @project.prompt_for_name
+        
+        if @project.name.nil?
+          raise "please specify a project name, or run from an existing checkout"
+        end
+      end
+
+      process(klass, subcommand_options, @project)
+    end
+
+    ################################################################################
+    def list (with_exit=true)
+      lines = @options.to_s.split(/\r?\n/)
+      lines.first << " command [options]"
+      puts lines.join("\n")
+      puts 
+      puts "Avaliable Commands:"
+
+      length = @first_names.keys.inject(0) {|m,o| m >= o.length ? m : o.length} + 4
+      @first_names.keys.sort.each do |name|
+        puts name.rjust(length) + " " + @command_names[name].description
+      end
+
+      exit if with_exit
+    end
+
+    ################################################################################
+    def process (klass, options, project)
+      klass.options.on('-h', '--help', 'This message') do |val|
+        puts usage_for(klass)
+        exit
+      end
+
+      klass.reset!
+      command_extras = klass.options.order!(options)
+      return unless klass.instance_methods.include?('run')
+
+      if klass.args_min and command_extras.length < klass.args_min
+        puts usage_for(klass)
+        exit 1
+      elsif klass.args_max and command_extras.length > klass.args_max
+        puts usage_for(klass)
+        exit 1
+      end
+
+      klass.new.run(project, command_extras)
+    end
+
+    ################################################################################
+    def usage_for (klass)
+      name = klass.name.is_a?(Array) ? klass.name.first : klass.name
+
+      lines = klass.options.to_s.split(/\r?\n/)
+      lines.first << " #{name} #{klass.usage || '[options]'}"
+      lines.first << "\n#{klass.description}"
+
+      if klass.name.is_a?(Array) and klass.name.length > 1
+        lines.first << "\nShortcuts: #{klass.name[1..-1].join(', ')}"
+      end
+
+      lines.first << "\n\nOptions for the #{name} command:"
+      lines.join("\n")
+    end
+
+    ################################################################################
+    def klass_from_string (string)
+      @command_names[@abbrevations[string]]
+    end
+
+  end
+  ################################################################################
+end
+################################################################################

data/lib/sc/path.rb

@@ -0,0 +1,51 @@
+################################################################################
+#
+# 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 SC
+  ################################################################################
+  module Path
+    ################################################################################
+    # convert a relative path to home to 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
+      path[0, 1] == '/' ? path : File.join(home, path)
+    end
+
+    ################################################################################
+    # 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
+
+  end
+  ################################################################################
+end
+################################################################################

data/lib/sc/project.rb

@@ -0,0 +1,265 @@
+################################################################################
+#
+# 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 SC
+  ################################################################################
+  class Project
+    ################################################################################
+    # The name of the project
+    attr_accessor :name
+
+    ################################################################################
+    # The repository for this project
+    attr_accessor :repository
+
+    ################################################################################
+    # Try to get info about the current directory's repository
+    def self.from_cwd (config)
+      url = nil
+      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
+
+      if url and project
+        # try to find a matching repository
+        repository   = config[:repositories].find {|r| r.url == url}
+        repository ||= Repository.new(:url => url)
+
+        new({
+          :repository => repository, 
+          :name => project[url.length + 1 .. -1].sub(/\/.*$/, ''), 
+        })
+      else
+        new
+      end
+    end
+
+    ################################################################################
+    # remove special characters from a project name
+    def self.clean_name (non_clean_name)
+      non_clean_name.gsub(/[^\w\d_-]+/, '_')
+    end
+
+    ################################################################################
+    # Setup a new project
+    def initialize (options={})
+      @name = options[:name]
+      @repository = options[:repository]
+    end
+
+    ################################################################################
+    # get the URL to this project
+    def url
+      "#{@repository.url}/#{@name}"
+    end
+
+    ################################################################################
+    # convert to a string
+    def to_s
+      @name
+    end
+
+    ################################################################################
+    # prompt the user to pick a project name from the repository
+    def prompt_for_name
+      names = []
+
+      if URI.parse(@repository.url).scheme != 'file'
+        puts "Fetching project list from repository, please wait..."
+        $stdout.flush
+      end
+
+      Svn.list(@repository.url) do |line|
+        next if line.match(/^svn:/)
+        names << line.sub(/\/$/, '').strip
+      end
+
+      if names.empty?
+        raise "there are no projects in the repository #{@repository.url}"
+      end
+
+      @name = Constants::TERMINAL.choose do |menu|
+        menu.header = "Projects"
+        menu.prompt = "Please choose a project: "
+
+        names.each do |name|
+          menu.choice(name) {name}
+        end
+      end
+    end
+
+    ################################################################################
+    # get a list of the directories that sc uses
+    def directories
+      [
+        url, 
+        trunk, 
+        branches,
+        branches('rel'), 
+        branches('bug'), 
+        branches('exp'),
+        tags,
+        tags('rel'),
+        tags('bug'),
+        tags('exp'),
+      ]
+    end
+
+    ################################################################################
+    # create the necessary project directories in the repository
+    def create
+      directories.each do |dir|
+        unless Svn.has_path(dir)
+          Svn.mkdir('-m', "'#{Constants::ME}: creating #{dir} for project #{name}.'", dir)
+        end
+      end
+    end
+
+    ################################################################################
+    # get the latest release branch version
+    def latest_release_branch
+      @versions ||= []
+
+      if @versions.empty?
+        Svn.list(release) do |line|
+          next if line.match(/^svn:/)
+          @versions << Version.new(line.sub(/\/$/, '').strip)
+        end
+      end
+
+      @versions.sort.last
+    end
+    
+    ################################################################################
+    # get the latest release tag for the given branch version
+    def latest_release_tag (branch_version)
+      tags = []
+      branch_version_str = branch_version.major_minor
+
+      Svn.list(tags('rel')) do |line|
+        tag = line.sub(/\/$/, '').strip
+        next unless tag[0, branch_version_str.length] == branch_version_str
+        tags << Version.new(tag)
+      end
+
+      tags.sort.last
+    end
+
+    ################################################################################
+    # checkout to the workspace
+    def checkout (version=nil, to=nil)
+      workspace = @repository.workspace
+      url = trunk
+      co_name = "#{@name}-trunk"
+
+      Dir.mkdir(workspace) unless File.exist?(workspace)
+
+      case version
+      when String
+        url = version
+        co_name = "#{@name}-" + version.sub("#{self.url}/", '').gsub(/\//, '-')
+        co_name.sub!(/branches-/, '')
+        co_name.sub!(/releases/, 'rel')
+      when Version
+        url = version.macro.nil? ? release(version.to_s) : tags("rel/#{version.to_s}")
+        co_name = "#{@name}-rel-#{version}"
+      end
+
+      co_name = to if to
+      local_dir = File.join(workspace, co_name)
+      Svn.checkout(url, local_dir) unless File.exist?(local_dir)
+
+      local_dir
+    end
+    
+    ################################################################################
+    # do some common stuff for merging
+    def merge (version, start_tag, end_tag, &error_block)
+      tmp_checkout = "#{@name}-merge-tmp-#{$$}"
+      dir = self.checkout(version, tmp_checkout)
+
+      base = self.url
+      start_tag = self.tags(start_tag) unless start_tag[0, base.length] == base
+      end_tag   = self.tags(end_tag)   unless end_tag[0, base.length]   == base
+
+      Dir.chdir(dir) do
+        conflicts = false
+
+        Svn.merge(start_tag, end_tag) do |line|
+          conflicts = true if line.match(/^\s*C/)
+          print line
+        end
+
+        if conflicts
+          message = "merge failed, you need to resolve conflicts in #{dir} "
+          message << yield if block_given?
+          raise message
+        end
+
+        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}"
+    end
+
+
+    ################################################################################
+    # get the full URL to the trunk for this repository and project
+    def trunk
+      "#{url}/trunk"
+    end
+
+    ################################################################################
+    # get the full URL path for branches
+    def branches (subdir=nil)
+      path = "#{url}/branches"
+      path << "/#{subdir}" if subdir
+      path
+    end
+    
+    ################################################################################
+    # get the full URL path for tags
+    def tags (subdir=nil)
+      path = "#{url}/tags"
+      path << "/#{subdir}" if subdir
+      path
+    end
+
+    ################################################################################
+    # get the full URL to the release branch
+    def release (version=nil)
+      path = branches('rel')
+      path << "/#{version}" if version
+      path
+    end
+
+  end
+  ################################################################################
+end
+################################################################################