braid 1.0.16 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78d66492c589068152aee142e694bf02ee1201bd
-  data.tar.gz: 54d080bf631011a6c09e8882337539eaed2b510f
+  metadata.gz: 6b8ca4b2ca46100c1204aa7e8303d29f0ca2f827
+  data.tar.gz: 2762804b4104a9102b215ae04c697607d279667a
 SHA512:
-  metadata.gz: dbde11ac65aae3c78581e0d99e90def3b997d72929723abcb9fb097d7743cd8ebb8697a8ae161a5af1795fdc632745f86928bddae45b08cc847d6ded37dbdebb
-  data.tar.gz: 1e52e6ad9304532cf6c8e340b9b57643e5550e9f4858ac1d798abcc116d1cc1e45355ada3b92cd76ac3d60ffcb9b4ad0c03650ea3b3550032b26fb1d24c83a6d
+  metadata.gz: d482a938bccaec81fdaf42c058a6d90fc88915335cf46b6a6896e00542850040a3de103026013cb974010389667397393efe1371108afc386f90ed02500b796a
+  data.tar.gz: 7a8eae42c2d2f5d41b6c1f8f18c34d3ee670c5acef87e79c24965a61b71808a16a81d676f00de2dc84ad5725292b046b4b9fe9a0d778d0372e1fa8e3fc52150a

data/.travis.yml

@@ -14,6 +14,4 @@ git:
   depth: 10
 before_install:
   - git --version
-  - git config --global user.name "Somebody"
-  - git config --global user.email "you@example.com"
   - gem update bundler

data/README.md

