spork 0.4.4 → 0.5.1

data/lib/spork/app_framework/rails.rb

@@ -0,0 +1,109 @@
+class Spork::AppFramework::Rails < Spork::AppFramework
+  
+  # TODO - subclass this out to handle different versions of rails
+  class NinjaPatcher
+    def self.run
+      ::Rails::Initializer.class_eval do
+        alias :load_environment_without_spork :load_environment unless method_defined?(:load_environment_without_spork)
+        def load_environment
+          result = load_environment_without_spork
+          Spork::AppFramework[:Rails].ninja_patcher.install_hooks
+          result
+        end
+      end
+    end
+    
+    def self.install_hooks
+      auto_reestablish_db_connection
+      delay_observer_loading
+      delay_app_preload
+      delay_application_controller_loading
+    end
+    
+    def self.delay_observer_loading
+      if ::Rails::Initializer.instance_methods.include?('load_observers')
+        Spork.trap_method(::Rails::Initializer, :load_observers)
+      end
+      if Object.const_defined?(:ActionController)
+        require "action_controller/dispatcher.rb"
+        Spork.trap_class_method(::ActionController::Dispatcher, :define_dispatcher_callbacks) if ActionController::Dispatcher.respond_to?(:define_dispatcher_callbacks)
+      end
+    end
+    
+    def self.delay_app_preload
+      if ::Rails::Initializer.instance_methods.include?('load_application_classes')
+        Spork.trap_method(::Rails::Initializer, :load_application_classes)
+      end
+    end
+    
+    def self.delay_application_controller_loading
+      if application_controller_source = ["#{Dir.pwd}/app/controllers/application.rb", "#{Dir.pwd}/app/controllers/application_controller.rb"].find { |f| File.exist?(f) }
+        application_helper_source = "#{Dir.pwd}/app/helpers/application_helper.rb"
+        load_paths = (::ActiveSupport.const_defined?(:Dependencies) ? ::ActiveSupport::Dependencies : ::Dependencies).load_paths
+        load_paths.unshift(File.expand_path('rails_stub_files', File.dirname(__FILE__)))
+        Spork.each_run do
+          require application_controller_source
+          require application_helper_source if File.exist?(application_helper_source)
+        end
+      end
+    end
+    
+    def self.auto_reestablish_db_connection
+      if Object.const_defined?(:ActiveRecord)
+        Spork.each_run do
+          ActiveRecord::Base.establish_connection
+        end
+      end
+    end
+  end
+  
+  def bootstrap_required?
+    false
+  end
+  
+  def preload(&block)
+    STDERR.puts "Preloading Rails environment"
+    STDERR.flush
+    ENV["RAILS_ENV"] ||= 'test'
+    preload_rails
+    require environment_file
+    yield
+  end
+  
+  def environment_file
+    @environment_file ||= File.expand_path("config/environment.rb", Dir.pwd)
+  end
+  
+  def boot_file
+    @boot_file ||= File.join(File.dirname(environment_file), 'boot')
+  end
+  
+  def environment_contents
+    @environment_contents ||= File.read(environment_file)
+  end
+  
+  def vendor
+    @vendor ||= File.expand_path("vendor/rails", Dir.pwd)
+  end
+  
+  def version
+    @version ||= (
+      if /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/.match(environment_contents)
+        $1
+      else
+        nil
+      end
+    )
+  end
+  
+  def ninja_patcher
+    ::Spork::AppFramework::Rails::NinjaPatcher
+  end
+  
+  def preload_rails
+    Object.const_set(:RAILS_GEM_VERSION, version) if version
+    require boot_file
+    ninja_patcher.run
+  end
+  
+end

data/lib/spork/app_framework/rails_stub_files/application.rb

@@ -0,0 +1,2 @@
+class ::ApplicationController < ActionController::Base
+end

data/lib/spork/app_framework/rails_stub_files/application_controller.rb

@@ -0,0 +1,2 @@
+class ::ApplicationController < ActionController::Base
+end

data/lib/spork/app_framework/rails_stub_files/application_helper.rb

@@ -0,0 +1,2 @@
+module ::ApplicationHelper
+end

data/lib/spork/app_framework/unknown.rb

@@ -0,0 +1,6 @@
+class Spork::AppFramework::Unknown < Spork::AppFramework
+  def bootstrap_required?
+    true
+  end
+  
+end

data/lib/spork/custom_io_streams.rb

