ruby-virtualenv 0.5.0 → 0.5.1

data/README.md

@@ -1,10 +1,5 @@
-Sandbox
-=======
-
-* http://github.com/nkryptic/sandbox
-
-DESCRIPTION:
-------------
+Ruby Virtualenv
+===============
 
 Inspired by Python's [virtualenv](http://pypi.python.org/pypi/virtualenv)
 project, Ruby-Virtualenv is a utility to create sandboxed Ruby/Rubygems
@@ -31,90 +26,64 @@ When you want to leave the environment:
 
     $ deactivate
 
-NOTES:
-------
+Notes
+-----
 
 * It creates an environment that has its own installation directory for Gems.
 * It doesn't share gems with other sandbox environments.
 * It (optionally) doesn't use the globally installed gems either.
 * It will use a local to the sandbox .gemrc file
 
-FEATURES/PROBLEMS:
-------------------
+Install
+-------
 
-Activating your sandbox environment will change your HOME directory
-temporarily to the sandbox directory. Other environment variables are
-set to enable this funtionality, so if you may experience odd behavior.
-Everything should be reset when you deactivate the sandbox.
+    $ gem install ruby-virtualenv
 
-USAGE:
-------
+Usage
+-----
 
 Create a new virtualenv (verbose output by default):
 
     $ ruby-virtualenv ~/.ruby-virtualenvs/my-new-sandbox
-    creating new sandbox in /home/nkryptic/ruby-projects/my-new-sandbox
+    creating new sandbox in ~/.ruby-virtualenvs/my-new-sandbox
     installing activation script
     installing .gemrc
     installing gems:
       nothing to do
 
-Create a new sandbox with no output:
-
-    $ ruby-virtualenv ~/.ruby-virtualenvs/my-new-sandbox -q
-
 Create a new sandbox with specific gems:
 
     $ ruby-virtualenv ~/.ruby-virtualenvs/my-new-sandbox -g rake,rails
-    creating new sandbox in /home/nkryptic/ruby-projects/my-new-sandbox
+    creating new sandbox in ~/.ruby-virtualenvs/my-new-sandbox
     installing activation script
     installing .gemrc
     installing gems:
       gem: rake
       gem: rails
 
-FUTURE PLANS:
--------------
-
-I hope to expand the full version branch to allow for installing both
-rubygems and ruby as part of the sandbox. This would enable experimentation
-with different versions of both and exclude the requirement on needing
-rubygems in the first place.
-
-REQUIREMENTS:
--------------
-
-* ruby
-* rubygems
-
-INSTALL:
---------
-
-    $ gem install ruby-virtualenv
-
-LICENSE:
---------
+License
+-------
 
-(The MIT License)
+    (The MIT License)
 
-Copyright (c) 2011 Francesc Esplugas
-Copyright (c) 2008 Jacob Radford
+    Copyright (c) 2011 Francesc Esplugas
+    Copyright (c) 2008 Jacob Radford
 
-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:
+    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 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.
+    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/Rakefile

@@ -1,2 +1,10 @@
 #!/usr/bin/env rake
+
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default  => :spec

data/lib/sandbox/cli.rb

@@ -41,7 +41,7 @@ module Sandbox
             tell_unless_really_quiet(error.message)
           when StandardError #, Timeout::Error
             tell_unless_really_quiet("Error: #{error.message}")
-            tell_when_really_verbose(error.backtrace.collect { |bt| "    #{bt}" }.join( "\n" )) if error.backtrace
+            tell_when_really_verbose(error.backtrace.collect { |bt| "    #{bt}" }.join("\n")) if error.backtrace
           when Interrupt
             tell_unless_really_quiet("Interrupted")
         else
@@ -52,9 +52,6 @@ module Sandbox
     end
     ## END CLASS METHODS
 
-    ## PUBLIC INSTANCE METHODS
-    public
-
     # The options for this execution.
     attr_reader :options
 
@@ -69,12 +66,12 @@ module Sandbox
       targets = options.delete(:args)
 
       if targets.size < 1
-        raise Sandbox::Error.new('no target specified - see `ruby-virtualenv --help` for assistance')
+        raise Sandbox::Error.new('No target specified. See `ruby-virtualenv -h` for assistance.')
       elsif targets.size > 1
-        raise Sandbox::Error.new('multiple targets specified - see `ruby-virtualenv --help` for assistance')
+        raise Sandbox::Error.new('Multiple targets specified. See `ruby-virtualenv -h` for assistance.')
       end
 
-      options[ :target ] = targets[0]
+      options[:target] = targets[0]
 
       Sandbox::Installer.new(options).populate
     end
@@ -85,7 +82,7 @@ module Sandbox
     # * determine command name to lookup in CommandManager
     # * load command and have it process any add't options
     # * catches exceptions for unknown switches or commands
-    def parse_args!( args )
+    def parse_args!(args)
       options[:original_args] = args.dup
       parser.parse!(args)
     rescue OptionParser::ParseError => ex
