nkryptic-sandbox 0.2.0

data/CHANGELOG

@@ -0,0 +1,10 @@
+
+v0.2.0 Functional basic version.
+  Requires rubygems and only installs environment (with optional gem installs).
+
+v0.1.2 Branched fullversion from master.
+  Full version will include ruby and rubygems installs.
+
+v0.1.1 Adding rspec and cucumber
+ 
+v0.1.0 First version

data/README.rdoc

@@ -0,0 +1,117 @@
+= Sandbox
+
+* http://github.com/nkryptic/sandbox
+
+== DESCRIPTION:
+
+Inspired by Python's virtualenv[http://pypi.python.org/pypi/virtualenv] 
+project, Sandbox is a utility to create sandboxed Ruby/Rubygems environments.
+
+It is meant to address the following issues:
+
+* Conflicts with unspecified gem dependency versions.
+* Applications can have their own gem repositories.
+* Permissions for installing your own gems.
+* Ability to try gems out without installing into your global repository.
+* A Simple way to enable this.
+
+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.
+
+Run the script with the following to enable your new environment:
+  
+  $ source bin/activate_sandbox
+
+When you want to leave the environment:
+  
+  $ deactivate_sandbox
+
+== 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:
+
+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.
+
+== USAGE:
+
+Create a new sandbox (rake gem installed by default):
+  $ cd ~/ruby-projects
+  $ sandbox my-new-sandbox
+
+Create a new sandbox with output (rake gem installed by default):
+  $ cd ~/ruby-projects
+  $ sandbox my-new-sandbox -v
+  creating new sandbox in /home/nkryptic/ruby-projects/my-new-sandbox
+  installing gems:
+    gem: rake
+
+Create a new sandbox with no gems installed:
+  $ cd ~/ruby-projects
+  $ sandbox my-new-sandbox -n
+  creating new sandbox in /home/nkryptic/ruby-projects/my-new-sandbox
+  installing gems:
+
+Create a new sandbox with specific gems:
+  $ cd ~/ruby-projects
+  $ sandbox my-new-sandbox -g rake,rails
+  creating new sandbox in /home/nkryptic/ruby-projects/my-new-sandbox
+  installing gems:
+    gem: rake
+    gem: rails
+    gem: rspec
+
+== 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 (currently, until full version complete)
+
+== INSTALL:
+
+  sudo gem install nkryptic-sandbox -s http://gems.github.com
+
+or
+
+  sudo gem sources --add http://gems.github.com
+  sudo gem install nkryptic-sandbox
+
+== LICENSE:
+
+(The MIT License)
+
+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:
+
+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/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+ 
+require 'lib/sandbox' unless defined? Sandbox
+ 
+begin
+  require 'echoe'
+  
+  Echoe.new( 'sandbox', Sandbox::Version::STRING ) do |p|  
+    # p.rubyforge_name            = 'nkryptic'
+    # p.summary                   = "Create virtual ruby/rubygems sandboxes."
+    p.description               = "Create virtual ruby/rubygems sandboxes."
+    p.url                       = "http://github.com/nkryptic/sandbox"
+    p.author                    = "Jacob Radford"
+    p.email                     = "nkryptic@gmail.com"
+    p.ignore_pattern            = [ "tmp/*", "script/*" ]
+    p.development_dependencies  = [
+                                    'echoe ~> 3.0',
+                                    'rspec ~> 1.1.0',
+                                    'mocha ~> 0.9',
+                                  ]
+    # p.dependencies = ['ParseTree >=2.1.1', 'ruby2ruby >=1.1.8']
+  end
+  
+rescue LoadError => boom
+  puts "You are missing a dependency required for meta-operations on this gem."
+  puts "#{boom.to_s.capitalize}."
+end
+
+Dir[ "#{File.dirname(__FILE__)}/tasks/*.rake" ].sort.each { |ext| load ext }
+ 
+# desc 'Generate RDoc documentation for Sandbox.'
+# Rake::RDocTask.new( :rdoc ) do |rdoc|
+#   files = [ 'README', 'LICENSE', 'lib/**/*.rb' ]
+#   rdoc.rdoc_files.add( files )
+#   rdoc.main = "README" # page to start on
+#   rdoc.title = "sandbox"
+#   # rdoc.template = File.exists?( t="/Users/chris/ruby/projects/err/rock/template.rb" ) ? t : "/var/www/rock/template.rb"
+#   rdoc.rdoc_dir = 'doc' # rdoc output folder
+#   rdoc.options << '--inline-source'
+# end

data/TODO

@@ -0,0 +1,14 @@
+
+* 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
+    

data/bin/sandbox

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'sandbox/cli'
+Sandbox::CLI.execute( ARGV )

data/features/development.feature

