spork 0.9.2 → 1.0.0rc0

data/Gemfile

@@ -1,7 +1,9 @@
 source :gemcutter
+gemspec
 gem 'cucumber', '~> 1.0.0'
-gem 'rspec', '~> 2.6'
+gem 'rspec', '~> 2.8'
 gem 'rake'
+gem "spork", :path => File.expand_path("../", __FILE__)
 
 if RUBY_VERSION =~ /^1\.9/
   gem 'ruby-debug19'

data/README.rdoc

@@ -20,40 +20,44 @@ Spork runs on POSIX systems using fork. It also runs on windows by pre-populatin
 
 == Supported Application Frameworks
 
-Actually, Spork ~can~ work with any application framework.  But, it ships with hooks and helpers to make an "out of the box" experience.
+Spork can work with any application framework, but needs work to prevent application files from being eager loaded.
 
-* Rails 3.0 (for Rails 2.{1,2,3}.x, please try spork 0.8.x)
-* Padrino
+See https://github.com/sporkrb/spork/wiki/Supported-Application-Frameworks for a list of supported frameworks and their gems.
 
 == INSTALL:
 
-=== rubygems:
+NOTICE:
 
-  [sudo] gem install spork --version 0.9.0
+* Rails support (and other app frameworks) have been extracted. If using spork with rails, you'll want to use spork-rails gem, https://github.com/sporkrb/spork-rails.
 
-(Rails 2.x)
+* If you wish to use the stable verson of spork 0.9, refer to https://github.com/sporkrb/spork/tree/v0.9.x
 
-  [sudo] gem install spork --version 0.8.4
-
-=== bundler:
+=== Bundler:
 
 Add to your Gemfile:
 
-  gem 'spork', '~> 0.9.0'
-
-(Rails 2.x, use this)
-
-  gem 'spork', '~> 0.8'
+  gem 'spork', '~> 1.0rc'
 
 == Usage
 
 From a terminal, change to your project directory.
 
-Then, bootstrap your spec/spec_helper.rb file.
+Then, bootstrap your test helper file. If running rspec,
+
+  spork rspec --bootstrap
+
+Cucumber:
+
+  spork cucumber --bootstrap
+
+TestUnit:
+
+  (Install the spork-testunit gem)
+  spork test_unit --bootstrap
 
