nkryptic-sandbox 0.2.0

data/spec/sandbox/installer_spec.rb

@@ -0,0 +1,219 @@
+
+require File.dirname( __FILE__ ) + '/../spec_helper'
+
+describe Sandbox::Installer, "(mocked)" do
+  
+  before( :each ) do
+    Sandbox.instance_eval { instance_variables.each { |v| remove_instance_variable v } }
+  end
+  
+  describe "creating an instance" do
+    # initialize( options={} )
+    it "should set it's options" do
+      opts = { :somewhere => true, :nowhere => false }
+      installer = Sandbox::Installer.new( opts )
+      installer.options[ :somewhere ].should be_true
+      installer.options[ :nowhere ].should be_false
+    end
+  end
+  
+  describe "instance" do
+    # target
+    describe "when target called" do
+      it "should validate target directory once" do
+        path = '/some/new/target'
+        opts = { :target => path }
+        @installer = Sandbox::Installer.new( opts )
+        @installer.expects( :resolve_target ).with( path ).once.then.returns( path )
+        @installer.target.should == path
+        @installer.target.should == path
+      end
+    end
+
+    # populate
+    describe "when populate called" do
+      it "should call all steps of populate process" do
+        @installer = Sandbox::Installer.new
+        @installer.expects( :create_directories )
+        @installer.expects( :install_scripts )
+        @installer.expects( :install_gems )
+        @installer.populate
+      end
+    end
+
+    # create_directories
+    describe "when create_directories called" do
+      before( :each ) do
+        @path = '/some/new/target'
+        @installer = Sandbox::Installer.new
+        @installer.stubs( :target ).returns( @path )
+      end
+      it "should create sandbox directory structure" do
+        FileUtils.expects( :mkdir_p ).with( @path + '/rubygems/bin' )
+        FileUtils.stubs( :ln_s )
+        @installer.create_directories
+      end
+      
+      it "should symlink gem bin directory" do
+        FileUtils.stubs( :mkdir_p )
+        FileUtils.expects( :ln_s ).with( @path + '/rubygems/bin', @path + '/bin' )
+        @installer.create_directories
+      end
+    end
+
+    # install_scripts
+    describe "when install_scripts called" do
+      before( :each ) do
+        @path = '/some/new/target'
+        @installer = Sandbox::Installer.new
+        @installer.stubs( :target ).returns( @path )
+      end
+      
+      it "should read template file" do
+        File.expects( :read ).with( regexp_matches( /templates\/activate_sandbox\.erb/ ) ).returns( '<%= target %>' )
+        File.stubs( :open )
+        @installer.install_scripts
+      end
+      
+      it "should write out activate script to SANDBOX/bin/activate_sandbox" do
+        file = StringIO.new
+        File.stubs( :read ).returns( '<%= target %>' )
+        File.expects( :open ).with( @path + '/bin/activate_sandbox', 'w' ).yields( file )
+        @installer.install_scripts
+        file.string.should == @path
+      end
+    end
+
+    # install_gems
+    describe "when install_gems called" do
+      before( :each ) do
+        @installer = Sandbox::Installer.new( :gems => [ 'mygem' ] )
+        @installer.stubs( :setup_sandbox_env )
+        @installer.stubs( :restore_sandbox_env )
+      end
+      
+      it "should install a good gem" do
+        @installer.expects( :shell_out ).with( 'gem install mygem' ).returns( [ true, 'blah' ] )
+        @installer.install_gems
+      end
+      
+      it "should gracefully handle a bad gem" do
+        @installer.expects( :shell_out ).with( 'gem install mygem' ).returns( [ false, 'blah' ] )
+        @installer.expects( :warn )
+        @installer.install_gems
+      end
+    end
+
+    # resolve_target( path )
+    describe "when resolve_target called" do
+      before( :each ) do
+        @path = '/absolute/path/to/parent'
+        @installer = Sandbox::Installer.new
+        @installer.stubs( :fix_path ).returns( @path )
+      end
+      
+      it "should raise error when it path exists" do
+        File.expects( :exists? ).with( @path ).returns( true )
+        lambda { @installer.resolve_target( @path ) }.should raise_error( Sandbox::Error )
+      end
+      
+      it "should return path when parent directory passes check_path!" do
+        File.expects( :exists? ).with( @path ).returns( false )
+        @installer.expects( :check_path! ).with( '/absolute/path/to' ).returns( true )
+        @installer.resolve_target( @path ).should == @path
+      end
+      
+      it "should return path when any parent directory passes check_path!" do
+        File.expects( :exists? ).with( @path ).returns( false )
+        @installer.expects( :check_path! ).with( '/absolute/path/to' ).returns( false )
+        @installer.expects( :check_path! ).with( '/absolute/path' ).returns( false )
+        @installer.expects( :check_path! ).with( '/absolute' ).returns( true )
+        @installer.resolve_target( @path ).should == @path
+      end
+    end
+
+    # check_path!( path )
+    describe "when check_path! called" do
+      before( :each ) do
+        @path = '/absolute/path/to/parent'
+        @installer = Sandbox::Installer.new
+      end
+      
+      it "should raise error when it is not writable" do
+        File.expects( :directory? ).with( @path ).returns( true )
+        File.expects( :writable? ).with( @path ).returns( false )
+        lambda { @installer.check_path!( @path ) }.should raise_error( Sandbox::Error )
+      end
+      
+      it "should raise error when it is not a directory" do
+        File.expects( :directory? ).with( @path ).returns( false )
+        File.expects( :exists? ).with( @path ).returns( true )
+        lambda { @installer.check_path!( @path ) }.should raise_error( Sandbox::Error )
+      end
+      
+      it "should return false when it doesn't exist" do
+        File.expects( :directory? ).with( @path ).returns( false )
+        File.expects( :exists? ).with( @path ).returns( false )
+        @installer.check_path!( @path ).should be_false
+      end
+      
+      it "should return true when it can be created" do
+        File.expects( :directory? ).with( @path ).returns( true )
+        File.expects( :writable? ).with( @path ).returns( true )
+        @installer.check_path!( @path ).should == true
+      end
+    end
+
+    # fix_path( path )
+    describe "when fix_path called" do
+      it "should not change absolute path" do
+        path = '/absolute/path/to/target'
+        @installer = Sandbox::Installer.new
+        @installer.fix_path( path ).should == path
+      end
+      
+      it "should make relative into absolute path" do
+        abs_path = '/absolute/working/directory'
+        path = 'relative/path/to/target'
+        FileUtils.expects( :pwd ).returns( abs_path )
+        @installer = Sandbox::Installer.new
+        @installer.fix_path( path ).should == abs_path + '/' + path
+      end
+    end
+  end
+end
+
+describe Sandbox::Installer, "(using tmpdir)" do
+  def tmppath() File.join( Dir.tmpdir, "sandbox_testing" ) end
+  def rmtmppath() FileUtils.rm_rf( tmppath ) end
+  def mktmppath() FileUtils.mkdir_p( tmppath ) end
+
+  def in_dir( dir = tmppath )
+    old_pwd = Dir.pwd
+    begin
+      Dir.chdir( dir )
+      yield
+    ensure
+      Dir.chdir( old_pwd )
+    end
+  end
+  
+  before( :each ) do
+    mktmppath
+  end
+  
+  after( :each ) do
+    rmtmppath
+  end
+  
+  it "should create target directory structure" do
+    target = tmppath + '/target'
+    @installer = Sandbox::Installer.new( :target => target )
+    @installer.create_directories
+    File.directory?( target + '/rubygems/bin' ).should be_true
+    File.symlink?( target + '/bin' ).should be_true
+  end
+end
+
+
+  

