nimboids-spork 0.8.99

data/features/rails_delayed_loading_workarounds.feature

@@ -0,0 +1,150 @@
+Feature: Rails Delayed Work arounds
+  To allow a rails developer to update as many parts of his application as possible without needing to restart Spork
+  Spork automatically tells rails to delay loading certain parts of the application until after the fork occurs
+
+  Background: Rails App with RSpec and Spork
+
+    Given I am in a fresh rails project named "test_rails_project"
+    And a file named "spec/spec_helper.rb" with:
+      """
+      require 'rubygems'
+      require 'spork'
+      require 'spork/ext/ruby-debug'
+
+      Spork.prefork do
+        require File.dirname(__FILE__) + '/../config/environment.rb'
+        require 'rspec'
+        require 'rspec/rails'
+      end
+
+      Spork.each_run do
+      end
+      """
+    And the application has a model, observer, route, and application helper
+
+    Given the following code appears in "config/routes.rb" after /routes\.draw/:
+      """
+        resources :users
+      """
+    Given a file named "app/helpers/application_helper.rb" with:
+      """
+      require 'reverseatron'
+      module ApplicationHelper
+        include Reverseatron
+      end
+      """
+    Given a file named "lib/reverseatron.rb" with:
+      """
+      module Reverseatron
+        def reverse_text(txt)
+          txt.reverse
+        end
+      end
+      """
+    Given a file named "app/controllers/users_controller.rb" with:
+      """
+      class UsersController < ApplicationController
+        $loaded_stuff << 'UsersController'
+        def index
+          @users = []
+        end
+      end
+      """
+    Given a file named "app/helpers/misc_helper.rb" with:
+      """
+      module MiscHelper
+        def misc_helper_method
+          'hello miscellaneous'
+        end
+      end
+      """
+    Given a file named "app/helpers/users_helper.rb" with:
+      """
+      module UsersHelper
+      end
+      """
+    Given a file named "app/views/users/index.html.erb" with:
+      """
+        Original View
+      """
+  Scenario: within a view rendered by a controller, calling helper methods from an included module in ApplicationHelper
+    Given a file named "spec/controllers/users_controller_spec.rb" with:
+      """
+      require "spec_helper"
+      describe UsersController do
+        render_views
+        it "renders a page, using a method inherited from ApplicationController" do
+          get :index
+          response.body.should_not include('Original View')
+          puts "Views are not being cached when rendering from a controller"
+
+          response.body.should include('listing users')
+          puts "Controller stack is functioning when rendering from a controller"
+
+          response.body.should include('hello miscellaneous')
+          puts "All helper modules were included when rendering from a controller"
+        end
+      end
+      """
+    Given a file named "spec/views/index.html.erb_spec.rb" with:
+      """
+      require "spec_helper"
+      describe "/users/index.html.erb" do
+
+        it "renders the view" do
+          render
+          rendered.should_not include('Original View')
+          puts "Views are not being cached when rendering directly"
+
+          rendered.should include('listing users')
+          puts "Controller stack is functioning when rendering directly"
+
+          rendered.should include('hello miscellaneous')
+          puts "All helper modules were included when rendering directly"
+        end
+      end
+      """
+    When I fire up a spork instance with "spork rspec"
+    And the contents of "app/views/users/index.html.erb" are changed to:
+      """
+      <%= reverse_text('listing users'.reverse) %>
+      <%= misc_helper_method rescue nil %>
+      <p>Here is a list of users</p>
+      """
+      
+    And I run rspec --drb spec/controllers/users_controller_spec.rb
+    Then the output should contain "Controller stack is functioning when rendering from a controller"
+    And  the output should contain "Views are not being cached when rendering from a controller"
+    And  the output should contain "All helper modules were included when rendering from a controller"
+
+    When I run rspec --drb spec/views/index.html.erb_spec.rb
+    Then the output should contain "Controller stack is functioning when rendering directly"
+    And  the output should contain "Views are not being cached when rendering directly"
+    And  the output should contain "All helper modules were included when rendering directly"
+
+    Given the contents of "app/helpers/application_helper.rb" are changed to:
+      """
+      module ApplicationHelper
+        def make_it_loud(message)
+          message.upcase
+        end
+      end
+      """
+    And the contents of "app/views/users/index.html.erb" are changed to:
+      """
+      <%= make_it_loud('listing users') %>
+      """
+    And the contents of "spec/controllers/users_controller_spec.rb" are changed to:
+      """
+      require "spec_helper"
+      describe UsersController do
+        render_views
+        it "renders a page, using a method inherited from ApplicationController" do
+          get :index
+          response.body.should include('LISTING USERS')
+          puts "Helpers aren't being cached"
+        end
+      end
+      """
+    When I run rspec --drb spec/controllers/users_controller_spec.rb
+    Then the output should contain "Helpers aren't being cached"

