ed 0.6.0 → 0.7.0

data/.travis.yml

@@ -3,7 +3,10 @@ rvm:
   - 1.8.7 # (current default)
   - 1.9.2
   - 1.9.3
-  - rbx-2.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
   - ruby-head
   - ree
 

data/README.md

@@ -16,13 +16,7 @@ __DESCRIPTION__
   one that you can use to check out commits and then run Ruby code in the  
   context of those commits.
 
-  So, for example, you might want to check out tag 'v0.1.0' and tag 'v0.2.0' to   
-  run the tests of both tags, or benchmark code from one commit against another,   
-  those kind of tasks.    
-
-__WHY?__
-
-  So I could: 
+__USE CASES__
 
   * Run test suites against different tags, commits, and branches inside Ruby.
   * Profile different tags, commits, and branches against one another inside Ruby. 

data/examples/pry.rb

@@ -1,10 +1,17 @@
 require "ed"
 require "pry"
 
-Repository "git://github.com/robgleeson/barney.git" do
-  before :each do |path|
-    $: << File.join(path, "lib/")
-    require "barney"
+Ed.configure do |config|
+  # Create a subprocess for each tag we switch to.
+  # It keeps the address space clean, and allows us to
+  # 'require "barney"' twice.
+  config.should_fork = true
+end
+
+Ed.new "git://github.com/robgleeson/barney.git" do
+  setup do |path|
+    $LOAD_PATH << File.join(path, "lib/")
+    require 'barney'
   end
 
   tag "0.1.0" do

data/lib/ed.rb

@@ -12,14 +12,13 @@ class Ed
 
   #
   # @example
-  #   Ed.configure do |config|
-  #     config.fork = true
-  #   end
+  #   (see Ed::Config.change)
   #
-  # @yieldparam config
+  # @yieldparam
   #   (see Ed::Config.change)
   #
-  # @return [void]
+  # @return
+  #   (see Ed::Config.change)
   #
   def self.configure &block
     Ed::Config.change(&block)
@@ -29,8 +28,11 @@ class Ed
   # @param [String] path
   #   The path to a git repository.
   #
+  # @param [Proc] &block
+  #   Executed in the scope of {Ed::Delegator}.
+  #
   # @yieldparam [Ed] _self
-  #   Yields self, if a block is given.
+  #   Yields self, if a block parameter is given.
   #
   # @return [Ed]
   #
@@ -49,15 +51,15 @@ class Ed
 
   #
   # @param [Proc] block
-  #   Executed before the block for {#commit}, {#tag} or #{branch} is run.
+  #   Executed each time {#commit}, {#tag} or {#branch} is called.
   #
   # @yieldparam [String] path
   #   The path to the repository on local disk.
   #
   # @return [void]
   #
-  def before stage, &block
-    add_observer(:before_filter, &block)
+  def setup &block
+    add_observer(:setup_block, &block)
   end
 
   #
@@ -65,7 +67,7 @@ class Ed
   #   A valid git commit, or git commit reference(tag or branch name).
   #
   # @param [Proc] block
-  #   Executed while the repository has switched to 'commit'.
+  #   Executed while the repository has switched to _commit_.
   #
   # @yieldparam [String] path
   #   The path to the repository on local disk.
@@ -73,7 +75,7 @@ class Ed
   # @return [void]
   #
   def commit commit, &block
-    if Ed::Config.fork?
+    if Ed::Config.should_fork?
       pid = fork do
         switch(commit, &block)
       end
@@ -97,7 +99,7 @@ class Ed
   #
   def switch commit, &block
     @repo.checkout '-q', commit
-    notify_observers(:before_filter, @repo.path)
+    notify_observers(:setup_block, @repo.path)
     block.call(@repo.path)
   end
   private :switch

data/lib/ed/config.rb

@@ -11,7 +11,7 @@ module Ed::Config
     # @example
     #
     #   Ed::Config.change do |config|
-    #     config.fork = false
+    #     config.should_fork = true
     #   end
     #
     def change
@@ -20,7 +20,7 @@ module Ed::Config
 
     #
     # @param [String, #to_s] path
-    #   The path to use when storing cloned repositories.
+    #   The path to use for storing cloned repositories.
     #
     # @return [Pathname]
     #
@@ -30,7 +30,8 @@ module Ed::Config
 
     #
     # @return [Pathname]
-    #   The path being used to store cloned repositories.
+    #  The path being used to store cloned repositories.
+    #
     #
     def repo_dir
       @repo_dir