data/spec/sandbox_spec.rb

@@ -0,0 +1,25 @@
+
+require File.dirname( __FILE__ ) + '/spec_helper.rb'
+
+describe Sandbox do
+  before( :each ) do
+    Sandbox.instance_eval { instance_variables.each { |v| remove_instance_variable v } }
+  end
+  
+  it "should have verbosity level" do
+    Sandbox.verbosity.should == 0
+  end
+  
+  it "should increase verbosity level" do
+    Sandbox.verbosity.should == 0
+    Sandbox.increase_verbosity
+    Sandbox.verbosity.should == 1
+  end
+  
+  it "should decrease verbosity level" do
+    Sandbox.verbosity.should == 0
+    Sandbox.decrease_verbosity
+    Sandbox.verbosity.should == -1
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,63 @@
+# begin
+#   require 'spec'
+# rescue LoadError
+#   require 'rubygems'
+#   # gem 'rspec'
+#   require 'spec'
+# end
+# 
+# $:.unshift( File.dirname( __FILE__ ) + '/../lib' )
+
+$:.unshift( File.dirname( __FILE__ ) + '/../lib' )
+require 'rubygems'
+require 'mocha'
+require 'spec'
+require 'stringio'
+require 'ostruct'
+require 'tempfile'
+
+require 'sandbox'
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  
+  def capture
+    results = OpenStruct.new
+    
+    begin
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+      yield
+      results.stdout = $stdout.string
+      results.stderr = $stderr.string
+    ensure
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+ 
+    return results
+  end
+  
+  alias silence capture
+  
+end
+
+
+## thanks to Jay Fields (http://blog.jayfields.com/2007/11/ruby-testing-private-methods.html)
+class Class
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    begin
+      self.class_eval { public *saved_private_instance_methods }
+      yield
+    ensure
+      self.class_eval { private *saved_private_instance_methods }
+    end
+  end
+end
+