data/features/rspec_rails_integration.feature

@@ -0,0 +1,92 @@
+Feature: Rails Integration
+  To get a developer up and running quickly
+  Spork automatically integrates with rails
+  Providing default hooks and behaviors
+
+  Background: Rails App with RSpec and Spork
+    Given I am in a fresh rails project named "test_rails_project"
+    And a file named "spec/spec_helper.rb" with:
+      """
+      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.
+        require File.dirname(__FILE__) + '/../config/environment.rb'
+        require 'rspec'
+        require 'rspec/rails'
+        
+        #### this is for this test only #######
+        $loaded_stuff << 'prefork block' ######
+        #######################################
+      end
+
+      Spork.each_run do
+        # This code will be run each time you run your specs.
+        
+        #### this is for this test only #######
+        $loaded_stuff << 'each_run block' #####
+        #######################################
+      end
+      """
+    And the application has a model, observer, route, and application helper
+  Scenario: Analyzing files were preloaded
+    When I run spork --diagnose
+    Then the output should not contain "user_observer.rb"
+    Then the output should not contain "user.rb"
+    Then the output should not contain "app/controllers/application.rb"
+    Then the output should not contain "app/controllers/application_controller.rb"
+    Then the output should not contain "app/controllers/application_helper.rb"
+    # Then the output should not contain "config/routes.rb"
+  
+  Scenario: Running spork with a rails app and observers
+    Given a file named "spec/did_it_work_spec.rb" with:
+    """
+    require 'spec_helper'
+    describe "Did it work?" do
+      it "checks to see if all worked" do
+        Spork.using_spork?.should == true
+        (Rails.respond_to?(:logger) ? Rails.logger : ActionController::Base.logger).info "hey there"
+        $loaded_stuff.should include('ActiveRecord::Base.establish_connection')
+        $loaded_stuff.should include('User')
+        $loaded_stuff.should include('UserObserver')
+        $loaded_stuff.should include('ApplicationHelper')
+        $loaded_stuff.should include('config/routes.rb')
+        $loaded_stuff.should include('each_run block')
+        $loaded_stuff.should include('prefork block')
+        puts "Specs successfully run within spork, and all initialization files were loaded"
+      end
+    end
+    """
+    When I fire up a spork instance with "spork rspec"
+    And I run rspec --drb spec/did_it_work_spec.rb
+    Then the error output should be empty
+    And the output should contain "Specs successfully run within spork, and all initialization files were loaded"
+    And the file "log/test.log" should include "hey there"
+
+
+  Scenario: Running spork with a rails app and a non-standard port
+    Given a file named "spec/did_it_work_spec.rb" with:
+    """
+    describe "Did it work?" do
+      it "checks to see if all worked" do
+        Spork.using_spork?.should == true
+        (Rails.respond_to?(:logger) ? Rails.logger : ActionController::Base.logger).info "hey there"
+        $loaded_stuff.should include('ActiveRecord::Base.establish_connection')
+        $loaded_stuff.should include('User')
+        $loaded_stuff.should include('UserObserver')
+        $loaded_stuff.should include('ApplicationHelper')
+        $loaded_stuff.should include('config/routes.rb')
+        $loaded_stuff.should include('each_run block')
+        $loaded_stuff.should include('prefork block')
+        puts "Specs successfully run within spork, and all initialization files were loaded"
+      end
+    end
+    """
+    When I fire up a spork instance with "spork rspec --port 7000"
+    And I run rspec --drb --drb-port 7000 spec/did_it_work_spec.rb
+    Then the error output should be empty
+    And the output should contain "Specs successfully run within spork, and all initialization files were loaded"
+    And the file "log/test.log" should include "hey there"

data/features/spork_debugger.feature

@@ -0,0 +1,108 @@
+Feature: Spork Debugger integration
+  As a developer
+  I want to invoke the debugger my specs within Spork
+  In order to drill in and figure out what's wrong
+
+  Scenario: Invoking the debugger via 'debugger'
+    Given a file named "spec/spec_helper.rb" with:
+      """
+      require 'rubygems'
+      require 'spork'
+      require 'spork/ext/ruby-debug'
+
+      Spork.prefork { require 'rspec' }
+      Spork.each_run { }
+      """
+    And a file named "spec/debugger_spec.rb" with:
+      """
+      require 'spec_helper.rb'
+
+      describe "Debugger" do
+        it "should debug" do
+          2.times do |count|
+            @message = "count = #{count}"
+            debugger
+            @message = nil
+          end
+          puts "it worked!"
+        end
+      end
+      """
+
+    When I fire up a spork instance with "spork rspec"
+    And I run this in the background: rspec --drb spec/debugger_spec.rb
+
+    Then the spork window should output a line containing "Debug Session Started"
+
+    When I type this in the spork window: "e @message"
+    Then the spork window should output a line containing "count = 0"
+
+    When I type this in the spork window: "continue"
+
+    When I type this in the spork window: "e @message"
+    Then the spork window should output a line containing "count = 1"
+
+    When I type this in the spork window: "continue"
+
+    Then the spork window should output a line containing "Debug Session Terminated"
+    And the output should contain "it worked!"
+
+  Scenario: When ruby-debug is already required and started.
+      Given a file named "spec/spec_helper.rb" with:
+      """
+      require 'rubygems'
+      require 'spork'
+      require 'ruby-debug'
+      Debugger.start
+
+      require 'spork/ext/ruby-debug'
+
+      Spork.prefork { require 'rspec' }
+      Spork.each_run { }
+      """
+
+    And a file named "spec/debugger_spec.rb" with:
+      """
+      require File.dirname(__FILE__) + '/spec_helper.rb'
+
+      describe "Debugger" do
+        it "should debug" do
+          @message = "yup"
+          debugger
+          puts "it worked!"
+        end
+      end
+      """
+
+    When I fire up a spork instance with "spork rspec"
+    And I run this in the background: rspec --drb spec/debugger_spec.rb
+
+    Then the spork window should output a line containing "Debug Session Started"
+
+    When I type this in the spork window: "e @message"
+    Then the spork window should output a line containing "yup"
+
+    When I type this in the spork window: "continue"
+
+    Then the spork window should output a line containing "Debug Session Terminated"
+    And the output should contain "it worked!"
+
+  Scenario: When ruby-debug is invoked during preload
+      Given a file named "spec/spec_helper.rb" with:
+      """
+      require 'rubygems'
+      require 'spork'
+      require 'spork/ext/ruby-debug'
+
+      STDERR.puts("Spork is ready and listening") # trick out the start spork step to believe spork is ready... naughty, but effective.
+      @message = "it worked"
+      debugger
+      Spork.prefork { require 'rspec' }
+      Spork.each_run { }
+      """
+
+    When I fire up a spork instance with "spork rspec"
+    Then the spork window should output a line containing "spec_helper.rb"
+    When I type this in the spork window: "e @message"
+    Then the spork window should output a line containing "it worked"
+    When I type this in the spork window: "continue"

data/features/steps/general_steps.rb

@@ -0,0 +1,3 @@
+Given /^this scenario is pending.+/ do
+  pending
+end

data/features/steps/rails_steps.rb

@@ -0,0 +1,67 @@
+Given /^I am in a fresh rails project named "(.+)"$/ do |folder_name|
+  @current_dir = SporkWorld::SANDBOX_DIR
+  # version_argument = ENV['RAILS_VERSION'] ? "_#{ENV['RAILS_VERSION']}_" : nil
+  # run("#{SporkWorld::RUBY_BINARY} #{%x{which rails}.chomp} #{folder_name}")
+  run(["rails", "new", folder_name].compact * " ")
+
+  if last_exit_status != 0
+    puts "Couldn't generate project.  Output:\nSTDERR:\n-------\n#{last_stderr}\n------\n\nSTDOUT:\n-------\n#{last_stdout}\n\n"
+    last_exit_status.should == 0
+  end
+  @current_dir = File.join(File.join(SporkWorld::SANDBOX_DIR, folder_name))
+  in_current_dir do
+    FileUtils.ln_sf(ENV["BUNDLE_GEMFILE"], "Gemfile")
+    FileUtils.ln_sf(ENV["BUNDLE_GEMFILE"] + ".lock", "Gemfile.lock")
+    FileUtils.ln_sf(File.dirname(ENV["BUNDLE_GEMFILE"]) + "/.bundle", ".bundle")
+  end
+end
+
+
+Given "the application has a model, observer, route, and application helper" do
+  Given 'the following code appears in "config/application.rb" after /^end/:',
+    """
+    ActiveRecord::Base.observers = [:user_observer]
+    """
+  Given 'a file named "app/models/user.rb" with:',
+    """
+    class User < ActiveRecord::Base
+      $loaded_stuff << 'User'
+    end
+    """
+  Given 'a file named "app/models/user_observer.rb" with:',
+    """
+    class UserObserver < ActiveRecord::Observer
+      $loaded_stuff << 'UserObserver'
+    end
+    """
+  Given 'a file named "app/helpers/application_helper.rb" with:',
+    """
+    module ApplicationHelper
+      $loaded_stuff << 'ApplicationHelper'
+    end
+    """
+  Given 'the following code appears in "config/environment.rb" after /Rails::Initializer.run/:',
+    """
+      config.active_record.observers = :user_observer
+    """
+  Given 'the following code appears in "config/routes.rb" after /^end/:',
+    """
+      $loaded_stuff << 'config/routes.rb'
+    """
+  Given 'a file named "config/initializers/initialize_loaded_stuff.rb" with:',
+    """
+    $loaded_stuff ||= []
+    """
+  Given 'a file named "config/initializers/log_establish_connection_calls.rb" with:',
+    """
+    class ActiveRecord::Base
+      class << self
+        def establish_connection_with_load_logging(*args)
+          $loaded_stuff << 'ActiveRecord::Base.establish_connection'
+          establish_connection_without_load_logging(*args)
+        end
+        alias_method_chain :establish_connection, :load_logging
+      end
+    end
+    """
+end

data/features/steps/sandbox_steps.rb

@@ -0,0 +1,115 @@
+Given /^I am in the directory "(.*)"$/ do |sandbox_dir_relative_path|
+  path = File.join(SporkWorld::SANDBOX_DIR, sandbox_dir_relative_path)
+  FileUtils.mkdir_p(path)
+  @current_dir = File.join(path)
+end
+
+Given /^a file named "([^\"]*)"$/ do |file_name|
+  create_file(file_name, '')
+end
+
+Given /^a file named "([^\"]*)" with:$/ do |file_name, file_content|
+  create_file(file_name, file_content)
+end
+
+When /^the contents of "([^\"]*)" are changed to:$/ do |file_name, file_content|
+  create_file(file_name, file_content)
+end
+
+# the following code appears in "config/environment.rb" after /Rails::Initializer.run/:
+Given /^the following code appears in "([^\"]*)" after \/([^\/]*)\/:$/ do |file_name, regex, content|
+  regex = Regexp.new(regex)
+  in_current_dir do
+    content_lines = File.read(file_name).split("\n")
+    0.upto(content_lines.length - 1) do |line_index|
+      if regex.match(content_lines[line_index])
+        content_lines.insert(line_index + 1, content)
+        break
+      end
+    end
+    File.open(file_name, 'wb') { |f| f << (content_lines * "\n") }
+  end
+end
+
+When /^I run (spork|rspec|cucumber)(| .*)$/ do |command, args|
+  run("#{command} #{args}")
+end
+
+When /^I run this in the background: (spork|rspec|cucumber)(| .*)$/ do |command, args|
+  @background_script = run_in_background("#{command} #{args}")
+end
+
+When /^I fire up a spork instance with "spork(.*)"$/ do |spork_opts|
+  @spork_server = run_in_background("#{SporkWorld::RUBY_BINARY} -I #{Cucumber::LIBDIR} #{SporkWorld::BINARY} #{spork_opts}")
+
+  output = ""
+  begin
+    status = Timeout::timeout(15) do
+      # Something that should be interrupted if it takes too much time...
+      while line = @spork_server.stderr.gets
+        output << line
+        puts line
+        break if line.include?("Spork is ready and listening")
+      end
+    end
+  rescue Timeout::Error
+    puts "I can't seem to launch Spork properly.  Output was:\n#{output}"
+    true.should == false
+  end
+end
+
+Then /^the spork window should output a line containing "(.+)"/ do |expected|
+  output = ""
+  begin
+    status = Timeout::timeout(5) do
+      # Something that should be interrupted if it takes too much time...
+      while line = @spork_server.stdout.gets
+        output << line
+        puts line
+        break if output.include?(expected)
+      end
+    end
+  rescue Timeout::Error
+    output.should include(expected)
+  end
+end
+
+When /^I type this in the spork window: "(.+)"/ do |line|
+  @spork_server.stdin.puts(line)
+  @spork_server.stdin.flush
+end
+
+
+Then /^the file "([^\"]*)" should include "([^\"]*)"$/ do |filename, content|
+  in_current_dir do
+    File.read(filename).should include(content)
+  end
+end
+
+Then /^the (error output|output) should contain$/ do |which, text|
+  (which == "error output" ? last_stderr : last_stdout).should include(text)
+end
+
+Then /^the (error output|output) should contain "(.+)"$/ do |which, text|
+  (which == "error output" ? last_stderr : last_stdout).should include(text)
+end
+
+Then /^the (error output|output) should match \/(.+)\/$/ do |which, regex|
+  (which == "error output" ? last_stderr : last_stdout).should match(Regexp.new(regex))
+end
+
+Then /^the (error output|output) should not contain$/ do |which, text|
+  (which == "error output" ? last_stderr : last_stdout).should_not include(text)
+end
+
+Then /^the (error output|output) should not contain "(.+)"$/ do |which, text|
+  (which == "error output" ? last_stderr : last_stdout).should_not include(text)
+end
+
+Then /^the (error output|output) should be empty$/ do |which|
+  (which == "error output" ? last_stderr : last_stdout).should == ""
+end
+
+Then /^the (error output|output) should be$/ do |which, text|
+  (which == "error output" ? last_stderr : last_stdout).should == text
+end