@@ -0,0 +1,23 @@
+module Spork::CustomIOStreams
+  def self.included(klass)
+    klass.send(:extend, ::Spork::CustomIOStreams::ClassMethods)
+  end
+  
+  def stderr
+    self.class.stderr
+  end
+
+  def stdout
+    self.class.stdout
+  end
+  
+  module ClassMethods
+    def stderr
+      $stderr
+    end
+  
+    def stdout
+      $stdout
+    end
+  end
+end

data/lib/spork/diagnoser.rb

@@ -0,0 +1,72 @@
+class Spork::Diagnoser
+  class << self
+    def loaded_files
+      @loaded_files ||= {}
+    end
+    
+    def install_hook!(dir = Dir.pwd)
+      @dir = File.expand_path(Dir.pwd, dir)
+      
+      Kernel.class_eval do
+        alias :require_without_diagnoser :require
+        alias :load_without_diagnoser :load
+        
+        def require(string)
+          ::Spork::Diagnoser.add_included_file(string, caller)
+          require_without_diagnoser(string)
+        end
+        
+        def load(string)
+          ::Spork::Diagnoser.add_included_file(string, caller)
+          load_without_diagnoser(string)
+        end
+      end
+    end
+    
+    def add_included_file(filename, callstack)
+      filename = expand_filename(filename)
+      return unless File.exist?(filename)
+      loaded_files[filename] = caller.select { |f| ! f.include?('lib/spork/diagnoser.rb')} if subdirectory?(filename)
+    end
+    
+    def expand_filename(filename)
+      ([Dir.pwd] + $:).each do |attempted_path|
+        attempted_filename = File.expand_path(filename, attempted_path)
+        return attempted_filename if File.file?(attempted_filename)
+        attempted_filename = attempted_filename + ".rb"
+        return attempted_filename if File.file?(attempted_filename)
+      end
+      filename
+    end
+    
+    def subdirectory?(directory)
+      File.expand_path(directory, Dir.pwd).include?(@dir)
+    end
+    
+    def remove_hook!
+      return unless Kernel.private_instance_methods.include?('require_without_diagnoser')
+      Kernel.class_eval do
+        alias :require :require_without_diagnoser
+        alias :load :load_without_diagnoser
+        
+        undef_method(:require_without_diagnoser)
+        undef_method(:load_without_diagnoser)
+      end
+      true
+    end
+    
+    def output_results(stdout)
+      project_prefix = Dir.pwd + "/"
+      minimify = lambda { |f| f.gsub(project_prefix, '')}
+      stdout.puts "- Spork Diagnosis -\n"
+      stdout.puts "-- Summary --"
+      stdout.puts loaded_files.keys.sort.map(&minimify)
+      stdout.puts "\n\n\n"
+      stdout.puts "-- Detail --"
+      loaded_files.keys.sort.each do |file|
+        stdout.puts "\n\n\n--- #{minimify.call(file)} ---\n"
+        stdout.puts loaded_files[file].map(&minimify)
+      end
+    end
+  end
+end

data/lib/spork/runner.rb

@@ -19,6 +19,7 @@ module Spork
       
       opt.separator "Options:"
       opt.on("-b", "--bootstrap")  {|ignore| @options[:bootstrap] = true }
+      opt.on("-d", "--diagnose")  {|ignore| @options[:diagnose] = true }
       opt.on("-h", "--help")  {|ignore| @options[:help] = true }
       non_option_args = args.select { |arg| ! args[0].match(/^-/) }
       @options[:server_matcher] = non_option_args[0]
@@ -45,7 +46,7 @@ module Spork
       if options[:server_matcher]
         @server = Spork::Server.supported_servers(options[:server_matcher]).first
         unless @server
-          @output.puts <<-ERROR
+          @error.puts <<-ERROR
 #{options[:server_matcher].inspect} didn't match a supported test framework.
 
 #{supported_servers_text}
@@ -54,7 +55,7 @@ module Spork
         end
         
         unless @server.available?
-          @output.puts  <<-USEFUL_ERROR
+          @error.puts  <<-USEFUL_ERROR
 I can't find the helper file #{@server.helper_file} for the #{@server.server_name} testing framework.
 Are you running me from the project directory?
           USEFUL_ERROR
@@ -63,7 +64,7 @@ Are you running me from the project directory?
       else
         @server = Spork::Server.available_servers.first
         if @server.nil?
