realityforge-braid 0.7.2

data/lib/braid/operations.rb

@@ -0,0 +1,423 @@
+require 'singleton'
+require 'rubygems'
+require defined?(JRUBY_VERSION) ? 'open3' : '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)
+
+        if defined?(JRUBY_VERSION)
+          Open3.popen3(cmd) do |stdin, stdout, stderr|
+            out = stdout.read
+            err = stderr.read
+          end
+          status = $?.exitstatus
+        else
+          status = Open4.popen4(cmd) do |pid, stdin, stdout, stderr|
+            out = stdout.read
+            err = stderr.read
+          end.exitstatus
+        end
+
+        [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)
+        cmd = "git commit --no-verify"
+        if message # allow nil
+          message_file = Tempfile.new("braid_commit")
+          message_file.print("Braid: #{message}")
+          message_file.flush
+          cmd << " -F #{message_file.path}"
+        end
+        cmd << " #{args.join(' ')}" unless args.empty?
+        status, out, err = exec(cmd)
+        message_file.unlink if message_file
+
+        if status == 0
+          true
+        elsif out.match(/nothing.* to commit/)
+          false
+        else
+          raise ShellExecutionError, err
+        end
+      end
+
+      def fetch(remote = nil, *args)
+        args.unshift "-n #{remote}" if remote
+        # open4 messes with the pipes of index-pack
+        sh("git fetch #{args.join(' ')} 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
+
+      def remote_rm(remote)
+        invoke(:remote, "rm", remote)
+        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
+
+        if defined?(JRUBY_VERSION)
+          Open3.popen3("git apply --index --whitespace=nowarn #{args.join(' ')} -") do |stdin, stdout, stderr|
+            stdin.puts(diff)
+            stdin.close
+            err = stderr.read
+          end
+          status = $?.exitstatus
+        else
+          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
+        end
+
+        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]
+        part.strip!
+        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

data/lib/braid/version.rb

@@ -0,0 +1,3 @@
+module Braid
+  VERSION = "0.7.2"
+end

data/lib/braid.rb

@@ -0,0 +1,48 @@
+$:.unshift dirname = File.dirname(__FILE__)
+require 'braid/version'
+
+module Braid
+  CONFIG_FILE          = ".braids"
+  REQUIRED_GIT_VERSION = "1.6"
+
+  def self.verbose
+    @verbose || false
+  end
+
+  def self.verbose=(new_value)
+    @verbose = !!new_value
+  end
+
+  def self.force
+    @force || false
+  end
+
+  def self.force=(new_value)
+    @force = !!new_value
+  end
+
+  def self.use_local_cache
+    [nil, "true", "1"].include?(ENV["BRAID_USE_LOCAL_CACHE"])
+  end
+
+  def self.local_cache_dir
+    File.expand_path(ENV["BRAID_LOCAL_CACHE_DIR"] || "#{ENV["HOME"]}/.braid/cache")
+  end
+
+  class BraidError < StandardError
+    def message
+      value = super
+      value if value != self.class.name
+    end
+  end
+end
+
+require dirname + '/core_ext'
+require 'braid/operations'
+require 'braid/mirror'
+require 'braid/config'
+require 'braid/command'
+
+Dir[dirname + '/braid/commands/*'].each do |file|
+  require file
+end

data/lib/core_ext.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+
+class Hash
+  def to_yaml(opts = {})
+    YAML::quick_emit(object_id, opts) do |out|
+      out.map(taguri, to_yaml_style) do |map|
+        sort.each do |k, v|
+          map.add(k, v)
+        end
+      end
+    end
+  end
+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

data/test/fixtures/shiny/README

@@ -0,0 +1,3 @@
+shiny app
+
+it uses braid to pull in a bunch of stuff!