git-multirepo 1.0.0.beta17 → 1.0.0.beta18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d6d791443ed5a120b81f84637cc1122c9f8611e
-  data.tar.gz: d10a799594143bb6fc24681be6fafb07570b9c11
+  metadata.gz: d88cc72e2ecea7331cc379e0d48f771302960e0c
+  data.tar.gz: 3778236c3c5e1cfe17ba4c16b5e26d3fd54186ab
 SHA512:
-  metadata.gz: c5bd81592ddb05d57730b49835106d917e07da5eec4465e5b8a8f58b1213a6f4cf6e613f8b0f2110dc879a19bb4bf81203ba5e4955f65b56924214fab106cee1
-  data.tar.gz: 5d9feaa0464c5dbdb462a100e2bc8e5f89bc2288df2e7e11f81e422c0eb52f152c1174a04394ee6dd4c45793f77fe0a2dce0d4bcbb3cedc97915c92387f91d16
+  metadata.gz: 7bdbdeff71220ce72b005dc66ac91cd45e0afddf227c0732b84e102d587192a29db3522b97eff8a988b53761b7b301664aeacfd3a5e0af9ec217fb183b4dde2f
+  data.tar.gz: e9f0f748cbd0d2385fee936886eb759f09f5e17898af4510920e51930b7dac92fdb1975dbc148207a73eadd4c401634cd7870f036cf695b7a98131323a99ca40

data/README.md

@@ -48,7 +48,7 @@ In essence:
 1. You tell git-multirepo what your dependencies are.
 2. Each time you commit the main repo, git-multirepo tracks what revision of each dependency is required by the project (don't worry, it ensures that you don't forget to commit changes to dependencies beforehand; more on that later).
 3. If you ever want to go back to a previous version of your project, git-multirepo handles checking out the main repo and appropriate revisions of all of its dependencies in a single, seamless operation.
-4. Setting up the project on a new machine is only a single `git clone` and `multi install` away.
+4. Setting up the project on a new machine is only a single `multi clone` away.
 
 ## Example
 