-          @output.puts  <<-USEFUL_ERROR
+          @error.puts  <<-USEFUL_ERROR
 I can't find any testing frameworks to use.
 Are you running me from a project directory?
           USEFUL_ERROR
@@ -76,12 +77,26 @@ Are you running me from a project directory?
     def run
       return false unless find_server
       ENV["DRB"] = 'true'
-      ENV["RAILS_ENV"] ||= 'test' if server.using_rails?
-      @output.puts "Using #{server.server_name}"
-      return server.bootstrap if options[:bootstrap]
-      return(false) unless server.preload
-      server.run
-      return true
+      @error.puts "Using #{server.server_name}"
+      @error.flush
+      case
+      when options[:bootstrap]
+        server.bootstrap
+      when options[:diagnose]
+        require 'spork/diagnoser'
+        
+        Spork::Diagnoser.install_hook!
+        server.preload
+        Spork::Diagnoser.output_results(@output)
+        return true
+      else
+        return(false) unless server.preload
+        server.run
+        return true
+      end
+    end
+    
+    def diagnose
     end
 
     private

data/lib/spork/server.rb

@@ -1,6 +1,8 @@
 require 'drb/drb'
 require 'rbconfig'
 require 'spork/forker.rb'
+require 'spork/custom_io_streams.rb'
+require 'spork/app_framework.rb'
 
 # This is based off of spec_server.rb from rspec-rails (David Chelimsky), which was based on Florian Weber's TDDMate
 class Spork::Server
@@ -9,6 +11,8 @@ class Spork::Server
   LOAD_PREFERENCE = ['RSpec', 'Cucumber']
   BOOTSTRAP_FILE = File.dirname(__FILE__) + "/../../assets/bootstrap.rb"
   
+  include Spork::CustomIOStreams
+  
   def self.port
     raise NotImplemented
   end
@@ -45,20 +49,16 @@ class Spork::Server
     LOAD_PREFERENCE.index(server_name) || LOAD_PREFERENCE.length
   end
   
-  def self.using_rails?
-    File.exist?("config/environment.rb")
-  end
-  
   def self.bootstrapped?
     File.read(helper_file).include?("Spork.prefork")
   end
   
   def self.bootstrap
     if bootstrapped?
-      puts "Already bootstrapped!"
+      stderr.puts "Already bootstrapped!"
       return
     end
-    puts "Bootstrapping #{helper_file}."
+    stderr.puts "Bootstrapping #{helper_file}."
     contents = File.read(helper_file)
     bootstrap_code = File.read(BOOTSTRAP_FILE)
     File.open(helper_file, "wb") do |f|
@@ -66,7 +66,7 @@ class Spork::Server
       f.puts contents
     end
     
-    puts "Done. Edit #{helper_file} now with your favorite text editor and follow the instructions."
+    stderr.puts "Done. Edit #{helper_file} now with your favorite text editor and follow the instructions."
     true
   end
   
@@ -80,7 +80,8 @@ class Spork::Server
     trap("SIGTERM") { abort; exit!(0) }
     trap("USR2") { abort; restart } if Signal.list.has_key?("USR2")
     DRb.start_service("druby://127.0.0.1:#{port}", self)
-    puts "Spork is ready and listening on #{port}!"
+    stderr.puts "Spork is ready and listening on #{port}!"
+    stderr.flush
     DRb.thread.join
   end
   
@@ -94,9 +95,10 @@ class Spork::Server
   
   def run(argv, stderr, stdout)
     return false if running?
+    
     @child = ::Spork::Forker.new do
       $stdout, $stderr = stdout, stderr
-      Spork.exec_each_run(helper_file)
+      Spork.exec_each_run { load helper_file }
       run_tests(argv, stderr, stdout)
     end
     @child.result
@@ -107,20 +109,30 @@ class Spork::Server
   end
   
   private
+    def self.framework
+      @framework ||= Spork::AppFramework.detect_framework
+    end
+    
     def self.preload
-      if bootstrapped?
-        puts "Loading Spork.prefork block..."
-        Spork.exec_prefork(helper_file)
-      else
-        puts "#{helper_file} has not been sporked.  Run spork --bootstrap to do so."
-        # are we in a rails app?
-        if using_rails?
-          puts "Preloading Rails environment"
-          require "config/environment.rb"
-        else
-          puts "There's nothing I can really do for you.  Bailing."
-          return false
+      Spork.exec_prefork do
+        unless bootstrapped?
+          stderr.puts "#{helper_file} has not been bootstrapped.  Run spork --bootstrap to do so."
+          stderr.flush
+        
+          if framework.bootstrap_required?
+            stderr.puts "I can't do anything for you by default for the framework your using: #{framework.short_name}.\nYou must bootstrap #{helper_file} to continue."
+            stderr.flush
+            return false
+          end
         end
