braid 0.7.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7df51db130d90c8981f291576c229352aa01ab7f
+  data.tar.gz: 1306a0ac5f768a442cce4c6d3ed21b64f1994f28
+SHA512:
+  metadata.gz: 8a15d53e0873009b3c70b0d553d1e8d9f76887ad01a0b66062af19e6223f7ba7e704b07c3d1ed9a22277197f8a39e88a53d9054419751804affef1a8631aaf9d
+  data.tar.gz: 89750c09fe1a371e247fcf24fb9ecaa245e8d4ab28ad3e4e040d29e67c892114476045aa3c2898afcbee36df0f11a6d126930e1cdc4abe7a6810e51c0d00c87b

data/.gitignore

@@ -4,9 +4,12 @@
 .DS_Store
 .bundle
 .idea
-Gemfile.lock
 coverage
 nbproject
 pkg
 pkg/*
 rdoc
+/*.iml
+/*.ipr
+/*.iws
+/Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - jruby-18mode
+git:
+  depth: 10

data/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# How to Contribute
+
+Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+
+* Fork it
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Commit your changes (`git commit -am 'Add some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create new Pull Request
+
+Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+
+## How to speed the merging of pull requests
+
+* Describe your changes in the CHANGELOG.
+* Give yourself some credit in the appropriate place (usually the CHANGELOG).
+* Make commits of logical units.
+* Ensure your commit messages help others understand what you are doing and why.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Maintain the same code style.
+* Maintain the same level of test coverage or improve it.
+
+## Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -1,6 +1,5 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
 gem 'rake'
-

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2007-2010 Cristi Balan, Norbert Crombach
+Copyright (c) 2007-2008 Cristi Balan
+Copyright (c) 2008-2015 Norbert Crombach
+Copyright (c) 2013-2015 Peter Donald
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,32 +1,59 @@
 # Braid
 
-Braid is a simple tool to help track git and svn vendor branches in a git repository.
+Braid is a simple tool to help track vendor branches in a
+[Git](http://git-scm.com/) repository.
 
-The project homepage is [here](http://github.com/evilchelu/braid/wikis/home).
+## Motivation
 
-## Requirements
+Vendoring allows you take the source code of an external library and ensure it's
+version controlled along with the main project. This is in contrast to including
+a reference to a packaged version of an external library that is available in a
+binary artifact repository such as Maven Central, RubyGems or NPM.
 
- * git 1.6+ (and git-svn if you want to mirror svn repositories)
- * main >= 4.2.0
- * open4 >= 1.0.1 (unless using jruby)
+Vendoring is useful when you need to patch or customize the external libraries
+or the external library is expected to co-evolve with the main project. The
+developer can make changes to the main project and patch the library in a single
+commit.
 
-## Installing using rubygems - official releases
+The problem arises when the external library makes changes that you want to
+integrate into your local vendored version or the developer makes changes to the
+local version that they want integrated into the external library.
 
-    gem install braid
+A typical "implementation" of vendoring is to simply download or checkout the
+source for the external library, remove the `.git` or `.svn` directories and
+commit it to the main source tree. However this approach makes it very difficult
+to update the library. When you want to update the library do you re-apply your
+local changes onto a new copy of the vendored library or do you re-apply the
+changes from the external library to local version? Both cases involve manual
+generation and application of patch files to source trees.
+
+This is where Braid comes into play. Braid makes it easy to vendor in remote git
+repositories and use an automated mechanism for updating the external library
+and generating patches to upgrade the external library.
+
+Braid creates a file `.braids` 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.
 
-## Installing from source
+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.
 
-    git clone git://github.com/evilchelu/braid.git
-    cd braid
-    bundle install
-    rake install # possibly requiring sudo
+Please note that you cannot change between mirror types after the initial add.
+You'll have to remove the mirror and add it again.
+
+## Installation
+
+    gem install braid
 
 ## Quick usage - ruby project
 
-Let's assume we're writing something like gitnub that needs grit in lib/grit. Initialize the repo (nothing braid related here):
+Let's assume we're writing the project `myproject` that needs grit in lib/grit. Initialize the repo (nothing braid related here):
 
-    git init gritty
-    cd gritty
+    git init myproject
+    cd myproject
     touch README
     git add README
     git commit -m "initial commit"
@@ -37,71 +64,83 @@ Now let's vendor grit:
 
 And you're done! Braid vendored grit into lib/grit. Feel free to inspect the changes with git log or git show.
 
-If further down the line, you want to bring new changes from grit in your repository, just update the mirror:
+If further down the line, you want to bring new changes from grit into your repository, just update the mirror:
 
     braid update lib/grit
 
-## Quick usage - rails project
+If you make changes to the grit library and want to generate a patch file so that you can submit the patch file
+to the grit project:
 
-Let's assume you want to start a new rails app called shiny. Initialize the repo (nothing braid related here):
+    braid diff lib/grit > grit.patch
 
-    git init shiny
-    cd shiny
-    touch README
-    git add README
-    git commit -m "initial commit"
+Once those changes have been applied to grit you probably want to update your local version of grit again.
 
-Vendor rails (this might take a while because the rails repo is huge!):
+    braid update lib/grit
 
-    braid add git://github.com/rails/rails.git vendor/rails
+## More usage
 
-Create your new rails app (nothing braid related here):
+Use the built in help system to find out about all commands and options:
+
+    braid help
+    braid help add # or braid add --help
+
+### Examples
 
-    ruby vendor/rails/railties/bin/rails .
-    git add .
-    git commit -m "rails ."
+#### Adding a mirror
 
-Add any plugins you might need:
+    braid add git://github.com/rails/rails.git vendor/rails
 
-    braid add git://github.com/thoughtbot/shoulda.git -p
-    braid add git://github.com/thoughtbot/factory_girl.git -p
-    braid add git://github.com/mbleigh/subdomain-fu.git -p
+#### Adding mirrors with revisions
 
-And you're done! Braid vendored rails and your plugins. Feel free to inspect the changes with git log or git show.
+    braid add --revision bf1b1e0 git://github.com/rails/rails.git vendor/rails
 
-If further down the line, you want to bring new changes from rails in your repository, just update the mirror:
+#### Adding mirrors with full history
 
-    braid update vendor/rails
+    braid add --full git://github.com/mislav/will_paginate.git vendor/plugins/will_paginate
 
-Or, if you want all mirrors updated:
+#### Updating mirrors
 
+    # Update a specific mirror
+    braid update vendor/plugins/cache_fu
+    # Update all mirrors
     braid update
 
-## More usage
+#### Updating mirrors with conflicts
 
-Use the built in help system to find out about all commands and options:
+If a braid update creates a conflict, braid will stop execution and leave the partially committed
+files in your working copy, just like a normal git merge conflict would.
 
-    braid help
-    braid help add # or braid add --help
+You will then have to resolve all conflicts and manually run `git commit`. The commit message is
+already prepared.
+
+If you want to cancel the braid update and the merge, you'll have to reset your working copy and
+index with `git reset --hard`.
+
+#### Locking and unlocking mirrors
 
-You may also want to read [Usage and examples](http://github.com/evilchelu/braid/wikis/usage-and-examples).
+    braid update --revision 6c1c16b vendor/rails
+    braid update --head vendor/rails
 
-## Troubleshooting
+#### Showing local changes made to mirrors
 
-Check [Troubleshooting](http://github.com/evilchelu/braid/wikis/troubleshooting) if you're having issues.
+    braid diff vendor/rails
 
 ## Contributing
 
-We appreciate any patches, error reports and usage ideas you may have. Please submit a lighthouse ticket or start a thread on the mailing list.
+We appreciate any patches, error reports and usage ideas you may have. Please
+submit an issue or pull request on GitHub.
 
-Bugs and feature requests: [braid project on lighthouse](http://evilchelu.lighthouseapp.com/projects/10600-braid)
+### Subversion
 
-Discussions and community support: [braid-gem google group](http://groups.google.com/group/braid-gem)
+While preparing to release Braid v1.0 the support for subversion repositories was removed as
+there was no active maintainers and inadequate test coverage. If there is anyone motivated to
+re-add and maintain the Subversion support, please contact the authors.
 
-## Authors
+# Authors
 
- * Cristi Balan (evilchelu)
- * Norbert Crombach (norbert)
+* Cristi Balan
+* Norbert Crombach
+* Peter Donald
 
 ## Contributors (alphabetically)
 

data/Rakefile

@@ -2,19 +2,11 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rake'
-require 'rake/testtask'
-
-task :default => :test
-
-def test_task(name, pattern)
-  Rake::TestTask.new(name) do |t|
-    ENV['TESTOPTS'] = '--runner=s'
-
-    t.libs << 'lib'
-    t.pattern = pattern
-    t.verbose = true
-  end
+require 'rspec/core/rake_task'
+desc 'Run all specs'
+RSpec::Core::RakeTask.new :spec  do |task|
+  task.rspec_opts = %w{--backtrace}
 end
 
-test_task(:test, "test/*_test.rb")
-namespace(:test) { test_task(:integration, "test/integration/*_test.rb") }
+desc "Test and package the gem"
+task :default => [:spec, :build]

data/bin/braid

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 require 'braid'
 
 require 'rubygems'
@@ -12,7 +12,7 @@ Home = File.expand_path(ENV['HOME'] || '~')
 # main kicks ass!
 Main {
   description <<-TXT
-    braid is a simple tool to help track git or svn repositories inside a git repository.
+    braid is a simple tool to help track git repositories inside a git repository.
 
     Run 'braid commandname help' for more details.
 
@@ -25,16 +25,9 @@ Main {
       Add a new mirror to be tracked.
 
         * adds metadata about the mirror to .braids
-        * adds the git or git svn remotes to .git/config
+        * adds the git remotes to .git/config
         * fetches and merges remote code into given directory
 
-      --type defaults:
-
-        * svn://path          # => svn
-        * git://path          # => git
-        * http://path/trunk   # => svn
-        * http://path.git     # => git
-
       Name defaults:
 
         * remote/path         # => path
@@ -43,19 +36,15 @@ Main {
     TXT
 
     examples <<-TXT
-      . braid add svn://remote/path
-      . braid add svn://remote/path local/dir
-      . braid add git://remote/path local/dir
       . braid add http://remote/path.git local/dir
-      . braid add http://remote/path --type git local/dir
-      . braid add svn://remote/path --branch notmaster
+      . braid add http://remote/path local/dir
     TXT
 
-    mixin :argument_url, :option_type, :optional_path, :option_branch, :option_rails_plugin, :option_revision, :option_full, :option_verbose
+    mixin :argument_url, :optional_path, :option_branch, :option_revision, :option_full, :option_verbose
 
     run {
       Braid.verbose = verbose
-      Braid::Command.run(:add, url, {"type" => type, "path" => path, "branch" => branch, "rails_plugin" => rails_plugin, "revision" => revision, "full" => full})
+      Braid::Command.run(:add, url, {'path' => path, 'branch' => branch, 'revision' => revision, 'full' => full})
     }
   }
 
@@ -79,7 +68,7 @@ Main {
 
     run {
       Braid.verbose = verbose
-      Braid::Command.run(:update, path, {"revision" => revision, "head" => head})
+      Braid::Command.run(:update, path, {'revision' => revision, 'head' => head})
     }
   }
 
@@ -89,7 +78,7 @@ Main {
 
         * removes metadata from .braids
         * removes the local directory and commits the removal
-        * removes the git remote by default, --keep can be used to supress that
+        * removes the git remote by default, --keep can be used to suppress that
     TXT
 
     examples <<-TXT
@@ -134,7 +123,7 @@ Main {
 
   mode(:setup) {
     description <<-TXT
-      Set up git and git-svn remotes.
+      Set up git remotes.
     TXT
 
     mixin :optional_path, :option_verbose, :option_force
@@ -184,15 +173,6 @@ Main {
     }
   }
 
-  mixin(:option_type) {
-    option(:type, :t) {
-      optional
-      argument :required
-      desc 'mirror type'
-      attr
-    }
-  }
-
   mixin(:option_branch) {
     option(:branch, :b) {
       optional
@@ -202,14 +182,6 @@ Main {
     }
   }
 
-  mixin(:option_rails_plugin) {
-    option(:rails_plugin, :p) {
-      optional
-      desc 'added mirror is a Rails plugin'
-      attr
-    }
-  }
-
   mixin(:option_revision) {
     option(:revision, :r) {
       optional

data/braid.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
 require 'braid/version'
 
 Gem::Specification.new do |s|
@@ -7,27 +7,27 @@ Gem::Specification.new do |s|
   s.version            = Braid::VERSION
   s.platform           = Gem::Platform::RUBY
 
-  s.authors            = ["Cristi Balan", "Norbert Crombach"]
-  s.email              = %q{evil@che.lu}
+  s.authors            = ['Cristi Balan', 'Norbert Crombach', 'Peter Donald']
+  s.email              = %q{evil@che.lu norbert.crombach@primetheory.org peter@realityforge.org}
 
-  s.homepage           = %q{http://evil.che.lu/projects/braid}
+  s.homepage           = %q{https://github.com/cristibalan/braid}
   s.summary            = %q{A simple tool for tracking vendor branches in git.}
   s.description        = %q{A simple tool for tracking vendor branches in git.}
 
   s.rubyforge_project  = %q{braid}
 
   s.files              = `git ls-files`.split("\n")
-  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
   s.executables        = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.default_executable = %q{braid}
-  s.require_paths      = ["lib"]
+  s.require_paths      = %w(lib)
 
   s.has_rdoc           = false
-  s.rdoc_options       = ["--line-numbers", "--inline-source", "--title", "braid", "--main"]
+  s.rdoc_options       = %w(--line-numbers --inline-source --title braid --main)
 
-  s.add_dependency(%q<main>, [">= 4.7.3"])
-  s.add_dependency(%q<open4>, [">= 1.0.1"]) unless defined?(JRUBY_VERSION)
+  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<test-spec>, [">= 0.10.0"])
-  s.add_development_dependency(%q<mocha>, [">= 0.9.11"])
+  s.add_development_dependency(%q<rspec>, ['= 2.12.0'])
+  s.add_development_dependency(%q<mocha>, ['>= 0.9.11'])
 end