realityforge-braid 0.7.2

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+*.rbc
+*.sw?
+.DS_Store
+.bundle
+.idea
+Gemfile.lock
+coverage
+nbproject
+pkg
+pkg/*
+rdoc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2010 Cristi Balan, Norbert Crombach
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Braid
+
+Braid is a simple tool to help track git and svn vendor branches in a git repository.
+
+The project homepage is [here](http://github.com/evilchelu/braid/wikis/home).
+
+## Requirements
+
+ * git 1.6+ (and git-svn if you want to mirror svn repositories)
+ * main >= 4.2.0
+ * open4 >= 1.0.1 (unless using jruby)
+
+## Installing using rubygems - official releases
+
+    gem install braid
+
+## Installing from source
+
+    git clone git://github.com/evilchelu/braid.git
+    cd braid
+    bundle install
+    rake install # possibly requiring sudo
+
+## 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):
+
+    git init gritty
+    cd gritty
+    touch README
+    git add README
+    git commit -m "initial commit"
+
+Now let's vendor grit:
+
+    braid add git://github.com/mojombo/grit.git lib/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:
+
+    braid update lib/grit
+
+## Quick usage - rails project
+
+Let's assume you want to start a new rails app called shiny. Initialize the repo (nothing braid related here):
+
+    git init shiny
+    cd shiny
+    touch README
+    git add README
+    git commit -m "initial commit"
+
+Vendor rails (this might take a while because the rails repo is huge!):
+
+    braid add git://github.com/rails/rails.git vendor/rails
+
+Create your new rails app (nothing braid related here):
+
+    ruby vendor/rails/railties/bin/rails .
+    git add .
+    git commit -m "rails ."
+
+Add any plugins you might need:
+
+    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
+
+And you're done! Braid vendored rails and your plugins. Feel free to inspect the changes with git log or git show.
+
+If further down the line, you want to bring new changes from rails in your repository, just update the mirror:
+
+    braid update vendor/rails
+
+Or, if you want all mirrors updated:
+
+    braid update
+
+## More usage
+
+Use the built in help system to find out about all commands and options:
+
+    braid help
+    braid help add # or braid add --help
+
+You may also want to read [Usage and examples](http://github.com/evilchelu/braid/wikis/usage-and-examples).
+
+## Troubleshooting
+
+Check [Troubleshooting](http://github.com/evilchelu/braid/wikis/troubleshooting) if you're having issues.
+
+## 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.
+
+Bugs and feature requests: [braid project on lighthouse](http://evilchelu.lighthouseapp.com/projects/10600-braid)
+
+Discussions and community support: [braid-gem google group](http://groups.google.com/group/braid-gem)
+
+## Authors
+
+ * Cristi Balan (evilchelu)
+ * Norbert Crombach (norbert)
+
+## Contributors (alphabetically)
+
+* Alan Harper
+* Christoph Sturm
+* Dennis Muhlestein
+* Ferdinand Svehla
+* Michael Klishin
+* Roman Heinrich
+* Travis Tilley
+* Tyler Rick

data/Rakefile

@@ -0,0 +1,20 @@
+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
+end
+
+test_task(:test, "test/*_test.rb")
+namespace(:test) { test_task(:integration, "test/integration/*_test.rb") }

data/bin/braid

@@ -0,0 +1,263 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'braid'
+
+require 'rubygems'
+require 'main'
+
+Home = File.expand_path(ENV['HOME'] || '~')
+
+# mostly blantantly stolen from ara's punch script
+# main kicks ass!
+Main {
+  description <<-TXT
+    braid is a simple tool to help track git or svn repositories inside a git repository.
+
+    Run 'braid commandname help' for more details.
+
+    All operations will be executed in the braid/track branch.
+    You can then merge back or cherry-pick changes.
+  TXT
+
+  mode(:add) {
+    description <<-TXT
+      Add a new mirror to be tracked.
+
+        * adds metadata about the mirror to .braids
+        * adds the git or git svn 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
+        * remote/path/trunk   # => path
+        * remote/path.git     # => path
+    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
+    TXT
+
+    mixin :argument_url, :option_type, :optional_path, :option_branch, :option_rails_plugin, :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})
+    }
+  }
+
+  mode(:update) {
+    description <<-TXT
+      Update a braid mirror.
+
+        * get new changes from remote
+        * always creates a merge commit
+        * updates metadata in .braids when revisions are changed
+
+      Defaults to updating all unlocked mirrors if none is specified.
+    TXT
+
+    examples <<-TXT
+      . braid update
+      . braid update local/dir
+    TXT
+
+    mixin :optional_path, :option_revision, :option_head, :option_verbose
+
+    run {
+      Braid.verbose = verbose
+      Braid::Command.run(:update, path, {"revision" => revision, "head" => head})
+    }
+  }
+
+  mode(:remove) {
+    description <<-TXT
+      Remove a mirror.
+
+        * 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
+    TXT
+
+    examples <<-TXT
+      . braid remove local/dir
+    TXT
+
+    mixin :argument_path, :option_verbose, :option_keep_remote
+
+    run {
+      options       = {
+          :keep => keep
+      }
+      Braid.verbose = verbose
+      Braid::Command.run(:remove, path, options)
+    }
+  }
+
+  mode(:diff) {
+    description <<-TXT
+      Show diff of local changes to mirror.
+    TXT
+
+    mixin :argument_path, :option_verbose
+
+    run {
+      Braid::Command.run(:diff, path)
+    }
+  }
+
+  mode(:push) {
+    description <<-TXT
+      Push local mirror changes to remote.
+    TXT
+
+    mixin :argument_path, :option_verbose
+
+    run {
+      Braid.verbose = verbose
+      Braid::Command.run(:push, path)
+    }
+  }
+
+  mode(:setup) {
+    description <<-TXT
+      Set up git and git-svn remotes.
+    TXT
+
+    mixin :optional_path, :option_verbose, :option_force
+
+    run {
+      Braid.verbose = verbose
+      Braid.force = force
+      Braid::Command.run(:setup, path)
+    }
+  }
+
+  mode(:version) {
+    description 'Show braid version.'
+
+    run {
+      puts "braid #{Braid::VERSION}"
+    }
+  }
+
+  mode(:list) {
+    description 'Show all tracked mirrors (and if updates are available).'
+
+    mixin :option_verbose
+
+    run {
+      Braid.verbose = verbose
+      Braid::Command.run(:list)
+    }
+  }
+
+  mixin(:argument_path) {
+    argument(:path) {
+      attr
+    }
+  }
+
+  mixin(:optional_path) {
+    argument(:path) {
+      optional
+      attr
+    }
+  }
+
+  mixin(:argument_url) {
+    argument(:url) {
+      attr
+    }
+  }
+
+  mixin(:option_type) {
+    option(:type, :t) {
+      optional
+      argument :required
+      desc 'mirror type'
+      attr
+    }
+  }
+
+  mixin(:option_branch) {
+    option(:branch, :b) {
+      optional
+      argument :required
+      desc 'remote branch name'
+      attr
+    }
+  }
+
+  mixin(:option_rails_plugin) {
+    option(:rails_plugin, :p) {
+      optional
+      desc 'added mirror is a Rails plugin'
+      attr
+    }
+  }
+
+  mixin(:option_revision) {
+    option(:revision, :r) {
+      optional
+      argument :required
+      desc 'revision to track'
+      attr
+    }
+  }
+
+  mixin(:option_head) {
+    option(:head) {
+      optional
+      desc 'mirror head'
+      attr
+    }
+  }
+
+  mixin(:option_full) {
+    option(:full) {
+      optional
+      desc 'include mirror history' # FIXME
+      attr
+    }
+  }
+
+  mixin(:option_verbose) {
+    option(:verbose, :v) {
+      optional
+      desc 'log shell commands'
+      attr
+    }
+  }
+
+  mixin(:option_force) {
+    option(:force, :f) {
+      optional
+      desc 'force'
+      attr
+    }
+  }
+
+  mixin(:option_keep_remote) {
+    option(:keep) {
+      optional
+      desc 'do not remove the remote'
+      attr
+    }
+  }
+
+  run { help! }
+}

data/braid.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'braid/version'
+
+Gem::Specification.new do |s|
+  s.name               = %q{realityforge-braid}
+  s.version            = Braid::VERSION
+  s.platform           = Gem::Platform::RUBY
+
+  s.authors            = ["Cristi Balan", "Norbert Crombach"]
+  s.email              = %q{evil@che.lu}
+
+  s.homepage           = %q{http://evil.che.lu/projects/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.executables        = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.default_executable = %q{braid}
+  s.require_paths      = ["lib"]
+
+  s.has_rdoc           = false
+  s.rdoc_options       = ["--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_development_dependency(%q<test-spec>, [">= 0.10.0"])
+  s.add_development_dependency(%q<mocha>, [">= 0.9.11"])
+end

data/lib/braid/command.rb

@@ -0,0 +1,136 @@
+module Braid
+  class Command
+    class InvalidRevision < BraidError
+    end
+
+    extend Operations::VersionControl
+    include Operations::VersionControl
+
+    def self.run(command, *args)
+      verify_git_version!
+
+      klass = Commands.const_get(command.to_s.capitalize)
+      klass.new.run(*args)
+
+    rescue BraidError => error
+      case error
+        when Operations::ShellExecutionError
+          msg "Shell error: #{error.message}"
+        else
+          msg "Error: #{error.message}"
+      end
+      exit(1)
+    end
+
+    def self.msg(str)
+      puts "Braid: #{str}"
+    end
+
+    def msg(str)
+      self.class.msg(str)
+    end
+
+    def config
+      @config ||= load_and_migrate_config
+    end
+
+    def verbose?
+      Braid.verbose
+    end
+
+    def force?
+      Braid.force
+    end
+
+    private
+
+    def setup_remote(mirror)
+      Command.run(:setup, mirror.path)
+    end
+
+    def use_local_cache?
+      Braid.use_local_cache
+    end
+
+    def self.verify_git_version!
+      git.require_version!(REQUIRED_GIT_VERSION)
+    end
+
+    def bail_on_local_changes!
+      git.ensure_clean!
+    end
+
+    def with_reset_on_error
+      work_head = git.head
+
+      begin
+        yield
+      rescue => error
+        msg "Resetting to '#{work_head[0, 7]}'."
+        git.reset_hard(work_head)
+        raise error
+      end
+    end
+
+    def load_and_migrate_config
+      config = Config.new
+      unless config.valid?
+        msg "Configuration is outdated. Migrating."
+        bail_on_local_changes!
+        config.migrate!
+        git.commit("Upgrade .braids", "-- .braids")
+      end
+      config
+    end
+
+    def add_config_file
+      git.add(CONFIG_FILE)
+    end
+
+    def display_revision(mirror, revision = nil)
+      revision ||= mirror.revision
+      mirror.type == "svn" ? "r#{revision}" : "'#{revision[0, 7]}'"
+    end
+
+    def validate_new_revision(mirror, new_revision)
+      unless new_revision
+        unless mirror.type == "svn"
+          return git.rev_parse(mirror.remote)
+        else
+          return svn.head_revision(mirror.url)
+        end
+      end
+
+      unless mirror.type == "svn"
+        new_revision = git.rev_parse(new_revision)
+      else
+        new_revision = svn.clean_revision(new_revision)
+      end
+      old_revision = mirror.revision
+
+      if new_revision == old_revision
+        raise InvalidRevision, "mirror is already at requested revision"
+      end
+
+      if mirror.type == "svn"
+        if old_revision && new_revision < old_revision
+          raise InvalidRevision, "local revision is higher than request revision"
+        end
+
+        if svn.head_revision(mirror.url) < new_revision
+          raise InvalidRevision, "requested revision is higher than remote revision"
+        end
+      end
+
+      new_revision
+    end
+
+    def determine_target_revision(mirror, new_revision)
+      unless mirror.type == "svn"
+        git.rev_parse(new_revision)
+      else
+        git_svn.commit_hash(mirror.remote, new_revision)
+      end
+    end
+  end
+end

data/lib/braid/commands/add.rb

@@ -0,0 +1,40 @@
+module Braid
+  module Commands
+    class Add < Command
+      def run(url, options = {})
+        bail_on_local_changes!
+
+        with_reset_on_error do
+          mirror           = config.add_from_options(url, options)
+
+          branch_message   = (mirror.type == "svn" || mirror.branch == "master") ? "" : " branch '#{mirror.branch}'"
+          revision_message = options["revision"] ? " at #{display_revision(mirror, options["revision"])}" : ""
+          msg "Adding #{mirror.type} mirror of '#{mirror.url}'#{branch_message}#{revision_message}."
+
+          # these commands are explained in the subtree merge guide
+          # http://www.kernel.org/pub/software/scm/git/docs/howto/using-merge-subtree.html
+
+          setup_remote(mirror)
+          mirror.fetch
+
+          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(target_revision, mirror.path)
+
+          mirror.revision = new_revision
+          mirror.lock = new_revision if options["revision"]
+          config.update(mirror)
+          add_config_file
+
+          git.commit("Add mirror '#{mirror.path}' at #{display_revision(mirror)}")
+          msg "Added mirror at #{display_revision(mirror)}."
+        end
+      end
+
+    end
+  end
+end

data/lib/braid/commands/diff.rb

@@ -0,0 +1,13 @@
+module Braid
+  module Commands
+    class Diff < Command
+      def run(path)
+        mirror = config.get!(path)
+        setup_remote(mirror)
+
+        diff = mirror.diff
+        puts diff unless diff.empty?
+      end
+    end
+  end
+end

data/lib/braid/commands/list.rb

@@ -0,0 +1,32 @@
+module Braid
+  module Commands
+    class List < Command
+      def run(path = nil, options = {})
+        with_reset_on_error do
+          path ? list_one(path, options) : list_all(options)
+        end
+      end
+
+      protected
+      def list_all(options = {})
+        options.reject! { |k, v| %w(revision head).include?(k) }
+        print "\n"
+        msg "Listing all mirrors.\n=======================================================\n"
+        config.mirrors.each_with_index do |path, i|
+          mirror = config.get!(path)
+          print " #{i + 1}) #{path.to_s}"
+          print " [LOCKED]" if mirror.locked?
+          setup_remote(mirror)
+          msg "Fetching new commits for '#{mirror.path}'." if verbose?
+          mirror.fetch
+          new_revision    = validate_new_revision(mirror, options["revision"])
+          target_revision = determine_target_revision(mirror, new_revision)
+          print " !!! UPDATE AVAILABLE !!!" if new_revision.to_s != mirror.base_revision.to_s
+          print "\n"
+        end
+        print "\n"
+      end
+
+    end
+  end
+end