ext 1.0.2 → 1.0.3

data/CHANGELOG

@@ -1,3 +1,8 @@
+September 28, 2011 Version 1.0.3 released
+- "up" now changes branches of subprojects
+- Subversion branch support added
+- "switch" command added.
+
 September 8, 2011 Version 1.0.2 released
 - For git, fixed bug preventing "ext up" from changing the branches of subprojects as expected.
 - For git, fixed bug preventing "ext checkout -b <branch_name>" from functioning as expected.

data/README

@@ -21,26 +21,35 @@ forms apply the action to all sub projects.
 
 The commands and usage are as follows (from 'ext help'):
 There's a tutorial available at http://nopugs.com/ext-tutorial
-There's a tutorial available at http://nopugs.com/ext-tutorial
 
 ext [OPTIONS] <command> [repository] [-b <branch>] [path]
-    -g, --git                        same as '--scm git'  Uses git to checkout/export the main project
-    -s, --svn, --subversion          same as '--scm svn'  Uses subversion to checkout/export the main project
-    -t, --type TYPE                  The type of project the main project is.  For example, 'rails'.
-        --scm SCM                    The SCM used to manage the main project.  For example, '--scm svn'.
-    -b, --branch BRANCH              The branch you want the subproject to checkout when doing 'ext install'
-    -f, --force_removal              When doing an uninstall of a subproject, remove it's files and subfolders, too.
-    -w, --workdir DIR                The working directory to execute commands from.  Use this if for some reason you
-                                     cannot execute ext from the main project's directory (or if it's just inconvenient,
-                                     such as in a script or in a Capistrano task)
-        --help                       does the same as 'ext help'  If you use this with a command
-                                     it will ignore the command and run help instead.
-        --version                    Displays the version number of externals and then exits.
-                                     Same as 'ext version'
+  -g, --git                same as '--scm git' Uses git to checkout/export the
+                           main project
+      --svn, --subversion  same as '--scm svn' Uses subversion to
+                           checkout/export the main project
+  -t, --type TYPE          The type of project the main project is. For example,
+                           'rails'.
+  -s, --scm SCM            The SCM used to manage the main project. For example,
+                           '--scm svn'.
+  -b, --branch BRANCH      The branch you want the subproject to checkout when
+                           doing 'ext install'
+  -f, --force_removal      When doing an uninstall of a subproject, remove it's
+                           files and subfolders, too.
+  -w, --workdir DIR        The working directory to execute commands from. Use
+                           this if for some reason you cannot execute ext from
+                           the main project's directory (or if it's just
+                           inconvenient, such as in a script or in a Capistrano
+                           task)
+      --help               does the same as 'ext help' If you use this with a
+                           command it will ignore the command and run help
+                           instead.
+      --version            Displays the version number of externals and then
+                           exits. Same as 'ext version'
+
 
 
 Commands that apply to the main project or the .externals file:
-freeze, help, init, install, touch_emptydirs, uninstall, update_ignore, upgrade_externals_file
+freeze, help, init, install, switch, touch_emptydirs, uninstall, update_ignore, version
 
 freeze          Usage: ext freeze project [REVISION]
 
@@ -65,6 +74,11 @@ install         Usage: ext install <repository> [-b <branch>] [path]
                 type is not obvious from the repository URL, use the --scm,
                 --git, or --svn flags.
 
+switch          Usage: ext switch <branch_name>
+                Changes to the named branch <branch_name> and updates any
+                subprojects and applies any changes that have been made to the
+                .externals file.
+
 touch_emptydirs Recurses through all directories from the
                 top and adds a .emptydir file to any empty directories it
                 comes across.  Useful for dealing with SCMs that refuse to
@@ -166,7 +180,33 @@ This will pass "--non-interactive --trust-certid" to all co calls dealing with
 subversion projects, regardless of which project it is.
 
 
+BRANCHES WITH SUBVERSION
+------------------------
+Subversion does not have a branch feature. Instead, subversion users use the copy
+feature to copy directories within the repository (branch), a switch command to switch the
+URL that the working directory points at (checkout), and a merge feature to merge
+directories (merge).
+
+ext handles branches in Subversion by splitting the URL given by 'svn info' into
+a repository part and a branch part.
+
+If you find yourself doing this:
+
+ext checkout svn+ssh://someserver/somepath/repository/branches/new_feature
+
+Then you almost certainly mean to do this:
+
+ext checkout svn+ssh://someserver/somepath/repository -b branches/new_feature
+
+For ext to use branch-related features with Subversion repositories, the repository
+must be known.  For subprojects this is never a problem, but for the main project,
+it's important that there is a repository field under [.] in the .externals file.
+This can be accomplished by using -b with commands like 'ext checkout' and 'ext init'
+or by manually editing the .externals file.
+
 