@@ -114,9 +111,9 @@ module Sandbox
         o.on('-n', '--no-gems', 'Do not install any gems after virtualenv is created.') { @options[:gems] = [] }
         o.on('-q', '--quiet', 'Show less output. (multiple allowed)') { |f| Sandbox.decrease_verbosity }
         o.on('-v', '--verbose', 'Show more output. (multiple allowed)') { |f| Sandbox.increase_verbosity }
-        o.on_tail('-h', '--help', 'Show this help message and exit.') { tell_unless_really_quiet( o ); exit }
-        o.on_tail('-H', '--long-help', 'Show the full description about the program.') { tell_unless_really_quiet( long_help ); exit }
-        o.on_tail('-V', '--version', 'Display the program version and exit.' ) { tell_unless_really_quiet( Sandbox::VERSION ); exit }
+        o.on_tail('-h', '--help', 'Show this help message and exit.') { tell_unless_really_quiet(o); exit }
+        o.on_tail('-H', '--long-help', 'Show the full description about the program.') { tell_unless_really_quiet(long_help); exit }
+        o.on_tail('-V', '--version', 'Display the program version and exit.') { tell_unless_really_quiet(Sandbox::VERSION); exit }
         o.separator ""
       end
     end
@@ -163,11 +160,10 @@ WARNINGS:
       HELP
     end
 
-    private
-
     def raise_parse_error(reason, args=[])
       raise Sandbox::ParseError.new(reason, args)
     end
+    private :raise_parse_error
 
   end
 end

data/lib/sandbox/errors.rb

@@ -6,7 +6,7 @@ module Sandbox
     end
 
     def message
-      out = ["Sandbox error: #{super}"]
+      out = [super]
       out.concat(backtrace.collect { |bt| "    #{bt}" }) if Sandbox.really_verbose?
       out.join("\n")
     end
@@ -23,7 +23,7 @@ module Sandbox
 
     def initialize(reason=nil, args=[])
       msg = if args.is_a?(Array) && args.size > 0
-        "#{reason} => #{args.join( ' ' )}"
+        "#{reason} => #{args.join(' ')}"
       elsif args.is_a?(String) && args.length > 0
         "#{reason} => #{args}"
       else

data/lib/sandbox/installer.rb

@@ -47,129 +47,103 @@ module Sandbox
       FileUtils.mkdir_p(gembin)
 
       bin = File.join(target, 'bin')
-      FileUtils.ln_s( gembin, bin )
+      FileUtils.ln_s(gembin, bin)
     end
 
     def install_gemrc
       filename = File.join(target, '.gemrc')
-      template = File.read(File.dirname( __FILE__ ) + '/templates/gemrc.erb')
-      script = ERB.new(template)
-      output = script.result(binding)
-
-      File.open(filename, 'w') do |f|
-        f.write output
-      end
+      template = File.read(File.dirname(__FILE__) + '/templates/gemrc.erb')
+      output = ERB.new(template).result(binding)
+      File.open(filename, 'w') { |f| f.write(output) }
     end
 
     def install_scripts
       filename = File.join(target, 'bin', 'activate')
-      template = File.read(File.dirname( __FILE__ ) + '/templates/activate.erb')
-      script = ERB.new(template)
-      output = script.result(binding)
-
-      File.open(filename, 'w') do |f|
-        f.write output
-      end
+      template = File.read(File.dirname(__FILE__) + '/templates/activate.erb')
+      output = ERB.new(template).result(binding)
+      File.open(filename, 'w') { |f| f.write(output) }
     end
 
     def install_gems
-      # gem = `which gem`.chomp
-      # return if gem.empty?
-      gems = options[ :gems ] || []
+      gems = options[:gems] || []
       if gems.size == 0
-        tell( "  nothing to install" )
+        tell("  nothing to install")
         return
       end
-      
+
       begin
         setup_sandbox_env
         gems.each do |gem|
-          tell_unless_really_quiet( "  gem: #{gem}" )
+          tell_unless_really_quiet("  gem: #{gem}")
           cmd = "gem install #{gem}"
-          # cmd = cmd + ' -V' if Sandbox.really_verbose?
-          status, output = shell_out( cmd )
+          status, output = shell_out(cmd)
           unless status
-            tell_unless_really_quiet( "    failed to install gem: #{gem}" )
+            tell_unless_really_quiet("    failed to install gem: #{gem}")
           end
         end
       ensure
         restore_sandbox_env
       end
     end
-    
-    def shell_out( cmd )
-      # err_capture = Sandbox.really_verbose? '2>&1' : '2>/dev/null'
-      # out = `#{cmd} #{err_capture}`
+
+    def shell_out(cmd)
       out = `#{cmd} 2>/dev/null`
       result = $?.exitstatus == 0
-      [ result, out ]
+      [result, out]
     end
-    
+
     def setup_sandbox_env
