git-multirepo 1.0.0.beta40 → 1.0.0.beta42

data/lib/multirepo/commands/checkout-command.rb

@@ -1,123 +1,120 @@
-require "multirepo/utility/console"
-require "multirepo/logic/revision-selector"
-require "multirepo/logic/performer"
-
-module MultiRepo
-  class CheckoutCommand < Command
-    self.command = "checkout"
-    self.summary = "Checks out the specified commit or branch of the main repo and checks out matching versions of all dependencies."
-    
-    def self.options
-      [
-        ['<ref>', 'The main repo tag, branch or commit id to checkout.'],
-        ['[--latest]', 'Checkout the HEAD of each dependency branch (as recorded in the lock file) instead of the exact required commits.'],
-        ['[--exact]', 'Checkout the exact specified ref for each repo, regardless of what\'s stored in the lock file.']
-      ].concat(super)
-    end
-    
-    def initialize(argv)
-      @ref = argv.shift_argument
-      @checkout_latest = argv.flag?("latest")
-      @checkout_exact = argv.flag?("exact")
-      super
-    end
-    
-    def validate!
-      super
-      help! "You must specify a branch or commit id to checkout" unless @ref
-      unless validate_only_one_flag(@checkout_latest, @checkout_exact)
-        help! "You can't provide more than one operation modifier (--latest, --exact, etc.)"
-      end
-    end
-    
-    def run
-      super
-      ensure_in_work_tree
-      
-      # Find out the checkout mode based on command-line options
-      mode = RevisionSelector.mode_for_args(@checkout_latest, @checkout_exact)
-      
-      strategy_name = RevisionSelectionMode.name_for_mode(mode)
-      Console.log_step("Checking out #{@ref} and its dependencies using the '#{strategy_name}' strategy...")
-      
-      main_repo = Repo.new(".")
-      
-      unless proceed_if_merge_commit?(main_repo, @ref, mode)
-        raise MultiRepoException, "Aborting checkout"
-      end
-      
-      checkout_core(main_repo, mode)
-            
-      Console.log_step("Done!")
-    rescue MultiRepoException => e
-      Console.log_error(e.message)
-    end
-    
-    def checkout_core(main_repo, mode)
-      initial_revision = main_repo.current_branch || main_repo.head_hash
-      begin
-        # Checkout first because the current ref might not be multirepo-enabled
-        checkout_main_repo_step(main_repo)
-        # Only then can we check for dependencies and make sure they are clean
-        ensure_dependencies_clean_step(main_repo)
-      rescue MultiRepoException => e
-        Console.log_error("Reverting main repo checkout")
-        main_repo.checkout(initial_revision)
-        raise e
-      end
-      dependencies_checkout_step(mode, @ref)
-    end
-    
-    def checkout_main_repo_step(main_repo)
-      Performer.perform_main_repo_checkout(main_repo, @ref)
-    end
-    
-    def ensure_dependencies_clean_step(main_repo)
-      unless Utils.ensure_dependencies_clean(ConfigFile.new(".").load_entries)
-        raise MultiRepoException, "Dependencies are not clean!"
-      end
-    end
-    
-    def dependencies_checkout_step(mode, ref = nil)
-      Performer.perform_on_dependencies do |config_entry, lock_entry|
-        # Find out the required dependency revision based on the checkout mode
-        revision = RevisionSelector.revision_for_mode(mode, ref, lock_entry)
-        perform_dependency_checkout(config_entry, revision)
-      end
-    end
-    
-    def proceed_if_merge_commit?(main_repo, ref, mode)
-      return true unless main_repo.commit(ref).is_merge?
-      
-      case mode
-      when RevisionSelectionMode::AS_LOCK
-        Console.log_error("The specified ref is a merge commit and an \"as-lock\" checkout was requested.")
-        Console.log_error("The resulting checkout would most probably not result in a valid project state.")
-        return false
-      when RevisionSelectionMode::LATEST
-        Console.log_warning("The specified ref is a merge commit and a \"latest\" checkout was requested.")
-        Console.log_warning("The work branches recorded in the branch from which the merge was performed will be checked out.")
-      end
-      
-      return true
-    end
-    
-    def perform_dependency_checkout(config_entry, revision)
-      dependency_name = config_entry.repo.basename
-      
-      # Make sure the repo exists on disk, and clone it if it doesn't
-      # (in case the checked-out revision had an additional dependency)
-      unless config_entry.repo.exists?
-        Console.log_substep("Cloning missing dependency '#{config_entry.path}' from #{config_entry.url}")
-        config_entry.repo.clone(config_entry.url)
-      end
-      
-      # Checkout!
-      if config_entry.repo.checkout(revision)
-        Console.log_substep("Checked out #{dependency_name} #{revision}")
-      else
-        raise MultiRepoException, "Couldn't check out the appropriate version of dependency #{dependency_name}"
-      end
-    end
-  end
+require "multirepo/utility/console"
+require "multirepo/logic/revision-selector"
+require "multirepo/logic/performer"
+
+module MultiRepo
+  class CheckoutCommand < Command
+    self.command = "checkout"
+    self.summary = "Checks out the specified commit or branch of the main repo and checks out matching versions of all dependencies."
+    
+    def self.options
+      [
+        ['<refname>', 'The main repo tag, branch or commit id to checkout.'],
+        ['[--latest]', 'Checkout the HEAD of each dependency branch (as recorded in the lock file) instead of the exact required commits.'],
+        ['[--exact]', 'Checkout the exact specified ref for each repo, regardless of what\'s stored in the lock file.']
+      ].concat(super)
+    end
+    
+    def initialize(argv)
+      @ref_name = argv.shift_argument
+      @checkout_latest = argv.flag?("latest")
+      @checkout_exact = argv.flag?("exact")
+      super
+    end
+    
+    def validate!
+      super
+      help! "You must specify a branch or commit id to checkout" unless @ref_name
+      unless validate_only_one_flag(@checkout_latest, @checkout_exact)
+        help! "You can't provide more than one operation modifier (--latest, --exact, etc.)"
+      end
+    end
+    
+    def run
+      ensure_in_work_tree
+      
+      # Find out the checkout mode based on command-line options
+      mode = RevisionSelector.mode_for_args(@checkout_latest, @checkout_exact)
+      
+      strategy_name = RevisionSelectionMode.name_for_mode(mode)
+      Console.log_step("Checking out #{@ref_name} and its dependencies using the '#{strategy_name}' strategy...")
+      
+      main_repo = Repo.new(".")
+      
+      unless proceed_if_merge_commit?(main_repo, @ref_name, mode)
+        raise MultiRepoException, "Aborting checkout"
+      end
+      
+      checkout_core(main_repo, mode)
+            
+      Console.log_step("Done!")
+    end
+    
+    def checkout_core(main_repo, mode)
+      initial_revision = main_repo.current_revision
+      begin
+        # Checkout first because the current ref might not be multirepo-enabled
+        checkout_main_repo_step(main_repo)
+        # Only then can we check for dependencies and make sure they are clean
+        ensure_dependencies_clean_step(main_repo)
+      rescue MultiRepoException => e
+        Console.log_warning("Restoring working copy to #{initial_revision}")
+        main_repo.checkout(initial_revision)
+        raise e
+      end
+      dependencies_checkout_step(mode, @ref_name)
+    end
+    
+    def checkout_main_repo_step(main_repo)
+      Performer.perform_main_repo_checkout(main_repo, @ref_name)
+    end
+    
+    def ensure_dependencies_clean_step(main_repo)
+      unless Utils.dependencies_clean?(ConfigFile.new(".").load_entries)
+        raise MultiRepoException, "Dependencies are not clean!"
+      end
+    end
+    
+    def dependencies_checkout_step(mode, ref_name = nil)
+      Performer.dependencies.each do |dependency|
+        # Find out the required dependency revision based on the checkout mode
+        revision = RevisionSelector.revision_for_mode(mode, ref_name, dependency.lock_entry)
+        perform_dependency_checkout(dependency.config_entry, revision)
+      end
+    end
+    
+    def proceed_if_merge_commit?(main_repo, ref_name, mode)
+      return true unless main_repo.ref(ref_name).is_merge?
+      
+      case mode
+      when RevisionSelectionMode::AS_LOCK
+        Console.log_error("The specified ref is a merge commit and an \"as-lock\" checkout was requested.")
+        Console.log_error("The resulting checkout would most probably not result in a valid project state.")
+        return false
+      when RevisionSelectionMode::LATEST
+        Console.log_warning("The specified ref is a merge commit and a \"latest\" checkout was requested.")
+        Console.log_warning("The work branches recorded in the branch from which the merge was performed will be checked out.")
+      end
+      
+      return true
+    end
+    
+    def perform_dependency_checkout(config_entry, revision)
+      dependency_name = config_entry.repo.basename
+      
+      # Make sure the repo exists on disk, and clone it if it doesn't
+      # (in case the checked-out revision had an additional dependency)
+      unless config_entry.repo.exists?
+        Console.log_substep("Cloning missing dependency '#{config_entry.path}' from #{config_entry.url}")
+        config_entry.repo.clone(config_entry.url)
+      end
+      
+      # Checkout!
+      if config_entry.repo.checkout(revision)
+        Console.log_substep("Checked out #{dependency_name} #{revision}")
+      else
+        raise MultiRepoException, "Couldn't check out the appropriate version of dependency #{dependency_name}"
+      end
+    end
+  end
 end

