rspec-isolation 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,8 @@
+source :gemcutter
+
+# Specify your gem's dependencies in rspec-isolation.gemspec
+gemspec
+
+group :development do
+  gem "ruby-debug19", :require => "ruby-debug"
+end

data/README.mkd

@@ -0,0 +1,88 @@
+Running Your Test Cases in Isolation
+====================================
+
+The RSpec examples are generally run in a single ruby process. It dosen't matter until your code introduces some **global variables**, which would **be polluted between examples**. A common solution is to reset them in the `after` hook, but it broken the DRY rule and would bring a lots of extra works. The best way is to **run them in separated sub processes**. This gem would help you to achieve this within a single method call.
+
+Dependency
+----------
+This gem is depended on Rspec 2.0 and above. You should have it installed before using this gem.
+
+Installation
+------------
+
+    sudo gem install rspec-isolation
+
+**Note:** The installation would NOT automatically install the rspec 2.0.
+
+Usage
+----------
+Image a spec file exists:
+
+    $greeting = "Hello, world!"
+
+		describe "Test with global vars" do
+			it "should be replace with my name" do
+				$greeting.gsub!(/\bworld\b/, "Kevin")
+				$greeting.should == "Hello, Kevin!"
+			end
+
+			it "should be replace with my hometown name" do
+			  $greeting.gsub!(/\bworld\b/, "Wuhan")
+			  $greeting.should == "Hello, Wuhan!"
+			end
+		end
+		
+The `$greeting` is polluted in the first example and the second example would failed.
+
+Now we require this gem:
+
+		require 'rspec/isolation'
+		
+Then you can choose one of the following ways to enable the isolation:
+
+1. Using `iso_it`:
+
+		require 'rspec/isolation'
+		$greeting = "Hello, world!"
+
+		describe "Test with global vars" do
+			iso_it "should be replace with my name" do
+				$greeting.gsub!(/\bworld\b/, "Kevin")
+				$greeting.should == "Hello, Kevin!"
+			end
+
+			it "should be replace with my hometown name" do
+			  $greeting.gsub!(/\bworld\b/, "Wuhan")
+			  $greeting.should == "Hello, Wuhan!"
+			end
+		end
+		
+	This would run the first example in a sub process.
+	
+2. Using `run_in_isolation` in `before(:each)` hook:
+
+		require 'rspec/isolation'
+		$greeting = "Hello, world!"
+
+		describe "Test with global vars" do
+			before(:each) do
+				run_in_isolation
+			end
+			it "should be replace with my name" do
+				$greeting.gsub!(/\bworld\b/, "Kevin")
+				$greeting.should == "Hello, Kevin!"
+			end
+
+			it "should be replace with my hometown name" do
+			  $greeting.gsub!(/\bworld\b/, "Wuhan")
+			  $greeting.should == "Hello, Wuhan!"
+			end
+		end
+		
+	This would run all examples in separated sub process. Note: It does not work 
+	if you put `run_in_isolation` in a `before(:all)` hook.
+	
+Author
+------
+Kevin Fu, corntrace@gmail.com, @corntrace. If you like and use this gem, please feel free to give me any
+recommandation.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rspec/isolation.rb

@@ -0,0 +1,10 @@
+module RSpec
+  module Isolation
+    def run_in_isolation
+      example.metadata[:run_in_isolation] = true
+    end
+  end
+end
+
+# $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rspec/isolation/core_ext'

data/lib/rspec/isolation/core_ext.rb

@@ -0,0 +1,71 @@
+RSpec::Core::ExampleGroup.send :include, RSpec::Isolation
+RSpec::Core::ExampleGroup.alias_example_to :run_in_isolation, :run_in_isolation => true
+RSpec::Core::ExampleGroup.alias_example_to :iso_it, :run_in_isolation => true
+
+RSpec::Core::Example.class_eval do
+  
+  delegate_to_metadata :run_in_isolation
+  
+  def isolated?
+    !!run_in_isolation
+  end
+  
+  def isolated_or_normal
+    if isolated?
+      read, write = IO.pipe
+      pid = fork do
+        read.close
+        begin
+          rest = yield
+          write.puts [Marshal.dump(rest)].pack("m")
+        rescue Exception => e
+          write.puts [Marshal.dump(e)].pack("m")
+        end
+        exit!
+      end
+      write.close
+      result = Marshal.load(read.read.unpack("m").first)
+      Process.wait2(pid)
+      return result
+    else
+      yield
+    end
+  end
+  
+  # Redefine the run method
+  def run(example_group_instance, reporter)
+    return if RSpec.wants_to_quit
+    @example_group_instance = example_group_instance
+    @example_group_instance.example = self
+
+    start(reporter)
+
+    begin
+      unless pending
+        with_pending_capture do
+          with_around_hooks do
+            begin
+              run_before_each
+              @in_block = true
+              result = isolated_or_normal { @example_group_instance.instance_eval(&@example_block) }
+              raise result if result.class < Exception
+              result
+            rescue Exception => e
+              set_exception(e)
+            ensure
+              @in_block = false
+              run_after_each
+            end
+          end
+        end
+      end
+    rescue Exception => e
+      set_exception(e)
+    ensure
+      @example_group_instance.example = nil
+      assign_auto_description
+    end
+
+    finish(reporter)
+  end
+end

data/lib/rspec/isolation/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Isolation
+    VERSION = "0.1.0"
+  end
+end

