rspec 0.0.10

data/lib/spec/translator.rb

@@ -0,0 +1,114 @@
+require 'fileutils'
+
+module Spec
+  class Translator
+    def translate(from, to)
+      from = File.expand_path(from)
+      to = File.expand_path(to)
+      if File.directory?(from)
+        translate_dir(from, to)
+      elsif(from =~ /\.rb$/)
+        translate_file(from, to)
+      end
+    end
+    
+    def translate_dir(from, to)
+      FileUtils.mkdir_p(to) unless File.directory?(to)
+      Dir["#{from}/*"].each do |sub_from|
+        path = sub_from[from.length+1..-1]
+        sub_to = File.join(to, path)
+        translate(sub_from, sub_to)
+      end
+    end
+
+    def translate_file(from, to)
+      translation = ""
+      File.open(from) do |io|
+        io.each_line do |line|
+          translation << translate_line(line)
+        end
+      end
+      File.open(to, "w") do |io|
+        io.write(translation)
+      end
+    end
+
+    def translate_line(line)
+      # Translate deprecated mock constraints
+      line.gsub!(/:any_args/, 'any_args')
+      line.gsub!(/:anything/, 'anything')
+      line.gsub!(/:boolean/, 'boolean')
+      line.gsub!(/:no_args/, 'no_args')
+      line.gsub!(/:numeric/, 'an_instance_of(Numeric)')
+      line.gsub!(/:string/, 'an_instance_of(String)')
+
+      return line if line =~ /(should_not|should)_receive/
+      
+      line.gsub!(/(^\s*)context([\s*|\(]['|"|A-Z])/, '\1describe\2')
+      line.gsub!(/(^\s*)specify([\s*|\(]['|"|A-Z])/, '\1it\2')
+      line.gsub!(/(^\s*)context_setup(\s*[do|\{])/, '\1before(:all)\2')
+      line.gsub!(/(^\s*)context_teardown(\s*[do|\{])/, '\1after(:all)\2')
+      line.gsub!(/(^\s*)setup(\s*[do|\{])/, '\1before(:each)\2')
+      line.gsub!(/(^\s*)teardown(\s*[do|\{])/, '\1after(:each)\2')
+      
+      if line =~ /(.*\.)(should_not|should)(?:_be)(?!_)(.*)/m
+        pre = $1
+        should = $2
+        post = $3
+        be_or_equal = post =~ /(<|>)/ ? "be" : "equal"
+        
+        return "#{pre}#{should} #{be_or_equal}#{post}"
+      end
+      
+      if line =~ /(.*\.)(should_not|should)_(?!not)\s*(.*)/m
+        pre = $1
+        should = $2
+        post = $3
+        
+        post.gsub!(/^raise/, 'raise_error')
+        post.gsub!(/^throw/, 'throw_symbol')
+        
+        unless standard_matcher?(post)
+          post = "be_#{post}"
+        end
+        
+        # Add parenthesis
+        post.gsub!(/^(\w+)\s+([\w|\.|\,|\(.*\)|\'|\"|\:|@| ]+)(\})/, '\1(\2)\3') # inside a block
+        post.gsub!(/^(redirect_to)\s+(.*)/, '\1(\2)') # redirect_to, which often has http:
+        post.gsub!(/^(\w+)\s+([\w|\.|\,|\(.*\)|\{.*\}|\'|\"|\:|@| ]+)/, '\1(\2)')
+        post.gsub!(/(\s+\))/, ')')
+        post.gsub!(/\)\}/, ') }')
+        post.gsub!(/^(\w+)\s+(\/.*\/)/, '\1(\2)') #regexps
+        line = "#{pre}#{should} #{post}"
+      end
+
+      line
+    end
+    
+    def standard_matcher?(matcher)
+      patterns = [
+        /^be/, 
+        /^be_close/,
+        /^eql/, 
+        /^equal/, 
+        /^has/, 
+        /^have/, 
+        /^change/, 
+        /^include/,
+        /^match/, 
+        /^raise_error/, 
+        /^respond_to/, 
+        /^redirect_to/, 
+        /^satisfy/, 
+        /^throw_symbol/,
+        # Extra ones that we use in spec_helper
+        /^pass/,
+        /^fail/,
+        /^fail_with/,
+      ]
+      matched = patterns.detect{ |p| matcher =~ p }
+      !matched.nil?
+    end
+    
+  end
+end

data/lib/spec/version.rb

@@ -0,0 +1,13 @@
+module Spec
+  module VERSION
+    unless defined? MAJOR
+      MAJOR  = 0
+      MINOR  = 0
+      TINY   = 10
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+
+      SUMMARY = "rspec version #{STRING}"
+    end
+  end
+end

data/plugins/mock_frameworks/flexmock.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#
+#  Created by Jim Weirich on 2007-04-10.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'flexmock/rspec'
+
+module Spec
+  module Plugins
+    module MockFramework
+      include FlexMock::MockContainer
+      def setup_mocks_for_rspec
+        # No setup required
+      end
+      def verify_mocks_for_rspec
+        flexmock_verify
+      end
+      def teardown_mocks_for_rspec
+        flexmock_close
+      end
+    end
+  end
+end

data/plugins/mock_frameworks/mocha.rb

@@ -0,0 +1,19 @@
+require 'mocha/standalone'
+require 'mocha/object'
+
+module Spec
+  module Plugins
+    module MockFramework
+      include Mocha::Standalone
+      def setup_mocks_for_rspec
+        mocha_setup
+      end
+      def verify_mocks_for_rspec
+        mocha_verify
+      end
+      def teardown_mocks_for_rspec
+        mocha_teardown
+      end
+    end
+  end
+end

data/plugins/mock_frameworks/rr.rb

@@ -0,0 +1,21 @@
+require 'rr'
+
+patterns = ::Spec::Runner::QuietBacktraceTweaker::IGNORE_PATTERNS
+patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
+
+module Spec
+  module Plugins
+    module MockFramework
+      include RR::Extensions::InstanceMethods
+      def setup_mocks_for_rspec
+        RR::Space.instance.reset
+      end
+      def verify_mocks_for_rspec
+        RR::Space.instance.verify_doubles
+      end
+      def teardown_mocks_for_rspec
+        RR::Space.instance.reset
+      end
+    end
+  end
+end

data/plugins/mock_frameworks/rspec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "spec", "mocks"))
+require 'spec/mocks/framework'
+require 'spec/mocks/extensions'
+
+module Spec
+  module Plugins
+    module MockFramework
+      include Spec::Mocks::ExampleMethods
+      def setup_mocks_for_rspec
+        $rspec_mocks ||= Spec::Mocks::Space.new
+      end
+      def verify_mocks_for_rspec
+        $rspec_mocks.verify_all
+      end
+      def teardown_mocks_for_rspec
+        $rspec_mocks.reset_all
+      end
+    end
+  end
+end

data/rake_tasks/examples.rake

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('examples') do |t|
+  t.spec_files = FileList['examples/**/*.rb']
+end

data/rake_tasks/examples_with_rcov.rake

@@ -0,0 +1,9 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+  t.spec_files = FileList['examples/**/*.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'examples']
+end

data/rake_tasks/failing_examples_with_html.rake

@@ -0,0 +1,9 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Generate HTML report for failing examples"
+Spec::Rake::SpecTask.new('failing_examples_with_html') do |t|
+  t.spec_files = FileList['failing_examples/**/*.rb']
+  t.spec_opts = ["--format", "html:../doc/output/documentation/tools/failing_examples.html", "--diff"]
+  t.fail_on_error = false
+end

data/rake_tasks/verify_rcov.rake

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/verify_rcov'
+
+RCov::VerifyTask.new(:verify_rcov => :spec) do |t|
+  t.threshold = 100.0 # Make sure you have rcov 0.7 or higher!
+  t.index_html = '../doc/output/coverage/index.html'
+end

data/spec/README.jruby

@@ -0,0 +1,15 @@
+= Running specs on JRuby =
+
+svn co http://svn.codehaus.org/jruby/trunk jruby
+cd jruby/jruby
+ant clean
+ant
+# put JRuby's bin dir on your PATH
+jruby -S gem install rake --no-ri --no-rdoc
+jruby -S gem install diff-lcs
+jruby -S gem install syntax
+cd ../testsuites/rspec
+mkdir target
+jruby -S rake checkout_code
+cd target/rspec
+jruby bin/spec spec -c

data/spec/autotest/discover_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + "/../autotest_helper"
+
+module DiscoveryHelper
+  def load_discovery
+    require File.dirname(__FILE__) + "/../../lib/autotest/discover"
+  end
+end
+
+
+class Autotest
+  describe Rspec, "discovery" do
+    include DiscoveryHelper
+    
+    it "should add the rspec autotest plugin" do
+      Autotest.should_receive(:add_discovery).and_yield
+      load_discovery
+    end
+  end  
+end

data/spec/autotest/rspec_spec.rb

@@ -0,0 +1,206 @@
+require File.dirname(__FILE__) + "/../autotest_helper"
+
+class Autotest
+  
+  module AutotestHelper
+    def rspec_output
+      <<-HERE
+.............PPF
+
+1)
+'false should be false' FAILED
+expected: true,
+     got: false (using ==)
+./spec/autotest/rspec_spec.rb:203:
+
+Finished in 0.158674 seconds
+
+16 examples, 1 failure, 2 pending
+
+Pending:
+Autotest::Rspec handling failed results should return an array of failed examples and errors (TODO)
+Autotest::Rspec tests/specs for a given file should find all the specs for a given file (TODO)
+HERE
+    end
+    
+    def common_setup
+      @proc = mock Proc
+      @kernel = mock Kernel
+      @kernel.stub!(:proc).and_return @proc
+
+      File.stub!(:exists).and_return true
+      @windows_alt_separator = "\\"
+      @posix_separator = '/'
+
+      @rspec_output = rspec_output
+    end
+  end
+
+  describe Rspec do
+    describe "selection of rspec command" do
+      include AutotestHelper
+    
+      before(:each) do
+        common_setup
+        @rspec_autotest = Rspec.new
+      end
+    
+      it "should try to find the spec command if it exists in ./bin and use it above everything else" do
+        File.stub!(:exists?).and_return true
+
+        spec_path = File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec")
+        File.should_receive(:exists?).with(spec_path).and_return true
+        @rspec_autotest.spec_command.should == spec_path
+      end
+
+      it "should otherwise select the default spec command in gem_dir/bin/spec" do
+        @rspec_autotest.stub!(:spec_commands).and_return ["/foo/spec"]
+        Config::CONFIG.stub!(:[]).and_return "/foo"
+        File.should_receive(:exists?).with("/foo/spec").and_return(true)
+
+        @rspec_autotest.spec_command.should == "/foo/spec"
+      end
+    
+      it "should raise an error if no spec command is found at all" do
+        File.stub!(:exists?).and_return false
+      
+        lambda {
+          @rspec_autotest.spec_command
+        }.should raise_error(RspecCommandError, "No spec command could be found!")
+      end
+    end
+    
+    describe "selection of rspec command (windows compatibility issues)" do
+      include AutotestHelper
+    
+      before(:each) do
+        common_setup
+      end
+    
+      it "should use the ALT_SEPARATOR if it is non-nil" do
+        @rspec_autotest = Rspec.new
+        spec_command = File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec")
+        @rspec_autotest.stub!(:spec_commands).and_return [spec_command]
+        @rspec_autotest.spec_command(@windows_alt_separator).should == spec_command.gsub('/', @windows_alt_separator)
+      end
+    
+      it "should not use the ALT_SEPATOR if it is nil" do
+        @windows_alt_separator = nil
+        @rspec_autotest = Rspec.new
+        spec_command = File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec")
+        @rspec_autotest.stub!(:spec_commands).and_return [spec_command]
+        @rspec_autotest.spec_command.should == spec_command
+      end
+    end
+
+    describe "adding spec.opts --options" do 
+      before(:each) do
+        @rspec_autotest = Rspec.new
+      end
+
+      it "should return the command line option to add spec.opts if the options file exists" do
+        File.stub!(:exist?).and_return true
+        @rspec_autotest.add_options_if_present.should == "-O spec/spec.opts "
+      end
+
+      it "should return an empty string if no spec.opts exists" do
+        File.stub!(:exist?).and_return false
+        Rspec.new.add_options_if_present.should == ""
+      end
+    end  
+  
+    describe "commands" do
+      before(:each) do
+        @rspec_autotest = Rspec.new
+        @rspec_autotest.stub!(:ruby).and_return "ruby"
+        @rspec_autotest.stub!(:add_options_if_present).and_return "-O spec/spec.opts"
+      
+        @ruby = @rspec_autotest.ruby
+        @spec_command = @rspec_autotest.spec_command
+        @options = @rspec_autotest.add_options_if_present
+        @files_to_test = {
+          :spec => ["file_one", "file_two"]
+        }
+        # this is not the inner representation of Autotest!
+        @rspec_autotest.stub!(:files_to_test).and_return @files_to_test
+        @files_to_test.stub!(:keys).and_return @files_to_test[:spec]
+        @to_test = @files_to_test.keys.flatten.join ' '
+      end
+
+      it "should contain the various commands, ordered by preference" do
+        Rspec.new.spec_commands.should == [
+          File.expand_path("#{File.dirname(__FILE__)}/../../bin/spec"),
+          "#{Config::CONFIG['bindir']}/spec"
+        ]
+      end
+    
+      it "should make the apropriate test command" do
+        @rspec_autotest.make_test_cmd(@files_to_test).should == "#{@ruby} -S #{@spec_command} #{@options} #{@to_test}"
+      end
+    end
+  
+    describe "mappings" do
+    
+      before(:each) do
+        @lib_file = "lib/something.rb"
+        @spec_file = "spec/something_spec.rb"
+        @rspec_autotest = Rspec.new
+        @rspec_autotest.hook :initialize
+      end
+    
+      it "should find the spec file for a given lib file" do
+        @rspec_autotest.should map_specs([@spec_file]).to(@lib_file)
+      end
+    
+      it "should find the spec file if given a spec file" do
+        @rspec_autotest.should map_specs([@spec_file]).to(@spec_file)
+      end
+    
+      it "should only find the file if the file is being tracked (in @file)"  do
+        @rspec_autotest.should map_specs([]).to("lib/untracked_file")
+      end
+    end
+  
+    describe "consolidating failures" do
+      include AutotestHelper
+    
+      before(:each) do
+        common_setup
+        @rspec_autotest = Rspec.new
+      
+        @spec_file = "spec/autotest/some_spec.rb"
+        @rspec_autotest.instance_variable_set("@files", {@spec_file => Time.now})
+        @rspec_autotest.stub!(:find_files_to_test).and_return true
+      end
+    
+      it "should return no failures if no failures were given in the output" do
+        @rspec_autotest.consolidate_failures([[]]).should == {}
+      end
+    
+      it "should return a hash with the spec filename => spec name for each failure or error" do
+        @rspec_autotest.stub!(:test_files_for).and_return "spec/autotest/some_spec.rb"
+        failures = [
+          [
+            "false should be false", 
+            "expected: true,\n     got: false (using ==)\n#{@spec_file}:203:"
+          ]
+        ]
+        @rspec_autotest.consolidate_failures(failures).should == {
+          @spec_file => ["false should be false"]
+        }
+      end
+    
+      it "should not include the subject file" do
+        subject_file = "lib/autotest/some.rb"
+        @rspec_autotest.stub!(:test_files_for).and_return "spec/autotest/some_spec.rb"
+        failures = [
+          [
+            "false should be false", 
+            "expected: true,\n     got: false (using ==)\n#{subject_file}:143:\n#{@spec_file}:203:"
+          ]
+        ]
+        @rspec_autotest.consolidate_failures(failures).keys.should_not include(subject_file)
+      end
+    end
+  end
+end