data/lib/multirepo/commands/clone-command.rb

@@ -1,71 +1,68 @@
-require "multirepo/utility/console"
-require "multirepo/utility/utils"
-require "multirepo/git/repo"
-require_relative "install-command"
-
-module MultiRepo
-  class CloneCommand < Command
-    self.command = "clone"
-    self.summary = "Clones the specified repository in a subfolder, then installs it."
-    
-    def self.options
-      [
-        ['<url>', 'The repository to clone.'],
-        ['<name>', 'The name of the containing folder that will be created.'],
-        ['[<ref>]', 'The branch, tag or commit id to checkout. Checkout will use "master" if unspecified.']
-      ].concat(super)
-    end
-    
-    def initialize(argv)
-      @url = argv.shift_argument
-      @name = argv.shift_argument
-      @ref = argv.shift_argument || "master"
-      super
-    end
-
-    def validate!
-      super
-      help! "You must specify a repository to clone" unless @url
-      help! "You must specify a containing folder name" unless @name
-    end
-
-    def run
-      super
-      Console.log_step("Cloning #{@url} ...")
-
-      raise MultiRepoException, "A directory named #{@name} already exists" if Dir.exists?(@name)
-
-      main_repo_path = "#{@name}/#{@name}"
-      main_repo = Repo.new(main_repo_path)
-      
-      # Recursively create the directory where we'll clone the main repo
-      FileUtils.mkpath(main_repo_path)
-      
-      # Clone the specified remote in the just-created directory
-      raise MultiRepoException, "Could not clone repo from #{@url}" unless main_repo.clone(@url)
-      
-      # Checkout the specified main repo ref so that install reads the proper config file
-      unless main_repo.checkout(@ref)
-        raise MultiRepoException, "Couldn't perform checkout of main repo #{@ref}!"
-      end
-      
-      Console.log_substep("Checked out main repo #{@ref}")
-      
-      # Make sure the ref we just checked out is tracked by multirepo
-      unless Utils.is_multirepo_tracked(main_repo_path)
-        raise MultiRepoException, "Ref #{@ref} is not tracked by multirepo"
-      end
-      
-      # Install
-      original_path = Dir.pwd
-      Dir.chdir(main_repo_path)
-      install_command = InstallCommand.new(CLAide::ARGV.new([]))
-      install_command.full_install
-      Dir.chdir(original_path)
-      
-      Console.log_step("Done!")
-    rescue MultiRepoException => e
-      Console.log_error(e.message)
-    end
-  end
+require "multirepo/utility/console"
+require "multirepo/utility/utils"
+require "multirepo/git/repo"
+require_relative "install-command"
+
+module MultiRepo
+  class CloneCommand < Command
+    self.command = "clone"
+    self.summary = "Clones the specified repository in a subfolder, then installs it."
+    
+    def self.options
+      [
+        ['<url>', 'The repository to clone.'],
+        ['<name>', 'The name of the containing folder that will be created.'],
+        ['[<refname>]', 'The branch, tag or commit id to checkout. Checkout will use "master" if unspecified.']
+      ].concat(super)
+    end
+    
+    def initialize(argv)
+      @url = argv.shift_argument
+      @name = argv.shift_argument
+      @ref_name = argv.shift_argument || "master"
+      super
+    end
+
+    def validate!
+      super
+      help! "You must specify a repository to clone" unless @url
+      help! "You must specify a containing folder name" unless @name
+    end
+
+    def run
+      Console.log_step("Cloning #{@url} ...")
+
+      raise MultiRepoException, "A directory named #{@name} already exists" if Dir.exists?(@name)
+
+      main_repo_path = "#{@name}/#{@name}"
+      main_repo = Repo.new(main_repo_path)
+      
+      # Recursively create the directory where we'll clone the main repo
+      FileUtils.mkpath(main_repo_path)
+      
+      # Clone the specified remote in the just-created directory
+      raise MultiRepoException, "Could not clone repo from #{@url}" unless main_repo.clone(@url)
+      
+      # Checkout the specified main repo ref so that install reads the proper config file
+      unless main_repo.checkout(@ref_name)
+        raise MultiRepoException, "Couldn't perform checkout of main repo #{@ref_name}!"
+      end
+      
+      Console.log_substep("Checked out main repo #{@ref_name}")
+      
+      # Make sure the ref we just checked out is tracked by multirepo
+      unless Utils.is_multirepo_tracked(main_repo_path)
+        raise MultiRepoException, "Ref #{@ref_name} is not tracked by multirepo"
+      end
+      
+      # Install
+      original_path = Dir.pwd
+      Dir.chdir(main_repo_path)
+      install_command = InstallCommand.new(CLAide::ARGV.new([]))
+      install_command.full_install
+      Dir.chdir(original_path)
+      
+      Console.log_step("Done!")
+    end
+  end
 end

