norbert-braid 0.4.9

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2008 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.rdoc

@@ -0,0 +1,27 @@
+= braid
+A simple tool for tracking vendor branches in git.
+
+http://evil.che.lu/projects/braid/
+
+== Requirements
+
+You will need git 1.5.4.5 or higher to run this version.
+
+== Installation
+
+  git clone git://github.com/evilchelu/braid.git
+  cd braid
+  gem build braid.gemspec
+  sudo gem install braid-x.y.z.gem
+
+== Usage
+
+  braid help
+  braid help COMMANDNAME
+
+For more usage examples and documentation check the project wiki at http://github.com/evilchelu/braid/wikis.
+Also see the bug tracker at http://evilchelu.lighthouseapp.com/projects/10600-braid for current issues and future plans.
+
+== Contributing
+
+If you want to send a patch please fork the project on GitHub and send a pull request.

data/Rakefile

@@ -0,0 +1,17 @@
+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,223 @@
+#!/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 help commandname' 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
+
+    run {
+      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_safe
+
+    run {
+      Braid::Command.run(:update, path, { "revision" => revision, "head" => head , "safe" => safe })
+    }
+  }
+
+  mode(:remove) {
+    description <<-TXT
+      Remove a mirror.
+
+        * removes metadata from .braids
+        * removes the local directory and commits the removal
+        * does NOT remove the git and git svn remotes in case you still need them around
+    TXT
+
+    examples <<-TXT
+      . braid remove local/dir
+    TXT
+
+    mixin :argument_path
+
+    run {
+      Braid::Command.run(:remove, path)
+    }
+  }
+
+  mode(:setup) {
+    description <<-TXT
+      Set up git and git-svn remotes.
+    TXT
+
+    examples <<-TXT
+      . braid setup local/dir
+    TXT
+
+    mixin :optional_path
+
+    run {
+      Braid::Command.run(:setup, path)
+    }
+  }
+
+  mode(:diff) {
+    description <<-TXT
+      Show diff of local changes to mirror.
+    TXT
+
+    examples <<-TXT
+      . braid diff local/dir
+    TXT
+
+    mixin :argument_path
+
+    run {
+      Braid::Command.run(:diff, path)
+    }
+  }
+
+  mode(:version) {
+    description 'Show braid version.'
+
+    run {
+      puts "braid #{Braid::VERSION}"
+    }
+  }
+
+  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_safe) {
+    option(:safe) {
+      optional
+      desc 'safe on merge errors'
+      attr
+    }
+  }
+
+  run { help! }
+}

