ed 0.2.1 → 0.3.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Robert Gleeson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -55,11 +55,8 @@ _supported_
 
 * Rubinius
 * CRuby (1.8 / 1.9)
-
-_unsupported_
-
-* JRuby
-* MacRuby
+* JRuby (support implemented without `Kernel#fork`.)
+* MacRuby (support implemented without `Kernel#fork`.)
 
 __INSTALL__
 

data/lib/ed.rb

@@ -1,5 +1,7 @@
 require 'observe'
 require 'ed/version'
+require 'ed/env'
+require 'ed/config'
 require 'ed/repository'
 require 'ed/context'
 require 'ed/core_ext/object'
@@ -8,6 +10,25 @@ class Ed
 
   include Observe
 
+  class << self
+    
+    #
+    # @example
+    #   Ed.configure do |config|
+    #     config.fork = true
+    #   end
+    #
+    # @yieldparam config
+    #   (see Ed::Config.change) 
+    #
+    # @return [void]
+    #
+    def configure &block
+      Ed::Config.change(&block)
+    end
+
+  end
+
   #
   # @param [String] path
   #   The path to a git repository.
@@ -21,7 +42,7 @@ class Ed
     @repo = Ed::Repository.new(path)
 
     if block_given? 
-      yield(self)
+      yield self
     end
   end
 
@@ -29,6 +50,9 @@ class Ed
   # @param [Proc] block
   #   A block executed before {#commit}, {#branch}, or {#tag} is called. 
   #
+  # @yieldparam [String] path
+  #   The path to the repository on local disk.
+  #
   # @return [void]
   #
   def before &block
@@ -37,29 +61,44 @@ class Ed
 
   #
   # @param [String] commit 
-  #   Any string that is passable to 'git checkout'.
+  #   A string you can pass to 'git checkout'.
   #
   # @param [Proc] block
   #   A block executed while the repository has switched to 'commit'.
   #
+  # @yieldparam [String] path
+  #   The path to the repository on local disk.
+  #
+  # @return [void] 
+  #
   def commit commit, &block
-    switch(commit, &block)
+    if Ed::Config.fork? 
+      pid = fork { 
+        switch(commit, &block) 
+      }
+
+      Process.wait(pid) 
+    else
+      switch(commit, &block)
+    end
   end
   alias_method :tag   , :commit
   alias_method :branch, :commit
-
-  
+ 
+  #
+  # Switches to 'commit', and runs &block.
+  #
+  # @param commit
+  #   (see Ed#commit)
+  #
+  # @param block
+  #   (see Ed#commit)
+  #
   def switch(commit, &block)
-    pid = fork do
-      @repo.checkout '-q', commit 
-      notify_observers(:before_filter, @repo.path)
-      block.call(@repo.path) 
-    end
-
-    Process.wait(pid)
+    @repo.checkout '-q', commit 
+    notify_observers(:before_filter, @repo.path)
+    block.call(@repo.path) 
   end
   private :switch
 
 end
-
-

data/lib/ed/config.rb

@@ -0,0 +1,75 @@
+require 'pathname'
+
+module Ed::Config 
+  
+  class << self 
+
+    #
+    # @yieldparam [Ed::Config] config
+    #   Yields {Ed::Config}.
+    #
+    # @example
+    #   
+    #   Ed::Config.change do |config|
+    #     config.fork = false
+    #   end
+    #
+    def change 
+      yield self 
+    end
+
+    #
+    # @param [String, #to_s] path
+    #   The path to use when storing cloned repositories.
+    #
+    # @return [Pathname]
+    #
+    def repo_dir= path
+      @repo_dir = Pathname.new path.to_s
+    end
+
+    #
+    # @return [Pathname] 
+    #   The path being used to store cloned repositories.
+    #
+    def repo_dir
+      @repo_dir
+    end
+    
+    #
+    # @param [Boolean] value
+    #   Enable or disable the creation of a subprocess before checking out a commit.
+    #
+    # @return [Boolean]
+    #
+    def fork= value
+      if value && Ed::Env.fork_unavailable?
+        raise ArgumentError, 'Kernel#fork is not available on your platform.'
+      end
+
+      @fork = value
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true if a subprocess is created before checking out a commit. 
+    #
+    def fork
+      @fork
+    end
+    alias_method :fork?, :fork
+
+  end
+
+  change do |config|
+    config.fork = false
+
+    if Ed::Env.windows?
+      config.repo_dir = ::ENV["TEMP"]
+    else
+      config.repo_dir = ::ENV["TMPDIR"] || "/tmp"
+    end
+  end
+
+end
+