+      
+        framework.preload do
+          if bootstrapped?
+            stderr.puts "Loading Spork.prefork block..."
+            stderr.flush
+            load(helper_file)
+          end
+        end  
       end
       true
     end
@@ -130,7 +142,8 @@ class Spork::Server
     end
     
     def restart
-      puts "restarting"
+      stderr.puts "restarting"
+      stderr.flush
       config       = ::Config::CONFIG
       ruby         = File::join(config['bindir'], config['ruby_install_name']) + config['EXEEXT']
       command_line = [ruby, $0, ARGV].flatten.join(' ')
@@ -144,7 +157,8 @@ class Spork::Server
     def sig_int_received
       if running?
         abort
-        puts "Running tests stopped.  Press CTRL-C again to stop the server."
+        stderr.puts "Running tests stopped.  Press CTRL-C again to stop the server."
+        stderr.flush
       else
         exit!(0)
       end

data/spec/spec_helper.rb

@@ -1,20 +1,102 @@
 require 'rubygems'
 require 'spec'
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-SPEC_TMP_DIR = File.dirname(__FILE__) + "/tmp"
-require 'spork'
-require 'spork/runner.rb'
-require 'spork/server.rb'
-require 'stringio'
-
-Spec::Runner.configure do |config|
-  config.before(:each) do
-    $test_stdout = StringIO.new
+unless $spec_helper_loaded
+  $spec_helper_loaded = true
+
+  $LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+  SPEC_TMP_DIR = File.expand_path('tmp', File.dirname(__FILE__))
+  
+  require 'spork'
+  require 'spork/runner.rb'
+  require 'spork/server.rb'
+  require 'spork/diagnoser.rb'
+  require 'stringio'
+  require 'fileutils'
+
+  Spec::Runner.configure do |config|
+    config.before(:each) do
+      $test_stdout = StringIO.new
+      $test_stderr = StringIO.new
+    end
+  
+    config.after(:each) do
+      FileUtils.rm_rf(SPEC_TMP_DIR) if File.directory?(SPEC_TMP_DIR)
+    
+    end
+  
+    def create_file(filename, contents)
+      FileUtils.mkdir_p(SPEC_TMP_DIR) unless File.directory?(SPEC_TMP_DIR)
+    
+      in_current_dir do
+        FileUtils.mkdir_p(File.dirname(filename))
+        File.open(filename, 'wb') { |f| f << contents }
+      end
+    end
+  
+    def in_current_dir(&block)
+      Dir.chdir(current_dir, &block)
+    end
+  
+    def current_dir
+      @current_dir ||= SPEC_TMP_DIR
+    end
+  end
+
+
+  module Spec
+    module Matchers
+      class IncludeAStringLike
+        def initialize(substring_or_regex)
+          case substring_or_regex
+          when String
+            @regex = Regexp.new(Regexp.escape(substring_or_regex))
+          when Regexp
+            @regex = substring_or_regex
+          else
+            raise ArgumentError, "don't know what to do with the #{substring_or_regex.class} you provided"
+          end
+        end
+
+        def matches?(list_of_strings)
+          @list_of_strings = list_of_strings
+          @list_of_strings.any? { |s| s =~ @regex }
+        end
+        def failure_message
+          "#{@list_of_strings.inspect} expected to include a string like #{@regex.inspect}"
+        end
+        def negative_failure_message
+          "#{@list_of_strings.inspect} expected to not include a string like #{@regex.inspect}, but did"
+        end
+      end
+
+      def include_a_string_like(substring_or_regex)
+        IncludeAStringLike.new(substring_or_regex)
+      end
+    end
   end
+
+  module Spork::TestIOStreams
+    def self.included(klass)
+      klass.send(:extend, ::Spork::TestIOStreams::ClassMethods)
+    end
+  
+    def stderr
+      self.class.stderr
+    end
+
+    def stdout
+      self.class.stdout
+    end
+  
+    module ClassMethods
+      def stderr
+        $test_stderr
+      end
   
-  config.after(:each) do
-    FileUtils.rm_rf(SPEC_TMP_DIR)
+      def stdout
+        $test_stdout
+      end
+    end
   end
 end