wakiki-spork 0.8.5

data/lib/spork/app_framework/padrino.rb

@@ -0,0 +1,22 @@
+class Spork::AppFramework::Padrino < Spork::AppFramework
+  
+  def preload(&block)
+    STDERR.puts "Preloading Padrino environment"
+    STDERR.flush
+    ENV["PADRINO_ENV"] ||= "test"
+    require boot_file
+    # Make it so that we don't have to restart Spork if we change, say, a model or routes
+    Spork.each_run { ::Padrino.reload! }
+    yield
+  end
+  
+  def entry_point
+    @entry_point ||= File.expand_path("config/boot.rb", Dir.pwd)
+  end
+  alias :boot_file :entry_point
+  
+  def boot_contents
+    @boot_contents ||= File.read(boot_file)
+  end
+  
+end

data/lib/spork/app_framework/rails.rb

@@ -0,0 +1,167 @@
+class Spork::AppFramework::Rails < Spork::AppFramework
+
+  # TODO - subclass this out to handle different versions of rails
+  # Also... this is the nastiest duck punch ever.  Clean this up.
+  # module NinjaPatcher
+  #   def self.included(klass)
+  #     klass.class_eval do
+  #       unless method_defined?(:load_environment_without_spork)
+  #         alias :load_environment_without_spork :load_environment
+  #         alias :load_environment :load_environment_with_spork
+  #       end
+  #
+  #       def self.run_with_spork(*args, &block) # it's all fun and games until someone gets an eye poked out
+  #         if ENV['RAILS_ENV']
+  #           Object.send(:remove_const, :RAILS_ENV)
+  #           Object.const_set(:RAILS_ENV, ENV['RAILS_ENV'].dup)
+  #         end
+  #         run_without_spork(*args, &block)
+  #       end
+  #
+  #       class << self
+  #         unless method_defined?(:run_without_spork)
+  #           alias :run_without_spork :run
+  #           alias :run :run_with_spork
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  #   def load_environment_with_spork
+  #     result = load_environment_without_spork
+  #     install_hooks
+  #     result
+  #   end
+  #
+  #   def install_hooks
+  #     auto_reestablish_db_connection
+  #     delay_observer_loading
+  #     delay_app_preload
+  #     delay_application_controller_loading
+  #     delay_route_loading
+  #     delay_eager_view_loading
+  #   end
+  #
+  #   def reset_rails_env
+  #     return unless ENV['RAILS_ENV']
+  #     Object.send(:remove_const, :RAILS_ENV)
+  #     Object.const_set(:RAILS_ENV, ENV['RAILS_ENV'].dup)
+  #   end
+  #
+  #   def delay_observer_loading
+  #     if ::Rails::Initializer.instance_methods.map(&:to_sym).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 delay_app_preload
+  #     if ::Rails::Initializer.instance_methods.map(&:to_sym).include?(:load_application_classes)
+  #       Spork.trap_method(::Rails::Initializer, :load_application_classes)
+  #     end
+  #   end
+  #
+  #   def 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)
+  #         # update the rails magic to refresh the module
+  #         ApplicationController.send(:helper, ApplicationHelper)
+  #       end
+  #     end
+  #   end
+  #
+  #   def auto_reestablish_db_connection
+  #     if Object.const_defined?(:ActiveRecord)
+  #       Spork.each_run do
+  #         # rails lib/test_help.rb is very aggressive about overriding RAILS_ENV and will switch it back to test after the cucumber env was loaded
+  #         reset_rails_env
+  #         ActiveRecord::Base.establish_connection
+  #       end
+  #     end
+  #   end
+  #
+  #   def delay_route_loading
+  #     require 'ruby-debug'; require "/Users/timcharper/Library/Application Support/TextMate/Bundles/RubyAMP.tmbundle/Support/ext/debugger_extension.rb"; Debugger.start; Debugger.start_control; debugger
+  #
+  #     if ::Rails::Initializer.instance_methods.map(&:to_sym).include?(:initialize_routing)
+  #       Spork.trap_method(::Rails::Initializer, :initialize_routing)
+  #     end
+  #   end
+  #
+  #   def delay_eager_view_loading
+  #     # So, in testing mode it seems it would be optimal to not eager load
+  #     # views (as your may only run a test that uses one or two views).
+  #     # However, I decided to delay eager loading rather than force it to
+  #     # disable because you may wish to eager load your views (I.E. you're
+  #     # testing concurrency)
+  #
+  #     # Rails 2.3.x +
+  #     if defined?(::ActionView::Template::EagerPath)
+  #       Spork.trap_method(::ActionView::Template::EagerPath, :load!)
+  #     else
+  #       raise "NOCOMMIT"
+  #     end
+  #   end
+  # end
+
+  def preload(&block)
+    STDERR.puts "Preloading Rails environment"
+    STDERR.flush
+    ENV["RAILS_ENV"] ||= 'test'
+    preload_rails
+    yield
+  end
+
+  def entry_point
+    @entry_point ||= File.expand_path("config/environment.rb", Dir.pwd)
+  end
+
+  alias :environment_file :entry_point
+
+  def boot_file
+    @boot_file ||= File.join(File.dirname(environment_file), 'boot')
+  end
+
+  def application_file
+    @application_file ||= File.join(File.dirname(environment_file), 'application')
+  end
+
+  def environment_contents
+    @environment_contents ||= File.read(environment_file)
+  end
+
+  def vendor
+    @vendor ||= File.expand_path("vendor/rails", Dir.pwd)
+  end
+
+  def deprecated_version
+    @version ||= (
+      if /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/.match(environment_contents)
+        $1
+      else
+        nil
+      end
+    )
+  end
+
+  def preload_rails
+    if deprecated_version && (not deprecated_version.match?(/^3/))
+      puts "This version of spork only supports Rails 3.0. To use spork with rails 2.3.x, downgrade to spork 0.8.x."
+      exit 1
+    end
+    require application_file
+    ::Rails.application
+
+    # ::Rails::Initializer.send(:include, Spork::AppFramework::Rails::NinjaPatcher)
+    1
+  end
+
+end

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