data/tasks/cucumber.rake

@@ -0,0 +1,25 @@
+begin
+  require 'cucumber'
+rescue LoadError
+  require 'rubygems'
+  require 'cucumber'
+end
+begin
+  require 'cucumber/rake/task'
+rescue LoadError
+  puts <<-EOS
+To use cucumber for testing you must install cucumber gem:
+    gem install cucumber
+EOS
+  exit( 0 )
+end
+ 
+# Try these:
+#
+# rake features
+# rake features PROFILE=html
+Cucumber::Rake::Task.new do |t|
+  # profile         = ENV[ 'PROFILE' ] || 'default'
+  # t.cucumber_opts = "--profile #{profile}"
+  t.cucumber_opts = "--format pretty"
+end

data/tasks/dcov.rake

@@ -0,0 +1,37 @@
+begin
+  require 'dcov'
+rescue LoadError
+  require 'rubygems'
+  begin
+    require 'dcov'
+  rescue LoadError
+    puts <<-EOS
+To generate documentation coverage with dcov you must install dcov gem:
+    gem install dcov
+EOS
+    exit( 0 )
+  end
+end
+
+desc "Generate coverage report for lib directory"
+task :dcov do
+  root      = Dir.pwd
+  dcov_dir  = File.join( root, 'coverage' )
+  lib_dir   = File.join( root, 'lib' )
+  
+  unless File.directory?( lib_dir )
+    puts "Aborting: please run from the root of the project"
+    exit( 0 )
+  end
+  
+  # files     = Dir[ File.join( lib_dir, '**', '*.rb' ) ]
+  options   = {
+    :path => dcov_dir,
+    :output_format => 'html',
+    :files => lib_dir
+    # :files => files
+  }
+  
+  Dir.mkdir( dcov_dir ) unless File.directory?( dcov_dir )
+  Dcov::Analyzer.new( options )
+end

data/tasks/gem.rake

@@ -0,0 +1,5 @@
+
+desc "Create this gem's .gemspec file"
+task :gemspec do
+  Rake::Task[ 'build_gemspec' ].invoke
+end

data/tasks/rspec.rake

@@ -0,0 +1,51 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run all the specs in spec directory"
+Spec::Rake::SpecTask.new( :spec ) do |t|
+  t.spec_opts = [ '--options', "spec/spec.opts" ]
+  t.spec_files = FileList[ 'spec/**/*_spec.rb' ]
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new( :rcov ) do |t|
+    t.spec_opts = [ '--options', "spec/spec.opts" ]
+    t.spec_files = FileList[ 'spec/**/*_spec.rb' ]
+    t.rcov = true
+    # t.rcov_opts = [ '--exclude', "spec/*" ]
+    t.rcov_opts = [ '--exclude', "spec" ]
+  end
+
+  desc "Print Specdoc for all specs in spec directory"
+  Spec::Rake::SpecTask.new( :doc ) do |t|
+    t.spec_opts = [ "--format", "specdoc", "--dry-run" ]
+    # t.spec_opts = [ "--format", "specdoc" ]
+    t.spec_files = FileList[ 'spec/**/*_spec.rb' ]
+  end
+  
+  desc "Run all the specs in spec directory individually"
+  task :deps do
+    individual_specs = Dir["spec/**/*_spec.rb"]
+    individual_specs.each do |single_spec|
+      if not system "spec #{single_spec} --options spec/spec.opts &> /dev/null"
+        puts "Dependency Issues: #{single_spec}"
+      else
+        puts "OK: #{single_spec}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: nkryptic-sandbox
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jacob Radford
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-01 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: 
+description: Create virtual ruby/rubygems sandboxes.
+email: nkryptic@gmail.com
+executables: 
+- sandbox
+extensions: []
+
+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
+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
+has_rdoc: true
+homepage: http://github.com/nkryptic/sandbox
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sandbox
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: sandbox
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Create virtual ruby/rubygems sandboxes.
+test_files: []
+