data/rspec-isolation.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rspec/isolation/version'
+
+Gem::Specification.new do |s|
+  s.name        = "rspec-isolation"
+  s.version     = RSpec::Isolation::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kevin Fu"]
+  s.email       = ["corntrace@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/rspec-isolation"
+  s.summary     = "Make rspec examples executed in separated processes."
+  s.description = "Make rspec examples executed in separated processes. \
+    Especially used in framework development."
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.5"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
+  s.require_path = 'lib'
+  
+  s.add_dependency("rspec", ["~> 2.0.0"])
+end

data/spec/rspec_isolation_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "#isolation" do
+  context "in before each" do
+    it "sets the example isolated" do
+      group = RSpec::Core::ExampleGroup.describe do
+        before(:each) {run_in_isolation}
+        example('example') {}
+      end
+      group.run
+      group.examples.first.run_in_isolation.should be_true
+    end
+  end
+  context "in the example" do
+    it "using iso_it sets the example isolated" do
+      group = RSpec::Core::ExampleGroup.describe do
+        iso_it {}
+      end
+      # group.run
+      group.examples.first.run_in_isolation.should be_true
+    end
+  end
+  context "failure and exception capture" do
+    it "should capture failures" do
+      group = RSpec::Core::ExampleGroup.describe
+      example = group.iso_it('example') { 1.should == 2 }
+
+      group.run
+      example.metadata[:execution_result][:exception_encountered].message.should == "expected: 2,\n     got: 1 (using ==)"
+    end
+    it "should capture exceptions" do
+      group = RSpec::Core::ExampleGroup.describe
+      example = group.iso_it('example') { raise "FOO" }
+
+      group.run
+      example.metadata[:execution_result][:exception_encountered].message.should == "FOO"
+    end
+  end
+  context "complicated conditions" do
+    RSpec::Core::ExampleGroup.module_eval do
+      def once_then_raise_error
+        $test_counter ||= 0
+        $test_counter += 1
+        raise "In the same process" if $test_counter > 1
+        return true
+      end
+    end
+    it "should raise error if run in the same process" do
+      group = RSpec::Core::ExampleGroup.describe do
+        $test_counter = 0
+        example {once_then_raise_error}
+        example {once_then_raise_error}
+      end
+      group.run
+      group.examples[0].metadata[:execution_result][:exception_encountered].should be_nil
+      group.examples[1].metadata[:execution_result][:exception_encountered].message.should == "In the same process"
+    end
+    it "should not raise if ran in isolation" do
+      group = RSpec::Core::ExampleGroup.describe do
+        $test_counter = 0
+        iso_it {once_then_raise_error}
+        iso_it {once_then_raise_error}
+        example {once_then_raise_error}
+      end
+      group.run
+      group.examples[0].metadata[:execution_result][:exception_encountered].should be_nil
+      group.examples[0].metadata[:execution_result][:exception_encountered].should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+require 'rspec/isolation'
+
+# Dir['./spec/support/**/*.rb'].map {|f| require f}
+
+module RSpec
+  module Core
+    module Matchers
+      def fail
+        raise_error(::RSpec::Expectations::ExpectationNotMetError)
+      end
+
+      def fail_with(message)
+        raise_error(::RSpec::Expectations::ExpectationNotMetError, message)
+      end
+    end
+  end
+end
+
+class NullObject
+  def method_missing(method, *args, &block)
+    # ignore
+  end
+end
+
+def sandboxed(&block)
+  begin
+    @orig_config = RSpec.configuration
+    @orig_world  = RSpec.world
+    new_config = RSpec::Core::Configuration.new
+    new_config.include(RSpec::Matchers)
+    new_world  = RSpec::Core::World.new(new_config)
+    RSpec.instance_variable_set(:@configuration, new_config)
+    RSpec.instance_variable_set(:@world, new_world)
+    object = Object.new
+    object.extend(RSpec::Core::ObjectExtensions)
+    object.extend(RSpec::Core::SharedExampleGroup)
+
+    (class << RSpec::Core::ExampleGroup; self; end).class_eval do
+      alias_method :orig_run, :run
+      def run(reporter=nil)
+        @orig_mock_space = RSpec::Mocks::space
+        RSpec::Mocks::space = RSpec::Mocks::Space.new
+        orig_run(reporter || NullObject.new)
+      ensure
+        RSpec::Mocks::space = @orig_mock_space
+      end
+    end
+
+    object.instance_eval(&block)
+  ensure
+    (class << RSpec::Core::ExampleGroup; self; end).class_eval do
+      remove_method :run
+      alias_method :run, :orig_run
+      remove_method :orig_run
+    end
+
+    RSpec.instance_variable_set(:@configuration, @orig_config)
+    RSpec.instance_variable_set(:@world, @orig_world)
+  end
+end
+
+def in_editor?
+  ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM')
+end
+
+RSpec.configure do |c|
+  c.color_enabled = !in_editor?
+  c.filter_run :focused => true
+  c.run_all_when_everything_filtered = true
+  c.filter_run_excluding :ruby => lambda {|version|
+    case version.to_s
+    when "!jruby"
+      RUBY_ENGINE != "jruby"
+    when /^> (.*)/
+      !(RUBY_VERSION.to_s > $1)
+    else
+      !(RUBY_VERSION.to_s =~ /^#{version.to_s}/)
+    end
+  }
+  c.around do |example|
+    sandboxed { example.run }
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-isolation
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kevin Fu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-16 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        - rc
+        - 5
+        version: 1.0.0.rc.5
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Make rspec examples executed in separated processes.     Especially used in framework development.
+email: 
+- corntrace@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.mkd
+- Rakefile
+- lib/rspec/isolation.rb
+- lib/rspec/isolation/core_ext.rb
+- lib/rspec/isolation/version.rb
+- rspec-isolation.gemspec
+- spec/rspec_isolation_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/rspec-isolation
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Make rspec examples executed in separated processes.
+test_files: []
+