@@ -0,0 +1 @@
+load(File.dirname(__FILE__) + "/application_controller.rb")

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

@@ -0,0 +1,22 @@
+# This is a stub used to help Spork delay the loading of the real ApplicationController
+class ::ApplicationController < ActionController::Base
+  @@preloading = true
+  class << self
+    def inherited(klass)
+      (@_descendants ||= []) << klass if @@preloading
+      super
+    end
+
+    def reapply_inheritance!
+      @@preloading = false
+      Array(@_descendants).each do |descendant|
+        descendant.master_helper_module.send(:include, master_helper_module)
+        descendant.send(:default_helper_module!)
+
+        descendant.respond_to?(:reapply_inheritance!) && descendant.reapply_inheritance!
+      end
+    end
+  end
+end
+
+Spork.each_run { ApplicationController.reapply_inheritance! }

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

@@ -0,0 +1,3 @@
+# This is a stub used to help Spork delay the loading of the real ApplicationHelper
+module ::ApplicationHelper
+end

data/lib/spork/app_framework/unknown.rb

@@ -0,0 +1,6 @@
+# This is used if no supported appliction framework is detected
+class Spork::AppFramework::Unknown < Spork::AppFramework
+  def entry_point
+    nil
+  end
+end

data/lib/spork/custom_io_streams.rb

@@ -0,0 +1,25 @@
+# This class is mainly used for testing.
+# When included (and used), it gives us an opportunity to stub out the output streams used for a given class
+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,105 @@
+# The Diagnoser hooks into load and require and keeps track of when files are required / loaded, and who loaded them.
+# It's used when you run spork --diagnose
+#
+# = Example
+#  
+#  Spork::Diagnoser.install_hook!('/path/env.rb', '/path')
+#  require '/path/to/env.rb'
+#  Spork::Diagnoser.output_results(STDOUT)
+class Spork::Diagnoser
+  class << self
+    def loaded_files
+      @loaded_files ||= {}
+    end
+    
+    # Installs the diagnoser hook into Kernel#require and Kernel#load
+    #
+    # == Parameters
+    #
+    # * +entry_file+ - The file that is used to load the project.  Used to filter the backtrace so anything that happens after it is hidden.
+    # * +dir+ - The project directory.  Any file loaded outside of this directory will not be logged.
+    def install_hook!(entry_file = nil, dir = Dir.pwd)
+      @dir = File.expand_path(Dir.pwd, dir)
+      @entry_file = entry_file
+      
+      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
+        private :require
+        
+        def load(string)
+          ::Spork::Diagnoser.add_included_file(string, caller)
+          load_without_diagnoser(string)
+        end
+        private :load
+      end
+    end
+    
+    def add_included_file(filename, callstack)
+      filename = expand_filename(filename)
+      return unless File.exist?(filename)
+      loaded_files[filename] = filter_callstack(caller) if subdirectory?(filename)
+    end
+    
+    # Uninstall the hook. Generally useful only for testing the Diagnoser.
+    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
+    
+    # output the results of a diagnostic run.
+    #
+    # == Parameters
+    #
+    # * +stdout+ - An IO stream to output the results to.
+    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
+    
+    private
+      def filter_callstack(callstack, entry_file = @entry_file)
+        callstack.pop until callstack.empty? || callstack.last.include?(@entry_file) if @entry_file
+        callstack.map do |line|
+          next if line.include?('lib/spork/diagnoser.rb')
+          line.gsub!('require_without_diagnoser', 'require')
+          line
+        end.compact
+      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
+  end
+end

data/lib/spork/ext/rails-reloader.rb