@@ -1,7 +1,7 @@
 # Braid
 
 [![Build Status](https://secure.travis-ci.org/cristibalan/braid.png?branch=master)](http://travis-ci.org/cristibalan/braid)
-[![Gem](https://img.shields.io/gem/v/braid.svg?maxAge=2592000)]()
+[![Gem](https://img.shields.io/gem/v/braid.svg?maxAge=2592000)](https://rubygems.org/gems/braid)
 
 Braid is a simple tool to help track vendor branches in a
 [Git](http://git-scm.com/) repository.
@@ -35,17 +35,11 @@ repositories and use an automated mechanism for updating the external library
 and generating patches to upgrade the external library.
 
 Braid creates a file `.braids.json` in the root of your repository that contains
-references to external libraries or mirrors. There are two types of mirrors in
-Braid: squashed and full. Mirrors are squashed by default, which is what you'll
-generally want because they're faster and don't pollute your history with
-commits from the mirrors.
+references to external libraries or mirrors. The configuration allows you to control
+aspects of the mirroring process such as;
 
-Full mirrors are useful when you want to view imported history in your own
-project. You usually want this if the mirror is also a repository you have
-access to, for example, when using shared code across projects.
-
-Please note that you cannot change between mirror types after the initial add.
-You'll have to remove the mirror and add it again.
+* whether the mirror is locked to a particular version of the external library.
+* whether the mirror includes the entire external library or just a subdirectory.
 
 ## Installation
 
@@ -99,13 +93,15 @@ Use the built in help system to find out about all commands and options:
 
     braid add git://github.com/rails/rails.git vendor/rails
 
-#### Adding mirrors with revisions
+#### Adding a subdirectory from a mirror
 
-    braid add --revision bf1b1e0 git://github.com/rails/rails.git vendor/rails
+This is useful if you want to add a subdirectory from a mirror into your own project.
 
-#### Adding mirrors with full history
+    braid add --path dist https://github.com/twbs/bootstrap.git vendor/assets/bootstrap
 
-    braid add --full git://github.com/mislav/will_paginate.git vendor/plugins/will_paginate
+#### Adding mirrors with revisions
+
+    braid add --revision bf1b1e0 git://github.com/rails/rails.git vendor/rails
 
 #### Updating mirrors
 

data/bin/braid

@@ -40,11 +40,11 @@ Main {
       . braid add http://remote/path local/dir
     TXT
 
-    mixin :argument_url, :optional_path, :option_branch, :option_revision, :option_full, :option_verbose, :option_remote_path
+    mixin :argument_url, :optional_local_path, :option_branch, :option_revision, :option_verbose, :option_path
 
     run {
       Braid.verbose = verbose
-      Braid::Command.run(:add, url, {'path' => path, 'branch' => branch, 'revision' => revision, 'full' => full, 'remote_path' => remote_path})
+      Braid::Command.run(:add, url, {'path' => local_path, 'branch' => branch, 'revision' => revision, 'remote_path' => path})
     }
   }
 
@@ -65,7 +65,7 @@ Main {
       . braid update local/dir
     TXT
 
-    mixin :optional_path, :option_revision, :option_head, :option_verbose, :option_keep_remote
+    mixin :optional_local_path, :option_revision, :option_head, :option_verbose, :option_keep_remote
 
     run {
       options = {
@@ -74,7 +74,7 @@ Main {
         'keep' => keep
       }
       Braid.verbose = verbose
-      Braid::Command.run(:update, path, options)
+      Braid::Command.run(:update, local_path, options)
     }
   }
 
@@ -91,14 +91,14 @@ Main {
       . braid remove local/dir
     TXT
 
-    mixin :argument_path, :option_verbose, :option_keep_remote
+    mixin :argument_local_path, :option_verbose, :option_keep_remote
 
     run {
       options = {
         :keep => keep
       }
       Braid.verbose = verbose
-      Braid::Command.run(:remove, path, options)
+      Braid::Command.run(:remove, local_path, options)
     }
   }
 
@@ -107,14 +107,14 @@ Main {
       Show diff of local changes to mirror.
     TXT
 
-    mixin :optional_path, :option_verbose, :option_keep_remote
+    mixin :optional_local_path, :option_verbose, :option_keep_remote
 
     run {
       options = {
         'keep' => keep
       }
       Braid.verbose = verbose
-      Braid::Command.run(:diff, path, options)
+      Braid::Command.run(:diff, local_path, options)
     }
   }
 
@@ -123,7 +123,7 @@ Main {
       Push local mirror changes to remote.
     TXT
 
-    mixin :argument_path, :option_branch, :option_verbose, :option_keep_remote
+    mixin :argument_local_path, :option_branch, :option_verbose, :option_keep_remote
 
     run {
       options = {
@@ -131,7 +131,7 @@ Main {
         'branch' => branch
       }
       Braid.verbose = verbose
-      Braid::Command.run(:push, path, options)
+      Braid::Command.run(:push, local_path, options)
     }
   }
 
@@ -140,12 +140,12 @@ Main {
       Set up git remotes.
     TXT
 
-    mixin :optional_path, :option_verbose, :option_force
+    mixin :optional_local_path, :option_verbose, :option_force
 
     run {
       Braid.verbose = verbose
       Braid.force = force
-      Braid::Command.run(:setup, path)
+      Braid::Command.run(:setup, local_path)
     }
   }
 
@@ -157,36 +157,25 @@ Main {
     }
   }
 
-  mode(:list) {
-    description 'Show all tracked mirrors (and if updates are available).'
-
-    mixin :option_verbose
-
-    run {
-      Braid.verbose = verbose
-      Braid::Command.run(:list)
-    }
-  }
-
   mode(:status) {
     description 'Show the status of all tracked mirrors (and if updates are available).'
 
-    mixin :optional_path, :option_verbose
+    mixin :optional_local_path, :option_verbose
 
     run {
       Braid.verbose = verbose
-      Braid::Command.run(:status, path)
+      Braid::Command.run(:status, local_path)
     }
   }
 
-  mixin(:argument_path) {
-    argument(:path) {
+  mixin(:argument_local_path) {
+    argument(:local_path) {
       attr
     }
   }
 
-  mixin(:optional_path) {
-    argument(:path) {
+  mixin(:optional_local_path) {
+    argument(:local_path) {
       optional
       attr
     }
@@ -207,8 +196,8 @@ Main {
     }
   }
 
-  mixin(:option_remote_path) {
-    option(:remote_path, :p) {
+  mixin(:option_path) {
+    option(:path, :p) {
       optional
       argument :required
       desc 'remote path'
@@ -233,14 +222,6 @@ Main {
     }
   }
 
-  mixin(:option_full) {
-    option(:full) {
-      optional
-      desc 'include mirror history' # FIXME
-      attr
-    }
-  }
-
   mixin(:option_verbose) {
     option(:verbose, :v) {
       optional

data/braid.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |s|
   s.add_dependency(%q<main>, ['>= 4.7.3'])
   s.add_dependency(%q<open4>, ['>= 1.0.1']) unless defined?(JRUBY_VERSION)
 
-  s.add_development_dependency(%q<rspec>, ['>= 2.12.0'])
+  s.add_development_dependency(%q<rspec>, ['>= 3.4.4'])
   s.add_development_dependency(%q<mocha>, ['>= 0.9.11'])
 end

data/lib/braid/commands/add.rb

@@ -19,9 +19,6 @@ module Braid
           new_revision    = validate_new_revision(mirror, options['revision'])
           target_revision = determine_target_revision(mirror, new_revision)
 
-          unless mirror.squashed?
-            git.merge_ours(target_revision)
-          end
           git.read_tree_prefix_u(target_revision, mirror.path)
 
           mirror.revision = new_revision

data/lib/braid/commands/diff.rb

@@ -8,24 +8,33 @@ module Braid
       protected
 
       def diff_all(options = {})
-        print "\n"
-        msg "Diffing all mirrors.\n=======================================================\n"
         config.mirrors.each do |path|
-          msg "Diffing #{path}\n=======================================================\n"
-          diff_one(path, options)
-          msg "=======================================================\n"
+          separator
+          msg "Diffing #{path}\n"
+          separator
+          diff = perform_diff(path, options)
+          puts diff unless diff.empty?
         end
-        print "\n"
       end
 
       def diff_one(path, options = {})
+        diff = perform_diff(path, options)
+        puts diff unless diff.empty?
+      end
+
+      def separator
+        puts "=======================================================\n"
+      end
+
+      def perform_diff(path, options = {})
         mirror = config.get!(path)
         setup_remote(mirror)
 
         diff = mirror.diff
-        puts diff unless diff.empty?
 
         clear_remote(mirror, options)
+
+        diff
       end
     end
   end

data/lib/braid/commands/push.rb

@@ -34,9 +34,13 @@ module Braid
         elsif File.directory?(remote_url)
           remote_url = File.expand_path(remote_url)
         end
+        user_name = git.config(%w(--local --get user.name))
+        user_email = git.config(%w(--local --get user.email))
         Dir.chdir(clone_dir) do
           msg 'Cloning mirror with local changes.'
           git.init
+          git.config(['--local', 'user.name', "\"#{user_name}\""]) if user_name
+          git.config(['--local', 'user.email', "\"#{user_email}\""]) if user_email
           git.fetch(mirror.cached_url) if File.exist?(mirror.cached_url)
           git.fetch(remote_url, "+refs/heads/#{mirror.branch}")
           git.checkout(base_revision)

data/lib/braid/commands/status.rb

@@ -2,9 +2,7 @@ module Braid
   module Commands
     class Status < Command
       def run(path = nil, options = {})
-        with_reset_on_error do
-          path ? status_one(path, options) : status_all(options)
-        end
+        path ? status_one(path, options) : status_all(options)
       end
 
       protected

data/lib/braid/commands/update.rb

@@ -55,7 +55,7 @@ module Braid
           return
         end
 
-        base_revision = mirror.base_revision if mirror.squashed?
+        base_revision = mirror.base_revision
 
         mirror.revision = new_revision
         mirror.lock = new_revision if options['revision']
@@ -63,16 +63,12 @@ module Braid
         msg "Merging in mirror '#{mirror.path}'." if verbose?
         in_error = false
         begin
-          if mirror.squashed?
-            local_hash                    = git.rev_parse('HEAD')
-            base_hash                     = generate_tree_hash(mirror, mirror.versioned_path(base_revision))
-            remote_hash                   = generate_tree_hash(mirror, target_revision)
-            ENV["GITHEAD_#{local_hash}"]  = 'HEAD'
-            ENV["GITHEAD_#{remote_hash}"] = target_revision
-            git.merge_trees(base_hash, local_hash, remote_hash)
-          else
-            git.merge_subtree(target_revision)
-          end
+          local_hash = git.rev_parse('HEAD')
+          base_hash = generate_tree_hash(mirror, mirror.versioned_path(base_revision))
+          remote_hash = generate_tree_hash(mirror, target_revision)
+          ENV["GITHEAD_#{local_hash}"] = 'HEAD'
+          ENV["GITHEAD_#{remote_hash}"] = target_revision
+          git.merge_trees(base_hash, local_hash, remote_hash)
         rescue Operations::MergeError => error
           in_error = true
           print error.conflicts_text

data/lib/braid/mirror.rb

@@ -1,6 +1,6 @@
 module Braid
   class Mirror
-    ATTRIBUTES = %w(url branch squashed revision lock remote_path)
+    ATTRIBUTES = %w(url branch revision lock path)
 
     class UnknownType < BraidError
       def message
@@ -30,11 +30,9 @@ module Braid
       path = (options['path'] || extract_path_from_url(url)).sub(/\/$/, '')
       raise PathRequired unless path
 
-      squashed = !options['full']
-
       remote_path = options['remote_path']
 
-      attributes = {'url' => url, 'branch' => branch, 'squashed' => squashed, 'remote_path' => remote_path}
+      attributes = {'url' => url, 'branch' => branch, 'path' => remote_path}
       self.new(path, attributes)
     end
 
@@ -46,19 +44,11 @@ module Braid
       !!lock
     end
 
-    def squashed?
-      !!squashed
-    end
-
     def merged?(commit)
       # tip from spearce in #git:
       # `test z$(git merge-base A B) = z$(git rev-parse --verify A)`
       commit = git.rev_parse(commit)
-      if squashed?
-        !!base_revision && git.merge_base(commit, base_revision) == commit
-      else
-        git.merge_base(commit, 'HEAD') == commit
-      end
+      !!base_revision && git.merge_base(commit, base_revision) == commit
     end
 
     def versioned_path(revision)
@@ -89,6 +79,14 @@ module Braid
       end
     end
 
+    def remote_path
+      self.attributes['path']
+    end
+
+    def remote_path=(remote_path)
+      self.attributes['path'] = remote_path
+    end
+
     def cached_url
       git_cache.path(url)
     end

data/lib/braid/operations.rb

@@ -315,6 +315,10 @@ module Braid
         end
       end
 
+      def config(args)
+        invoke(:config, args) rescue nil
+      end
+
       def rm_r(path)
         invoke(:rm, '-r', path)
         true

data/lib/braid/version.rb

@@ -1,3 +1,3 @@
 module Braid
-  VERSION = '1.0.16'
+  VERSION = '1.0.17'
 end

data/lib/braid.rb

@@ -43,7 +43,6 @@ require 'braid/config'
 require 'braid/command'
 require 'braid/commands/add'
 require 'braid/commands/diff'
-require 'braid/commands/list'
 require 'braid/commands/push'
 require 'braid/commands/remove'
 require 'braid/commands/setup'

data/spec/config_spec.rb

@@ -10,14 +10,14 @@ describe 'Braid::Config, when empty' do
   end
 
   it 'should not get a mirror by name' do
-    @config.get('path').should be_nil
-    lambda { @config.get!('path') }.should raise_error(Braid::Config::MirrorDoesNotExist)
+    expect(@config.get('path')).to be_nil
+    expect { @config.get!('path') }.to raise_error(Braid::Config::MirrorDoesNotExist)
   end
 
   it 'should add a mirror and its params' do
     @mirror = build_mirror
     @config.add(@mirror)
-    @config.get('path').path.should_not be_nil
+    expect(@config.get('path').path).not_to be_nil
   end
 end
 
@@ -33,27 +33,27 @@ describe 'Braid::Config, with one mirror' do
   end
 
   it 'should get the mirror by name' do
-    @config.get('path').should == @mirror
-    @config.get!('path').should == @mirror
+    expect(@config.get('path')).to eq(@mirror)
+    expect(@config.get!('path')).to eq(@mirror)
   end
 
   it 'should raise when trying to overwrite a mirror on add' do
-    lambda { @config.add(@mirror) }.should raise_error(Braid::Config::PathAlreadyInUse)
+    expect { @config.add(@mirror) }.to raise_error(Braid::Config::PathAlreadyInUse)
   end
 
   it 'should remove the mirror' do
     @config.remove(@mirror)
-    @config.get('path').should be_nil
+    expect(@config.get('path')).to be_nil
   end
 
   it 'should update the mirror with new params' do
     @mirror.branch = 'other'
     @config.update(@mirror)
-    @config.get('path').attributes.should == {'branch' => 'other'}
+    expect(@config.get('path').attributes).to eq({'branch' => 'other'})
   end
 
   it 'should raise when trying to update nonexistent mirror' do
     @mirror.instance_variable_set('@path', 'other')
-    lambda { @config.update(@mirror) }.should raise_error(Braid::Config::MirrorDoesNotExist)
+    expect { @config.update(@mirror) }.to raise_error(Braid::Config::MirrorDoesNotExist)
   end
 end

data/spec/integration/adding_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../integration_helper'
+require File.dirname(__FILE__) + '/integration_helper'
 
 describe 'Adding a mirror in a clean repository' do
 
@@ -9,33 +9,55 @@ describe 'Adding a mirror in a clean repository' do
 
   describe 'from a git repository' do
     before do
-      @shiny = create_git_repo_from_fixture('shiny')
-      @skit1 = create_git_repo_from_fixture('skit1')
-    end
+      @repository_dir = create_git_repo_from_fixture('shiny', :name => 'Some body', :email => 'somebody@example.com')
+      @vendor_repository_dir = create_git_repo_from_fixture('skit1')
 
-    it 'should add the files and commit' do
-      in_dir(@shiny) do
-        run_command("#{BRAID_BIN} add #{@skit1}")
+      in_dir(@repository_dir) do
+        run_command("#{BRAID_BIN} add #{@vendor_repository_dir}")
       end
+    end
 
-      file_name = 'skit1/layouts/layout.liquid'
-      run_command("diff -U 3 #{File.join(FIXTURE_PATH, file_name)} #{File.join(TMP_PATH, 'shiny', file_name)}")
+    it 'should add the files and commit' do
+      assert_no_diff("#{FIXTURE_PATH}/skit1/layouts/layout.liquid", "#{@repository_dir}/skit1/layouts/layout.liquid")
 
-      output = run_command('git log --pretty=oneline').split("\n")
-      output.length.should == 2
-      output[0].should =~ /Braid: Add mirror 'skit1' at '[0-9a-f]{7}'/
+      assert_commit_subject(/Braid: Add mirror 'skit1' at '[0-9a-f]{7}'/)
+      assert_commit_author('Some body')
+      assert_commit_email('somebody@example.com')
     end
 
     it 'should create .braids.json and add the mirror to it' do
-      in_dir(@shiny) do
-        run_command("#{BRAID_BIN} add #{@skit1}")
+      braids = YAML::load_file("#{@repository_dir}/.braids.json")
+      expect(braids['skit1']['url']).to eq(@vendor_repository_dir)
+      expect(braids['skit1']['revision']).not_to be_nil
+      expect(braids['skit1']['branch']).to eq('master')
+      expect(braids['skit1']['path']).to be_nil
+    end
+  end
+
+  describe 'from a subdirectory in a git repository' do
+    before do
+      @repository_dir = create_git_repo_from_fixture('shiny', :name => 'Some body', :email => 'somebody@example.com')
+      @vendor_repository_dir = create_git_repo_from_fixture('skit1')
+
+      in_dir(@repository_dir) do
+        run_command("#{BRAID_BIN} add --path layouts #{@vendor_repository_dir}")
       end
+    end
+
+    it 'should add the files and commit' do
+      assert_no_diff("#{FIXTURE_PATH}/skit1/layouts/layout.liquid", "#{@repository_dir}/skit1/layout.liquid")
 
-      braids = YAML::load_file("#{@shiny}/.braids.json")
-      braids['skit1']['squashed'].should == true
-      braids['skit1']['url'].should == @skit1
-      braids['skit1']['revision'].should_not be_nil
-      braids['skit1']['branch'].should == 'master'
+      assert_commit_subject(/Braid: Add mirror 'skit1' at '[0-9a-f]{7}'/)
+      assert_commit_author('Some body')
+      assert_commit_email('somebody@example.com')
+    end
+
+    it 'should create .braids.json and add the mirror to it' do
+      braids = YAML::load_file("#{@repository_dir}/.braids.json")
+      expect(braids['skit1']['url']).to eq(@vendor_repository_dir)
+      expect(braids['skit1']['revision']).not_to be_nil
+      expect(braids['skit1']['branch']).to eq('master')
+      expect(braids['skit1']['path']).to eq('layouts')
     end
   end
 end