@@ -0,0 +1,13 @@
+Feature: Development processes of newgem itself (rake tasks)
+
+  As a Newgem maintainer or contributor
+  I want rake tasks to maintain and release the gem
+  So that I can spend time on the tests and code, and not excessive time on maintenance processes
+    
+  Scenario: Generate RubyGem
+    Given this project is active project folder
+    And 'pkg' folder is deleted
+    When task 'rake gem' is invoked
+    Then folder 'pkg' is created
+    And file with name matching 'pkg/*.gem' is created else you should run "rake manifest" to fix this
+    And gem spec key 'rdoc_options' contains /--mainREADME.rdoc/

data/features/steps/common.rb

@@ -0,0 +1,174 @@
+def in_project_folder(&block)
+  project_folder = @active_project_folder || @tmp_root
+  FileUtils.chdir(project_folder, &block)
+end
+
+def in_home_folder(&block)
+  FileUtils.chdir(@home_path, &block)
+end
+
+Given %r{^a safe folder} do
+  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  FileUtils.mkdir_p @tmp_root
+  FileUtils.mkdir_p @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+  Given "env variable $HOME set to '#{@home_path}'"
+end
+
+Given %r{^this project is active project folder} do
+  Given "a safe folder"
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given %r{^env variable \$([\w_]+) set to '(.*)'} do |env_var, value|
+  ENV[env_var] = value
+end
+
+def force_local_lib_override(project_name = @project_name)
+  rakefile = File.read(File.join(project_name, 'Rakefile'))
+  File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+    f << "$:.unshift('#{@lib_path}')\n"
+    f << rakefile
+  end
+end
+
+def setup_active_project_folder project_name
+  @active_project_folder = File.join(@tmp_root, project_name)
+  @project_name = project_name
+end
+
+Given %r{'(.*)' folder is deleted} do |folder|
+  in_project_folder do
+    FileUtils.rm_rf folder
+  end
+end
+
+When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
+  FileUtils.chdir(@active_project_folder) do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES)
+  end
+end
+
+When %r{run executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "ruby #{executable} #{arguments} > #{@stdout}"
+  end
+end
+
+When %r{^task 'rake (.*)' is invoked$} do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then %r{^folder '(.*)' is created} do |folder|
+  in_project_folder do
+    File.exists?(folder).should be_true
+  end
+end
+
+Then %r{^file '(.*)' (is|is not) created} do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then %r{^file with name matching '(.*)' is created} do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then %r{gem file '(.*)' and generated file '(.*)' should be the same} do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then %r{^output same as contents of '(.*)'$} do |file|
+  expected_output = File.read(File.join(File.dirname(__FILE__) + "/../expected_outputs", file))
+  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}")
+  actual_output.should == expected_output
+end
+
+Then %r{^(does|does not) invoke generator '(.*)'$} do |does_invoke, generator|
+  actual_output = File.read(File.dirname(__FILE__) + "/../../tmp/#{@stdout}")
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then %r{help options '(.*)' and '(.*)' are displayed} do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then %r{^output (does|does not) match \/(.*)\/} do |does, regex|
+  actual_output = File.read(@stdout)
+  (does == 'does') ?
+    actual_output.should(match(/#{regex}/)) :
+    actual_output.should_not(match(/#{regex}/)) 
+end
+
+Then %r{^contents of file '(.*)' (does|does not) match \/(.*)\/} do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then %r{^all (\d+) tests pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^all (\d+) examples pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^yaml file '(.*)' contains (\{.*\})} do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then %r{^Rakefile can display tasks successfully} do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then %r{^task 'rake (.*)' is executed successfully} do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then %r{^gem spec key '(.*)' contains \/(.*)\/} do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end

data/features/steps/env.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../../lib/sandbox"
+
+# gem 'cucumber'
+# require 'cucumber'
+# gem 'rspec'
+# require 'spec'
+
+begin
+  require 'cucumber'
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'cucumber'
+  require 'spec'
+end

data/lib/sandbox/cli.rb

@@ -0,0 +1,185 @@
+
+require 'optparse'
+require 'sandbox'
+
+module Sandbox  
+  class CLI
+    
+    DEFAULTS = {
+      :gems => [ 'rake', ]
+    }
+    
+    ## CLASS METHODS
+    class << self
+      
+      # invokes sandbox via command-line ARGV as the options
+      def execute( args = ARGV )
+        verify_environment!
+        parse( args ).execute!
+      rescue Exception => error
+        handle_error( error )
+      end
+      
+      # returns a new CLI instance which has parsed the given arguments.
+      # will load the command to execute based upon the arguements.
+      # if an error occurs, it will print out simple error message and exit 
+      def parse( args )
+        cli = new
+        cli.parse_args!( args )
+        cli
+      end
+      
+      def verify_environment!
+        raise LoadedSandboxError if ENV[ 'SANDBOX' ]
+      end
+      
+      # pretty error handling
+      def handle_error( error )
+        case error
+          when Sandbox::Error
+            puts error.message
+          when StandardError #, Timeout::Error
+            message = [ "Error: #{error.message}" ]
+            message.concat( error.backtrace.collect { |bt| "    #{bt}" } ) if Sandbox.really_verbose?
+            puts message.join( "\n" )
+          when Interrupt
+            puts "Interrupted"
+        else
+          raise error
+        end
+      end
+      
+    end
+    ## END CLASS METHODS
+    
+    ## PUBLIC INSTANCE METHODS
+    public
+    
+    # The options for this execution.
+    attr_reader :options
+    
+    # setup of a new CLI instance
+    def initialize
+      @options = DEFAULTS.dup
+      @parser = nil
+    end
+    
+    
+    # perform the sandbox creation
+    def execute!
+      targets = options.delete( :args )
+      
+      if targets.size < 1
+        raise Sandbox::Error.new( 'no target specified - see `sandbox --help` for assistance' )
+      elsif targets.size > 1
+        raise Sandbox::Error.new( 'multiple targets specified - see `sandbox --help` for assistance' )
+      end
+      
+      options[ :target ] = targets[0]
+      
+      Sandbox::Installer.new( options ).populate
+    end
+    
+    # processes +args+ to:
+    # 
+    # * load global option for the application
+    # * 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 )
+      options[ :original_args ] = args.dup
+      parser.parse!( args )
+    rescue OptionParser::ParseError => ex
+      raise_parse_error( ex.reason, ex.args )
+    else
+      options[ :args ] = args
+    end
+    
+    def parser
+      @parser ||= create_parser
+    end
+    
+    def create_parser
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.program_name = 'sandbox TARGET'
+        o.define_head "Create virtual ruby/rubygems sandboxes."
+        o.separator ""
+        
+        o.separator "ARGUMENTS:"
+        o.separator "  TARGET      Target path to new sandbox.  Must not exist beforehand."
+        o.separator ""
+        
+        o.separator "OPTIONS"
+        o.on( '-g', '--gems gem1,gem2', Array, 'Gems to install after sandbox is created. (defaults to [rake])' ) { |gems| @options[ :gems ] = gems }
+        o.on( '-n', '--no-gems', 'Do not install any gems after sandbox 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.' ) { puts o; exit }
+        o.on_tail( '-H', '--long-help', 'Show the full description about the program' ) { puts long_help; exit }
+        o.on_tail( '-V', '--version', 'Display the program version and exit.' ) { puts Sandbox::Version::STRING; exit }
+        o.separator ""
+      end
+    end
+    
+    def show_help
+      puts parser
+    end
+    
+    def long_help
+      unindent( <<-HELP )
+      --------------------------------------------------------------------------------
+        Sandbox is a utility to create sandboxed Ruby/Rubygems environments.
+        
+        It is meant to address the following issues:
+        1. Conflicts with unspecified gem dependency versions.
+        2. Applications can have their own gem repositories.
+        3. Permissions for installing your own gems.
+        4. Ability to try gems out without installing into your global repository.
+        5. A Simple way to enable this.
+        
+        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.
+        
+        Run the script with the following to enable your new environment:
+          $ source bin/activate
+        
+        When you want to leave the environment:
+          $ deactivate
+        
+        NOTES:
+        1. It creates an environment that has its own installation directory for Gems.
+        2. It doesn't share gems with other sandbox environments.
+        3. It (optionally) doesn't use the globally installed gems either.
+        4. It will use a local to the sandbox .gemrc file
+        
+        WARNINGS:
+        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.
+      HELP
+    end
+    
+    def unindent( output )
+      indent = output[/\A\s*/]
+      output.strip.gsub(/^#{indent}/, "")
+    end
+    
+    ## END PUBLIC INSTANCE METHODS
+    
+    
+    ## PRIVATE INSTANCE METHODS
+    private
+    
+    def raise_parse_error( reason, args=[] )
+        raise Sandbox::ParseError.new( reason, args )
+      end
+    
+    ## END PRIVATE INSTANCE METHODS
+    
+  end
+  
+end

data/lib/sandbox/errors.rb

@@ -0,0 +1,43 @@
+
+module Sandbox
+  
+  class Error < StandardError
+    
+    def initialize( msg=nil )
+      super msg
+    end
+    
+    def message
+      out = []
+      value = super
+      out << "Sandbox error: #{value}"
+      out.concat( backtrace.collect { |bt| "    #{bt}" } ) if Sandbox.really_verbose?
+      out.join( "\n" )
+    end
+    
+  end
+  
+  class LoadedSandboxError < Sandbox::Error
+    
+    def initialize( msg=nil )
+      msg ||= "You cannot run sandbox from a loaded sandbox environment"
+    end
+    
+  end
+  
+  class ParseError < Sandbox::Error
+    
+    def initialize( reason=nil, args=[] )
+      if args.is_a?( Array ) and args.size > 0
+        msg = "#{reason} => #{args.join( ' ' )}"
+      elsif args.is_a?( String ) and args.length > 0
+        msg = "#{reason} => #{args}"
+      else
+        msg = reason
+      end
+      super msg
+    end
+    
+  end
+  
+end