nkryptic-sandbox 0.2.0 → 0.2.1

data/README.rdoc

@@ -80,7 +80,7 @@ the first place.
 == REQUIREMENTS:
 
 * ruby
-* rubygems (currently, until full version complete)
+* rubygems
 
 == INSTALL:
 

data/Rakefile

@@ -15,9 +15,9 @@ begin
     p.email                     = "nkryptic@gmail.com"
     p.ignore_pattern            = [ "tmp/*", "script/*" ]
     p.development_dependencies  = [
-                                    'echoe ~> 3.0',
-                                    'rspec ~> 1.1.0',
-                                    'mocha ~> 0.9',
+                                    # 'echoe ~> 3.0',
+                                    # 'rspec ~> 1.1.0',
+                                    # 'mocha ~> 0.9',
                                   ]
     # p.dependencies = ['ParseTree >=2.1.1', 'ruby2ruby >=1.1.8']
   end

data/TODO

@@ -1,14 +1,69 @@
 
-* allow gem versions to be specified when installing
-* better documentation
-  * of the codebase
-* more specs
-  * why not try for 100% coverage
-* improve ui output
-  * use verbosity level
-  * include more messages about status
-  * move to ui class?
-* user config
-  * list of gems to install
-      ~/.sandbox/config
-    
+TODO: put in timeout when installing gems
+TODO: check for network connection
+TODO: perhaps look in installed rubygems cache first
+TODO: make rubygems dependency fail immediately and gracefully?
+      * in bin/sandbox?
+TODO: replace backticks for gem installs with open4 library?
+TODO: allow for sandbox to be rerun against existing sandbox to update it?
+TODO: test against various OS platforms
+      * BSD
+      * OSX
+      * Gentoo
+      * Debian/Ubuntu
+      * Could it work on Windows?
+      * ?
+TODO: test against other shells
+      * csh
+      * zsh
+TODO: test against other ruby versions?
+      * jruby
+TODO: allow gem versions to be specified when installing
+TODO: better documentation
+      * of the codebase
+      * in the readme
+TODO: improve ui output
+      * use verbosity level
+      * include more messages about status
+      * move to ui class?
+TODO: user config
+      * set list of ruby variants to query?
+      * list of gems to install
+          ~/.sandbox/config
+TODO: allow for install of ruby/rubygems
+      * how
+        * select dynamically?
+        * preset in config file?
+      * MRI, JRuby, Rubinius?
+        * each would have their own install method
+        * rubygems install would vary then
+TODO: perhaps the following could be added to the activate script???
+      # function not_sourced() {
+      #   ## ZSH source check
+      #   test -n "$ZSH_NAME" -a "$HISTCMD" = "0" && return 0
+      #   ## BASH source check
+      #   test "`basename $1 2>/dev/null`" = "activate_sandbox" && return 0
+      #   ## script was not sourced
+      #   return 1
+      # }
+      # function exit_with_warning() {
+      #   echo "You must source this script (ie. source bin/activate_sandbox)"
+      #   exit 1
+      # }
+      # not_sourced $0 && exit_with_warning
+      # unset not_sourced
+      # unset exit_with_warning
+      
+      # OTHER WAYS
+      # ====
+      # ONLY WORKS FOR BASH
+      # if [[ "$BASH_SOURCE" == "$0" ]]
+      # then
+      #    echo "script was executed, not sourced"
+      # fi
+      # ====
+      # COULD WORK FOR BASH:
+      # if [ -n `readlink -f $0` ]; then
+      #    echo "script was executed, not sourced"
+      # fi
+

data/lib/sandbox/cli.rb

@@ -122,9 +122,9 @@ module Sandbox
       end
     end
     
-    def show_help
-      puts parser
-    end
+    # def show_help
+    #   puts parser
+    # end
     
     def long_help
       unindent( <<-HELP )
