ed 0.7.0 → 0.8.0

data/.travis.yml

@@ -1,14 +1,6 @@
-
 rvm: 
-  - 1.8.7 # (current default)
   - 1.9.2
   - 1.9.3
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - ruby-head
-  - ree
 
 notifications:
   irc: "irc.freenode.org#flowof.info"

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/README.md

@@ -11,40 +11,28 @@ __OVERVIEW__
 
 __DESCRIPTION__
 
-  A Domain Specific Language(DSL) that you can use to talk to Git from Ruby.  
-  It isn't intended to be a full interface to Git, but a very small subset of  
-  one that you can use to check out commits and then run Ruby code in the  
-  context of those commits.
-
-__USE CASES__
-
-  * Run test suites against different tags, commits, and branches inside Ruby.
-  * Profile different tags, commits, and branches against one another inside Ruby. 
-  * Explore code in different tags, commits, and branches using a REPL 
-    like [Pry](https://github.com/pry/pry).
-
+  Ed is a library that you can use to talk to Git from Ruby.  
+  It is useful when you'd like to run Ruby code in the context of multiple     
+  commits, tags, or branchs. 
+  
 __EXAMPLE__
 
-The example below shows how you can run a test suite against two different 
+The example below shows how you can run the test suite of two different 
 tags from a remote repository.  
 The [examples](https://github.com/robgleeson/ed/tree/master/examples) directory
 has a few other examples you might want to check out.
 
 __1.__
 
-Travel time and run the tests for tag '0.1.0' and tag '0.2.0'.  
+Run the tests for tag 'v0.1.0' and tag 'v0.2.0'.  
 
     Ed.new "git://github.com/robgleeson/observe.git" do  
       tag "v0.1.0" do |path|
-        Dir.chdir(path) do 
-          system "rake test"
-        end
+        system "cd '#{path}' && rake test"
       end
 
       tag "v0.2.0" do |path|
-        Dir.chdir(path) do
-          system "rake test"
-        end
+        system "cd '#{path}' && rake test"
       end
     end
 
@@ -52,10 +40,8 @@ __PLATFORM SUPPORT__
 
 _supported_ 
 
-* Rubinius
-* CRuby (1.8 / 1.9)
-* JRuby 
-* MacRuby 
+* CRuby 1.9
+
 
 __INSTALL__
 

data/ed.gemspec

@@ -20,7 +20,10 @@ Gem::Specification.new do |s|
 
 
   #s.add_runtime_dependency     "scm"     , "~> 0.1.0.pre1"
-  
+
+  s.required_ruby_version = "~> 1.9.1"
+
+  s.add_runtime_dependency     "shell_command", "~> 0.1.0"
   s.add_runtime_dependency     "observe" , "~> 0.2.0"
   s.add_development_dependency "rake"    , "~> 0.9.2"
   s.add_development_dependency "minitest", "~> 2.6"

data/lib/ed.rb

@@ -1,8 +1,11 @@
 require 'observe'
+require 'shell_command'
+require 'fileutils'
 require 'ed/version'
 require 'ed/env'
 require 'ed/config'
 require 'ed/repository'
+require 'ed/repository_copy'
 require 'ed/delegator'
 require 'ed/core_ext/object'
 
@@ -37,7 +40,11 @@ class Ed
   # @return [Ed]
   #
   def initialize path, &block
-    @repo = Ed::Repository.new(path)
+    if Ed::Repository.remote?(path) || Ed::Config.copy_repository?
+      @repo = Ed::RepositoryCopy.new(path)
+    else
+      @repo = Ed::Repository.new(path)
+    end
 
     if block_given?
       if block.arity == 1

data/lib/ed/config.rb

@@ -37,6 +37,23 @@ module Ed::Config
       @repo_dir
     end
 
+    #
+    # @param [Boolean]
+    #   If true, a copy of a repository is created to work off.
+    #
+    def copy_repository= value
+      @copy_repository = value
+    end
+
+    #
+    # @return [Boolean]
+    #   When true, a copy of a repository is created to work off.
+    #
+    def copy_repository
+      @copy_repository
+    end
+    alias_method :copy_repository?, :copy_repository
+
     #
     # @param [Boolean] value
     #   If true is given, a subprocess is created to check out a commit.
@@ -64,6 +81,7 @@ module Ed::Config
 
   change do |config|
     config.should_fork = false
+    config.copy_repository = true
 
     if Ed::Env.windows?
       config.repo_dir = ::ENV["TEMP"]

data/lib/ed/repository.rb

@@ -1,46 +1,68 @@
-require 'fileutils'
+#
+# The {Ed::Repository} class provides a interface to talk to a Git repository.  
+# It does _not_ make a copy of the repository but works off the path it is   
+# given.
+#
+# The {Ed::RepositoryCopy} class provides the same interface as this class but  
+# it creates a working copy of the repository to allow for parallel access.  
+#
+# The default behavior is to use {Ed::RepositoryCopy} when talking to a    
+# repository but if you would like to disable copying you can use the  
+# {Ed::Config#copy_repository=} config option. You should be aware of its  
+# implications, though.
+#
 
 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
+  #
+  # @param [String] path
+  #   The URI to a git a repository.
+  #
+  # @return [Boolean]
+  #   Returns true if the path is considered to be remote.
+  #
+  def self.remote? path
+    !local?(path)
+  end
 
-      output = `git ls-remote #{args.join(' ')}`
+  #
+  # @param [String] path
+  #   The URI to a git a repository.
+  #
+  # @return [Boolean]
+  #   Returns true if the path is considered to be local.
+  #
+  def self.local? path
+    URI.parse(path).scheme == "file" || !to_s.include?(':')
+  end
 
-      output.each_line do |line|
-        sha, ref = line.split(/\s+/, 2)
-        yield sha, ref.chomp
-      end
+  #
+  # @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)
+  #
+  # @raise 
+  #   (see Ed::Repository#git)
+  #
+  # @return [Enumerator]
+  #   Returns a Enumerator if no block is given.
+  #
+  def self.ls_remote *args
+    unless block_given?
+      return enum_for(:ls_remote, *args)
     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
+    output = ShellCommand.run!("git ls-remote #{args.join(' ')}").stdout  
 
+    output.each_line do |line|
+      sha, ref = line.split(/\s+/, 2)
+      yield sha, ref.chomp
+    end
   end
 
   #
@@ -57,15 +79,7 @@ class Ed::Repository
   #   Returns a instance of {Ed::Repository}.
   #
   def initialize path
-    @path = copy!(path.to_s)
-
-    parent = Process.pid
-
-    at_exit do
-      if parent == Process.pid
-        FileUtils.rm_rf(@path)
-      end
-    end
+    @path = path
   end
 
   #
@@ -79,49 +93,18 @@ class Ed::Repository
   end
 
   #
-  # @param [String] from
-  #   The URI to copy from.
-  #
-  # @return [String]
-  #   The path to the copied repository.
+  # Provides low-level access to the git binary in the context of {#path}.
   #
-  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)
-
-      sha, _ =
-      remotes.find do |_, ref|
-        ref == 'HEAD'
-      end
-    end
-
-    #
-    # 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!
-
+  # @raise [ShellCommand::Exception]
+  #   If git exits with a status code that is non-zero.
   #
-  # Provides low-level access to the git binary in the context of {#path}.
-  # @return [void]
+  # @return [ShellCommand::Command]
   #
   def git *args
-    system "git", "--git-dir=#{@path}/.git", "--work-tree=#{@path}", *args
+    ShellCommand.run! "git",
+                      "--git-dir=#{@path}/.git", 
+                      "--work-tree=#{@path}", 
+                      *args
   end
   private :git
 

data/lib/ed/repository_copy.rb

@@ -0,0 +1,96 @@
+#
+# A {Ed::RepositoryCopy} is a subclass of {Ed::Repository} but with a distinct   
+# difference: it creates a copy of the repository it provides a interface to.    
+#
+# By creating copies, it can allow parallel access to the same repository  
+# because every instance of {Ed::RepositoryCopy} has its own copy of the  
+# repository to work off.  
+#
+# All remote repositories are _always_ instances of {Ed::RepositoryCopy}, and  
+# local repositories can be copied, too. It is recommended to create copies if  
+# you plan to access the same repository in parallel (either from Ed, or  
+# outside Ed).  
+#
+# The default behavior is to create a copy all the time, but it can be  
+# configured from {Ed::Config.copy_repository=}. A {RepositoryCopy} is cached  
+# per-thread, and lives for the life of a process but for no longer, it is  
+# destroyed when the process exits.  
+#
+
+class Ed::RepositoryCopy < Ed::Repository
+
+  #
+  # @param
+  #   (see Ed::Repository#initialize)
+  #
+  # @return [Ed::RepositoryCopy]
+  #   Returns a instance of {Ed::RepositoryCopy}.
+  #
+  def initialize path
+    @source   = path
+    @path     = copy!
+    @copy_dir = nil
+
+    parent = Process.pid
+
+    at_exit do
+      if parent == Process.pid
+        FileUtils.rm_rf(@path.to_s)
+      end
+    end
+  end
+
+  #
+  # @param [String] from
+  #   The URI to copy from.
+  #
+  # @raise 
+  #   (see Ed::Repository#git) 
+  #
+  # @return [String]
+  #   The path to the copied repository.
+  #
+  def copy!
+    unless File.exists? copy_dir
+      FileUtils.mkdir_p copy_dir
+      ShellCommand.run! 'git', 'clone', '-q', @source, copy_dir
+    end
+
+    copy_dir
+  end
+  private :copy!
+
+  #
+  # @raise 
+  #   (see Ed::Repository#git)
+  #
+  # @return [String]
+  #   Returns the directory path a repository can be copied into.
+  # 
+  def copy_dir
+    if @copy_dir
+      return @copy_dir
+    end
+
+    commit    = nil
+    repo      = File.basename(@source)
+    pid       = Process.pid
+    thread_id = Thread.current.object_id
+
+    if Ed::Repository.local?(@source)
+      commit = ShellCommand.run!("git --git-dir=#{@source}/.git HEAD").stdout
+    else
+      remotes = Ed::Repository.ls_remote(@source)
+
+      commit, _ =
+      remotes.find do |_, ref|
+        ref == 'HEAD'
+      end
+    end
+
+    @copy_dir =
+    File.join Ed::Config.repo_dir, "ed/#{repo}/#{pid}/#{thread_id}/#{commit}"
+  end
+  private :copy_dir
+
+end

data/lib/ed/version.rb

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

data/test/test_ed.rb

@@ -43,13 +43,13 @@ context Ed do
     end
 
     it 'must clone and store the repository locally.' do
-      File.exists?(@repo.path).must_equal(true)
+      File.exists?(@repo.path.to_s).must_equal(true)
     end
 
     it 'must checkout the "0.1.0" tag.' do
       Tempfile.open "assertion" do |tmpfile|
         @ed.setup do |path|
-          $: << File.join(path, "lib")
+          $: << File.join(path.to_s, "lib")
           require 'thread'
           require 'barney'
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ed
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000 Z
+date: 2012-02-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: shell_command
+  requirement: &70357890439740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70357890439740
 - !ruby/object:Gem::Dependency
   name: observe
-  requirement: &70119687020140 !ruby/object:Gem::Requirement
+  requirement: &70357890439280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +32,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70119687020140
+  version_requirements: *70357890439280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70119687019520 !ruby/object:Gem::Requirement
+  requirement: &70357890438800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70119687019520
+  version_requirements: *70357890438800
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70119687019020 !ruby/object:Gem::Requirement
+  requirement: &70357890438320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +54,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70119687019020
+  version_requirements: *70357890438320
 description: A Domain Specific Language(DSL) that you can use to talk to Git from
   Ruby.
 email:
@@ -54,6 +65,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,6 +80,7 @@ files:
 - lib/ed/delegator.rb
 - lib/ed/env.rb
 - lib/ed/repository.rb
+- lib/ed/repository_copy.rb
 - lib/ed/version.rb
 - test/setup.rb
 - test/test_ed.rb
@@ -80,12 +93,9 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ~>
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 1406613959917538667
+      version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -94,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1406613959917538667
+      hash: -3106733997781854880
 requirements: []
 rubyforge_project: Ed
 rubygems_version: 1.8.15