ext 1.1.3 → 2.0.0

data/lib/externals/ext.rb

@@ -4,59 +4,55 @@ require 'optparse'
 require 'externals/command'
 require 'fileutils'
 
+require_relative "../../version"
+
 Dir.entries(File.join(File.dirname(__FILE__), 'extensions')).each do |extension|
   require "externals/extensions/#{extension}" if extension =~ /.rb$/
 end
 
 module Externals
-  VERSION = '1.1.3'
-  PROJECT_TYPES_DIRECTORY = File.join(File.dirname(__FILE__), '..', 'externals','project_types')
-
   # Full commands operate on the main project as well as the externals
   # short commands only operate on the externals
   # Main commands only operate on the main project
   FULL_COMMANDS_HASH = [
     [:checkout, "ext checkout <repository>",
-      %{Checks out <repository>, and checks out any subprojects
+     %{Checks out <repository>, and checks out any subprojects
       registered in <repository>'s .externals file.}],
     [:export, "ext export <repository>",
-      %{Like checkout except this command fetches as little
+     %{Like checkout except this command fetches as little
       history as possible.}],
     [:status, "ext status",
-      %{Prints out the status of the main project, followed by
+     %{Prints out the status of the main project, followed by
       the status of each subproject.}],
     [:update, "ext update",
-      %{Brings the main project, and all subprojects, up to the
+     %{Brings the main project, and all subprojects, up to the
       latest version.}]
-  ]
+  ].freeze
   SHORT_COMMANDS_HASH = [
     [:co, "Like checkout, but skips the main project and
           only checks out subprojects."],
     [:ex, "Like export, but skips the main project."],
     [:st, "Like status, but skips the main project."],
     [:up, "Like update, but skips the main project."]
-  ]
+  ].freeze
   MAIN_COMMANDS_HASH = [
     [:freeze, "ext freeze <subproject> [REVISION]",
-      %{Locks a subproject into a specific revision/branch.  If no
+     %{Locks a subproject into a specific revision/branch.  If no
       revision is supplied, the current revision/branch of the
       project will be used.  You can specify the subproject by name
       or path.}],
     [:help, "You probably just ran this command just now."],
     [:init, "Creates a .externals file containing only [main]
-      It will try to determine the SCM used by the main project,
-      as well as the project type.  You don't have to specify
-      a project type if you don't want to or if your project type
-      isn't supported.  It just means that when using 'install'
-      that you'll want to specify the 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
+      It will try to determine the SCM used by the main project."],
+    [:install, "ext install <repository> [-b <branch>] <path>",
+     "Registers <repository> in .externals under the appropriate
+      SCM.  Checks out the subproject at given path,
+      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,
       --git, or --svn flags."],
     [:switch, "ext switch <branch_name>",
-      "Changes to the named branch <branch_name> and updates any
+     "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
@@ -64,10 +60,10 @@ module Externals
       comes across.  Useful for dealing with SCMs that refuse to
       track empty directories (such as git, for example)"],
     [:unfreeze, "ext unfreeze <subproject>",
-      %{Unfreezes a previously frozen subproject.  You can specify
+     %{Unfreezes a previously frozen subproject.  You can specify
       the subproject by name or path.}],
     [:uninstall, "ext uninstall [-f|--force_removal] <project>",
-      "Removes a subproject from being tracked by ext.  If you
+     "Removes a subproject from being tracked by ext.  If you
       want the files associated with this subproject deleted as well
       (if, for example, you wish to reinstall it from a different
       repository) then you can use the -f option to remove the files."],
@@ -77,11 +73,10 @@ module Externals
       and so you probably only will run this if you are manually
       maintaining .externals"],
     [:version, "Displays the version number of externals and exits."],
-  ]
-
+  ].freeze
 
   FULL_COMMANDS = FULL_COMMANDS_HASH.map(&:first)
-  SHORT_COMMANDS =  SHORT_COMMANDS_HASH.map(&:first)
+  SHORT_COMMANDS = SHORT_COMMANDS_HASH.map(&:first)
   MAIN_COMMANDS = MAIN_COMMANDS_HASH.map(&:first)
 
   COMMANDS = FULL_COMMANDS + SHORT_COMMANDS + MAIN_COMMANDS
@@ -89,40 +84,14 @@ module Externals
   COULD_NOT_DETERMINE_SCM = 1
   NO_EXTERNALS_FILE = 2
 
-  Dir.entries(File.join(File.dirname(__FILE__), '..', 'externals','scms')).each do |project|
+  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
-
   class Ext
     include FileUtils
     extend FileUtils
 
-    attr_accessor :path_calculator
-
-    def self.project_types
-      types = Dir.entries(PROJECT_TYPES_DIRECTORY).select do |file|
-        file =~ /\.rb$/
-      end
-
-      types.map do |type|
-        /^(.*)\.rb$/.match(type)[1]
-      end
-    end
-
-    def self.project_type_files
-      project_types.map do |project_type|
-        "#{File.join(PROJECT_TYPES_DIRECTORY, project_type)}.rb"
-      end
-    end
-
-    project_type_files.each do |file|
-      require file
-    end
-
     def self.new_opts main_options, sub_options
       opts = OptionParser.new(
         "ext [OPTIONS] <command> [repository] [-b <branch>] [path]"
@@ -133,37 +102,35 @@ module Externals
 
       project_classes.each do |project_class|
         project_class.fill_in_opts(opts, main_options, sub_options,
-          :summary_width => summary_width)
+                                   :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[:type] = 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)
+              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
+              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("--revision REVISION", "-r REVISION",
-        String,
-        *"The revision you want the
+              String,
+              *"The revision you want the
         subproject to checkout when doing 'ext install'".lines_by_width(summary_width)
       ) {|revision| sub_options[:revision] = main_options[:revision] = revision}
       opts.on("--force_removal", "-f",
-        String,
-        *"When doing an uninstall of a subproject,
+              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
+      ) { 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)".lines_by_width(summary_width)) {|dir|
         raise "No such directory: #{dir}" unless File.exist?(dir) && File.directory?(dir)
+
         main_options[:workdir] = dir
       }
       opts.on(
@@ -187,7 +154,7 @@ module Externals
 
       unless args.nil? || args.empty?
         command = args[0]
-        args = args[1..(args.size - 1)] || []
+        args = args[1..] || []
       end
 
       command &&= command.to_sym
@@ -196,20 +163,23 @@ module Externals
       command = :version if main_options[:version]
 
       if !command || command.to_s == ''
+        # :nocov:
         puts "hey... you didn't tell me what you want to do."
         puts "Try 'ext help' for a list of commands"
-        exit
+        exit 1
+        # :nocov:
       end
 
       unless COMMANDS.index command
+        # :nocov:
         puts "unknown command: #{command}"
         puts "for a list of commands try 'ext help'"
-        exit
+        exit 1
+        # :nocov:
       end
 
-
       Dir.chdir(main_options[:workdir] || ".") do
-        self.new(main_options).send(command, args, sub_options)
+        new(main_options).send(command, args, sub_options)
       end
     end
 
@@ -220,9 +190,9 @@ module Externals
       puts
     end
 
-    def help(args, options)
+    def help(_args, _options)
       puts "There's a tutorial available at http://nopugs.com/ext-tutorial\n\n"
-      puts "#{self.class.new_opts({},{}).to_s}\n\n"
+      puts "#{self.class.new_opts({}, {})}\n\n"
 
       puts "\nCommands that apply to the main project or the .externals file:"
       puts "#{MAIN_COMMANDS.join(', ')}\n\n"
@@ -240,6 +210,7 @@ module Externals
     @registered_scms = nil
     def self.registered_scms
       return @registered_scms if @registered_scms
+
       @registered_scms ||= []
 
       scmdir = File.join(File.dirname(__FILE__), 'scms')
@@ -255,9 +226,10 @@ module Externals
 
     def projects
       return @projects if @projects
+
       @projects = []
       configuration.sections.each do |section|
-        @projects << Ext.project_class(section[:scm]||infer_scm(section[:repository])).new(
+        @projects << Ext.project_class(section[:scm] || infer_scm(section[:repository])).new(
           section.attributes.merge(:path => section.title))
       end
       #let's set the parents of these projects
@@ -272,11 +244,14 @@ module Externals
       project ||= subprojects.detect do |p|
         File.split(p.path).last.strip == name
       end
-      project ||= subprojects.detect do |p|
+      project || subprojects.detect do |p|
+        # TODO: test (or delete) this code path!
+        # :nocov:
         p.name == name
+        # :nocov:
       end
     end
-    alias :subproject :subproject_by_name_or_path
+    alias subproject subproject_by_name_or_path
 
     def subprojects
       s = []
@@ -287,7 +262,7 @@ module Externals
     end
 
     def main_project
-      projects.detect {|p| p.main_project?}
+      projects.detect(&:main_project?)
     end
 
     def configuration
@@ -316,43 +291,17 @@ module Externals
 
       scm = configuration['.']
       scm = scm['scm'] if scm
-      scm ||= options[:scm]
-
-      type = configuration['.']
-      type = type['type'] if type
-
-      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."
-        else
-          possible_project_types.each do |project_type|
-            install_project_type project_type
-          end
-        end
-      end
+      scm || options[:scm]
     end
 
     def self.project_class(scm)
-      Externals.module_eval("#{scm.to_s.cap_first}Project", __FILE__, __LINE__)
+      Externals.const_get("#{scm.to_s.cap_first}Project")
     end
 
     def self.project_classes
-      retval = []
-      registered_scms.each do |scm|
-        retval << project_class(scm)
+      registered_scms.map do |scm|
+        project_class(scm)
       end
-
-      retval
     end
 
     SHORT_COMMANDS.each do |command_name|
@@ -368,16 +317,18 @@ Please use
             p.name == project_name_or_path || p.path == project_name_or_path
           end
 
+          # :nocov:
           raise "no such project" unless project
+          # :nocov:
 
           project.send command_name, args, options
         else
-          subprojects.each {|p| p.send(*([command_name, args, options].flatten))}
+          subprojects.each {|p| p.send(*[command_name, args, options].flatten)}
         end
       end
     end
 
-    def freeze args, options
+    def freeze args, _options
       project = subproject_by_name_or_path(args[0])
 
       raise "No such project named #{args[0]}" unless project
@@ -391,7 +342,10 @@ Please use
         if branch
           section[:branch] = branch
         else
+          # TODO: test (or delete) this code path!
+          # :nocov:
           section.rm_setting :branch
+          # :nocov:
         end
       end
       section[:revision] = revision
@@ -401,7 +355,7 @@ Please use
       subproject_by_name_or_path(args[0]).up
     end
 
-    def unfreeze args, options
+    def unfreeze args, _options
       project = subproject_by_name_or_path(args[0])
 
       raise "No such project named #{args[0]}" unless project
@@ -409,8 +363,10 @@ Please use
       section = configuration[project.path]
 
       unless section[:revision]
+        # :nocov:
         puts "Uhh... #{project.name} wasn't frozen, so I can't unfreeze it."
-        exit
+        exit 1
+        # :nocov:
       end
 
       section.rm_setting :revision
@@ -422,8 +378,10 @@ Please use
 
     def install args, options
       if !File.exist?('.externals')
-        STDERR.puts "This project does not appear to be managed by externals.  Try 'ext init' first"
+        # :nocov:
+        warn "This project does not appear to be managed by externals.  Try 'ext init' first"
         exit NO_EXTERNALS_FILE
+        # :nocov:
       end
       repository = args[0]
       path = args[1]
@@ -435,15 +393,17 @@ Please use
       scm ||= infer_scm(repository)
 
       unless scm
-        STDERR.puts "Unable to determine SCM from the repository name.
+        # :nocov:
+        warn "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)"
         exit COULD_NOT_DETERMINE_SCM
+        # :nocov:
       end
 
       project = self.class.project_class(scm).new(:repository => repository,
-        :path => path || path_calculator.new, :scm => scm)
+                                                  :path => path, :scm => scm)
       path = project.path
 
       raise "no path" unless path
@@ -466,7 +426,9 @@ that you are installing. Use an option to specify it
 
     def uninstall args, options
       unless File.exist?('.externals')
+        # :nocov:
         raise "Hmm... there's no .externals file in this directory."
+        # :nocov:
       end
 
       project = subproject_by_name_or_path(args[0])
@@ -475,7 +437,6 @@ that you are installing. Use an option to specify it
 
       main_project.drop_from_ignore project.path
 
-
       configuration.remove_section(project.path)
       configuration.write '.externals'
       reload_configuration
@@ -487,15 +448,18 @@ that you are installing. Use an option to specify it
       end
     end
 
-    def update_ignore args, options
+    def update_ignore _args, options
       scm = configuration['.']
       scm = scm['scm'] if scm
 
       scm ||= options[:scm]
 
       unless scm
-        raise "You need to either specify the scm as the first line in .externals (for example, scm = git), or use an option to specify it
+        # :nocov:
+        raise "You need to either specify the scm as the first line in .externals (for example, scm = git), " \
+                "or use an option to specify it
           (such as --git or --svn)"
+        # :nocov:
       end
 
       project = self.class.project_class(scm).new(:path => ".")
@@ -507,10 +471,10 @@ that you are installing. Use an option to specify it
       end
     end
 
-    def touch_emptydirs args, options
+    def touch_emptydirs _args, _options
       require 'find'
 
-      excludes = ['.','..','.svn', '.git']
+      excludes = ['.', '..', '.svn', '.git']
 
       excludes.dup.each do |exclude|
         excludes << "./#{exclude}"
@@ -522,23 +486,26 @@ that you are installing. Use an option to specify it
         if File.directory?(f)
           excluded = false
           File.split(f).each do |part|
-            exclude ||= excludes.index(part)
+            excluded ||= excludes.index(part)
           end
 
-          if !excluded && ((Dir.entries(f) - excludes).size == 0)
+          if !excluded && (Dir.entries(f) - excludes).empty?
             paths << f
           end
         end
       end
 
       paths.each do |p|
-        open(File.join(p,".emptydir"), "w").close
+        # TODO: is there not an easier way to touch a file??
+        # rubocop:disable Style/FileOpen
+        f = File.open(File.join(p, ".emptydir"), "w")
+        # rubocop:enable Style/FileOpen
+      ensure
+        f.close
       end
-
     end
 
-
-    def status args, options
+    def status _args, options
       options ||= {}
       scm = options[:scm]
 
@@ -548,24 +515,27 @@ that you are installing. Use an option to specify it
       end
 
       if !scm
-        possible_project_classes = self.class.project_classes.select do |project_class|
-          project_class.detected?
-        end
+        # TODO: test (or delete) this code path!
+        # :nocov:
+        possible_project_classes = self.class.project_classes.select(&:detected?)
 
-        raise "Could not determine this projects scm" if  possible_project_classes.empty?
+        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(',')}
+          possible_project_classes.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
+        # :nocov:
       end
 
       unless scm
+        # :nocov:
         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)"
+        # :nocov:
       end
 
       project = main_project
@@ -587,24 +557,27 @@ by creating the .externals file manually"
       end
 
       if !scm
-        possible_project_classes = self.class.project_classes.select do |project_class|
-          project_class.detected?
-        end
+        # TODO: test (or delete) this code path!
+        # :nocov:
+        possible_project_classes = self.class.project_classes.select(&:detected?)
 
-        raise "Could not determine this projects scm" if  possible_project_classes.empty?
+        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(',')}
+          possible_project_classes.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
+        # :nocov:
       end
 
       unless scm
+        # :nocov:
         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)"
+        # :nocov:
       end
 
       old_config = configuration
@@ -639,7 +612,7 @@ commands below if you actually wish to delete them."
       end
     end
 
-    def update args, options
+    def update _args, options
       options ||= {}
       scm = options[:scm]
 
@@ -649,8 +622,10 @@ commands below if you actually wish to delete them."
       end
 
       unless scm
+        # :nocov:
         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)"
+        # :nocov:
       end
 
       project = main_project
@@ -673,7 +648,7 @@ commands below if you actually wish to delete them."
       end
 
       Dir.chdir path do
-        self.class.new({}).co [], {} #args, options
+        self.class.new({}).co [], {}
       end
     end
 
@@ -686,7 +661,10 @@ commands below if you actually wish to delete them."
       main_project = do_checkout_or_export repository, path, options, :export
 
       if path == "."
+        # TODO: test (or delete) this code path!
+        # :nocov:
         path = main_project.name
+        # :nocov:
       end
 
       Dir.chdir path do
@@ -695,42 +673,27 @@ commands below if you actually wish to delete them."
     end
 
     def init args, options = {}
+      # :nocov:
       raise ".externals already exists" if File.exist?('.externals')
+      # :nocov:
 
       scm = options[:scm]
-      type = options[:type]
 
       if !scm
-        possible_project_classes = self.class.project_classes.select do |project_class|
-          project_class.detected?
-        end
+        possible_project_classes = self.class.project_classes.select(&:detected?)
 
-        raise "Could not determine this project's scm" if  possible_project_classes.empty?
+        raise "Could not determine this project's scm" if possible_project_classes.empty?
         if possible_project_classes.size > 1
+          # :nocov:
           raise "This project appears to be managed by multiple SCMs: #{
-          possible_project_classes.map(&:to_s).join(',')}
+          possible_project_classes.join(',')}
 Please explicitly declare the SCM (using --git or --svn, or, by creating .externals manually"
+          # :nocov:
         end
 
         scm = possible_project_classes.first.scm
       end
 
-      if !type
-        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.size == 0
-          puts "WARNING: We could not automatically determine the project type.
-          Be sure to specify paths when adding subprojects to your .externals file"
-        else
-          type = possible_project_types.first
-        end
-      end
-
       config = Configuration::Configuration.new_empty
       raise ".externals already exists" if File.exist?('.externals')
 
@@ -744,33 +707,30 @@ Please use the --type option to tell ext which to use."
             options[:branch]
           )
         elsif args[0]
+          # TODO: test (or delete) this code path!
+          # :nocov:
           config['.'][:repository] = args[0].strip
+          # :nocov:
         end
       end
 
       config['.'][:scm] = scm
-      config['.'][:type] = type if type
 
       config.write '.externals'
       reload_configuration
     end
 
-    def version(args, options)
+    def version(_args, _options)
       puts Externals::VERSION
     end
 
-    def self.project_type_detector name
-      Externals.module_eval("#{name.classify}Detector", __FILE__, __LINE__)
-    end
-
-    def install_project_type name
-      self.path_calculator = Externals.module_eval("#{name.classify}ProjectType::DefaultPathCalculator", __FILE__, __LINE__)
-    end
-
     protected
+
     def do_checkout_or_export repository, path, options, sym
       if File.exist?('.externals')
+        # :nocov:
         raise "seems main project is already checked out here?"
+        # :nocov:
       else
         #We appear to be attempting to checkout/export a main project
         scm = options[:scm]
@@ -778,13 +738,18 @@ Please use the --type option to tell ext which to use."
         scm ||= infer_scm(repository)
 
         if !scm
+          # TODO: test (or delete) this code path!
+          # :nocov:
           scm ||= configuration['main']
           scm &&= scm['scm']
+          # :nocov:
         end
 
         unless scm
+          # :nocov:
           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)"
+          # :nocov:
         end
 
         main_project = self.class.project_class(scm).new(
@@ -799,12 +764,19 @@ Please use the --type option to tell ext which to use."
     end
 
     def infer_scm(path)
-      self.class.registered_scms.each do |scm|
-        return scm if self.class.project_class(scm).scm_path?(path)
+      registered_scms.find do |scm|
+        project_class(scm).scm_path?(path)
       end
-      nil
     end
-  end
-end
 
+    private
+
+    def registered_scms
+      self.class.registered_scms
+    end
 
+    def project_class(scm)
+      self.class.project_class(scm)
+    end
+  end
+end