+Copyright Information
+---------------------
 The externals project is copyright 2008 by Miles Georgi, nopugs.com, azimux.com
 and is released under the MIT license.
 

data/lib/externals/configuration/configuration.rb

@@ -134,6 +134,14 @@ module Externals
         sections << Section.new("[#{title.to_s}]", "")
       end
 
+      def removed_project_paths other_config
+        all_paths - other_config.all_paths
+      end
+
+      def all_paths
+        sections.map(&:title)
+      end
+
       def self.new_empty
         new nil, true
       end

data/lib/externals/ext.rb

@@ -5,7 +5,7 @@ require 'externals/command'
 require 'externals/extensions/symbol'
 
 module Externals
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
   PROJECT_TYPES_DIRECTORY = File.join(File.dirname(__FILE__), '..', 'externals','project_types')
 
   # Full commands operate on the main project as well as the externals
@@ -51,6 +51,10 @@ module Externals
       feature offered by the SCM of the main project.  If the SCM
       type is not obvious from the repository URL, use the --scm,
       --git, or --svn flags."],
+    [:switch, "ext switch <branch_name>",
+      "Changes to the named branch <branch_name> and updates any
+      subprojects and applies any changes that have been made to the
+      .externals file."],
     [:touch_emptydirs, "Recurses through all directories from the
       top and adds a .emptydir file to any empty directories it
       comes across.  Useful for dealing with SCMs that refuse to
@@ -75,20 +79,19 @@ module Externals
 
   COMMANDS = FULL_COMMANDS + SHORT_COMMANDS + MAIN_COMMANDS
 
+  Dir.entries(File.join(File.dirname(__FILE__), 'extensions')).each do |extension|
+    require "externals/extensions/#{extension}" if extension =~ /.rb$/
+  end
 
-  class Ext
-    Dir.entries(File.join(File.dirname(__FILE__), 'extensions')).each do |extension|
-      require "externals/extensions/#{extension}" if extension =~ /.rb$/
-    end
-
-    Dir.entries(File.join(File.dirname(__FILE__), '..', 'externals','scms')).each do |project|
-      require "externals/scms/#{project}" if project =~ /_project.rb$/
-    end
+  Dir.entries(File.join(File.dirname(__FILE__), '..', 'externals','scms')).each do |project|
+    require "externals/scms/#{project}" if project =~ /_project.rb$/
+  end
 
-    Dir.entries(PROJECT_TYPES_DIRECTORY).each do |type|
-      require File.join(PROJECT_TYPES_DIRECTORY, type) if type =~ /\.rb$/
-    end
+  Dir.entries(PROJECT_TYPES_DIRECTORY).each do |type|
+    require File.join(PROJECT_TYPES_DIRECTORY, type) if type =~ /\.rb$/
+  end
 
+  class Ext
     attr_accessor :path_calculator
 
     def self.project_types
@@ -114,35 +117,52 @@ module Externals
     end
 
     def self.new_opts main_options, sub_options
-      opts = OptionParser.new
-
-      opts.banner = "ext [OPTIONS] <command> [repository] [-b <branch>] [path]"
+      opts = OptionParser.new(
+        "ext [OPTIONS] <command> [repository] [-b <branch>] [path]"
+      )
+      opts.summary_indent = '  '
+      opts.summary_width = 24
+      summary_width = 53
 
       project_classes.each do |project_class|
-        project_class.fill_in_opts(opts, main_options, sub_options)
-      end
-
-      opts.on("--type TYPE", "-t TYPE", "The type of project the main project is.  For example, 'rails'.",
-        String) {|type| sub_options[:scm] = main_options[:type] = type}
-      opts.on("--scm SCM", "-s SCM", "The SCM used to manage the main project.  For example, '--scm svn'.",
-        String) {|scm| sub_options[:scm] = main_options[:scm] = scm}
-      opts.on("--branch BRANCH", "-b BRANCH", "The branch you want the subproject to checkout when doing 'ext install'",
-        String) {|branch| sub_options[:branch] = main_options[:branch] = branch}
-      opts.on("--force_removal", "-f", "When doing an uninstall of a subproject, remove it's files and subfolders, too.",
-        String) {|branch| sub_options[:force_removal] = true}
-      opts.on("--workdir DIR", "-w DIR", "The working directory to execute commands from.  Use this if for some reason you
+        project_class.fill_in_opts(opts, main_options, sub_options,
+          :summary_width => summary_width)
+      end
+
+      opts.on("--type TYPE", "-t TYPE",
+        String,
+        *"The type of project the main project is.
+          For example, 'rails'.".lines_by_width(summary_width)
+      ) {|type| sub_options[:scm] = main_options[:type] = type}
+      opts.on("--scm SCM", "-s SCM",
+        String,
+        *"The SCM used to manage the main project.  For example, '--scm svn'.".lines_by_width(summary_width)
+      ) {|scm| sub_options[:scm] = main_options[:scm] = scm}
+      opts.on("--branch BRANCH", "-b BRANCH",
+        String,
+        *"The branch you want the
+        subproject to checkout when doing 'ext install'".lines_by_width(summary_width)
+      ) {|branch| sub_options[:branch] = main_options[:branch] = branch}
+      opts.on("--force_removal", "-f",
+        String,
+        *"When doing an uninstall of a subproject,
+        remove it's files and subfolders, too.".lines_by_width(summary_width)
+      ) {|branch| sub_options[:force_removal] = true}
+      opts.on("--workdir DIR", "-w DIR", String, *"The working directory to execute commands from.  Use this if for some reason you
         cannot execute ext from the main project's directory (or if it's just inconvenient, such as in a script
-        or in a Capistrano task)",
-        String) {|dir|
+        or in a Capistrano task)".lines_by_width(summary_width)) {|dir|
         raise "No such directory: #{dir}" unless File.exists?(dir) && File.directory?(dir)
         main_options[:workdir] = dir
       }
-      opts.on("--help", "does the same as 'ext help'  If you use this with a command
-        it will ignore the command and run help instead.") {main_options[:help] = true}
-      opts.on("--version", "Displays the version number of externals and then exits.
-        Same as 'ext version'") {
+      opts.on(
+        "--help", *"does the same as 'ext help'  If you use this with a command
+        it will ignore the command and run help instead.".lines_by_width(summary_width)
+      ) {main_options[:help] = true}
+      opts.on("--version", *"Displays the version number of externals and then exits.
+        Same as 'ext version'".lines_by_width(summary_width)) {
         main_options[:version] = true
       }
+      opts
     end
 
     def self.run *arguments
@@ -539,6 +559,70 @@ by creating the .externals file manually"
       self.class.new({}).st [], {} #args, options
     end
 
+    def switch args, options
+      branch = args[0]
+
+      options ||= {}
+      scm = options[:scm]
+
+      if !scm
+        scm ||= configuration['.']
+        scm &&= scm['scm']
+      end
+
+      if !scm
+        possible_project_classes = self.class.project_classes.select do |project_class|
+          project_class.detected?
+        end
+
+        raise "Could not determine this projects scm" if  possible_project_classes.empty?
+        if possible_project_classes.size > 1
+          raise "This project appears to be managed by multiple SCMs: #{
+          possible_project_classes.map(&:to_s).join(',')}
+Please explicitly declare the SCM (by using --git or --svn, or,
+by creating the .externals file manually"
+        end
+
+        scm = possible_project_classes.first.scm
+      end
+
+      unless scm
+        raise "You need to either specify the scm as the first line in .externals, or use an option to specify it
+          (such as --git or --svn)"
+      end
+
+      old_config = configuration
+      project = main_project
+      project.scm ||= scm
+
+      if project.current_branch == branch
+        puts "Already on branch #{branch}"
+      else
+        project.switch branch, options
+        project.up
+
+        reload_configuration
+
+        #update subprojects
+        self.class.new({}).up [], {} #args, options
+
+        removed_project_paths = old_config.removed_project_paths(
+          configuration
+        ).select{|path| File.exists?(path)}
+
+        if !removed_project_paths.empty?
+          puts "WARNING: The following subprojects are no longer being maintained in the
+.externals file.  You might want to remove them.  You can copy and paste the
+commands below if you actually wish to delete them."
+          removed_project_paths.each do |path|
+            if File.exists? path
+              puts "  rm -r #{path}"
+            end
+          end
+        end
+      end
+    end
+
     def update args, options
       options ||= {}
       #repository = args[0]
@@ -635,11 +719,23 @@ Please use the --type option to tell ext which to use."
       end
 
       config = Configuration::Configuration.new_empty
-
       raise ".externals already exists" if File.exists?('.externals')
 
       config.add_empty_section '.'
 
+      # If we are using subversion, we should warn about not setting a branch
+      if scm == "svn"
+        if options[:branch]
+          config['.'][:repository] = SvnProject.extract_repository(
+            SvnProject.info_url,
+            options[:branch]
+          )
+        elsif args[0]
+          config['.'][:repository] = args[0].strip
+        else
+        end
+      end
+
       config['.'][:scm] = scm
       config['.'][:type] = type if type
 

data/lib/externals/extensions/string.rb

@@ -2,8 +2,38 @@ String.class_eval do
   def cap_first
     "#{self[0].chr.upcase}#{self[1..(self.length - 1)]}"
   end
-  
+
   def classify
     split('_').map(&:cap_first).join
   end
+
+  #avoid collision
+  raise unless instance_methods.include?("lines")
+  raise if instance_methods.include?("lines_by_width")
+  def lines_by_width(width = 32)
+    width ||= 32
+    lines = []
+    string = gsub(/\s+/, ' ')
+    while string.size > 0
+      if string.size <= width
+        lines << string
+        string = ""
+      else
+        index = string[0, width + 1].rindex(/\s/)
+        unless index
+          # let's find the first space we can.
+          index = string.index(/\s/)
+        end
+        if index
+          lines << string[0, index]
+          string = string[(index + 1)..-1]
+        else
+          lines << string
+          string = ""
+        end
+      end
+    end
+
+    lines
+  end
 end

data/lib/externals/project.rb

@@ -56,6 +56,10 @@ module Externals
       self.class.default_branch
     end
 
+    def switch branch_name, options = {}
+      raise "subclass responsibility"
+    end
+
     def initialize hash
       raise "Abstract class" if self.class == Project
       raise "expected hash" unless hash.is_a? Hash

data/lib/externals/scms/git_project.rb

@@ -22,6 +22,9 @@ module Externals
 
       puts(gitclonecmd = "git #{opts} clone \"#{repository}\" #{dest}")
       puts `#{gitclonecmd}`
+      unless $? == 0
+        raise "git clone of #{repository} failed."
+      end
 
       change_to_branch_revision(command)
     end
@@ -86,6 +89,33 @@ module Externals
       end
     end
 
+    def switch branch_name, options = {}
+      cb = current_branch
+      if cb == branch_name
+        puts "Already on branch #{branch_name}"
+      else
+        # This allows the main project to be checked out to a directory
+        # that doesn't match it's name.
+        Dir.chdir path do
+          # let's see if the branch exists in the remote repository
+          # and if not, fetch it.
+          if !branch_exists("origin/#{branch_name}")
+            puts `git #{scm_opts} fetch`
+          end
+
+          # if the local branch doens't exist, add --track -b
+          if branch_exists(branch_name)
+            puts `git #{scm_opts} checkout #{branch_name}`
+          else
+            puts `git #{resolve_opts("co")} checkout --track -b #{branch_name} origin/#{branch_name}`
+          end
+          unless $? == 0
+            raise "Could not checkout origin/#{branch_name}"
+          end
+        end
+      end
+    end
+
     def ex *args
       if path != '.'
         (rmdircmd = "rmdir #{path}")
@@ -131,9 +161,12 @@ module Externals
       path =~ /^git:/ || path =~ /.git$/
     end
 
-    def self.fill_in_opts opts, main_options, sub_options
-      opts.on("--git", "-g", "same as '--scm git'  Uses git to checkout/export the main project",
-        Integer) {sub_options[:scm] = main_options[:scm] = 'git'}
+    def self.fill_in_opts opts, main_options, sub_options, options
+      opts.on("--git", "-g",
+        Integer,
+        *"same as '--scm git'  Uses git to
+        checkout/export the main project".lines_by_width(options[:summary_width])
+      ) {sub_options[:scm] = main_options[:scm] = 'git'}
     end
 
     def self.detected?
@@ -150,7 +183,7 @@ module Externals
       text.split(/\n/).detect {|r| r.strip == path.strip}
     end
 
-    def ignore_text(path)
+    def ignore_text(path = nil)
       return '' unless File.exists? '.gitignore'
       retval = ''
       open('.gitignore') do |f|