@@ -74,9 +74,9 @@ If you want to add another dependency later on, you can run `multi add ../NewDep
 
 If you want to checkout a previous revision (say `e690d`), you use the checkout command: `multi checkout e690d`. This will checkout the main repo's `e690d` revision and all of its dependencies with the proper revisions in detached HEAD state.
 
-If you want to setup your project on another machine, simply clone the main repo in a container directory (see above) and run `multi install`. This will clone each dependency and checkout the appropriate branches.
+If you want to setup your project on another machine, simply run `multi clone` with the appropriate parameters. This will clone the project and each of its dependencies, then checkout the appropriate work branches.
 
-If you want to stop using git-multirepo, run `multi uninit`. This will remove all traces of git-multirepo from your repository and working copy.
+If you want to stop using git-multirepo, run `multi uninit`. This will remove all traces of git-multirepo from your repository and working copy, including local git hooks.
 
 ## Advantages
 
@@ -96,15 +96,15 @@ If you want to stop using git-multirepo, run `multi uninit`. This will remove al
 | Merging Changes to Dependencies | easy | hard | passable |
 | Contributing Upstream | easy | easy | passable |
 | Continuous Integration | medium | medium | easy |
-| Complex Branch-Based Workflows | hard* | hard | easy |
+| Complex Branch-Based Workflows | medium* | hard | easy |
 
-(*) This should get better in future versions of git-multirepo.
+(*) Ongoing work should make this easier in future versions of git-multirepo.
 
 ## Limitations
 
 - git-multirepo should be considered beta at the moment. All of the core features work as described, though. Suggestions and contributions are welcome.
 - The project and its dependencies must live beside each other on disk (for now).
-- There are currently no features to facilitate branch-heavy workflows.
+- Some more commands need to be implemented to facilitate branch-heavy workflows.
 - You must (ideally) install the tool on your CI server: `gem install git-multirepo`
 
 ## Summary of Commands
@@ -120,7 +120,7 @@ Here is a quick rundown of commands available to you in git-multirepo:
 | clone | Clones the specified repository in a subfolder, then installs it. |
 | edit | Opens the .multirepo file in the default text editor. |
 | fetch | Performs a git fetch on all dependencies. |
-| install | Clones and checks out dependencies as defined in the .multirepo file, and installs git-multirepo's local pre-commit hook. |
+| install | Clones and checks out dependencies as defined in the version-controlled multirepo metadata files and installs git-multirepo's local git hooks. |
 | open | Opens all dependencies in the current OS's file explorer. |
 | remove | Removes the specified dependency from multirepo. |
 | update | Force-updates the multirepo lock file. |
@@ -134,7 +134,7 @@ git-multirepo stores all of its metadata in two files:
 
 | File | Format | Contents |
 |------|--------|----------|
-| .multirepo | YAML | A collection of your project's dependencies. For each dependency, stores its **local path** relative to the main repo, the **remote URL** and the **work branch** your project depends upon.
+| .multirepo | YAML | A collection of your project's dependencies. For each dependency, stores its **local path** relative to the main repo and the **remote URL** your project depends upon.
 | .multirepo.lock | YAML | For each dependency, stores the **commit hash** and **branch** on which the dependency was when the main repo was committed. The dependency's **name** is also included but only serves as a reference to make inspecting the lock file easier. |
 
 The information contained in .multirepo and .multirepo.lock allow one-step cloning of a project and all its dependencies, and checking out any prior revision of the main project with appropriate revisions of all of its dependencies, respectively.

data/lib/info.rb

@@ -1,5 +1,5 @@
 module MultiRepo
   NAME = "git-multirepo"
-  VERSION = "1.0.0.beta17"
+  VERSION = "1.0.0.beta18"
   DESCRIPTION = "Track multiple Git repositories side-by-side."
 end

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

@@ -5,9 +5,15 @@ module MultiRepo
     self.command = "checkout"
     self.summary = "Checks out the specified commit or branch of the main repo and checks out matching versions of all dependencies."
     
+    class CheckoutMode
+      AS_LOCK = 0
+      LATEST = 1
+      EXACT = 2
+    end
+    
     def self.options
       [
-        ['[ref]', 'The main repo tag, branch or commit hash to checkout.'],
+        ['[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)
@@ -30,20 +36,37 @@ module MultiRepo
       validate_in_work_tree
       ensure_multirepo_initialized
       
+      Console.log_step("Checking out #{@ref} and its dependencies...")
+      
+      # Find out the checkout mode based on command-line options
+      mode = if @checkout_latest then
+        CheckoutMode::LATEST
+      elsif @checkout_exact then
+        CheckoutMode::EXACT
+      else
+        CheckoutMode::AS_LOCK
+      end
+      
+      checkout_core(@ref, mode)
+      
+      Console.log_step("Done!")
+    rescue MultiRepoException => e
+      Console.log_error(e.message)
+    end
+    
+    def checkout_core(ref, mode)
       main_repo = Repo.new(".")
       initial_revision = main_repo.current_branch || main_repo.head_hash
-                  
-      Console.log_step("Checking out #{@ref} and its dependencies...")
       
       unless main_repo.is_clean?
-        raise MultiRepoException, "Can't checkout #{@ref} because the main repo contains uncommitted changes"
+        raise MultiRepoException, "Can't checkout #{ref} because the main repo contains uncommitted changes"
       end
       
-      unless main_repo.checkout(@ref)
-        raise MultiRepoException, "Couldn't perform checkout of main repo #{@ref}!"
+      unless main_repo.checkout(ref)
+        raise MultiRepoException, "Couldn't perform checkout of main repo #{ref}!"
       end
       
-      Console.log_substep("Checked out main repo #{@ref}")
+      Console.log_substep("Checked out main repo #{ref}")
       
       unless LockFile.exists?
         main_repo.checkout(initial_revision)
@@ -59,15 +82,19 @@ module MultiRepo
       LockFile.load.each do |lock_entry|
         config_entry = config_entries.select{ |config_entry| config_entry.id == lock_entry.id }.first
         
-        # First, make sure the repo exists on disk (in case the checked-out revision had an additional dependency)
+        # First, 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
         
-        # Find out the actual revision to checkout based on command flags
-        revision = @checkout_latest ? lock_entry.branch : lock_entry.head
-        revision = @checkout_exact ? @ref : revision
+        # Find out the proper revision to checkout based on the checkout mode
+        revision = case mode
+        when CheckoutMode::AS_LOCK; lock_entry.head
+        when CheckoutMode::LATEST; lock_entry.branch
+        when CheckoutMode::EXACT; ref
+        end
         
         # Checkout!
         if config_entry.repo.checkout(revision)
@@ -76,10 +103,6 @@ module MultiRepo
           raise MultiRepoException, "Couldn't check out the appropriate version of dependency #{lock_entry.name}"
         end
       end
-      
-      Console.log_step("Done!")
-    rescue MultiRepoException => e
-      Console.log_error(e.message)
     end
   end
 end

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

@@ -11,13 +11,15 @@ module MultiRepo
     def self.options
       [
         ['[url]', 'The repository to clone.'],
-        ['[name]', 'The name of the containing folder that will be created.']
+        ['[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
       super
     end
 
@@ -42,7 +44,8 @@ module MultiRepo
       original_path = Dir.pwd
       Dir.chdir(main_repo_path)
       
-      InstallCommand.new(CLAide::ARGV.new([])).install_internal
+      install_command = InstallCommand.new(CLAide::ARGV.new([]))
+      install_command.install_core(@ref)
       
       Dir.chdir(original_path)
             

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

@@ -1,43 +1,57 @@
 require "multirepo/utility/console"
 require "multirepo/utility/utils"
 require "multirepo/git/repo"
+require "multirepo/commands/checkout-command"
 
 module MultiRepo
   class InstallCommand < Command
     self.command = "install"
-    self.summary = "Clones and checks out dependencies as defined in the .multirepo file, and installs git-multirepo's local hooks."
+    self.summary = "Clones and checks out dependencies as defined in the version-controlled multirepo metadata files and installs git-multirepo's local git hooks."
     
+    def self.options
+      [['[ref]', 'The branch, tag or commit id to checkout. Checkout will use "master" if unspecified.']].concat(super)
+    end
+    
+    def initialize(argv)
+      @ref = argv.shift_argument
+      super
+    end
+        
     def run
       validate_in_work_tree
       ensure_multirepo_initialized
       
       Console.log_step("Cloning dependencies and installing hook...")
       
-      install_internal
+      install_core(@ref)
       
       Console.log_step("Done!")
     rescue MultiRepoException => e
       Console.log_error(e.message)
     end
     
-    def install_internal
+    def install_core(ref)
       config_entries = ConfigFile.load
 
       Console.log_substep("Installing #{config_entries.count} dependencies...");
       
-      config_entries.each { |e| install(e) }
+      # Clone or fetch configured repos
+      config_entries.each { |e| clone_or_fetch(e) }
+      
+      # Checkout the repos as specified in the lock file
+      checkout_command = CheckoutCommand.new(CLAide::ARGV.new([]))
+      checkout_command.checkout_core(ref || "master", CheckoutCommand::CheckoutMode::LATEST)
       
       install_hooks
     end
     
-    def install(entry)
+    def clone_or_fetch(entry)
       if entry.repo.exists?
         check_repo_validity(entry)
         fetch_repo(entry)
       else
         clone_repo(entry)
       end
-      checkout_branch(entry)
     end
     
     # Repo operations

data/lib/multirepo/files/config-entry.rb

@@ -8,14 +8,12 @@ module MultiRepo
     attr_accessor :id
     attr_accessor :path
     attr_accessor :url
-    attr_accessor :branch
     attr_accessor :repo
     
     def encode_with(coder)
       coder["id"] = @id
       coder["path"] = @path
       coder["url"] = @url
-      coder["branch"] = @branch
     end
     
     def ==(entry)
@@ -28,7 +26,6 @@ module MultiRepo
       @id = SecureRandom.uuid
       @path = repo.path
       @url = repo.exists? ? repo.remote('origin').url : nil
-      @branch = repo.exists? ? repo.current_branch : nil
     end
     
     def repo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-multirepo
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta17
+  version: 1.0.0.beta18
 platform: ruby
 authors:
 - Michaël Fortin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler