Roman2K-rails-test-serving 0.1.1 → 0.1.2

data/Manifest

@@ -0,0 +1,6 @@
+lib/rails_test_serving.rb
+LICENSE
+Rakefile
+README.rdoc
+test/rails_test_serving_test.rb
+Manifest

data/README.rdoc

@@ -1,6 +1,6 @@
-Tired of waiting 10 seconds before your tests run? RailsTestServing can make them run almost instantly. Details in the {introduction article}[http://roman.flucti.com/a-test-server-for-rails-applications].
+Tired of waiting 10 seconds before your tests run? RailsTestServing can make them run almost instantly.
 
-== Quick usage instructions
+== Usage
 
 1.  Install the gem:
       gem install Roman2K-rails-test-serving -v '>= 0.1.1' -s http://gems.github.com
@@ -10,8 +10,12 @@ Tired of waiting 10 seconds before your tests run? RailsTestServing can make the
       require 'rails_test_serving'
       RailsTestServing.boot
 
-3.  Append the following line to <tt>~/.bash_login</tt>:
-      export RUBYLIB="test:$RUBYLIB"
+3.  Append the following line to <tt>~/.bash_profile</tt>:
+      export RUBYLIB=".:test:$RUBYLIB"
+    
+    If you get loading errors during the next steps:
+    * Move the +RUBYLIB+ line from <tt>~/.bash_profile</tt> to <tt>~/.bash_login</tt> instead.
+    * If you are using TextMate, you may try to apply {this (hopefully temporary) fix}[http://roman.flucti.com/textmate-fix-for-relative-require-test_helper].
 
 4.  Start the server:
       cd <project-dir>
@@ -22,8 +26,24 @@ Tired of waiting 10 seconds before your tests run? RailsTestServing can make the
       ruby test/unit/account_test.rb -n /balance/
     As a consequence, they work in RubyMate too (⌘R in TextMate).
 
+6.  Details in the {introduction article}[http://roman.flucti.com/a-test-server-for-rails-applications].
+
 <b>Note:</b> if the server is not started, tests fall back to running the usual way.
 
+== Options
+
+An option hash can be specified for RailsTestServing to use, by defining <tt>$test_server_options</tt> right before <tt>require 'rails_test_serving'</tt>. It must be a hash with symbol keys. Currently available options are:
++reload+::  An array of regular expressions (or any object responding to <tt>#===</tt>) matching the name of the files that should be forced to reload right after the regular constant cleanup. Note that the constants these files have defined are not removed before the new +require+.
+
+Example <tt>test_helper.rb</tt> head:
+  require 'rubygems'
+
+  $test_server_options = { :reload => [/blueprint/] }
+  require 'rails_test_serving'
+  RailsTestServing.boot
+  
+  # ...remainder here...
+
 == Caveats
 
 * Tested working with Rails 2.1.2 up to 2.2.0 RC2. Compatibility with versions of Rails out of that range is guaranteed.
@@ -32,4 +52,12 @@ Tired of waiting 10 seconds before your tests run? RailsTestServing can make the
 
 == Credits
 
-Written by {Roman Le Négrate}[http://roman.flucti.com] ({contact}[mailto:roman.lenegrate@gmail.com]). Released under the MIT license: see the +LICENSE+ file.
+Code:
+* {Roman Le Négrate}[http://roman.flucti.com], a.k.a. Roman2K ({contact}[mailto:roman.lenegrate@gmail.com])
+* {Jack Chen}[http://github.com/chendo], a.k.a. chendo
+
+Feedback:
+* Justin Ko
+* {Dr Nic Williams}[http://drnicwilliams.com]
+
+Released under the MIT license: see the +LICENSE+ file.

data/Rakefile

@@ -1,6 +1,6 @@
 require 'echoe'
 
-Echoe.new('rails-test-serving', '0.1.1') do |p|
+Echoe.new('rails-test-serving', '0.1.2') do |p|
   p.description     = "Makes unit tests of a Rails application run instantly"
   p.url             = "https://github.com/Roman2K/rails-test-serving"
   p.author          = "Roman Le Négrate"

data/lib/rails_test_serving.rb

@@ -1,3 +1,4 @@
+require 'pathname'
 require 'thread'
 require 'test/unit'
 require 'drb/unix'
@@ -10,7 +11,31 @@ module RailsTestServing
   class ServerUnavailable < StandardError
   end
   
-  SERVICE_URI = "drbunix:tmp/sockets/test_server.sock"
+  SOCKET_PATH = ['tmp', 'sockets', 'test_server.sock']
+  
+  def self.service_uri
+    @service_uri ||= begin
+      # Determine RAILS_ROOT
+      root, max_depth = Pathname('.'), Pathname.pwd.expand_path.to_s.split(File::SEPARATOR).size
+      until root.join('config', 'boot.rb').file?
+        root = root.parent
+        if root.to_s.split(File::SEPARATOR).size >= max_depth
+          raise "RAILS_ROOT could not be determined"
+        end
+      end
+      root = root.cleanpath
+      
+      # Adjust load path
+      $: << root << root.join('test')
+      
+      # Ensure socket directory exists
+      path = root.join(*SOCKET_PATH)
+      path.dirname.mkpath
+      
+      # URI
+      "drbunix:#{path}"
+    end
+  end
   
   def self.boot(argv=ARGV)
     if argv.delete('--serve')
@@ -20,6 +45,14 @@ module RailsTestServing
     end
   end
   
+  def self.options
+    @options ||= begin
+      options = $test_server_options || {}
+      options[:reload] ||= []
+      options
+    end
+  end
+  
   module ConstantManagement
     extend self
     
@@ -80,7 +113,7 @@ module RailsTestServing
   
     def run_tests!
       handle_process_lifecycle do
-        server = DRbObject.new_with_uri(SERVICE_URI)
+        server = DRbObject.new_with_uri(RailsTestServing.service_uri)
         begin
           puts(server.run($0, ARGV))
         rescue DRb::DRbConnError
@@ -106,7 +139,7 @@ module RailsTestServing
     GUARD = Mutex.new
     
     def self.start
-      DRb.start_service(SERVICE_URI, Server.new)
+      DRb.start_service(RailsTestServing.service_uri, Server.new)
       DRb.thread.join
     end
     
@@ -115,7 +148,6 @@ module RailsTestServing
       enable_dependency_tracking
       start_cleaner
       load_framework
-      
       log "** Test server started (##{$$})\n"
     end
     
@@ -130,6 +162,7 @@ module RailsTestServing
       $stdout.flush
     end
     
+    # TODO clean this up, making 'path' a Pathname instead of a String
     def shorten_path(path)
       shortenable, base = File.expand_path(path), File.expand_path(Dir.pwd)
       attempt = shortenable.sub(/^#{Regexp.escape base + File::SEPARATOR}/, '')
@@ -339,6 +372,12 @@ module RailsTestServing
     
     def clean_up_app
       ActionController::Dispatcher.new(StringIO.new).cleanup_application
+      
+      # Reload files that match :reload here instead of in reload_app since the
+      # :reload option is intended to target files that don't change between two
+      # consecutive runs (an external library for example). That way, they are
+      # reloaded in the background instead of slowing down the next run.
+      reload_specified_source_files
     end
     
     def remove_tests
@@ -349,7 +388,24 @@ module RailsTestServing
     end
     
     def reload_app
+      reload_specified_source_files
       ActionController::Dispatcher.new(StringIO.new).reload_application
     end
+    
+    def reload_specified_source_files
+      to_reload =
+        $".select do |path|
+          RailsTestServing.options[:reload].any? do |matcher|
+            matcher === path
+          end
+        end
+      
+      # Force a reload by removing matched files from $"
+      $".replace($" - to_reload)
+      
+      to_reload.each do |file|
+        require file.split('.').first  # remove extension, most likely '.rb'
+      end
+    end
   end
 end unless defined? RailsTestServing

data/rails-test-serving.gemspec

@@ -1,68 +1,32 @@
+# -*- encoding: utf-8 -*-
 
-# Gem::Specification for Rails-test-serving-0.1.1
-# Originally generated by Echoe
+Gem::Specification.new do |s|
+  s.name = %q{rails-test-serving}
+  s.version = "0.1.2"
 
---- !ruby/object:Gem::Specification 
-name: rails-test-serving
-version: !ruby/object:Gem::Version 
-  version: 0.1.1
-platform: ruby
-authors: 
-- "Roman Le N\xC3\xA9grate"
-autorequire: 
-bindir: bin
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Le N\303\251grate"]
+  s.date = %q{2008-11-18}
+  s.description = %q{Makes unit tests of a Rails application run instantly}
+  s.email = %q{roman.lenegrate@gmail.com}
+  s.extra_rdoc_files = ["lib/rails_test_serving.rb", "LICENSE", "README.rdoc"]
+  s.files = ["lib/rails_test_serving.rb", "LICENSE", "Rakefile", "README.rdoc", "test/rails_test_serving_test.rb", "Manifest", "rails-test-serving.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{https://github.com/Roman2K/rails-test-serving}
+  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers", "--charset", "UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rails-test-serving}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Makes unit tests of a Rails application run instantly}
+  s.test_files = ["test/rails_test_serving_test.rb"]
 
-date: 2008-11-17 00:00:00 +01:00
-default_executable: 
-dependencies: []
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
 
-description: Makes unit tests of a Rails application run instantly
-email: roman.lenegrate@gmail.com
-executables: []
-
-extensions: []
-
-extra_rdoc_files: 
-- lib/rails_test_serving.rb
-- LICENSE
-- README.rdoc
-files: 
-- lib/rails_test_serving.rb
-- LICENSE
-- Manifest
-- Rakefile
-- README.rdoc
-- test/rails_test_serving_test.rb
-- rails-test-serving.gemspec
-has_rdoc: true
-homepage: https://github.com/Roman2K/rails-test-serving
-post_install_message: 
-rdoc_options: 
-- --main
-- README.rdoc
-- --inline-source
-- --line-numbers
-- --charset
-- UTF-8
-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: "1.2"
-  version: 
-requirements: []
-
-rubyforge_project: rails-test-serving
-rubygems_version: 1.3.1
-specification_version: 2
-summary: Makes unit tests of a Rails application run instantly
-test_files: 
-- test/rails_test_serving_test.rb
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/rails_test_serving_test.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+
 require 'test/unit'
 require 'mocha'
 Mocha::Configuration.prevent :stubbing_non_existent_method
@@ -11,6 +12,34 @@ class RailsTestServingTest < Test::Unit::TestCase
   
 # class
 
+  def test_service_uri
+    # RAILS_ROOT is the current directory
+    setup_service_uri_test do
+      FileTest.expects(:file?).with("config/boot.rb").returns true
+      FileUtils.expects(:mkpath).with("tmp/sockets")
+      assert_equal "drbunix:tmp/sockets/test_server.sock", RailsTestServing.service_uri
+    end
+    
+    # RAILS_ROOT is in the parent directory
+    setup_service_uri_test do
+      FileTest.stubs(:file?).with("config/boot.rb").returns false
+      FileTest.stubs(:file?).with("../config/boot.rb").returns true
+      FileUtils.expects(:mkpath).with("../tmp/sockets")
+      assert_equal "drbunix:../tmp/sockets/test_server.sock", RailsTestServing.service_uri
+    end
+    
+    # RAILS_ROOT cannot be determined
+    setup_service_uri_test do
+      Pathname.stubs(:pwd).returns(Pathname("/foo/bar"))
+      FileTest.expects(:file?).with("config/boot.rb").returns false
+      FileTest.expects(:file?).with("../config/boot.rb").returns false
+      FileTest.expects(:file?).with("../../config/boot.rb").returns false
+      FileTest.expects(:file?).with("../../../config/boot.rb").never
+      FileUtils.expects(:mkpath).never
+      assert_raise(RuntimeError) { RailsTestServing.service_uri }
+    end
+  end
+
   def test_boot
     argv = []
     Client.expects(:run_tests)
@@ -26,6 +55,18 @@ class RailsTestServingTest < Test::Unit::TestCase
     RailsTestServing.boot(argv)
     assert_equal [], argv
   end
+  
+private
+
+  def setup_service_uri_test(wont_mkpath=false)
+    old_load_path = $:.dup
+    begin
+      return yield
+    ensure
+      RailsTestServing.instance_variable_set(:@service_uri, nil)
+      $:.replace(old_load_path)
+    end
+  end
 end
 
 class RailsTestServing::ConstantManagementTest < Test::Unit::TestCase
@@ -210,3 +251,44 @@ private
     S.new
   end
 end
+
+class RailsTestServing::CleanerTest < Test::Unit::TestCase
+  include RailsTestServing
+  
+# private
+
+  def test_reload_specified_source_files
+    Cleaner.any_instance.stubs(:start_worker)
+    
+    # Empty :reload option
+    preserve_features do
+      $".replace ["foo.rb"]
+      RailsTestServing.stubs(:options).returns({:reload => []})
+      
+      Cleaner.any_instance.expects(:require).never
+      Cleaner.new.instance_eval { reload_specified_source_files }
+      assert_equal ["foo.rb"], $"
+    end
+    
+    # :reload option contains regular expressions
+    preserve_features do
+      $".replace ["foo.rb", "bar.rb"]
+      RailsTestServing.stubs(:options).returns({:reload => [/foo/]})
+      
+      Cleaner.any_instance.expects(:require).with("foo").once
+      Cleaner.new.instance_eval { reload_specified_source_files }
+      assert_equal ["bar.rb"], $"
+    end
+  end
+  
+private
+
+  def preserve_features
+    old = $".dup
+    begin
+      return yield
+    ensure
+      $".replace(old)
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: Roman2K-rails-test-serving
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - "Roman Le N\xC3\xA9grate"
 autorequire: 
 bindir: bin
-cert_chain: 
-date: 2008-11-16 15:00:00 -08:00
+cert_chain: []
+
+date: 2008-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -25,10 +26,10 @@ extra_rdoc_files:
 files: 
 - lib/rails_test_serving.rb
 - LICENSE
-- Manifest
 - Rakefile
 - README.rdoc
 - test/rails_test_serving_test.rb
+- Manifest
 - rails-test-serving.gemspec
 has_rdoc: true
 homepage: https://github.com/Roman2K/rails-test-serving