data/lib/ed/env.rb

@@ -0,0 +1,40 @@
+module Ed::Env
+
+  class << self
+    #
+    # @return [Boolean]
+    #   Are we on Windows?
+    #
+    def windows?
+      RUBY_PLATFORM['mswin32'] ||
+      RUBY_PLATFORM['mingw']   ||
+      RUBY_PLATFORM['cygwin']  
+    end
+
+    #
+    # @return [Boolean]
+    #   Are we on JRuby?
+    #
+    def jruby?
+      RUBY_PLATFORM == 'java'
+    end
+
+    #
+    # @return [Boolean]
+    #   Are we on MacRuby?
+    #
+    def macruby?
+      defined?(RUBY_ENGINE) && RUBY_ENGINE == 'macruby'
+    end
+
+    #
+    # @return [Boolean]
+    #   Returns true if Kernel#fork is unavailable.
+    #
+    def fork_unavailable?
+      macruby? || jruby? || windows?
+    end
+
+  end
+
+end

data/lib/ed/repository.rb

@@ -30,6 +30,14 @@ class Ed::Repository
       @path = path.to_s
       @copy = false
     end
+
+    parent = Process.pid
+
+    ObjectSpace.define_finalizer(self) do
+      if parent == Process.pid
+        FileUtils.rm_rf(@path)
+      end
+    end
   end
 
   #
@@ -38,26 +46,25 @@ class Ed::Repository
   #
   # @return [void]
   #
-  def checkout *options
-    git "checkout", *options
+  def checkout *args
+    git "checkout", *args
   end
 
   #
   # @param [String] from 
   #   The path to copy from.
   #
-  # @param [String] to
-  #   The path to copy to.
-  #
   # @return [String]
   #   The path to the copied repository.
   #
-  def copy! from, to = "/tmp/#{Process.pid}-#{Thread.current.object_id}.ed" 
+  def copy! from
+    to = File.join(Ed::Config.repo_dir, "ed/#{Process.pid}/#{object_id}")
+
     unless File.exists? to
       FileUtils.mkdir_p(to) 
       system 'git', 'clone', '-q', from, to
     end
-
+    
     to
   end
   private :copy!

data/lib/ed/version.rb

@@ -1,3 +1,3 @@
 class Ed
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ed
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-14 00:00:00.000000000 Z
+date: 2012-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observe
-  requirement: &70336697199260 !ruby/object:Gem::Requirement
+  requirement: &70173273170720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70336697199260
+  version_requirements: *70173273170720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70336697198720 !ruby/object:Gem::Requirement
+  requirement: &70173273169240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70336697198720
+  version_requirements: *70173273169240
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70336697198240 !ruby/object:Gem::Requirement
+  requirement: &70173273168380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70336697198240
+  version_requirements: *70173273168380
 description: A Domain Specific Language(DSL) that you can use to talk to Git from
   Ruby.
 email:
@@ -55,6 +55,7 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - ed.gemspec
@@ -62,8 +63,10 @@ files:
 - examples/pry.rb
 - examples/test-suite.rb
 - lib/ed.rb
+- lib/ed/config.rb
 - lib/ed/context.rb
 - lib/ed/core_ext/object.rb
+- lib/ed/env.rb
 - lib/ed/repository.rb
 - lib/ed/version.rb
 - test/setup.rb
@@ -80,18 +83,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -643359230186522538
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -643359230186522538
 requirements: []
 rubyforge_project: Ed
 rubygems_version: 1.8.11
@@ -101,3 +98,4 @@ summary: A Domain Specific Language(DSL) that you can use to talk to Git from Ru
 test_files:
 - test/setup.rb
 - test/test_ed.rb
+has_rdoc: