isolate 1.3.0 → 1.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+=== 1.4.0 / 2009-09-30
+
+* Added automatic cleanup.
+* Minor code refactoring.
+
 === 1.3.0 / 2009-09-23
 
 * Add support for Gem build args. See the README for details.

data/README.rdoc

@@ -78,11 +78,17 @@ exceptions, <tt>:source</tt> and <tt>:args</tt>.
 
 === Installing Isolated Gems
 
-By default, Isolate will install your gems automatically. You can pass
-<tt>:install</tt> and <tt>:verbose</tt> options to control things:
+By default, Isolate will install and clean up your gems
+automatically. You can pass the <tt>:cleanup</tt>, <tt>:install</tt>,
+and <tt>:verbose</tt> options to control things:
+
+    # don't remove unnecesary gems
+    Isolate.gems "vendor/isolated", :cleanup => false do
+      ...
+    end
 
     # install, but quietly
-    Isolate.gems "vendor/isolated" :verbose => false do
+    Isolate.gems "vendor/isolated", :verbose => false do
       ...
     end
 
@@ -129,16 +135,13 @@ the preinitializer:
       # Twitter authentication
       gem "oauth", "~> 0.3"
 
-      environment :development, :test do
-        gem "modelizer" # easy model factories
+      environment :cucumber, :development, :test do
+        gem "cucumber"     # stories!
+        gem "modelizer"    # easy model factories
         gem "sqlite3-ruby" # database support
         gem "vlad"         # deployment
         gem "webrat"       # integration tests
       end
-
-      environment :cucumber do
-        gem "cucumber" # stories!
-      end
     end
 
 Since this is in the preinitializer, Isolate will install and activate

data/lib/isolate.rb

@@ -1,4 +1,5 @@
 require "rubygems/dependency_installer"
+require "rubygems/uninstaller"
 require "rubygems/requirement"
 
 # Restricts +GEM_PATH+ and +GEM_HOME+ and provides a DSL for
@@ -14,9 +15,13 @@ class Isolate
     def matches? environment # :nodoc:
       environments.empty? || environments.include?(environment)
     end
+
+    def matches_spec? spec
+      self.name == spec.name and self.requirement.satisfied_by? spec.version
+    end
   end
 
-  VERSION = "1.3.0" # :nodoc:
+  VERSION = "1.4.0" # :nodoc:
 
   attr_reader :entries # :nodoc:
 
@@ -28,6 +33,7 @@ class Isolate
 
   def self.activate environment
     instance.activate environment
+    instance.cleanup if instance.cleanup?
   end
 
   # Declare an isolated RubyGems environment, installed in +path+. The
@@ -36,7 +42,7 @@ class Isolate
   #
   # Option defaults:
   #
-  #    { :install => true, :verbose => true }
+  #    { :cleanup => true, :install => true, :verbose => true }
 
   def self.gems path, options = {}, &block
     @@instance = new path, options, &block
@@ -65,9 +71,11 @@ class Isolate
     @enabled      = false
     @entries      = []
     @environments = []
-    @install      = options.key?(:install) ? options[:install] : true
     @path         = path
-    @verbose      = options.key?(:verbose) ? options[:verbose] : true
+
+    @install      = options.fetch :install, true
+    @verbose      = options.fetch :verbose, true
+    @cleanup      = @install && options.fetch(:cleanup, true)
 
     instance_eval(&block) if block_given?
   end
@@ -85,6 +93,34 @@ class Isolate
     self
   end
 
+  def cleanup
+    activated = Gem.loaded_specs.values.map { |s| s.full_name }
+    extra     = Gem.source_index.gems.values.sort.reject { |spec|
+      activated.include? spec.full_name or
+        entries.any? { |e| e.matches_spec? spec }
+    }
+
+    log "Cleaning..." unless extra.empty?
+
+    padding = extra.size.to_s.size # omg... heaven forbid you use math
+    format  = "[%0#{padding}d/%s] Nuking %s."
+    extra.each_with_index do |e, i|
+      log format % [i + 1, extra.size, e.full_name]
+
+      Gem::DefaultUserInteraction.use_ui Gem::SilentUI.new do
+        Gem::Uninstaller.new(e.name,
+                             :version     => e.version,
+                             :ignore      => true,
+                             :executables => true,
+                             :install_dir => self.path).uninstall
+      end
+    end
+  end
+
+  def cleanup? # :nodoc:
+    @cleanup
+  end
+
   def disable # :nodoc:
     return self unless enabled?
 
@@ -130,14 +166,12 @@ class Isolate
   # Restricts +gem+ calls inside +block+ to a set of +environments+.
 
   def environment *environments, &block
-    old = @environments.dup
-    @environments.concat environments.map { |e| e.to_s }
+    old = @environments
+    @environments = @environments.dup.concat environments.map { |e| e.to_s }
 
-    begin
-      instance_eval(&block)
-    ensure
-      @environments = old
-    end
+    instance_eval(&block)
+  ensure
+    @environments = old
   end
 
   # Express a gem dependency. Works pretty much like RubyGems' +gem+
@@ -147,16 +181,22 @@ class Isolate
   def gem name, *requirements
     options = Hash === requirements.last ? requirements.pop : {}
 
-    requirement = requirements.empty? ?
-      Gem::Requirement.default :
-      Gem::Requirement.new(requirements)
+    requirement = if requirements.empty? then
+                    Gem::Requirement.default
+                  else
+                    Gem::Requirement.new(requirements)
+                  end
 
-    entry = Entry.new name, requirement, @environments.dup,  options
+    entry = Entry.new name, requirement, @environments,  options
 
     entries << entry
     entry
   end
 
+  def log s
+    $stderr.puts s if verbose?
+  end
+
   def install environment = nil # :nodoc:
     env = environment.to_s if environment
 
@@ -164,15 +204,17 @@ class Isolate
       !Gem.available?(e.name, *e.requirement.as_list) && e.matches?(env)
     end
 
+    log "Isolating #{environment}..." unless installable.empty?
+
+    padding = installable.size.to_s.size # omg... heaven forbid you use math
+    format  = "[%0#{padding}d/%s] Isolating %s (%s)."
     installable.each_with_index do |e, i|
-      if verbose?
-        padding  = installable.size.to_s.size
-        progress = "[%0#{padding}d/%s]" % [i + 1, installable.size]
-        warn "#{progress} Isolating #{e.name} (#{e.requirement})."
-      end
+      log format % [i + 1, installable.size, e.name, e.requirement]
 
       old         = Gem.sources.dup
-      options     = e.options.merge :install_dir => path
+      options     = e.options.merge(:install_dir   => path,
+                                    :generate_rdoc => false,
+                                    :generate_ri   => false)
       source      = options.delete :source
       args        = options.delete :args
       Gem.sources = Array(source) if source

data/test/test_isolate.rb

@@ -4,6 +4,8 @@ require "rubygems/requirement"
 require "isolate"
 
 class TestIsolate < MiniTest::Unit::TestCase
+  WITH_HOE = "test/fixtures/with-hoe"
+
   def setup
     @isolate = Isolate.new "tmp/gems", :install => false, :verbose => false
   end
@@ -11,24 +13,25 @@ class TestIsolate < MiniTest::Unit::TestCase
   def teardown
     @isolate.disable
     Isolate.instance.disable if Isolate.instance
-    Gem::DependencyInstaller.reset_last_install
+    Gem::DependencyInstaller.reset_value
+    Gem::Uninstaller.reset_value
     FileUtils.rm_rf "tmp/gems"
   end
 
   def test_self_gems
     assert_nil Isolate.instance
 
-    Isolate.gems "test/fixtures/with-hoe" do
+    Isolate.gems WITH_HOE do
       gem "hoe"
     end
 
     refute_nil Isolate.instance
-    assert_equal "test/fixtures/with-hoe", Isolate.instance.path
+    assert_equal WITH_HOE, Isolate.instance.path
     assert_equal "hoe", Isolate.instance.entries.first.name
   end
 
   def test_activate
-    @isolate = Isolate.new "test/fixtures/with-hoe"
+    @isolate = Isolate.new WITH_HOE
 
     assert_nil Gem.loaded_specs["hoe"]
 
@@ -39,7 +42,7 @@ class TestIsolate < MiniTest::Unit::TestCase
   end
 
   def test_activate_environment
-    @isolate = Isolate.new "test/fixtures/with-hoe"
+    @isolate = Isolate.new WITH_HOE
     @isolate.gem "rubyforge"
 
     @isolate.environment "borg" do
@@ -52,7 +55,7 @@ class TestIsolate < MiniTest::Unit::TestCase
   end
 
   def test_activate_environment_explicit
-    @isolate = Isolate.new "test/fixtures/with-hoe"
+    @isolate = Isolate.new WITH_HOE
 
     @isolate.gem "rubyforge"
 
@@ -74,7 +77,7 @@ class TestIsolate < MiniTest::Unit::TestCase
     begin; @isolate.activate; rescue Gem::LoadError; end
 
     assert_equal ["foo", Gem::Requirement.default],
-      Gem::DependencyInstaller.last_install
+      Gem::DependencyInstaller.value.shift
   end
 
   def test_activate_install_environment
@@ -82,13 +85,29 @@ class TestIsolate < MiniTest::Unit::TestCase
     @isolate.environment(:nope) { gem "foo" }
 
     @isolate.activate
-    assert_nil Gem::DependencyInstaller.last_install
+    assert_empty Gem::DependencyInstaller.value
   end
 
   def test_activate_ret
     assert_equal @isolate, @isolate.activate
   end
 
+  # TODO: cleanup with 2 versions of same gem, 1 activated
+  # TODO: install with 1 older version, 1 new gem to be installed
+
+  def test_cleanup
+    @isolate = Isolate.new WITH_HOE, :verbose => false
+    # no gems specified on purpose
+    @isolate.activate
+    @isolate.cleanup
+
+    expected = [["hoe",       "2.3.3", WITH_HOE],
+                ["rake",      "0.8.7", WITH_HOE],
+                ["rubyforge", "1.0.4", WITH_HOE]]
+
+    assert_equal expected, Gem::Uninstaller.value
+  end
+
   def test_disable
     home, path = ENV.values_at "GEM_HOME", "GEM_PATH"
     load_path  = $LOAD_PATH.dup
@@ -111,7 +130,7 @@ class TestIsolate < MiniTest::Unit::TestCase
   end
 
   def test_enable
-    assert !Gem.find_files("minitest/unit.rb").empty?,
+    refute_empty Gem.find_files("minitest/unit.rb"),
       "There's a minitest/unit in the current env, since we're running it."
 
     @isolate.enable
@@ -122,7 +141,7 @@ class TestIsolate < MiniTest::Unit::TestCase
     assert_equal [], Gem.find_files("minitest/unit.rb"),
       "Can't find minitest/unit now, 'cause we're activated!"
 
-    assert Gem.loaded_specs.empty?
+    assert_empty Gem.loaded_specs
     assert_equal [@isolate.path], Gem.path
   end
 
@@ -150,7 +169,7 @@ class TestIsolate < MiniTest::Unit::TestCase
 
   def test_gem
     g = @isolate.gem "foo"
-    assert @isolate.entries.include?(g)
+    assert_includes @isolate.entries, g
 
     assert_equal "foo", g.name
     assert_equal Gem::Requirement.create(">= 0"), g.requirement
@@ -175,23 +194,43 @@ class TestIsolate < MiniTest::Unit::TestCase
     i = Isolate.new "foo/gems"
     assert i.install?
     assert i.verbose?
+    assert i.cleanup?
+
+    i = Isolate.new "foo/gems",
+      :cleanup => false, :install => false, :verbose => false
 
-    i = Isolate.new "foo/gems", :install => false, :verbose => false
+    refute i.cleanup?
     refute i.install?
     refute i.verbose?
+
+    i = Isolate.new "foo/gems", :install => false
+    refute i.cleanup?, "no install, no cleanup"
   end
 end
 
-# Gem::DependencyInstaller#install is brutally stubbed.
+module BrutalStub
+  @@value = []
+  def value; @@value end
+  def reset_value; value.clear end
+end
 
 class Gem::DependencyInstaller
-  @@last_install = nil
-  def self.last_install; @@last_install end
-  def self.reset_last_install; @@last_install = nil end
+  extend BrutalStub
 
   alias old_install install
-
   def install name, requirement
-    @@last_install = [name, requirement]
+    self.class.value << [name, requirement]
+  end
+end
+
+class Gem::Uninstaller
+  extend BrutalStub
+
+  attr_reader :gem, :version, :gem_home
+  alias old_uninstall uninstall
+  def uninstall
+    self.class.value << [self.gem,
+                         self.version.to_s,
+                         self.gem_home.sub(Dir.pwd + "/", '')]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: isolate
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - John Barnette
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-23 00:00:00 -07:00
+date: 2009-09-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency