timcharper-spork 0.3

data/README.rdoc

@@ -0,0 +1,70 @@
+= Spork
+
+* http://github.com/timcharper/spork
+
+== SYNOPSIS:
+
+Spork is a Drb spec server (similar to the script/spec_server provided by rspec-rails), except rather than using the Rails constant unloading to reload your files, it forks a copy of the server each time you run your specs.  The result?  Spork runs more solid: it doesn't get corrupted over time, and it properly handles modules and any voo-doo meta programming you may have put in your app.
+
+Because Spork uses Kernel.fork, it only works on POSIX systems.  This means Windows users are not invited to this party.  Sorry :(
+
+Spork is still experimental, but is performing solid for us.
+
+== INSTALL:
+
+  [sudo] gem install timcharper-spork --source http://gems.github.com/
+
+alternatively:
+
+  git clone git://github.com/timcharper/spork.git
+  cd spork
+  gem build spork.gemspec
+  sudo gem install spork.gemspec
+
+== Usage
+
+From a terminal, change to your project directory.
+
+Then, bootstrap your spec/spec_helper.rb file.
+
+  spork --bootstrap
+
+Next, edit spec/spec_helper.rb and follow the instructions that were put at the top.
+
+Finally, run spork.  A spec DRb server will be running!
+
+  spork
+
+To get the TextMate RSpec bundle to use spork, go to config->advanced->shell variables, and add TM_RSPEC_OPTS=--drb.
+
+To run from the command line, use spec --drb spec/lib/my_spec.rb
+
+Or, you could add --drb to your spec.opts file.
+
+== Some potential issues and ways to overcome them:
+
+=== ActiveRecord reports "connection has gone away" for the first few specs
+
+Not sure why this happens, but if you simply add a line to re-establish your database connection on each line as follows, the problem goes away:
+
+  Spork.each_run do
+    ActiveRecord::Base.establish_connection # make sure that the db connection is ready.
+  end
+
+=== Couldn't find formatter class Spec::Runner::Formatter::TextMateFormatter Make sure the --require option is specified *before* --format
+
+On one of our projects, many of us using TextMate with spork, only one developer got this error message while the rest of us ran just fine.  I don't know exactly why it happened, but requiring the textmate formatter in the prefork block made it go away, like this:
+
+  Spork.prefork do
+    gem "rspec", "= 1.2.6"
+    require 'spec'
+    ...
+    require 'spec/runner/formatter/text_mate_formatter'
+    ...
+  end
+
+== Kudos to
+
+* Ben Mabey - help with documentation, testing, suggestions.
+* David Chelimsky - for the fine RSpec testing framework, and the original rspec-rails spec_server implementation, which Spork has built upon.
+* Lead Media Partners - just for being an awesome place to work.

data/assets/bootstrap.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'spork'
+
+Spork.prefork do
+  # Loading more in this block will cause your specs to run faster. However, 
+  # if you change any configuration or code from libraries loaded here, you'll
+  # need to restart spork for it take effect.
+  
+end
+
+Spork.each_run do
+  # This code will be run each time you run your specs.
+  
+end
+
+# --- Instructions ---
+# - Sort through your spec_helper file. Place as much environment loading 
+#   code that you don't normally modify during development in the 
+#   Spork.prefork block.
+# - Place the rest under Spork.each_run block
+# - Any code that is left outside of the blocks will be ran during preforking
+#   and during each_run!
+# - These instructions should self-destruct in 10 seconds.  If they don't,
+#   feel free to delete them.
+#
+
+
+
+

data/bin/spork

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+gem 'test-unit', '1.2.3' if RUBY_VERSION.to_f >= 1.9
+
+require 'rubygems'
+require 'spork'
+require 'optparse'
+
+ENV["DRB"] = 'true'
+ENV["RAILS_ENV"] ||= 'test' if Spork.using_rails?
+
+options = {}
+parser = OptionParser.new
+parser.on("-d", "--daemon")     {|ignore| options[:daemon] = true }
+parser.on("-b", "--bootstrap")  {|ignore| options[:bootstrap] = true }
+parser.on("-p", "--pid PIDFILE"){|pid|    options[:pid]    = pid  }
+parser.parse!(ARGV)
+
+unless File.exist?(Spork::SPEC_HELPER_FILE)
+  puts <<-USEFUL_ERROR
+Bummer!
+
+I can't find the file spec/spec_helper.rb, which I need in order to run.
+
+Are you running me from a project directory that has rspec set up?
+USEFUL_ERROR
+  exit 1
+end
+
+if options[:bootstrap]
+  if Spork.bootstrap
+    exit 0
+  else
+    exit 1
+  end
+end
+
+require 'spork/spec_server'
+Spork.preload || exit(1)
+
+if options[:daemon]
+  ::Spork::SpecServer.daemonize(options[:pid])
+else
+  ::Spork::SpecServer.run
+end
+

data/lib/spork/spec_server.rb

@@ -0,0 +1,58 @@
+require 'drb/drb'
+require 'rbconfig'
+
+# This is based off of spec_server.rb from rspec-rails (David Chelimsky), which was based on Florian Weber's TDDMate
+class Spork::SpecServer
+  DRB_PORT = 8989
+  def self.restart_test_server
+    puts "restarting"
+    config       = ::Config::CONFIG
+    ruby         = File::join(config['bindir'], config['ruby_install_name']) + config['EXEEXT']
+    command_line = [ruby, $0, ARGV].flatten.join(' ')
+    exec(command_line)
+  end
+
+  def self.daemonize(pid_file = nil)
+    return yield if $DEBUG
+    pid = Process.fork{
+      Process.setsid
+      trap("SIGINT"){ exit! 0 }
+      trap("SIGTERM"){ exit! 0 }
+      trap("SIGHUP"){ restart_test_server }
+      File.open("/dev/null"){|f|
+        STDERR.reopen f
+        STDIN.reopen  f
+        STDOUT.reopen f
+      }
+      run
+    }
+    puts "spec_server launched (PID: %d)" % pid
+    File.open(pid_file,"w"){|f| f.puts pid } if pid_file
+    exit! 0
+  end
+  
+  def self.run
+    trap("USR2") { ::Spork::SpecServer.restart_test_server } if Signal.list.has_key?("USR2")
+    DRb.start_service("druby://127.0.0.1:#{DRB_PORT}", ::Spork::SpecServer.new)
+    puts "Spork is ready and listening on #{DRB_PORT}!"
+    DRb.thread.join
+  end
+  
+  def run(argv, stderr, stdout)
+    $stdout = stdout
+    $stderr = stderr
+    child_pid = Kernel.fork do
+      Spork.running!
+      load ::Spork::SPEC_HELPER_FILE
+    
+      ::Spec::Runner::CommandLine.run(
+        ::Spec::Runner::OptionParser.parse(
+          argv,
+          $stderr,
+          $stdout
+        )
+      )
+    end
+    Process.wait(child_pid)
+  end
+end

data/lib/spork.rb

@@ -0,0 +1,67 @@
+module Spork
+  SPEC_HELPER_FILE = File.join(Dir.pwd, "spec/spec_helper.rb")
+  
+  def self.prefork(&block)
+    return if @already_preforked
+    @already_preforked = true
+    yield
+  end
+  
+  def self.each_run(&block)
+    return if @state == :preforking || (@state != :not_using_spork && @already_run)
+    @already_run = true
+    yield
+  end
+  
+  def self.preforking!
+    @state = :preforking
+  end
+  
+  def self.running!
+    @state = :running
+  end
+  
+  def self.state
+    @state ||= :not_using_spork
+  end
+  
+  def self.using_rails?
+    File.exist?("config/environment.rb")
+  end
+  
+  def self.using_prefork?
+    File.read(SPEC_HELPER_FILE).include?("Spork.prefork")
+  end
+  
+  def self.bootstrap
+    puts "Bootstrapping #{SPEC_HELPER_FILE}"
+    contents = File.read(SPEC_HELPER_FILE)
+    bootstrap_code = File.read(File.dirname(__FILE__) + "/../assets/bootstrap.rb")
+    File.open(SPEC_HELPER_FILE, "wb") do |f|
+      f.puts bootstrap_code
+      f.puts contents
+    end
+    
+    puts "Done. Edit #{SPEC_HELPER_FILE} now with your favorite text editor and follow the instructions."
+    true
+  end
+  
+  def self.preload
+    if using_prefork?
+      puts "Loading Spork.prefork block..."
+      Spork.preforking!
+      load SPEC_HELPER_FILE
+    else
+      puts "spec_helper.rb is 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
+      end
+    end
+    true
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: timcharper-spork
+version: !ruby/object:Gem::Version 
+  version: "0.3"
+platform: ruby
+authors: 
+- Tim Harper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A forking Drb spec server
+email: 
+- timcharper+spork@gmail.com
+executables: 
+- spork
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/spork
+- lib/spork/spec_server.rb
+- lib/spork.rb
+- assets/bootstrap.rb
+has_rdoc: true
+homepage: http://github.com/timcharper/spork
+post_install_message: 
+rdoc_options: 
+- --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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: spork
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: spork 0.3
+test_files: []
+