data/braid.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name = %q{braid}
+  s.version = "0.4.9"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cristi Balan", "Norbert Crombach"]
+  s.date = %q{2008-09-06}
+  s.default_executable = %q{braid}
+  s.description = %q{A simple tool for tracking vendor branches in git.}
+  s.email = %q{evil@che.lu}
+  s.executables = ["braid"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["LICENSE", "README.rdoc", "Rakefile", "braid.gemspec", "bin/braid", "lib/braid/command.rb", "lib/braid/commands/add.rb", "lib/braid/commands/diff.rb", "lib/braid/commands/remove.rb", "lib/braid/commands/setup.rb", "lib/braid/commands/update.rb", "lib/braid/config.rb", "lib/braid/mirror.rb", "lib/braid/operations.rb", "lib/braid.rb", "test/braid_test.rb", "test/config_test.rb", "test/mirror_test.rb", "test/operations_test.rb", "test/test_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://evil.che.lu/projects/braid}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "braid", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{braid}
+  s.rubygems_version = %q{1.1.0}
+  s.summary = %q{A simple tool for tracking vendor branches in git.}
+
+  s.add_dependency(%q<main>, [">= 2.8.0"])
+  s.add_dependency(%q<open4>, [">= 0.9.6"])
+end

data/lib/braid/command.rb

@@ -0,0 +1,119 @@
+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 str
+    end
+
+    def msg(str)
+      self.class.msg(str)
+    end
+
+    def config
+      @config ||= load_and_migrate_config
+    end
+
+    private
+      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_commit(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,44 @@
+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)}" : ""
+          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_hash = determine_target_commit(mirror, new_revision)
+
+          unless mirror.squashed?
+            git.merge_ours(target_hash)
+          end
+          git.read_tree(target_hash, mirror.path)
+
+          mirror.revision = new_revision
+          mirror.lock = new_revision if options["revision"]
+          config.update(mirror)
+          add_config_file
+
+          commit_message = "Add mirror '#{mirror.path}/'#{revision_message}"
+          git.commit(commit_message)
+        end
+      end
+
+      private
+        def setup_remote(mirror)
+          Command.run(:setup, mirror.path)
+        end
+    end
+  end
+end

data/lib/braid/commands/diff.rb

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

data/lib/braid/commands/remove.rb

@@ -0,0 +1,23 @@
+module Braid
+  module Commands
+    class Remove < Command
+      def run(path)
+        mirror = config.get!(path)
+
+        bail_on_local_changes!
+
+        with_reset_on_error do
+          msg "Removing mirror from '#{mirror.path}/'."
+
+          git.rm_r(mirror.path)
+
+          config.remove(mirror)
+          add_config_file
+
+          commit_message = "Remove mirror '#{mirror.path}/'"
+          git.commit(commit_message)
+        end
+      end
+    end
+  end
+end

data/lib/braid/commands/setup.rb

@@ -0,0 +1,33 @@
+module Braid
+  module Commands
+    class Setup < Command
+      def run(path = nil)
+        path ? setup_one(path) : setup_all
+      end
+
+      protected
+        def setup_all
+          msg "Setting up all mirrors."
+          config.mirrors.each do |path|
+            setup_one(path)
+          end
+        end
+
+        def setup_one(path)
+          mirror = config.get!(path)
+
+          if git.remote_exists?(mirror.remote)
+            msg "Mirror '#{mirror.path}/' already has a remote. Skipping."
+            return
+          end
+
+          msg "Setting up remote for '#{mirror.path}/'."
+          unless mirror.type == "svn"
+            git.remote_add(mirror.remote, mirror.url, mirror.branch)
+          else
+            git_svn.init(mirror.remote, mirror.url)
+          end
+        end
+    end
+  end
+end

data/lib/braid/commands/update.rb

@@ -0,0 +1,78 @@
+module Braid
+  module Commands
+    class Update < Command
+      def run(path, options = {})
+        bail_on_local_changes!
+
+        with_reset_on_error do
+          path ? update_one(path, options) : update_all(options)
+        end
+      end
+
+      protected
+        def update_all(options = {})
+          options.reject! { |k,v| %w(revision head).include?(k) }
+          msg "Updating all mirrors."
+          config.mirrors.each do |path|
+            update_one(path, options)
+          end
+        end
+
+        def update_one(path, options = {})
+          mirror = config.get!(path)
+
+          # check options for lock modification
+          if mirror.locked?
+            if options["head"]
+              msg "Unlocking mirror '#{mirror.path}/'."
+              mirror.lock = nil
+            elsif !options["revision"]
+              msg "Mirror '#{mirror.path}/' is locked to #{display_revision(mirror, mirror.lock)}. Skipping."
+              return
+            end
+          end
+
+          mirror.fetch
+
+          new_revision = validate_new_revision(mirror, options["revision"])
+          target_hash = determine_target_commit(mirror, new_revision)
+
+          if mirror.merged?(target_hash)
+            msg "Mirror '#{mirror.path}/' is already up to date. Skipping."
+            return
+          end
+
+          diff = mirror.diff if mirror.squashed? # get diff before setting revision
+
+          mirror.revision = new_revision
+          mirror.lock = new_revision if options["revision"]
+          config.update(mirror)
+
+          msg "Updating mirror '#{mirror.path}/'."
+          if mirror.squashed?
+            git.rm_r(mirror.path)
+            git.read_tree(target_hash, mirror.path)
+            unless diff.empty?
+              git.apply(diff, *(options["safe"] ? ["--reject"] : []))
+            end
+          else
+            git.merge_subtree(target_hash)
+          end
+
+          add_config_file
+
+          revision_message = " to " + (options["revision"] ? display_revision(mirror) : "HEAD")
+          commit_message = "Update mirror '#{mirror.path}/'#{revision_message}"
+          git.commit(commit_message)
+
+        rescue Operations::ShellExecutionError => error
+          if options["safe"]
+            msg "Caught shell error. Breaking."
+            exit(0)
+          else
+            raise error
+          end
+        end
+    end
+  end
+end