-      @old_env = Hash[ *ENV.select { |k,v| ['HOME','GEM_HOME','GEM_PATH'].include?( k ) }.flatten ]
-      # @old_env = {}
-      # @old_env[ 'HOME' ]      = ENV[ 'HOME' ]
-      # @old_env[ 'GEM_HOME' ]  = ENV[ 'GEM_HOME' ]
-      # @old_env[ 'GEM_PATH' ]  = ENV[ 'GEM_PATH' ]
-      
-      ENV[ 'HOME' ]     = target
-      ENV[ 'GEM_HOME' ] = "#{target}/rubygems"
-      ENV[ 'GEM_PATH' ] = "#{target}/rubygems"
+      @old_env = Hash[ *ENV.select { |k,v| ['HOME','GEM_HOME','GEM_PATH'].include?(k) }.flatten ]
+
+      ENV['HOME']     = target
+      ENV['GEM_HOME'] = "#{target}/rubygems"
+      ENV['GEM_PATH'] = "#{target}/rubygems"
     end
-    
+
     def restore_sandbox_env
-      # ENV.update( @old_env )
-      ENV[ 'HOME' ]     = @old_env[ 'HOME' ]
-      ENV[ 'GEM_HOME' ] = @old_env[ 'GEM_HOME' ]
-      ENV[ 'GEM_PATH' ] = @old_env[ 'GEM_PATH' ]
+      ENV['HOME']     = @old_env['HOME']
+      ENV['GEM_HOME'] = @old_env['GEM_HOME']
+      ENV['GEM_PATH'] = @old_env['GEM_PATH']
     end
-    
-    def resolve_target( path )
-      # should consider replacing with 'pathname' => Pathname.new( path )
-      path = fix_path( path )
-      if File.exists?( path )
+
+    def resolve_target(path)
+      path = fix_path(path)
+      if File.exists?(path)
         raise Sandbox::Error, "target '#{path}' exists"
       end
-      
+
       base = path
-      while base = File.dirname( base )
-        if check_path!( base )
+      while base = File.dirname(base)
+        if check_path!(base)
           break
         elsif base == '/'
           raise "something is seriously wrong; we should never get here"
         end
       end
-      return path
+
+      path
     end
-    
-    def check_path!( path )
-      if File.directory?( path )
-        if File.writable?( path )
+
+    def check_path!(path)
+      if File.directory?(path)
+        if File.writable?(path)
           return true
         else
           raise Sandbox::Error, "path '#{path}' has a permission problem"
         end
-      elsif File.exists?( path )
+      elsif File.exists?(path)
         raise Sandbox::Error, "path '#{path}' is not a directory"
       end
       false
     end
-    
-    def fix_path( path )
-      unless path.index( '/' ) == 0
-        path = File.join( FileUtils.pwd, path )
+
+    def fix_path(path)
+      unless path.index('/') == 0
+        path = File.join(FileUtils.pwd, path)
       end
       path
     end
 
-    ## END PUBLIC INSTANCE METHODS
-
-
-    ## PRIVATE INSTANCE METHODS
-    private
-
-    ## END PRIVATE INSTANCE METHODS
-  
   end
-  
-end
+
+end

data/lib/sandbox/templates/activate.erb

@@ -33,18 +33,12 @@ deactivate () {
         export PATH
     fi
 
-    if [ -n "$_OLD_SANDBOX_HOME" ] ; then
-        HOME="$_OLD_SANDBOX_HOME"
-        export HOME
-    fi
-
     if [ -n "$_OLD_SANDBOX_PS1" ] ; then
         PS1="$_OLD_SANDBOX_PS1"
         export PS1
     fi
 
     unset _OLD_SANDBOX_PATH
-    unset _OLD_SANDBOX_HOME
     unset _OLD_SANDBOX_GEM_HOME
     unset _OLD_SANDBOX_GEM_PATH
     unset _OLD_SANDBOX_PS1
@@ -68,24 +62,16 @@ activate () {
     _OLD_SANDBOX_GEM_HOME="$GEM_HOME"
     _OLD_SANDBOX_GEM_PATH="$GEM_PATH"
     _OLD_SANDBOX_PATH="$PATH"
-    _OLD_SANDBOX_HOME="$HOME"
     _OLD_SANDBOX_PS1="$PS1"
 
     # set the sandbox-aware states
     SANDBOX_ENV="<%= target %>"
     PATH="$SANDBOX_ENV/bin:$PATH"
-    HOME="$SANDBOX_ENV"
     GEM_HOME="$SANDBOX_ENV/rubygems"
     GEM_PATH="$GEM_HOME"
-    if [ "`basename \"$SANDBOX_ENV\"`" = "__" ] ; then
-        # special case for Aspen magic directories
-        # see http://www.zetadev.com/software/aspen/
-        PS1="[ruby-virtualenv:`basename \`dirname \"$SANDBOX_ENV\"\``] $PS1"
-    else
-        PS1="(ruby-virtualenv:`basename \"$SANDBOX_ENV\"`) $PS1"
-    fi
+    PS1="(`basename \"$SANDBOX_ENV\"`) $PS1"
 
-    export SANDBOX_ENV PATH HOME GEM_HOME GEM_PATH PS1
+    export SANDBOX_ENV PATH GEM_HOME GEM_PATH PS1
 
     forget_cached_commands