@@ -38,31 +39,31 @@ module Ed::Config
 
     #
     # @param [Boolean] value
-    #   Enable or disable the creation of a subprocess to check out a commit.
+    #   If true is given, a subprocess is created to check out a commit.
     #
     # @return [Boolean]
     #
-    def fork= value
+    def should_fork= value
       if value && Ed::Env.fork_unavailable?
         raise ArgumentError, 'Kernel#fork is not available on your platform.'
       end
 
-      @fork = value
+      @should_fork = value
     end
 
     #
     # @return [Boolean]
     #   Returns true if a subprocess is created to check out a commit.
     #
-    def fork
-      @fork
+    def should_fork
+      @should_fork
     end
-    alias_method :fork?, :fork
+    alias_method :should_fork?, :should_fork
 
   end
 
   change do |config|
-    config.fork = false
+    config.should_fork = false
 
     if Ed::Env.windows?
       config.repo_dir = ::ENV["TEMP"]

data/lib/ed/core_ext/object.rb

@@ -1,22 +1,15 @@
 #
-# @param [String] path
-#   The URI to a git repository.
+# @param
+#   (see Ed#initialize)
 #
-# @param [Proc] &block
-#   Executed in the calling scope, or within the scope of {Ed::Delegator}.
+# @yieldparam
+#   (see Ed#initialize)
 #
-# @yieldparam [Ed] repo
-#   Optionally yields an instance of {Ed}.
-#
-# @return [void]
+# @return
+#   (see Ed#initialize)
 #
 def Repository path, &block
-  if block.arity == 1
-    block.call Ed.new(path)
-  else
-    delegator = Ed::Delegator.new Ed.new(path)
-    delegator.instance_eval(&block)
-  end
+  Ed.new path, &block
 end
 
 

data/lib/ed/delegator.rb

@@ -10,13 +10,13 @@ class Ed::Delegator
 
   #
   # @param block
-  #   (see Ed#before)
+  #   (see Ed#setup)
   #
   # @return
-  #   (see Ed#before)
+  #   (see Ed#setup)
   #
-  def before stage, &block
-    @__delegate__.before(stage, &block)
+  def setup &block
+    @__delegate__.setup(&block)
   end
 
   #

data/lib/ed/repository.rb

@@ -2,38 +2,66 @@ require 'fileutils'
 
 class Ed::Repository
 
+  class << self
+
+    #
+    # @param [String] *args
+    #   The same commands given to 'git ls-remote'.
+    #
+    # @yieldparam [String] sha
+    #   The commit SHA.
+    #
+    # @yieldparam [String] ref
+    #   The reference (e.g: HEAD, tag, or branch)
+    #
+    # @return [Enumerator]
+    #   Returns a Enumerator if no block is given.
+    #
+    def ls_remote *args
+      unless block_given?
+        return enum_for(:ls_remote, *args)
+      end
+
+      output = `git ls-remote #{args.join(' ')}`
+
+      output.each_line do |line|
+        sha, ref = line.split(/\s+/, 2)
+        yield sha, ref.chomp
+      end
+    end
+
+    #
+    # @param [String] path
+    #   The URI to a git a repository.
+    #
+    # @return [Boolean]
+    #   Returns true if the repository is considered to exist on filesystem.
+    #
+    def is_local? path
+      path[0..6] == "file://" || !path.include?(":")
+    end
+
+  end
+
   #
   # @return [String]
   #   The path to the repository on local disk.
   #
-  attr_reader  :path
-  
-  #
-  # @return [Boolean] 
-  #   Has the repository been copied?
-  #
-  attr_reader  :copy
-  alias_method :copy?, :copy
+  attr_reader :path
 
   #
   # @param [String, #to_s] path
   #   The URI to a git repository.
   #
-  # @param [Boolean] copy
-  #   If true, a copy of the repository is created.
+  # @return [Ed::Repository]
+  #   Returns a instance of {Ed::Repository}.
   #
-  def initialize path, copy = true
-    if copy
-      @path = copy!(path.to_s)
-      @copy = true
-    else
-      @path = path.to_s
-      @copy = false
-    end
+  def initialize path
+    @path = copy!(path.to_s)
 
     parent = Process.pid
 
-    ObjectSpace.define_finalizer(self) do
+    at_exit do
       if parent == Process.pid
         FileUtils.rm_rf(@path)
       end
@@ -42,7 +70,7 @@ class Ed::Repository
 
   #
   # @param [String] *options
-  #   The same commands given to 'git checkout' 
+  #   The same commands given to 'git checkout'
   #
   # @return [void]
   #
@@ -51,32 +79,49 @@ class Ed::Repository
   end
 
   #
-  # @param [String] from 
-  #   The path to copy from.
+  # @param [String] from
+  #   The URI to copy from.
   #
   # @return [String]
   #   The path to the copied repository.
   #
-  def copy! from
-    to = File.join(Ed::Config.repo_dir, "ed/#{Process.pid}/#{object_id}")
+  def copy! path
+    if Ed::Repository.is_local?(path)
+      sha = system("git", "--git-dir=#{path}/.git", "rev-parse", "HEAD")
+    else
+      remotes = Ed::Repository.ls_remote(path)
 
-    unless File.exists? to
-      FileUtils.mkdir_p(to) 
-      system 'git', 'clone', '-q', from, to
+      sha, _ =
+      remotes.find do |_, ref|
+        ref == 'HEAD'
+      end
     end
-    
-    to
+
+    #
+    # Directory layout:
+    # <REPO_DIR>/ed/<REPO_NAME>/<PROCESS ID>/<THREAD ID>/<COMMIT SHA>
+    #
+    repo_name   = File.basename(path)
+    process_id  = Process.pid
+    thread_id   = Thread.current.object_id
+    namespace   = "ed/#{repo_name}/#{process_id}/#{thread_id}/#{sha}"
+    destination = File.join(Ed::Config.repo_dir, namespace)
+
+    unless File.exists? destination
+      FileUtils.mkdir_p(destination)
+      system 'git', 'clone', '-q', path, destination
+    end
+
+    destination
   end
   private :copy!
 
-  # 
-  # Provides low-level access to the git binary in the context of {#path}. 
+  #
+  # Provides low-level access to the git binary in the context of {#path}.
   # @return [void]
   #
   def git *args
-    Dir.chdir(@path) do
-      system "git", *args
-    end
+    system "git", "--git-dir=#{@path}/.git", "--work-tree=#{@path}", *args
   end
   private :git
 

data/lib/ed/version.rb

@@ -1,3 +1,3 @@
 class Ed
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/test/test_ed.rb

@@ -1,14 +1,37 @@
 context Ed do
 
   context 'initialize' do
-    it 'must instance_eval when given a block with no block parameters.' do
+    it 'must call a block (if given).' do
       mock = MiniTest::Mock.new
-      mock.expect(:ok, nil)
+      mock.expect(:message, nil)
 
       Ed.new 'git://github.com/robgleeson/IProcess.git' do
-        before :each do
-          mock.ok
-        end
+        mock.message
+      end
+
+      mock.verify
+    end
+
+    it 'must call a block with parameters (if given).' do
+      mock = MiniTest::Mock.new
+      mock.expect(:message, nil)
+
+      Ed.new 'git://github.com/robgleeson/IProcess.git' do |ed|
+        mock.message
+      end
+
+      mock.verify
+    end
+
+    it 'must yield a instance of Ed as block parameter (if given.)' do
+      Ed.new 'git://github.com/robgleeson/IProcess.git' do |ed|
+        ed.must_be_instance_of(Ed)
+      end
+    end
+
+    it 'must instance_eval when given a block with no block parameters.' do
+      Ed.new 'git://github.com/robgleeson/IProcess.git' do
+        self.must_be_instance_of(Ed::Delegator)
       end
     end
   end
@@ -25,7 +48,7 @@ context Ed do
 
     it 'must checkout the "0.1.0" tag.' do
       Tempfile.open "assertion" do |tmpfile|
-        @ed.before :each do |path|
+        @ed.setup do |path|
           $: << File.join(path, "lib")
           require 'thread'
           require 'barney'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ed
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-23 00:00:00.000000000 Z
+date: 2012-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observe
-  requirement: &70220677377500 !ruby/object:Gem::Requirement
+  requirement: &70119687020140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220677377500
+  version_requirements: *70119687020140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70220677376880 !ruby/object:Gem::Requirement
+  requirement: &70119687019520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70220677376880
+  version_requirements: *70119687019520
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70220677376400 !ruby/object:Gem::Requirement
+  requirement: &70119687019020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70220677376400
+  version_requirements: *70119687019020
 description: A Domain Specific Language(DSL) that you can use to talk to Git from
   Ruby.
 email:
@@ -85,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3748924748542527421
+      hash: 1406613959917538667
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3748924748542527421
+      hash: 1406613959917538667
 requirements: []
 rubyforge_project: Ed
 rubygems_version: 1.8.15