@@ -140,14 +140,14 @@ module Sandbox
         
         Running from your own gem repositories is fairly straight-forward, but 
         managing the necessary environment is a pain.  This utility will create a new
-        environment which may be activated by the script `bin/activate` in your
-        sandbox directory.
+        environment which may be activated by the script `bin/activate_sandbox` in
+        your sandbox directory.
         
         Run the script with the following to enable your new environment:
-          $ source bin/activate
+          $ source bin/activate_sandbox
         
         When you want to leave the environment:
-          $ deactivate
+          $ deactivate_sandbox
         
         NOTES:
         1. It creates an environment that has its own installation directory for Gems.

data/lib/sandbox/errors.rb

@@ -21,6 +21,7 @@ module Sandbox
     
     def initialize( msg=nil )
       msg ||= "You cannot run sandbox from a loaded sandbox environment"
+      super msg
     end
     
   end

data/lib/sandbox/installer.rb

@@ -99,10 +99,10 @@ module Sandbox
     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.update( @old_env )
+      ENV[ 'HOME' ]     = @old_env[ 'HOME' ]
+      ENV[ 'GEM_HOME' ] = @old_env[ 'GEM_HOME' ]
+      ENV[ 'GEM_PATH' ] = @old_env[ 'GEM_PATH' ]
     end
     
     def resolve_target( path )
@@ -117,7 +117,7 @@ module Sandbox
         if check_path!( base )
           break
         elsif base == '/'
-          break
+          raise "something is seriously wrong; we should never get here"
         end
       end
       return path

data/lib/sandbox/templates/activate_sandbox.erb

@@ -89,3 +89,9 @@ export PS1
 if [ -n "$BASH" -o -n "$ZSH_VERSION" ] ; then
     hash -r
 fi
+
+
+# 
+# 
+# Thanks to the virtualenv developers ( http://pypi.python.org/pypi/virtualenv )
+# 

data/lib/sandbox/version.rb

@@ -5,7 +5,7 @@ module Sandbox
     
     MAJOR = 0
     MINOR = 2
-    TINY  = 0
+    TINY  = 1
 
     STRING = [ MAJOR, MINOR, TINY ].join( '.' )
     

data/sandbox.gemspec

@@ -2,18 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sandbox}
-  
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jacob Radford"]
-  s.date = %q{2008-12-01}
+  s.date = %q{2008-12-05}
   s.default_executable = %q{sandbox}
   s.description = %q{Create virtual ruby/rubygems sandboxes.}
   s.email = %q{nkryptic@gmail.com}
   s.executables = ["sandbox"]
   s.extra_rdoc_files = ["CHANGELOG", "TODO", "README.rdoc", "tasks/rspec.rake", "tasks/cucumber.rake", "tasks/gem.rake", "tasks/dcov.rake", "lib/sandbox.rb", "lib/sandbox/installer.rb", "lib/sandbox/cli.rb", "lib/sandbox/templates/activate_sandbox.erb", "lib/sandbox/version.rb", "lib/sandbox/errors.rb", "bin/sandbox"]
-  s.files = ["sandbox.gemspec", "CHANGELOG", "TODO", "spec/sandbox/cli_spec.rb", "spec/sandbox/installer_spec.rb", "spec/sandbox_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Manifest", "features/steps/common.rb", "features/steps/env.rb", "features/development.feature", "README.rdoc", "tasks/rspec.rake", "tasks/cucumber.rake", "tasks/gem.rake", "tasks/dcov.rake", "Rakefile", "lib/sandbox.rb", "lib/sandbox/installer.rb", "lib/sandbox/cli.rb", "lib/sandbox/templates/activate_sandbox.erb", "lib/sandbox/version.rb", "lib/sandbox/errors.rb", "bin/sandbox"]
+  s.files = ["sandbox.gemspec", "CHANGELOG", "TODO", "spec/sandbox/errors_spec.rb", "spec/sandbox/cli_spec.rb", "spec/sandbox/installer_spec.rb", "spec/sandbox_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Manifest", "features/steps/common.rb", "features/steps/env.rb", "features/development.feature", "README.rdoc", "tasks/rspec.rake", "tasks/cucumber.rake", "tasks/gem.rake", "tasks/dcov.rake", "Rakefile", "lib/sandbox.rb", "lib/sandbox/installer.rb", "lib/sandbox/cli.rb", "lib/sandbox/templates/activate_sandbox.erb", "lib/sandbox/version.rb", "lib/sandbox/errors.rb", "bin/sandbox"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/nkryptic/sandbox}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sandbox", "--main", "README.rdoc"]
@@ -27,17 +26,8 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<echoe>, ["~> 0", "= 3.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 0", "= 1.1.0"])
-      s.add_development_dependency(%q<mocha>, ["~> 0", "= 0.9"])
     else