-  spork --bootstrap
+(If you don't specifiy a test framework, spork will find one and pick it.)
 
-Next, edit spec/spec_helper.rb and follow the instructions that were put at the top.
+Follow the instructions.
 
 Finally, run spork.  A spec DRb server will be running!
 
@@ -131,4 +135,4 @@ See http://wiki.github.com/sporkrb/spork/troubleshooting
 * Roger Pack - JRuby support / Windows
 * Donald Parish - Windows support (Magazine strategy)
 
-Spork (c) 2011 Tim Harper, released under the MIT license
+Spork (c) 2012 Tim Harper, released under the MIT license

data/features/diagnostic_mode.feature

@@ -11,7 +11,7 @@ Feature: Diagnostic Mode
       require 'spork'
 
       Spork.prefork do
-        require 'lib/awesome.rb'
+        require './lib/awesome.rb'
         require '../external_dependency/super_duper.rb'
       end
 
@@ -38,4 +38,3 @@ Feature: Diagnostic Mode
     And the output should contain "spec/spec_helper.rb:5"
     And the output should not contain "super_duper.rb"
     And the output should not contain "diagnose.rb"
-     

data/features/support/bundler_helpers.rb

@@ -1,4 +1,3 @@
-require 'bundler'
 module BundlerHelpers
   extend self
   def install_bundle(dir)
@@ -19,7 +18,7 @@ module BundlerHelpers
       FileUtils.rm(gemfile_lock)
       FileUtils.rm_rf(dir + "/.bundle")
     when ! File.exist?(bundle_environment)
-      puts "Bundle #{gemfile} not installed.  Installing..."
+      puts "Installing bundle #{gemfile}..."
     when File.mtime(bundle_environment) < File.mtime(gemfile_lock)
       puts "#{gemfile_lock} is newer than #{bundle_environment}.  Reinstalling"
     else
@@ -28,13 +27,8 @@ module BundlerHelpers
     install_bundle(dir)
   end
 
-  def expand_gemfile(gemfile)
-    possibilities = [File.expand_path(gemfile, Dir.pwd), SporkWorld::GEMFILES_ROOT + gemfile + "Gemfile"]
-    possibilities.detect {|f| File.exist?(f)} || raise(RuntimeError, %(Gemfile not found:\n #{possibilities * "\n"}))
-  end
-
   def set_gemfile(gemfile)
-    gemfile = expand_gemfile(gemfile || "rails3.0")
+    gemfile = File.expand_path(gemfile)
     ensure_installed(File.dirname(gemfile))
     ENV["BUNDLE_GEMFILE"] = gemfile.to_s
   end

data/features/support/env.rb

@@ -1,105 +1,18 @@
 require 'rubygems'
 require 'pathname'
-require 'fileutils'
-require 'forwardable'
-require 'tempfile'
 require 'rspec/expectations'
 require 'timeout'
 
-require(File.dirname(__FILE__) + '/background_job.rb')
-
-SPORK_ROOT    = Pathname.new(File.expand_path('../../', File.dirname(__FILE__)))
-class SporkWorld
-  RUBY_BINARY   = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
-  BINARY        = SPORK_ROOT + 'bin/spork'
-  SANDBOX_DIR   = SPORK_ROOT + "tmp/sandbox"
-  GEMFILES_ROOT = SPORK_ROOT + "features/gemfiles"
-  SPORK_LIBDIR  = SPORK_ROOT + "lib"
-  
-  extend Forwardable
-  def_delegators SporkWorld, :sandbox_dir, :spork_lib_dir
-
-  def spork_lib_dir
-    @spork_lib_dir ||= File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
-  end
-
-  def initialize
-    @current_dir = SANDBOX_DIR
-    @background_jobs = []
-  end
-
-  private
-  attr_reader :last_exit_status, :last_stderr, :last_stdout, :background_jobs
-  def last_stderr
-    return @last_stderr if @last_stderr
-    if @background_job
-      @last_stderr = @background_job.stderr.read
-    end
-  end
-
-
-  def last_stdout
-    return @last_stdout if @last_stdout
-    if @background_job
-      @last_stdout = @background_job.stdout.read
-    end
-  end
-
-  def create_file(file_name, file_content)
-    file_content.gsub!("SPORK_LIB", "'#{spork_lib_dir}'") # Some files, such as Rakefiles need to use the lib dir
-    in_current_dir do
-      FileUtils.mkdir_p(File.dirname(file_name))
-      File.open(file_name, 'w') { |f| f << file_content }
-    end
-  end
-
-  def in_current_dir(&block)
-    Dir.chdir(@current_dir, &block)
-  end
-
-  def run(command)
-    stderr_file = Tempfile.new('spork')
-    stderr_file.close
-    in_current_dir do
-      @last_stdout = `env RUBYOPT= bundle exec #{command} 2> #{stderr_file.path}`
-      @last_exit_status = $?.exitstatus
-    end
-    @last_stderr = IO.read(stderr_file.path)
-  end
-
-  def run_in_background(command)
-    in_current_dir do
-      @background_job = BackgroundJob.run("env RUBYOPT= bundle exec " +  command)
-    end
-    @background_jobs << @background_job
-    @background_job
-  end
-
-  def terminate_background_jobs
-    if @background_jobs
-      @background_jobs.each do |background_job|
-        background_job.kill
-      end
-    end
-    @background_jobs.clear
-    @background_job = nil
-  end
-end
-
-require((SPORK_ROOT + "features/support/bundler_helpers.rb").to_s)
-BundlerHelpers.set_gemfile(ENV["GEMFILE"])
+APP_ROOT    = Pathname.new(File.expand_path('../../', File.dirname(__FILE__)))
+SANDBOX_DIR = APP_ROOT + "tmp/sandbox"
 
+require(APP_ROOT + "features/support/background_job.rb")
+require(APP_ROOT + "features/support/spork_world.rb")
 
 World do
   SporkWorld.new
 end
 
-Before do
-  FileUtils.rm_rf SporkWorld::SANDBOX_DIR
-  FileUtils.mkdir_p SporkWorld::SANDBOX_DIR
-end
-
-After do
-  # FileUtils.rm_rf SporkWorld::SANDBOX_DIR
-  terminate_background_jobs
-end
+# FileUtils.rm_rf SporkWorld::SANDBOX_DIR
+Before { reset_sandbox_dir }
+After  { terminate_background_jobs }

data/features/support/spork_world.rb

@@ -0,0 +1,84 @@
+require 'forwardable'
+require 'fileutils'
+require 'tempfile'
+require 'pathname'
+
+class SporkWorld
+  SPORK_ROOT    = Pathname.new(File.expand_path('../../', File.dirname(__FILE__)))
+  RUBY_BINARY   = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+  BINARY        = SPORK_ROOT + 'bin/spork'
+
+  extend Forwardable
+  def_delegators SporkWorld, :sandbox_dir, :spork_lib_dir
+
+  def spork_lib_dir
+    @spork_lib_dir ||= File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
+  end
+
+  def initialize
+    @current_dir = SANDBOX_DIR
+    @background_jobs = []
+  end
+
+  private
+  attr_reader :last_exit_status, :last_stderr, :last_stdout, :background_jobs
+  def last_stderr
+    return @last_stderr if @last_stderr
+    if @background_job
+      @last_stderr = @background_job.stderr.read
+    end
+  end
+
+
+  def last_stdout
+    return @last_stdout if @last_stdout
+    if @background_job
+      @last_stdout = @background_job.stdout.read
+    end
+  end
+
+  def create_file(file_name, file_content)
+    file_content.gsub!("SPORK_LIB", "'#{spork_lib_dir}'") # Some files, such as Rakefiles need to use the lib dir
+    in_current_dir do
+      FileUtils.mkdir_p(File.dirname(file_name))
+      File.open(file_name, 'w') { |f| f << file_content }
+    end
+  end
+
+  def in_current_dir(&block)
+    Dir.chdir(@current_dir, &block)
+  end
+
+  def run(command)
+    stderr_file = Tempfile.new('spork')
+    stderr_file.close
+    in_current_dir do
+      @last_stdout = `env RUBYOPT= bundle exec #{command} 2> #{stderr_file.path}`
+      @last_exit_status = $?.exitstatus
+    end
+    @last_stderr = IO.read(stderr_file.path)
+  end
+
+  def run_in_background(command)
+    in_current_dir do
+      @background_job = BackgroundJob.run("env RUBYOPT= bundle exec " +  command)
+    end
+    @background_jobs << @background_job
+    @background_job
+  end
+
+  def terminate_background_jobs
+    if @background_jobs
+      @background_jobs.each do |background_job|
+        background_job.kill
+      end
+    end
+    @background_jobs.clear
+    @background_job = nil
+  end
+
+  def reset_sandbox_dir
+    FileUtils.rm_rf SANDBOX_DIR
+    FileUtils.mkdir_p SANDBOX_DIR
+  end
+end

data/features/unknown_app_framework.feature

@@ -7,7 +7,7 @@ Feature: Unknown app frameworks
     Given a file named "spec/spec_helper.rb" with:
       """
       require 'rubygems'
-      require 'spec'
+      require 'rspec'
       """
     When I run spork
     Then the error output should contain "Using RSpec"
@@ -16,11 +16,10 @@ Feature: Unknown app frameworks
   Scenario: Sporked spec_helper
     Given a file named "spec/spec_helper.rb" with:
       """
-      require 'rubygems'
       require 'spork'
       
       Spork.prefork do
-        require 'spec'
+        require 'rspec'
       end
       
       Spork.each_run do
@@ -31,12 +30,11 @@ Feature: Unknown app frameworks
       """
       describe "Did it work?" do
         it "checks to see if all worked" do
-          Spork.state.should == :using_spork
-          puts "Specs successfully run within spork"
+          Spork.using_spork?.should == true
+          puts 'Specs successfully run within spork'
         end
       end
       """
     When I fire up a spork instance with "spork rspec"
-    And I run spec --drb spec/did_it_work_spec.rb 
+    And I run rspec --drb spec/did_it_work_spec.rb
     Then the output should contain "Specs successfully run within spork"
-  

data/lib/spork.rb

@@ -11,7 +11,6 @@ module Spork
   autoload :Runner,        (LIBDIR + 'spork/runner').to_s
   autoload :Forker,        (LIBDIR + 'spork/forker').to_s
   autoload :Diagnoser,     (LIBDIR + 'spork/diagnoser').to_s
-  autoload :GemHelpers,    (LIBDIR + 'spork/gem_helpers').to_s
 
   class << self
     # Run a block, during prefork mode.  By default, if prefork is called twice in the same file and line number, the supplied block will only be ran once.
@@ -98,15 +97,9 @@ module Spork
     end
     
     def detect_and_require(subfolder)
-      ([LIBDIR.to_s] + other_spork_gem_load_paths).uniq.each do |gem_path|
-        Dir.glob(File.join(gem_path, subfolder)).each { |file| require file }
-      end
-    end
-
-    # This method is used to auto-discover peer plugins such as spork-testunit.
-    def other_spork_gem_load_paths
-      @other_spork_gem_load_paths ||= Spork::GemHelpers.latest_load_paths.grep(/spork/).select do |g|
-        not g.match(%r{/spork-[0-9\-.]+/lib}) # don't include other versions of spork
+      Gem.find_files(subfolder).uniq.each do |path|
+        next if path.match(/_spec\.rb/)
+        require path
       end
     end
 

data/lib/spork/app_framework.rb

@@ -1,41 +1,23 @@
 class Spork::AppFramework
-  # A hash of procs where the key is the class name, and the proc takes no arguments and returns true if it detects that said application framework is being used in the project.
-  # 
-  # The key :Rails maps to Spork::AppFramework::Rails
-  #
-  # This is used to reduce the amount of code needed to be loaded - only the detected application framework's support code is loaded.
-  SUPPORTED_FRAMEWORKS = {
-    :Padrino => lambda {
-      File.exist?("config/boot.rb") && File.read("config/boot.rb").include?('PADRINO')
-    },
-    :Rails => lambda {
-      File.exist?("config/environment.rb") && (
-        File.read("config/environment.rb").include?('RAILS_GEM_VERSION') ||
-        (File.exist?("config/application.rb") && File.read("config/application.rb").include?("Rails::Application"))
-      )
-    }
-  } unless defined? SUPPORTED_FRAMEWORKS
-  
-  def self.setup_autoload
-    ([:Unknown] + SUPPORTED_FRAMEWORKS.keys).each do |name|
-      autoload name, File.join(File.dirname(__FILE__), "app_framework", name.to_s.downcase)
-    end
+  APP_FRAMEWORKS = []
+  def self.inherited(child)
+    APP_FRAMEWORKS << child
   end
-  
   # Iterates through all SUPPORTED_FRAMEWORKS and returns the symbolic name of the project application framework detected.  Otherwise, returns :Unknown
   def self.detect_framework_name
-    SUPPORTED_FRAMEWORKS.each do |key, value|
-      return key if value.call
-    end
-    :Unknown
+    detect_framework.short_name
   end
   
   # Same as detect_framework_name, but returns an instance of the specific AppFramework class.
-  def self.detect_framework
-    name = detect_framework_name
-    self[name]
+  def self.detect_framework_class
+    APP_FRAMEWORKS.select(&:present?).first || Spork::AppFramework::Unknown
   end
   
+  # Same as detect_framework_name, but returns an instance of the specific AppFramework class.
+  def self.detect_framework
+    detect_framework_class.new
+  end
+
   # Initializes, stores, and returns a singleton instance of the named AppFramework.
   #
   # == Parameters
@@ -70,6 +52,10 @@ class Spork::AppFramework
   def short_name
     self.class.short_name
   end
+
+  def self.present?
+    raise "#{self} should have defined #{self}.present?, but didn't"
+  end
   
   protected
     def self.instances
@@ -77,4 +63,4 @@ class Spork::AppFramework
     end
 end
 
-Spork::AppFramework.setup_autoload
+Spork.detect_and_require('spork/app_framework/*.rb')