braid 0.5

data/lib/braid/mirror.rb

@@ -0,0 +1,173 @@
+module Braid
+  class Mirror
+    TYPES = %w(git svn)
+    ATTRIBUTES = %w(url remote type branch squashed revision lock)
+
+    class UnknownType < BraidError
+      def message
+        "unknown type: #{super}"
+      end
+    end
+    class CannotGuessType < BraidError
+      def message
+        "cannot guess type: #{super}"
+      end
+    end
+    class PathRequired < BraidError
+      def message
+        "path is required"
+      end
+    end
+
+    include Operations::VersionControl
+
+    attr_reader :path, :attributes
+
+    def initialize(path, attributes = {})
+      @path = path.sub(/\/$/, '')
+      @attributes = attributes
+    end
+
+    def self.new_from_options(url, options = {})
+      url = url.sub(/\/$/, '')
+
+      branch = options["branch"] || "master"
+
+      if type = options["type"] || extract_type_from_url(url)
+        raise UnknownType, type unless TYPES.include?(type)
+      else
+        raise CannotGuessType, url
+      end
+
+      unless path = options["path"] || extract_path_from_url(url)
+        raise PathRequired
+      end
+
+      if options["rails_plugin"]
+        path = "vendor/plugins/#{path}"
+      end
+
+      remote = "braid/#{path}".gsub("_", '-') # stupid git svn changes all _ to ., weird
+      squashed = !options["full"]
+      branch = nil if type == "svn"
+
+      attributes = { "url" => url, "remote" => remote, "type" => type, "branch" => branch, "squashed" => squashed }
+      self.new(path, attributes)
+    end
+
+    def ==(comparison)
+      path == comparison.path && attributes == comparison.attributes
+    end
+
+    def type
+      # override Object#type
+      attributes["type"]
+    end
+
+    def locked?
+      !!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
+    end
+
+    def diff
+      remote_hash = git.rev_parse("#{base_revision}:")
+      local_hash = git.tree_hash(path)
+      remote_hash != local_hash ? git.diff_tree(remote_hash, local_hash, path) : ""
+    end
+
+    def fetch
+      unless type == "svn"
+        git_cache.fetch(url) if cached?
+        git.fetch(remote)
+      else
+        git_svn.fetch(remote)
+      end
+    end
+
+    def cached?
+      git.remote_url(remote) == git_cache.path(url)
+    end
+
+    def base_revision
+      if revision
+        unless type == "svn"
+          git.rev_parse(revision)
+        else
+          git_svn.commit_hash(remote, revision)
+        end
+      else
+        inferred_revision
+      end
+    end
+
+    private
+      def method_missing(name, *args)
+        if ATTRIBUTES.find { |attribute| name.to_s =~ /^(#{attribute})(=)?$/ }
+          unless $2
+            attributes[$1]
+          else
+            attributes[$1] = args[0]
+          end
+        else
+          raise NameError, "unknown attribute `#{name}'"
+        end
+      end
+
+      def inferred_revision
+        local_commits = git.rev_list("HEAD", "-- #{path}").split("\n")
+        remote_hashes = git.rev_list("--pretty=format:\"%T\"", remote).split("commit ").map do |chunk|
+          chunk.split("\n", 2).map { |value| value.strip }
+        end
+        hash = nil
+        local_commits.each do |local_commit|
+          local_tree = git.tree_hash(path, local_commit)
+          if match = remote_hashes.find { |_, remote_tree| local_tree == remote_tree }
+            hash = match[0]
+            break
+          end
+        end
+        hash
+      end
+
+      def self.extract_type_from_url(url)
+        return nil unless url
+        url.sub!(/\/$/, '')
+
+        # check for git:// and svn:// URLs
+        url_scheme = url.split(":").first
+        return url_scheme if TYPES.include?(url_scheme)
+
+        return "svn" if url[-6..-1] == "/trunk"
+        return "git" if url[-4..-1] == ".git"
+      end
+
+      def self.extract_path_from_url(url)
+        return nil unless url
+        name = File.basename(url)
+
+        if File.extname(name) == ".git"
+          # strip .git
+          name[0..-5]
+        elsif name == "trunk"
+          # use parent
+          File.basename(File.dirname(url))
+        else
+          name
+        end
+      end
+  end
+end

data/lib/braid/operations.rb

@@ -0,0 +1,385 @@
+require 'singleton'
+require 'rubygems'
+require 'open4'
+require 'tempfile'
+
+module Braid
+  module Operations
+    class ShellExecutionError < BraidError
+      def initialize(err = nil)
+        @err = err
+      end
+
+      def message
+        @err.to_s.split("\n").first
+      end
+    end
+    class VersionTooLow < BraidError
+      def initialize(command, version, required)
+        @command = command
+        @version = version.to_s.split("\n").first
+        @required = required
+      end
+
+      def message
+        "#{@command} version too low: #{@version}. #{@required} needed."
+      end
+    end
+    class UnknownRevision < BraidError
+      def message
+        "unknown revision: #{super}"
+      end
+    end
+    class LocalChangesPresent < BraidError
+      def message
+        "local changes are present"
+      end
+    end
+    class MergeError < BraidError
+      def message
+        "could not merge"
+      end
+    end
+
+    # The command proxy is meant to encapsulate commands such as git, git-svn and svn, that work with subcommands.
+    class Proxy
+      include Singleton
+
+      def self.command; name.split('::').last.downcase; end # hax!
+
+      def version
+        status, out, err = exec!("#{self.class.command} --version")
+        out.sub(/^.* version/, "").strip
+      end
+
+      def require_version(required)
+        required = required.split(".")
+        actual = version.split(".")
+
+        actual.each_with_index do |actual_piece, idx|
+          required_piece = required[idx]
+
+          return true unless required_piece
+
+          case (actual_piece <=> required_piece)
+            when -1
+              return false
+            when 1
+              return true
+            when 0
+              next
+          end
+        end
+
+        return actual.length >= required.length
+      end
+
+      def require_version!(required)
+        require_version(required) || raise(VersionTooLow.new(self.class.command, version, required))
+      end
+
+      private
+        def command(name)
+          # stub
+          name
+        end
+
+        def invoke(arg, *args)
+          exec!("#{command(arg)} #{args.join(' ')}".strip)[1].strip # return stdout
+        end
+
+        def method_missing(name, *args)
+          invoke(name, *args)
+        end
+
+        def exec(cmd)
+          cmd.strip!
+
+          previous_lang = ENV['LANG']
+          ENV['LANG'] = 'C'
+
+          out, err = nil
+          log(cmd)
+          status = Open4.popen4(cmd) do |pid, stdin, stdout, stderr|
+            out = stdout.read
+            err = stderr.read
+          end.exitstatus
+          [status, out, err]
+
+        ensure
+          ENV['LANG'] = previous_lang
+        end
+
+        def exec!(cmd)
+          status, out, err = exec(cmd)
+          raise ShellExecutionError, err unless status == 0
+          [status, out, err]
+        end
+
+        def sh(cmd, message = nil)
+          message ||= "could not fetch" if cmd =~ /fetch/
+          log(cmd)
+          `#{cmd}`
+          raise ShellExecutionError, message unless $?.exitstatus == 0
+          true
+        end
+
+        def msg(str)
+          puts "Braid: #{str}"
+        end
+
+        def log(cmd)
+          msg "Executing `#{cmd}`" if verbose?
+        end
+
+        def verbose?
+          Braid.verbose
+        end
+    end
+
+    class Git < Proxy
+      def commit(message, *args)
+
+        commit_message_file = Tempfile.new("braid_commit", ".")
+        commit_message_file.print("Braid: " + message)
+        commit_message_file.flush
+        status, out, err = exec("git commit -F #{commit_message_file.path} --no-verify #{args.join(' ')}")
+        commit_message_file.unlink
+
+        if status == 0
+          true
+        elsif out.match(/nothing.* to commit/)
+          false
+        else
+          raise ShellExecutionError, err
+        end
+      end
+
+      def fetch(remote = nil)
+        args = remote && "-n #{remote}"
+        # open4 messes with the pipes of index-pack
+        sh("git fetch #{args} 2>&1 >/dev/null")
+      end
+
+      def checkout(treeish)
+        invoke(:checkout, treeish)
+        true
+      end
+
+      # Returns the base commit or nil.
+      def merge_base(target, source)
+        invoke(:merge_base, target, source)
+      rescue ShellExecutionError
+        nil
+      end
+
+      def rev_parse(opt)
+        invoke(:rev_parse, opt)
+      rescue ShellExecutionError
+        raise UnknownRevision, opt
+      end
+
+      # Implies tracking.
+      def remote_add(remote, path, branch)
+        invoke(:remote, "add", "-t #{branch} -m #{branch}", remote, path)
+        true
+      end
+
+      # Checks git and svn remotes.
+      def remote_url(remote)
+        key = "remote.#{remote}.url"
+        begin
+          invoke(:config, key)
+        rescue ShellExecutionError
+          invoke(:config, "svn-#{key}")
+        end
+      rescue ShellExecutionError
+        nil
+      end
+
+      def reset_hard(target)
+        invoke(:reset, "--hard", target)
+        true
+      end
+
+      # Implies no commit.
+      def merge_ours(opt)
+        invoke(:merge, "-s ours --no-commit", opt)
+        true
+      end
+
+      # Implies no commit.
+      def merge_subtree(opt)
+        # TODO which options are needed?
+        invoke(:merge, "-s subtree --no-commit --no-ff", opt)
+        true
+      rescue ShellExecutionError
+        raise MergeError
+      end
+
+      def merge_recursive(base_hash, local_hash, remote_hash)
+        invoke(:merge_recursive, base_hash, "-- #{local_hash} #{remote_hash}")
+        true
+      rescue ShellExecutionError
+        raise MergeError
+      end
+
+      def read_tree_prefix(treeish, prefix)
+        invoke(:read_tree, "--prefix=#{prefix}/ -u", treeish)
+        true
+      end
+
+      def rm_r(path)
+        invoke(:rm, "-r", path)
+        true
+      end
+
+      def tree_hash(path, treeish = "HEAD")
+        out = invoke(:ls_tree, treeish, "-d", path)
+        out.split[2]
+      end
+
+      def diff_tree(src_tree, dst_tree, prefix = nil)
+        cmd = "git diff-tree -p --binary #{src_tree} #{dst_tree}"
+        cmd << " --src-prefix=a/#{prefix}/ --dst-prefix=b/#{prefix}/" if prefix
+        status, out, err = exec!(cmd)
+        out
+      end
+
+      def status_clean?
+        status, out, err = exec("git status")
+        !out.split("\n").grep(/nothing to commit/).empty?
+      end
+
+      def ensure_clean!
+        status_clean? || raise(LocalChangesPresent)
+      end
+
+      def head
+        rev_parse("HEAD")
+      end
+
+      def branch
+        status, out, err = exec!("git branch | grep '*'")
+        out[2..-1]
+      end
+
+      def apply(diff, *args)
+        err = nil
+        status = Open4.popen4("git apply --index --whitespace=nowarn #{args.join(' ')} -") do |pid, stdin, stdout, stderr|
+          stdin.puts(diff)
+          stdin.close
+
+          err = stderr.read
+        end.exitstatus
+        raise ShellExecutionError, err unless status == 0
+        true
+      end
+
+      def clone(*args)
+        # overrides builtin
+        invoke(:clone, *args)
+      end
+
+      private
+        def command(name)
+          "#{self.class.command} #{name.to_s.gsub('_', '-')}"
+        end
+    end
+
+    class GitSvn < Proxy
+      def self.command; "git svn"; end
+
+      def commit_hash(remote, revision)
+        out = invoke(:log, "--show-commit --oneline", "-r #{revision}", remote)
+        part = out.to_s.split(" | ")[1]
+        raise UnknownRevision, "r#{revision}" unless part
+        git.rev_parse(part)
+      end
+
+      def fetch(remote)
+        sh("git svn fetch #{remote} 2>&1 >/dev/null")
+      end
+
+      def init(remote, path)
+        invoke(:init, "-R", remote, "--id=#{remote}", path)
+        true
+      end
+
+      private
+        def command(name)
+          "#{self.class.command} #{name}"
+        end
+
+        def git
+          Git.instance
+        end
+    end
+
+    class Svn < Proxy
+      def clean_revision(revision)
+        revision.to_i if revision
+      end
+
+      def head_revision(path)
+        # not using svn info because it's retarded and doesn't show the actual last changed rev for the url
+        # git svn has no clue on how to get the actual HEAD revision number on it's own
+        status, out, err = exec!("svn log -q --limit 1 #{path}")
+        out.split(/\n/).find { |x| x.match /^r\d+/ }.split(" | ")[0][1..-1].to_i
+      end
+    end
+
+    class GitCache
+      include Singleton
+
+      def fetch(url)
+        dir = path(url)
+
+        # remove local cache if it was created with --no-checkout
+        if File.exists?("#{dir}/.git")
+          FileUtils.rm_r(dir)
+        end
+
+        if File.exists?(dir)
+          Dir.chdir(dir) do
+            git.fetch
+          end
+        else
+          FileUtils.mkdir_p(local_cache_dir)
+          git.clone("--mirror", url, dir)
+        end
+      end
+
+      def path(url)
+        File.join(local_cache_dir, url.gsub(/[\/:@]/, "_"))
+      end
+
+      private
+        def local_cache_dir
+          Braid.local_cache_dir
+        end
+
+        def git
+          Git.instance
+        end
+    end
+
+    module VersionControl
+      def git
+        Git.instance
+      end
+
+      def git_svn
+        GitSvn.instance
+      end
+
+      def svn
+        Svn.instance
+      end
+
+      def git_cache
+        GitCache.instance
+      end
+    end
+  end
+end