-      s.add_dependency(%q<echoe>, ["~> 0", "= 3.0"])
-      s.add_dependency(%q<rspec>, ["~> 0", "= 1.1.0"])
-      s.add_dependency(%q<mocha>, ["~> 0", "= 0.9"])
     end
   else
-    s.add_dependency(%q<echoe>, ["~> 0", "= 3.0"])
-    s.add_dependency(%q<rspec>, ["~> 0", "= 1.1.0"])
-    s.add_dependency(%q<mocha>, ["~> 0", "= 0.9"])
   end
 end

data/spec/sandbox/cli_spec.rb

@@ -47,6 +47,32 @@ describe Sandbox::CLI do
     end
   end
   
+  describe "handling errors" do
+    it "should just print Sandbox::Error message" do
+      err = Sandbox::Error.new( "spec test msg" )
+      Sandbox::CLI.expects( :puts ).once.with( regexp_matches( /^Sandbox error: spec test msg/ ) )
+      Sandbox::CLI.handle_error( err )
+    end
+    
+    it "should just print wrapped StandardError message" do
+      err = StandardError.new( "spec test msg" )
+      Sandbox::CLI.expects( :puts ).once.with( regexp_matches( /^Error: spec test msg/ ) )
+      Sandbox::CLI.handle_error( err )
+    end
+    
+    it "should have simple message for Interrupt" do
+      err = Interrupt.new( "spec test msg" )
+      Sandbox::CLI.expects( :puts ).once.with( 'Interrupted' )
+      Sandbox::CLI.handle_error( err )
+    end
+    
+    it "should reraise other errors" do
+      err = NotImplementedError.new( 'you should have implemented it, dummy' )
+      Sandbox::CLI.expects( :raise ).once.with( err )
+      Sandbox::CLI.handle_error( err )
+    end
+  end
+  
   describe "a new instance" do
     
     before( :each ) do
@@ -193,6 +219,16 @@ describe Sandbox::CLI do
       
     end
     
+    describe "instance calling long_help" do
+      it "should return a long descriptive string" do
+        @cli.long_help.split( "\n" ).size.should be > 20
+        @cli.long_help.should =~ /activate_sandbox/
+        @cli.long_help.should =~ /deactivate_sandbox/
+        @cli.long_help.should =~ /NOTES:/
+        @cli.long_help.should =~ /WARNINGS:/
+      end
+    end
+    
   end
   
 end

data/spec/sandbox/errors_spec.rb

@@ -0,0 +1,34 @@
+
+require File.dirname( __FILE__ ) + '/../spec_helper.rb'
+
+describe 'new', Sandbox::Error do
+  it "should wrap it's message with 'Sandbox error'" do
+    Sandbox::Error.new( 'msg' ).message.should == 'Sandbox error: msg'
+  end
+end
+
+describe 'new', Sandbox::LoadedSandboxError do
+  it "should have informative default msg" do
+    Sandbox::LoadedSandboxError.new.message.should =~ /loaded sandbox/
+  end
+end
+
+describe 'new', Sandbox::ParseError do
+  it "should accept reason with array" do
+    Sandbox::ParseError.new( 'testing', [ 1, 2, 3, 4 ] ).
+        message.should =~ /testing => 1 2 3 4/
+  end
+  
+  it "should accept reason with string" do
+    Sandbox::ParseError.new( 'testing', "1, 2, 3, 4" ).
+        message.should =~ /testing => 1, 2, 3, 4/
+  end
+  
+  it "should fall back to reason alone" do
+    Sandbox::ParseError.new( 'testing', [] ).
+        message.should =~ /testing$/
+    Sandbox::ParseError.new( 'testing', '' ).
+        message.should =~ /testing$/
+  end
+end
+

