ext 0.0.10 → 0.1.0

data/lib/externals/ext.rb

@@ -1,10 +1,16 @@
 require 'externals/project'
+require 'externals/old_project'
 require 'externals/configuration/configuration'
+require 'externals/configuration/old_configuration'
 require 'optparse'
 require 'externals/command'
-require 'ext/symbol'
+require 'extensions/symbol'
 
 module Externals
+  #exit status
+  OBSOLETE_EXTERNALS_FILE = 15
+  
+  
   PROJECT_TYPES_DIRECTORY = File.join(File.dirname(__FILE__), '..', 'externals','project_types')
 
   # Full commands operate on the main project as well as the externals
@@ -37,11 +43,11 @@ module Externals
       main project.  This is automatically performed by install,
       and so you probably only will run this if you are manually
       maintaining .externals"],
-    [:install, "ext install <repository[:branch]> [path]",
+    [:install, "ext install <repository> [-b <branch>] [path]",
       "Registers <repository> in .externals under the appropriate
       SCM.  Checks out the project, and also adds it to the ignore
-      feature offered by the SCM of the main project.  If the SCM 
-      type is not obvious from the repository URL, use the --scm, 
+      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."],
     [:init, "Creates a .externals file containing only [main]
       It will try to determine the SCM used by the main project,
@@ -53,7 +59,9 @@ module Externals
       top and adds a .emptydir file to any empty directories it
       comes across.  Useful for dealing with SCMs that refuse to
       track empty directories (such as git, for example)"],
-    [:help, "You probably just ran this command just now."]
+    [:help, "You probably just ran this command just now."],
+    [:upgrade_externals_file, "Converts the old format that stored
+      as [main][svn][git] to [<path1>][<path2>]..."],
   ]
 
 
@@ -65,18 +73,24 @@ module Externals
 
 
   class Ext
-    Dir.entries(File.join(File.dirname(__FILE__), '..', 'ext')).each do |extension|
-      require "ext/#{extension}" if extension =~ /.rb$/
+    Dir.entries(File.join(File.dirname(__FILE__), '..', 'extensions')).each do |extension|
+      require "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','old_scms')).each do |project|
+      require "externals/old_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
 
+    attr_accessor :path_calculator
+
     def self.project_types
       types = Dir.entries(PROJECT_TYPES_DIRECTORY).select do |file|
         file =~ /\.rb$/
@@ -102,16 +116,18 @@ module Externals
     def self.new_opts main_options, sub_options
       opts = OptionParser.new
 
-      opts.banner = "ext [OPTIONS] <command> [repository[:branch]] [path]"
+      opts.banner = "ext [OPTIONS] <command> [repository] [-b <branch>] [path]"
 
       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'.",
-        Integer) {|type| sub_options[:scm] = main_options[:type] = type}
+        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'.",
-        Integer) {|scm| sub_options[:scm] = main_options[:scm] = scm}
+        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("--workdir DIR", "-w 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)",
@@ -153,10 +169,29 @@ module Externals
         exit
       end
 
+
       Dir.chdir(main_options[:workdir] || ".") do
+        if command == :upgrade_externals_file
+          main_options[:upgrade_externals_file] = true
+        elsif command != :help
+          if externals_file_obsolete?
+            puts "your .externals file Appears to be in an obsolete format"
+            puts "Please run 'ext upgrade_externals_file' to migrate it to the new format"
+            exit OBSOLETE_EXTERNALS_FILE
+          end
+        end
+
         new(main_options).send(command, args, sub_options)
       end
     end
+    
+    def self.externals_file_obsolete?
+      return false if !File.exists?('.externals')
+      
+      open('.externals', 'r') do |f|
+        f.read =~ /^\s*\[git\]\s*$|^\s*\[main\]\s*$|^\s*\[svn\]\s*$/
+      end      
+    end
 
     def print_commands(commands)
       commands.each do |command|
@@ -198,17 +233,36 @@ module Externals
     end
 
     def projects
-      configuration.projects
+      p = []
+      configuration.sections.each do |section|
+        p << Ext.project_class(section[:scm]||infer_scm(section[:repository])).new(
+          section.attributes.merge(:path => section.title))
+      end
+      p
     end
 
     def subprojects
-      configuration.subprojects
+      s = []
+      projects.each do |project|
+        s << project unless project.main_project?
+      end
+      s
+    end
+    
+    def main_project
+      projects.detect {|p| p.main_project?}
     end
 
     def configuration
       return @configuration if @configuration
 
-      @configuration = Configuration::Configuration.new
+      file_string = ''
+      if File.exists? '.externals'
+        open('.externals', 'r') do |f|
+          file_string = f.read
+        end
+      end
+      @configuration = Configuration::Configuration.new(file_string)
     end
 
     def reload_configuration
@@ -219,12 +273,37 @@ module Externals
     def initialize options
       super()
 
-      scm = configuration['main']
+      if options[:upgrade_externals_file]
+        type ||= options[:type]
+        
+
+        if type
+          install_project_type type
+        else
+          
+          possible_project_types = self.class.project_types.select do |project_type|
+            self.class.project_type_detector(project_type).detected?
+          end
+
+          if possible_project_types.size > 1
+            raise "We found multiple project types that this could be: #{possible_project_types.join(',')}
+Please use
+ the --type option to tell ext which to use."
+          elsif possible_project_types.empty?
+            install_project_type OldConfiguration::Configuration.new[:main][:type]
+          else
+            install_project_type possible_project_types.first
+          end
+        end
+        return
+      end
+
+      scm = configuration['.']
       scm = scm['scm'] if scm
       scm ||= options[:scm]
       #scm ||= infer_scm(repository)
 
-      type = configuration['main']
+      type = configuration['.']
       type = type['type'] if type
 
       type ||= options[:type]
@@ -252,6 +331,22 @@ Please use
       Externals.module_eval("#{scm.to_s.cap_first}Project", __FILE__, __LINE__)
     end
 
+    def self.project_classes
+      retval = []
+      registered_scms.each do |scm|
+        retval << project_class(scm)
+      end
+
+      retval
+    end
+    def self.project_class(scm)
+      Externals.module_eval("#{scm.to_s.cap_first}Project", __FILE__, __LINE__)
+    end
+
+    def self.old_project_class(scm)
+      Externals.module_eval("Old#{scm.to_s.cap_first}Project", __FILE__, __LINE__)
+    end
+
     def self.project_classes
       retval = []
       registered_scms.each do |scm|
@@ -285,30 +380,38 @@ Please use
 
     def install args, options
       init args, options unless File.exists? '.externals'
-      row = args.join " "
+      repository = args[0]
+      path = args[1]
 
       orig_options = options.dup
 
       scm = options[:scm]
 
-      scm ||= infer_scm(row)
-      
+      scm ||= infer_scm(repository)
+
       unless scm
-        raise "Unable to determine SCM from the repository name.  
+        raise "Unable to determine SCM from the repository name.
 You need to either specify the scm used to manage the subproject
 that you are installing. Use an option to specify it
 (such as --git or --svn)"
       end
 
-      if !configuration[scm]
-        configuration.add_empty_section(scm)
-      end
-      configuration[scm].add_row(row)
-      configuration.write
+      project = self.class.project_class(scm).new(:repository => repository, 
+        :path => path || path_calculator.new, :scm => scm)
+      path = project.path
+      
+      raise "no path" unless path
+      
+      raise "already exists" if configuration[path]
+      
+      project.branch = options[:branch] if options[:branch]
+      
+      attributes = project.attributes.dup
+      attributes.delete(:path)
+      configuration[path] = project.attributes
+      configuration.write '.externals'
       reload_configuration
 
-      project = self.class.project_class(scm).new(row)
-
       project.co
 
       update_ignore args, orig_options
@@ -318,7 +421,7 @@ that you are installing. Use an option to specify it
       #path = args[0]
 
 
-      scm = configuration['main']
+      scm = configuration['.']
       scm = scm['scm'] if scm
 
       scm ||= options[:scm]
@@ -328,9 +431,9 @@ that you are installing. Use an option to specify it
           (such as --git or --svn)"
       end
 
-      project = self.class.project_class(scm).new(".")
+      project = self.class.project_class(scm).new(:path => ".")
 
-      raise "only makes sense for main project" unless project.main?
+      raise "only makes sense for main project" unless project.main_project?
 
       subprojects.each do |subproject|
         puts "about to add #{subproject.path} to ignore"
@@ -372,14 +475,14 @@ that you are installing. Use an option to specify it
 
     def status args, options
       options ||= {}
-      repository = "."
-      path = "."
-      main_project = nil
+      #repository = "."
+      #path = "."
+      #main_project = nil
       scm = options[:scm]
-      scm ||= infer_scm(repository)
+      #scm ||= infer_scm(repository)
 
       if !scm
-        scm ||= configuration['main']
+        scm ||= configuration['.']
         scm &&= scm['scm']
       end
 
@@ -404,21 +507,22 @@ by creating the .externals file manually"
           (such as --git or --svn)"
       end
 
-      main_project = self.class.project_class(scm).new("#{repository} #{path}", :is_main)
-      main_project.st
+      #main_project = self.class.project_class(scm).new("#{repository} #{path}", :is_main)
+      project = main_project
+      project.scm ||= scm
+      project.st
 
       self.class.new({}).st [], {} #args, options
     end
 
     def update args, options
       options ||= {}
-      repository = args[0]
-      main_project = nil
+      #repository = args[0]
       scm = options[:scm]
-      scm ||= infer_scm(repository)
+      #scm ||= infer_scm(repository)
 
       if !scm
-        scm ||= configuration['main']
+        scm ||= configuration['.']
         scm &&= scm['scm']
       end
 
@@ -427,8 +531,10 @@ by creating the .externals file manually"
           (such as --git or --svn)"
       end
 
-      main_project = self.class.project_class(scm).new("#{repository} #{path}", :is_main)
-      main_project.up
+      #main_project = self.class.project_class(scm).new("#{repository} #{path}", :is_main)
+      project = main_project
+      project.scm ||= scm
+      project.up
 
       self.class.new({}).up [], {} #args, options
     end
@@ -506,20 +612,46 @@ Please use the --type option to tell ext which to use."
 
       config = Configuration::Configuration.new_empty
 
-      config.sections << Configuration::Section.new("[main]\n",
-        "scm = #{scm}\n" +
-          "#{'type = ' + type if type}\n")
+      raise ".externals already exists" if File.exists?('.externals')
+      
+      config.add_empty_section '.'
+
+      config['.'][:scm] = scm
+      config['.'][:type] = type if type
 
-      config.write
+      config.write '.externals'
       reload_configuration
     end
 
+    def upgrade_externals_file args, options = {}
+      old = OldConfiguration::Configuration.new
+
+      config = Configuration::Configuration.new_empty
+
+      main = old['main']
+      config.add_empty_section '.'
+
+      config['.'][:scm] = main[:scm]
+      config['.'][:type] = main[:type]
+
+      old.subprojects.each do |subproject|
+        path = subproject.path
+        config.add_empty_section path
+        config[path][:repository] = subproject.repository
+        config[path][:scm] = subproject.scm
+        config[path][:branch] = subproject.branch if subproject.branch
+      end
+
+      config.write('.externals')
+    end
+
     def self.project_type_detector name
       Externals.module_eval("#{name.classify}Detector", __FILE__, __LINE__)
     end
 
     def install_project_type name
       Externals.module_eval("#{name.classify}ProjectType", __FILE__, __LINE__).install
+      self.path_calculator = Externals.module_eval("#{name.classify}ProjectType::DefaultPathCalculator", __FILE__, __LINE__)
     end
     #
     #
@@ -549,7 +681,8 @@ Please use the --type option to tell ext which to use."
           (such as --git or --svn)"
         end
 
-        main_project = self.class.project_class(scm).new("#{repository} #{path}", :is_main)
+        main_project = self.class.project_class(scm).new(:repository => repository,
+          :path => path)
 
         main_project.send(sym)
         main_project

data/lib/externals/old_project.rb

@@ -0,0 +1,114 @@
+module Externals
+  # this regular expression will match a quoted string
+  # it will allow for " to be escaped with "" within the string
+  quoted = '(?:"(?:(?:[^"]*(?:"")?)*)")'
+
+  # this regular expression will match strings of text that are not quoted.  They must appear at the start of a line or after a ,
+  # it will also match empty strings like ,,
+  unquoted = '(?:[^"\\s][^\\s$]*)'
+
+  column = "(#{quoted}|#{unquoted})"
+  PROJECT_LINE_REGEX = Regexp.new("^\\s*#{column}(?:\\s+#{column})?\\s*$")
+
+  class OldProject
+    attr_accessor :branch, :repository, :path
+    attr_writer :is_main, :name
+    
+    def name
+      @name ||= (extract_name(repository))
+    end
+    
+    def main?
+      @is_main
+    end
+
+    def self.scm
+      raise "subclass responsibility"
+    end
+    
+        
+    def scm
+      self.class.scm
+    end
+    
+    
+    def initialize row_string, is_main = false
+      #raise "Abstract class" if self.class == Project
+      
+      #It's the main project
+      self.is_main = is_main || row_string == "."
+        
+      if row_string =~ PROJECT_LINE_REGEX
+        repbranch = trim_quotes($1)
+        self.path = trim_quotes($2)
+        
+        repbranch = repbranch.strip if repbranch
+        
+        if repbranch =~ /^([^\n]*):(\w+)$/
+          self.repository = $1
+          self.branch = $2
+        else
+          self.repository = repbranch
+        end
+        
+        self.path = self.path.strip if self.path
+      else
+        raise "poorly formatted .externals entry: #{row_string}"
+      end
+    end
+    
+    [:co, :ex].each do |method_name|
+      define_method method_name do |args| 
+        raise "subclass responsibility"
+      end
+    end
+  
+    def update_ignore path
+      if !ignore_contains?(path)
+        append_ignore path
+      end
+    end
+ 
+    def checkout *args
+      co(*args)
+    end
+    
+    def export *args
+      ex(*args)
+    end
+    
+    def extract_name repository
+      if repository =~ /\/([\w_-]+)(?:\.git)?$/
+        $1
+      end
+    end
+    
+    def path
+      @path || default_path
+    end
+
+    def parent_path
+      File.dirname path
+    end
+    
+    def self.project_line? line
+      #Make sure it's not a comment
+      return false if line =~ /^\s*#/
+      
+      line =~ PROJECT_LINE_REGEX
+    end
+    
+    
+
+    protected
+    def trim_quotes value
+      if value
+        if [value[0].chr, value[-1].chr] == ['"', '"']
+          value[1..-2]
+        else
+          value
+        end
+      end
+    end
+  end
+end