norbert-braid 0.4.9

data/lib/braid/config.rb

@@ -0,0 +1,101 @@
+require 'yaml'
+require 'yaml/store'
+
+module Braid
+  class Config
+    class PathAlreadyInUse < BraidError
+      def message
+        "path already in use: #{super}"
+      end
+    end
+    class MirrorDoesNotExist < BraidError
+      def message
+        "mirror does not exist: #{super}"
+      end
+    end
+
+    def initialize(config_file = CONFIG_FILE)
+      @db = YAML::Store.new(config_file)
+    end
+
+    def add_from_options(url, options)
+      mirror = Mirror.new_from_options(url, options)
+
+      add(mirror)
+      mirror
+    end
+
+    def mirrors
+      @db.transaction(true) do
+        @db.roots
+      end
+    end
+
+    def get(path)
+      @db.transaction(true) do
+        if attributes = @db[path.to_s.sub(/\/$/, '')]
+          Mirror.new(path, attributes)
+        end
+      end
+    end
+
+    def get!(path)
+      mirror = get(path)
+      raise MirrorDoesNotExist, path unless mirror
+      mirror
+    end
+
+    def add(mirror)
+      @db.transaction do
+        raise PathAlreadyInUse, mirror.path if @db[mirror.path]
+        write_mirror(mirror)
+      end
+    end
+
+    def remove(mirror)
+      @db.transaction do
+        @db.delete(mirror.path)
+      end
+    end
+
+    def update(mirror)
+      @db.transaction do
+        raise MirrorDoesNotExist, mirror.path unless @db[mirror.path]
+        @db.delete(mirror.path)
+        write_mirror(mirror)
+      end
+    end
+
+    def valid?
+      @db.transaction(true) do
+        !@db.roots.any? do |path|
+          @db[path]["url"].nil?
+        end
+      end
+    end
+
+    def migrate!
+      @db.transaction do
+        @db.roots.each do |path|
+          attributes = @db[path]
+          if attributes["local_branch"]
+            attributes["url"] = attributes.delete("remote")
+            attributes["remote"] = attributes.delete("local_branch")
+            attributes["squashed"] = attributes.delete("squash")
+            attributes["lock"] = attributes["revision"] # so far this has always been true
+          end
+          @db[path] = clean_attributes(attributes)
+        end
+      end
+    end
+
+    private
+      def write_mirror(mirror)
+        @db[mirror.path] = clean_attributes(mirror.attributes)
+      end
+
+      def clean_attributes(hash)
+        hash.reject { |k,v| v.nil? }
+      end
+  end
+end

data/lib/braid/mirror.rb

@@ -0,0 +1,168 @@
+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.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.fetch(remote)
+      else
+        git_svn.fetch(remote)
+      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 base_revision
+        if revision
+          unless type == "svn"
+            git.rev_parse(revision)
+          else
+            git_svn.commit_hash(remote, revision)
+          end
+        else
+          inferred_revision
+        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,297 @@
+require 'singleton'
+require 'rubygems'
+require 'open4'
+
+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)
+        @command = command
+        @version = version.to_s.split("\n").first
+      end
+
+      def message
+        "#{@command} version too low: #{@version}"
+      end
+    end
+    class UnknownRevision < BraidError
+      def message
+        "unknown revision: #{super}"
+      end
+    end
+    class LocalChangesPresent < BraidError
+      def message
+        "local changes are present"
+      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))
+      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
+          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
+    end
+
+    class Git < Proxy
+      def commit(message, *args)
+        status, out, err = exec("git commit -m #{message.inspect} --no-verify #{args.join(' ')}")
+
+        if status == 0
+          true
+        elsif out.match(/nothing.* to commit/)
+          false
+        else
+          raise ShellExecutionError, err
+        end
+      end
+
+      def fetch(remote)
+        # open4 messes with the pipes of index-pack
+        system("git fetch -n #{remote} &> /dev/null")
+        raise ShellExecutionError, "could not fetch" unless $? == 0
+        true
+      end
+
+      def checkout(treeish)
+        # TODO debug
+        msg "Checking out '#{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_exists?(remote)
+        # TODO clean up and maybe return more information
+        !!File.readlines(".git/config").find { |line| line =~ /^\[(svn-)?remote "#{Regexp.escape(remote)}"\]/ }
+      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
+      end
+
+      def read_tree(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
+
+      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.instance.rev_parse(part) # FIXME ugly ugly ugly
+      end
+
+      def fetch(remote)
+        # open4 messes with the pipes of index-pack
+        system("git svn fetch #{remote} &> /dev/null")
+        raise ShellExecutionError, "could not fetch" unless $? == 0
+        true
+      end
+
+      def init(remote, path)
+        invoke(:init, "-R", remote, "--id=#{remote}", path)
+        true
+      end
+
+      private
+        def command(name)
+          "#{self.class.command} #{name}"
+        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
+
+    module VersionControl
+      def git
+        Git.instance
+      end
+
+      def git_svn
+        GitSvn.instance
+      end
+
+      def svn
+        Svn.instance
+      end
+    end
+  end
+end
+
+

data/lib/braid.rb

@@ -0,0 +1,23 @@
+$:.unshift File.dirname(__FILE__)
+
+module Braid
+  VERSION = "0.4.9"
+
+  CONFIG_FILE = ".braids"
+  REQUIRED_GIT_VERSION = "1.5.4.5"
+
+  class BraidError < StandardError
+    def message
+      value = super
+      value if value != self.class.name
+    end
+  end
+end
+
+require 'braid/operations'
+require 'braid/mirror'
+require 'braid/config'
+require 'braid/command'
+Dir[File.dirname(__FILE__) + '/braid/commands/*'].each do |file|
+  require file
+end

data/test/braid_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+describe "Braid" do
+  it "puts the lotion in the basket" do
+    # dedicated to dblack
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+describe_shared "Braid::Config, in general" do
+  db = "tmp.yml"
+
+  before(:each) do
+    @config = Braid::Config.new(db)
+  end
+
+  after(:each) do
+    FileUtils.rm(db) rescue nil
+  end
+end
+
+describe "Braid::Config, when empty" do
+  it_should_behave_like "Braid::Config, in general"
+
+  it "should not get a mirror by name" do
+    @config.get("path").should.be.nil
+    lambda { @config.get!("path") }.should.raise(Braid::Config::MirrorDoesNotExist)
+  end
+
+  it "should add a mirror and its params" do
+    @mirror = build_mirror
+    @config.add(@mirror)
+    @config.get("path").path.should.not.be.nil
+  end
+end
+
+describe "Braid::Config, with one mirror" do
+  it_should_behave_like "Braid::Config, in general"
+
+  before(:each) do
+    @mirror = build_mirror
+    @config.add(@mirror)
+  end
+
+  it "should get the mirror by name" do
+    @config.get("path").should == @mirror
+    @config.get!("path").should == @mirror
+  end
+
+  it "should raise when trying to overwrite a mirror on add" do
+    lambda { @config.add(@mirror) }.should.raise(Braid::Config::PathAlreadyInUse)
+  end
+
+  it "should remove the mirror" do
+    @config.remove(@mirror)
+    @config.get("path").should.be.nil
+  end
+
+  it "should update the mirror with new params" do
+    @mirror.branch = "other"
+    @config.update(@mirror)
+    @config.get("path").attributes.should == { "branch" => "other" }
+  end
+
+  it "should raise when trying to update nonexistent mirror" do
+    @mirror.instance_variable_set("@path", "other")
+    lambda { @config.update(@mirror) }.should.raise(Braid::Config::MirrorDoesNotExist)
+  end
+end