data/spec/sandbox/installer_spec.rb

@@ -130,6 +130,12 @@ describe Sandbox::Installer, "(mocked)" do
         @installer.expects( :check_path! ).with( '/absolute' ).returns( true )
         @installer.resolve_target( @path ).should == @path
       end
+      
+      it "should have emergency safeguard for dirname on root" do
+        @installer.stubs( :fix_path ).returns( '/absolute' )
+        @installer.expects( :check_path! ).with( '/' ).returns( false )
+        lambda { @installer.resolve_target( '/absolute' ) }.should raise_error( RuntimeError )
+      end
     end
 
     # check_path!( path )
@@ -180,6 +186,52 @@ describe Sandbox::Installer, "(mocked)" do
         @installer.fix_path( path ).should == abs_path + '/' + path
       end
     end
+    
+    # shell_out( cmd )
+    describe "when shell_out called" do
+      it "should record true when successful" do
+        @installer = Sandbox::Installer.new
+        result = @installer.shell_out( '/bin/true' )
+        result.first.should be_true
+      end
+      
+      it "should record false when unsuccessful" do
+        @installer = Sandbox::Installer.new
+        result = @installer.shell_out( '/bin/false' )
+        result.first.should_not be_true
+      end
+      
+      it "should record std output" do
+        @installer = Sandbox::Installer.new
+        result = @installer.shell_out( 'ls -d /' )
+        result.last.chomp.should == '/'
+      end
+      
+      it "should ignore std error" do
+        @installer = Sandbox::Installer.new
+        result = @installer.shell_out( 'ls -d / 1>&2' )
+        result.last.chomp.should == ''
+      end
+    end
+    
+    describe "setup and restore sandbox env called" do
+      it "should set and restore the environment" do
+        orig_home = ENV[ 'HOME' ]
+        orig_gem_home = ENV[ 'GEM_HOME' ]
+        orig_gem_path = ENV[ 'GEM_PATH' ]
+        @installer = Sandbox::Installer.new
+        @installer.stubs( :target ).returns( 'dummypath' )
+        
+        @installer.setup_sandbox_env
+        ENV[ 'HOME' ].should == 'dummypath'
+        ENV[ 'GEM_HOME' ].should == 'dummypath/rubygems'
+        ENV[ 'GEM_PATH' ].should == 'dummypath/rubygems'
+        @installer.restore_sandbox_env
+        ENV[ 'HOME' ].should == orig_home
+        ENV[ 'GEM_HOME' ].should == orig_gem_home
+        ENV[ 'GEM_PATH' ].should == orig_gem_path
+      end
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nkryptic-sandbox
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jacob Radford
@@ -9,45 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-01 00:00:00 -08:00
+date: 2008-12-05 00:00:00 -08:00
 default_executable: sandbox
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: "3.0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 1.1.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: "0.9"
-    version: 
+dependencies: []
+
 description: Create virtual ruby/rubygems sandboxes.
 email: nkryptic@gmail.com
 executables: 
@@ -73,6 +38,7 @@ files:
 - sandbox.gemspec
 - CHANGELOG
 - TODO
+- spec/sandbox/errors_spec.rb
 - spec/sandbox/cli_spec.rb
 - spec/sandbox/installer_spec.rb
 - spec/sandbox_spec.rb