@@ -0,0 +1,14 @@
+Spork.each_run do
+  ::ActiveSupport.const_defined?(:Dependencies) ?
+    ::ActiveSupport::Dependencies.mechanism = :load :
+    ::Dependencies.mechanism = :load
+
+  require 'action_controller/dispatcher'
+  dispatcher = ::ActionController::Dispatcher.new($stdout)
+
+  if ::ActionController::Dispatcher.respond_to?(:reload_application)
+    ::ActionController::Dispatcher.reload_application
+  else
+    dispatcher.reload_application
+  end
+end if Spork.using_spork?

data/lib/spork/ext/ruby-debug.rb

@@ -0,0 +1,150 @@
+require 'socket'
+require 'forwardable'
+
+begin
+require 'ruby-debug'
+
+# Experimental!
+
+class SporkDebugger
+  DEFAULT_PORT = 10_123
+  HOST = '127.0.0.1'
+
+  extend Forwardable
+  def_delegators :state, *[:prepare_debugger, :initialize]
+  attr_reader :state
+
+  class << self
+    attr_reader :instance
+    def run
+      @instance ||= new
+    end
+  end
+
+  def initialize
+    @state = SporkDebugger::PreloadState.new
+    Spork.send(:each_run_procs).unshift(lambda do
+      @state = @state.transition_to_each_run_state
+    end)
+  end
+
+  module NetworkHelpers
+    def find_port(starting_with)
+      port = starting_with
+      begin
+        server = TCPServer.new(HOST, port)
+        server.close
+      rescue Errno::EADDRINUSE
+        port += 1
+        retry
+      end
+
+      port
+    end
+  end
+
+  class PreloadState
+    include NetworkHelpers
+    def initialize
+      Spork.each_run { install_hook }
+      listen_for_connection_signals
+    end
+
+    def finish
+      @tcp_service.close; @tcp_service = nil;
+    end
+
+    def transition_to_each_run_state
+      finish
+      SporkDebugger::EachRunState.new(@port)
+    end
+
+    protected
+      def install_hook
+        Kernel.class_eval do
+          alias :debugger_without_spork_hook :debugger
+          def debugger(steps = 1)
+            SporkDebugger.instance.prepare_debugger
+            debugger_without_spork_hook
+          end
+        end
+      end
+
+      def listen_for_connection_signals
+        @port = SporkDebugger::DEFAULT_PORT
+        begin
+          @tcp_service = TCPServer.new(SporkDebugger::HOST, @port)
+        rescue Errno::EADDRINUSE
+          @port += 1
+          retry
+        end
+        Thread.new { main_loop }
+      end
+
+      def main_loop
+        while @tcp_service do
+          socket = @tcp_service.accept
+          port = Marshal.load(socket)
+          Marshal.dump(true, socket)
+          connect_rdebug_client(port)
+          socket.close
+        end
+      rescue => e
+        puts "error: #{e.class} - #{e}"
+      end
+
+      def connect_rdebug_client(port = Debugger::PORT)
+        puts "\n\n - Debug Session Started - \n\n\n"
+        begin
+          Debugger.start_client(SporkDebugger::HOST, port)
+        rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED
+        end
+        puts "\n\n - Debug Session Terminated - \n\n\n"
+      end
+  end
+
+  class EachRunState
+    include NetworkHelpers
+    def initialize(connection_request_port)
+      @connection_request_port = connection_request_port
+    end
+
+    def prepare_debugger
+      return if @debugger_prepared
+      @debugger_prepared = true
+      port, cport = start_rdebug_server
+      signal_spork_server_to_connect_to_rdebug_server(port)
+      wait_for_connection
+      puts "\n\n - breakpoint - see your spork server for the debug terminal - \n\n"
+    end
+
+    def signal_spork_server_to_connect_to_rdebug_server(rdebug_server_port)
+      socket = TCPSocket.new(SporkDebugger::HOST, @connection_request_port)
+      Marshal.dump(rdebug_server_port, socket)
+      response = Marshal.load(socket)
+      socket.close
+    end
+
+    def start_rdebug_server
+      Debugger.stop if Debugger.started?
+      port = find_port(Debugger::PORT)
+      cport = find_port(port + 1)
+      Debugger.start_remote(SporkDebugger::HOST, [port, cport]) do
+        Debugger.run_init_script(StringIO.new)
+      end
+      Debugger.start
+      [port, cport]
+    end
+
+    protected
+      def wait_for_connection
+        while Debugger.handler.interface.nil?; sleep 0.10; end
+      end
+  end
+end
+
+Spork.prefork { SporkDebugger.run } if Spork.using_spork?
+
+rescue LoadError
+  raise LoadError, "Your project has loaded spork/ext/ruby-debug, which relies on the ruby-debug gem. It appears that ruby-debug is not installed. Please install it."
+end