data/lib/multirepo/commands/command.rb

@@ -1,76 +1,90 @@
-require "claide"
-
-require "info"
-require "multirepo/multirepo-exception"
-require "multirepo/config"
-
-module MultiRepo
-  class Command < CLAide::Command
-    self.abstract_command = true
-    self.command = "multi"
-    self.version = VERSION
-    self.description = DESCRIPTION
-    
-    def initialize(argv)
-      @argv = argv
-      Config.instance.verbose = argv.flag?("verbose") ? true : false
-      Config.instance.git_executable = argv.option("git-exe", "git")
-      super
-    end
-    
-    def run
-      help! "Unknown argument(s): #{@argv.remainder.join(', ')}" unless @argv.empty?
-    end
-
-    def validate!
-      path = Config.instance.git_executable
-      is_git_exe = path =~ /.*(git)|(git.exe)$/
-      file_exists = path == "git" || File.exists?(path)
-      help! "Invalid git executable '#{path}'" unless is_git_exe && file_exists
-    end
-    
-    def install_hooks(path)
-      actual_path = path || "."
-      Utils.install_hook("pre-commit", actual_path)
-      Utils.install_hook("post-commit", actual_path)
-    end
-    
-    def uninstall_hooks
-      FileUtils.rm_f(".git/hooks/pre-commit")
-      FileUtils.rm_f(".git/hooks/post-commit")
-    end
-    
-    def update_gitconfig(path)
-      actual_path = path || "."
-      resource_file = Utils.path_for_resource(".gitconfig")
-      target_file = File.join(actual_path, '.git/config')
-      
-      template = File.read(resource_file)
-      first_template_line = template.lines.first
-      
-      Utils.append_if_missing(target_file, Regexp.new(Regexp.quote(first_template_line)), template)
-    end
-    
-    def multirepo_enabled_dependencies
-      ConfigFile.new(".").load_entries.select { |e| Utils.is_multirepo_enabled(e.repo.path) }
-    end
-
-    def validate_only_one_flag(*flags)
-      flags.reduce(0) { |count, flag| count += 1 if flag; count } <= 1
-    end
-    
-    def ensure_in_work_tree
-      repo = Repo.new(".")
-      raise MultiRepoException, "Not a git repository" unless repo.exists?
-      raise MultiRepoException, "HEAD is unborn (you must perform at least one commit)" unless repo.head_born?
-    end
-    
-    def ensure_multirepo_enabled
-      raise MultiRepoException, "multirepo is not initialized in this repository." unless Utils.is_multirepo_enabled(".")
-    end
-
-    def ensure_multirepo_tracked
-      raise MultiRepoException, "This revision is not tracked by multirepo." unless Utils.is_multirepo_tracked(".")
-    end
-  end
+require "claide"
+
+require "info"
+require "multirepo/multirepo-exception"
+require "multirepo/config"
+require "multirepo/files/config-file"
+require "multirepo/files/lock-file"
+
+module MultiRepo
+  class Command < CLAide::Command
+    self.abstract_command = true
+    self.command = "multi"
+    self.version = VERSION
+    self.description = DESCRIPTION
+    
+    def self.report_error(exception)
+      if exception.instance_of?(MultiRepoException)
+        Console.log_error(exception.message)
+        return
+      end
+      raise exception
+    end
+    
+    def initialize(argv)
+      @argv = argv
+      Config.instance.verbose = argv.flag?("verbose") ? true : false
+      Config.instance.git_executable = argv.option("git-exe", "git")
+      super
+    end
+    
+    def run
+      help!
+    end
+
+    def validate!
+      super
+      path = Config.instance.git_executable
+      is_git_exe = path =~ /.*(git)|(git.exe)$/
+      file_exists = path == "git" || File.exists?(path)
+      help! "Invalid git executable '#{path}'" unless is_git_exe && file_exists
+    end
+    
+    def install_hooks(path)
+      actual_path = path || "."
+      Utils.install_hook("pre-commit", actual_path)
+      Utils.install_hook("post-commit", actual_path)
+    end
+    
+    def uninstall_hooks
+      FileUtils.rm_f(".git/hooks/pre-commit")
+      FileUtils.rm_f(".git/hooks/post-commit")
+    end
+    
+    def update_gitconfig(path)
+      actual_path = path || "."
+      resource_file = Utils.path_for_resource(".gitconfig")
+      target_file = File.join(actual_path, '.git/config')
+      
+      template = File.read(resource_file)
+      first_template_line = template.lines.first
+      
+      Utils.append_if_missing(target_file, Regexp.new(Regexp.quote(first_template_line)), template)
+    end
+    
+    def multirepo_enabled_dependencies
+      ConfigFile.new(".").load_entries.select { |e| Utils.is_multirepo_enabled(e.repo.path) }
+    end
+
+    def validate_only_one_flag(*flags)
+      flags.reduce(0) { |count, flag| count += 1 if flag; count } <= 1
+    end
+    
+    def ensure_in_work_tree
+      repo = Repo.new(".")
+      raise MultiRepoException, "Not a git repository" unless repo.exists?
+      raise MultiRepoException, "HEAD is unborn (you must perform at least one commit)" unless repo.head_born?
+    end
+    
+    def ensure_multirepo_enabled
+      raise MultiRepoException, "multirepo is not initialized in this repository." unless Utils.is_multirepo_enabled(".")
+    end
+
+    def ensure_multirepo_tracked
+      raise MultiRepoException, "Revision is not tracked by multirepo." unless Utils.is_multirepo_tracked(".")
+      
+      lock_file_valid = LockFile.new(".").validate!
+      raise MultiRepoException, "Revision is multirepo-enabled but contains a corrupted lock file!" unless lock_file_valid
+    end
+  end
 end