evilchelu-braid 0.4.0 → 0.4.10

data/{License.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Cristi Balan
+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

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

@@ -1,4 +1,17 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+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

@@ -1,14 +1,11 @@
 #!/usr/bin/env ruby
+
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'braid'
 
-begin
-  require 'rubygems'
-rescue LoadError
-end
+require 'rubygems'
 require 'main'
 
-require 'braid'
-
 Home = File.expand_path(ENV['HOME'] || '~')
 
 # mostly blantantly stolen from ara's punch script
@@ -54,10 +51,10 @@ Main {
       . braid add svn://remote/path --branch notmaster
     TXT
 
-    mixin :argument_remote, :option_type, :optional_mirror, :option_branch, :option_rails_plugin, :option_revision, :option_full
+    mixin :argument_url, :option_type, :optional_path, :option_branch, :option_rails_plugin, :option_revision, :option_full
 
     run {
-      Braid::Command.run(:add, remote, { "type" => type, "mirror" => mirror, "branch" => branch, "rails_plugin" => rails_plugin, "revision" => revision, "full" => full })
+      Braid::Command.run(:add, url, { "type" => type, "path" => path, "branch" => branch, "rails_plugin" => rails_plugin, "revision" => revision, "full" => full })
     }
   }
 
@@ -77,10 +74,10 @@ Main {
       . braid update local/dir
     TXT
 
-    mixin :optional_mirror, :option_revision, :option_head
+    mixin :optional_path, :option_revision, :option_head, :option_safe
 
     run {
-      Braid::Command.run(:update, mirror, { "revision" => revision, "head" => head })
+      Braid::Command.run(:update, path, { "revision" => revision, "head" => head , "safe" => safe })
     }
   }
 
@@ -97,10 +94,10 @@ Main {
       . braid remove local/dir
     TXT
 
-    mixin :argument_mirror
+    mixin :argument_path
 
     run {
-      Braid::Command.run(:remove, mirror)
+      Braid::Command.run(:remove, path)
     }
   }
 
@@ -113,26 +110,26 @@ Main {
       . braid setup local/dir
     TXT
 
-    mixin :optional_mirror
+    mixin :optional_path
 
     run {
-      Braid::Command.run(:setup, mirror)
+      Braid::Command.run(:setup, path)
     }
   }
 
   mode(:diff) {
     description <<-TXT
-      Show diff between '#{Braid::WORK_BRANCH}' and HEAD.
+      Show diff of local changes to mirror.
     TXT
 
     examples <<-TXT
       . braid diff local/dir
     TXT
 
-    mixin :argument_mirror
+    mixin :argument_path
 
     run {
-      Braid::Command.run(:diff, mirror)
+      Braid::Command.run(:diff, path)
     }
   }
 
@@ -140,25 +137,25 @@ Main {
     description 'Show braid version.'
 
     run {
-      puts "braid #{Braid::VERSION::STRING}"
+      puts "braid #{Braid::VERSION}"
     }
   }
 
-  mixin(:argument_mirror) {
-    argument(:mirror) {
+  mixin(:argument_path) {
+    argument(:path) {
       attr
     }
   }
 
-  mixin(:optional_mirror) {
-    argument(:mirror) {
+  mixin(:optional_path) {
+    argument(:path) {
       optional
       attr
     }
   }
 
-  mixin(:argument_remote) {
-    argument(:remote) {
+  mixin(:argument_url) {
+    argument(:url) {
       attr
     }
   }
@@ -214,5 +211,13 @@ Main {
     }
   }
 
+  mixin(:option_safe) {
+    option(:safe) {
+      optional
+      desc 'safe on merge errors'
+      attr
+    }
+  }
+
   run { help! }
 }

data/braid.gemspec

@@ -1,25 +1,25 @@
 Gem::Specification.new do |s|
   s.name = %q{braid}
-  s.version = "0.4.0"
+  s.version = "0.4.10"
 
   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-05-01}
+  s.date = %q{2008-09-23}
   s.default_executable = %q{braid}
-  s.description = %q{Braid is a simple tool to help track git and svn vendor branches in a git repository}
+  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 = ["History.txt", "License.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/braid", "config/hoe.rb", "config/requirements.rb", "lib/braid.rb", "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/exceptions.rb", "lib/braid/operations.rb", "lib/braid/version.rb", "braid.gemspec", "script/destroy", "script/generate", "setup.rb", "spec/braid_spec.rb", "spec/config_spec.rb", "spec/operations_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/deployment.rake", "tasks/environment.rake", "tasks/rspec.rake", "tasks/website.rake"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files = ["bin/braid", "braid.gemspec", "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", "LICENSE", "Rakefile", "README.rdoc", "test/braid_test.rb", "test/config_test.rb", "test/fixtures/shiny/README", "test/fixtures/skit1/layouts/layout.liquid", "test/fixtures/skit1/preview.png", "test/fixtures/skit1.1/layouts/layout.liquid", "test/fixtures/skit1.2/layouts/layout.liquid", "test/integration/adding_test.rb", "test/integration/updating_test.rb", "test/integration_helper.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 = ["--main", "README.txt"]
+  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{Braid is a simple tool to help track git and svn vendor branches in a git repository}
+  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"])

data/lib/braid.rb

@@ -1,28 +1,25 @@
-$:.unshift dir = File.dirname(__FILE__)
-
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
-require 'open4'
-require 'yaml'
-require 'yaml/store'
+$:.unshift File.dirname(__FILE__)
 
 module Braid
-  MIRROR_TYPES = %w[git svn]
-  WORK_BRANCH = "braid/track"
+  VERSION = "0.4.10"
+
   CONFIG_FILE = ".braids"
+  USE_LOCAL_CACHE = ENV["BRAID_USE_LOCAL_CACHE"] || true
+  LOCAL_CACHE_DIR = ENV["BRAID_LOCAL_CACHE_DIR"] || "#{ENV["HOME"]}/.braid/cache/"
   REQUIRED_GIT_VERSION = "1.5.4.5"
-end
 
-require 'braid/version'
-require 'braid/exceptions'
+  class BraidError < StandardError
+    def message
+      value = super
+      value if value != self.class.name
+    end
+  end
+end
 
-require 'braid/config'
 require 'braid/operations'
-
+require 'braid/mirror'
+require 'braid/config'
 require 'braid/command'
-Dir["#{dir}/braid/commands/*"].each do |file|
+Dir[File.dirname(__FILE__) + '/braid/commands/*'].each do |file|
   require file
 end

data/lib/braid/command.rb

@@ -1,68 +1,118 @@
 module Braid
   class Command
-    include Operations::Mirror
-    include Operations::Helpers
-
-    class << self
-      include Operations::Helpers
-      include Operations::Git
-
-      def run(command, *args)
-        raise Braid::Git::VersionTooLow unless verify_git_version(REQUIRED_GIT_VERSION)
+    class InvalidRevision < BraidError
+    end
 
-        klass = Braid::Commands.const_get(command.to_s.capitalize)
-        klass.new.run(*args)
+    extend Operations::VersionControl
+    include Operations::VersionControl
 
-      rescue Braid::Git::LocalChangesPresent => e
-        msg "Local changes are present. You have to commit or stash them before running braid commands."
-        msg "Exiting."
+    def self.run(command, *args)
+      verify_git_version!
 
-      rescue Braid::Git::VersionTooLow => e
-        msg "This version of braid requires at least git #{REQUIRED_GIT_VERSION}. You have #{extract_git_version}."
-        msg "Exiting."
+      klass = Commands.const_get(command.to_s.capitalize)
+      klass.new.run(*args)
 
-      rescue => e
-        # FIXME
+    rescue BraidError => error
+      case error
+      when Operations::ShellExecutionError
+        msg "Shell error: #{error.message}"
+      else
+        msg "Error: #{error.message}"
       end
+      exit(1)
+    end
 
-      def msg(str)
-        puts str
-      end
+    def self.msg(str)
+      puts str
+    end
+
+    def msg(str)
+      self.class.msg(str)
     end
 
     def config
-      @config ||= Braid::Config.new
+      @config ||= load_and_migrate_config
     end
 
     private
-      def msg(str)
-        self.class.msg(str)
+      def self.verify_git_version!
+        git.require_version!(REQUIRED_GIT_VERSION)
       end
 
-      def in_work_branch
-        # make sure there is a git repository
-        begin
-          old_branch = get_current_branch
-        rescue => e
-          msg "Error occured: #{e.message}"
-          raise e
-        end
+      def bail_on_local_changes!
+        git.ensure_clean!
+      end
 
-        create_work_branch
-        work_head = get_work_head
+      def with_reset_on_error
+        work_head = git.head
 
         begin
-          invoke(:git_checkout, WORK_BRANCH)
           yield
-        rescue => e
-          msg "Error occured: #{e.message}"
-          if get_current_branch == WORK_BRANCH
-            msg "Resetting '#{WORK_BRANCH}' to '#{work_head}'."
-            invoke(:git_reset_hard, work_head)
+        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
-          raise e
-        ensure
-          invoke(:git_checkout, old_branch)
+        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

data/lib/braid/commands/add.rb

@@ -1,54 +1,43 @@
 module Braid
   module Commands
     class Add < Command
-      def run(remote, options = {})
-        raise Braid::Git::LocalChangesPresent if invoke(:local_changes?)
+      def run(url, options = {})
+        bail_on_local_changes!
 
-        in_work_branch do
-          mirror, params = config.add_from_options(remote, options)
-          local_branch = get_local_branch_name(mirror, params)
+        with_reset_on_error do
+          mirror = config.add_from_options(url, options)
 
-          config.update(mirror, { "local_branch" => local_branch })
-          params["local_branch"] = local_branch # TODO check
-
-          msg "Adding #{params["type"]} mirror of '#{params["remote"]}'" + (params["type"] == "git" ? ", branch '#{params["branch"]}'" : "") + "."
+          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)
-          fetch_remote(params["type"], local_branch)
-
-          validate_revision_option(params, options)
-          target = determine_target_commit(params, options)
+          mirror.fetch
 
-          msg "Merging code into '#{mirror}/'."
+          new_revision = validate_new_revision(mirror, options["revision"])
+          target_hash = determine_target_commit(mirror, new_revision)
 
-          unless params["squash"]
-            invoke(:git_merge_ours, target)
+          unless mirror.squashed?
+            git.merge_ours(target_hash)
           end
-          invoke(:git_read_tree, target, mirror)
+          git.read_tree(target_hash, mirror.path)
 
-          config.update(mirror, { "revision" => options["revision"] })
+          mirror.revision = new_revision
+          mirror.lock = new_revision if options["revision"]
+          config.update(mirror)
           add_config_file
 
-          revision_message = options["revision"] ? " at #{display_revision(params["type"], options["revision"])}" : ""
-          commit_message = "Add mirror '#{mirror}/'#{revision_message}."
-          invoke(:git_commit, commit_message)
+          commit_message = "Add mirror '#{mirror.path}/'#{revision_message}"
+          git.commit(commit_message)
         end
       end
 
-      protected
-        def setup_remote(mirror)
-          Braid::Command.run(:setup, mirror)
-        end
-
       private
-        def get_local_branch_name(mirror, params)
-          res = "braid/#{params["type"]}/#{mirror}"
-          res << "/#{params["branch"]}" if params["type"] == "git"
-          res.gsub!("_", '-') # stupid git svn changes all _ to ., weird
-          res
+        def setup_remote(mirror)
+          Command.run(:setup, mirror.path)
         end
     end
   end