rspec 1.3.0 → 2.0.0

data/lib/spec/rake/spectask.rb

@@ -1,230 +0,0 @@
-#!/usr/bin/env ruby
-
-# Define a task library for running RSpec contexts.
-
-require 'rake'
-require 'rake/tasklib'
-
-module Spec
-  module Rake
-
-    # A Rake task that runs a set of specs.
-    #
-    # Example:
-    #
-    #   Spec::Rake::SpecTask.new do |t|
-    #     t.warning = true
-    #     t.rcov = true
-    #   end
-    #
-    # This will create a task that can be run with:
-    #
-    #   rake spec
-    #
-    # If rake is invoked with a "SPEC=filename" command line option,
-    # then the list of spec files will be overridden to include only the
-    # filename specified on the command line.  This provides an easy way
-    # to run just one spec.
-    #
-    # If rake is invoked with a "SPEC_OPTS=options" command line option,
-    # then the given options will override the value of the +spec_opts+
-    # attribute.
-    #
-    # If rake is invoked with a "RCOV_OPTS=options" command line option,
-    # then the given options will override the value of the +rcov_opts+
-    # attribute.
-    #
-    # Examples:
-    #
-    #   rake spec                                      # run specs normally
-    #   rake spec SPEC=just_one_file.rb                # run just one spec file.
-    #   rake spec SPEC_OPTS="--diff"                   # enable diffing
-    #   rake spec RCOV_OPTS="--aggregate myfile.txt"   # see rcov --help for details
-    #
-    # Each attribute of this task may be a proc. This allows for lazy evaluation,
-    # which is sometimes handy if you want to defer the evaluation of an attribute value
-    # until the task is run (as opposed to when it is defined).
-    #
-    # This task can also be used to run existing Test::Unit tests and get RSpec
-    # output, for example like this:
-    #
-    #   require 'spec/rake/spectask'
-    #   Spec::Rake::SpecTask.new do |t|
-    #     t.ruby_opts = ['-rtest/unit']
-    #     t.spec_files = FileList['test/**/*_test.rb']
-    #   end
-    #
-    class SpecTask < ::Rake::TaskLib
-      def self.attr_accessor(*names)
-        super(*names)
-        names.each do |name|
-          module_eval "def #{name}() evaluate(@#{name}) end" # Allows use of procs
-        end
-      end
-
-      # Name of spec task. (default is :spec)
-      attr_accessor :name
-
-      # Array of directories to be added to $LOAD_PATH before running the
-      # specs. Defaults to ['<the absolute path to RSpec's lib directory>']
-      attr_accessor :libs
-
-      # If true, requests that the specs be run with the warning flag set.
-      # E.g. warning=true implies "ruby -w" used to run the specs. Defaults to false.
-      attr_accessor :warning
-
-      # Glob pattern to match spec files. (default is 'spec/**/*_spec.rb')
-      # Setting the SPEC environment variable overrides this.
-      attr_accessor :pattern
-
-      # Array of commandline options to pass to RSpec. Defaults to [].
-      # Setting the SPEC_OPTS environment variable overrides this.
-      attr_accessor :spec_opts
-
-      # Whether or not to use RCov (default is false)
-      # See http://eigenclass.org/hiki.rb?rcov
-      attr_accessor :rcov
-
-      # Array of commandline options to pass to RCov. Defaults to ['--exclude', 'lib\/spec,bin\/spec'].
-      # Ignored if rcov=false
-      # Setting the RCOV_OPTS environment variable overrides this.
-      attr_accessor :rcov_opts
-
-      # Directory where the RCov report is written. Defaults to "coverage"
-      # Ignored if rcov=false
-      attr_accessor :rcov_dir
-
-      # Array of commandline options to pass to ruby. Defaults to [].
-      attr_accessor :ruby_opts
-
-      # Whether or not to fail Rake when an error occurs (typically when specs fail).
-      # Defaults to true.
-      attr_accessor :fail_on_error
-
-      # A message to print to stderr when there are failures.
-      attr_accessor :failure_message
-
-      # Where RSpec's output is written. Defaults to $stdout.
-      # DEPRECATED. Use --format FORMAT:WHERE in spec_opts.
-      attr_accessor :out
-
-      # Explicitly define the list of spec files to be included in a
-      # spec.  +spec_files+ is expected to be an array of file names (a
-      # FileList is acceptable).  If both +pattern+ and +spec_files+ are
-      # used, then the list of spec files is the union of the two.
-      # Setting the SPEC environment variable overrides this.
-      attr_accessor :spec_files
-
-      # Use verbose output. If this is set to true, the task will print
-      # the executed spec command to stdout. Defaults to false.
-      attr_accessor :verbose
-
-      # Explicitly define the path to the ruby binary, or its proxy (e.g. multiruby)
-      attr_accessor :ruby_cmd
-
-      # Defines a new task, using the name +name+.
-      def initialize(name=:spec)
-        @name = name
-        @libs = ['lib']
-        @pattern = nil
-        @spec_files = nil
-        @spec_opts = []
-        @warning = false
-        @ruby_opts = []
-        @fail_on_error = true
-        @rcov = false
-        @rcov_opts = ['--exclude', 'lib\/spec,bin\/spec,config\/boot.rb']
-        @rcov_dir = "coverage"
-
-        yield self if block_given?
-        @pattern = 'spec/**/*_spec.rb' if pattern.nil? && spec_files.nil?
-        define
-      end
-
-      def define # :nodoc:
-        spec_script = File.expand_path(File.join(File.dirname(__FILE__),"..","..","..","bin","spec"))
-
-        lib_path = libs.join(File::PATH_SEPARATOR)
-        actual_name = Hash === name ? name.keys.first : name
-        unless ::Rake.application.last_comment
-          desc "Run specs" + (rcov ? " using RCov" : "")
-        end
-        task name do
-          RakeFileUtils.verbose(verbose) do
-            unless spec_file_list.empty?
-              # ruby [ruby_opts] -Ilib -S rcov [rcov_opts] bin/spec -- examples [spec_opts]
-              # or
-              # ruby [ruby_opts] -Ilib bin/spec examples [spec_opts]
-              cmd_parts = [ruby_cmd || RUBY]
-              cmd_parts += ruby_opts
-              cmd_parts << %[-I"#{lib_path}"]
-              cmd_parts << "-S rcov" if rcov
-              cmd_parts << "-w" if warning
-              cmd_parts << rcov_option_list
-              cmd_parts << %[-o "#{rcov_dir}"] if rcov
-              cmd_parts << %["#{spec_script}"]
-              cmd_parts << "--" if rcov
-              cmd_parts += spec_file_list.collect { |fn| %["#{fn}"] }
-              cmd_parts << spec_option_list
-              if out
-                cmd_parts << %[> "#{out}"]
-                STDERR.puts "The Spec::Rake::SpecTask#out attribute is DEPRECATED and will be removed in a future version. Use --format FORMAT:WHERE instead."
-              end
-              cmd = cmd_parts.join(" ")
-              puts cmd if verbose
-              unless system(cmd)
-                STDERR.puts failure_message if failure_message
-                raise("Command #{cmd} failed") if fail_on_error
-              end
-            end
-          end
-        end
-
-        if rcov
-          desc "Remove rcov products for #{actual_name}"
-          task paste("clobber_", actual_name) do
-            rm_r rcov_dir rescue nil
-          end
-
-          clobber_task = paste("clobber_", actual_name)
-          task :clobber => [clobber_task]
-
-          task actual_name => clobber_task
-        end
-        self
-      end
-
-      def rcov_option_list # :nodoc:
-        if rcov
-          ENV['RCOV_OPTS'] || rcov_opts.join(" ") || ""
-        else
-          ""
-        end
-      end
-
-      def spec_option_list # :nodoc:
-        STDERR.puts "RSPECOPTS is DEPRECATED and will be removed in a future version. Use SPEC_OPTS instead." if ENV['RSPECOPTS']
-        ENV['SPEC_OPTS'] || ENV['RSPECOPTS'] || spec_opts.join(" ") || ""
-      end
-
-      def evaluate(o) # :nodoc:
-        case o
-          when Proc then o.call
-          else o
-        end
-      end
-
-      def spec_file_list # :nodoc:
-        if ENV['SPEC']
-          FileList[ ENV['SPEC'] ]
-        else
-          result = []
-          result += spec_files.to_a if spec_files
-          result += FileList[ pattern ].to_a if pattern
-          FileList[result]
-        end
-      end
-
-    end
-  end
-end

data/lib/spec/rake/verify_rcov.rb

@@ -1,52 +0,0 @@
-module RCov
-  # A task that can verify that the RCov coverage doesn't
-  # drop below a certain threshold. It should be run after
-  # running Spec::Rake::SpecTask.
-  class VerifyTask < Rake::TaskLib
-    # Name of the task. Defaults to :verify_rcov
-    attr_accessor :name
-    
-    # Path to the index.html file generated by RCov, which
-    # is the file containing the total coverage.
-    # Defaults to 'coverage/index.html'
-    attr_accessor :index_html
-    
-    # Whether or not to output details. Defaults to true.
-    attr_accessor :verbose
-    
-    # The threshold value (in percent) for coverage. If the 
-    # actual coverage is not equal to this value, the task will raise an 
-    # exception. 
-    attr_accessor :threshold
-    
-    # Require the threshold value be met exactly.  This is the default.
-    attr_accessor :require_exact_threshold
-    
-    def initialize(name=:verify_rcov)
-      @name = name
-      @index_html = 'coverage/index.html'
-      @verbose = true
-      @require_exact_threshold = true
-      yield self if block_given?
-      raise "Threshold must be set" if @threshold.nil?
-      define
-    end
-    
-    def define
-      desc "Verify that rcov coverage is at least #{threshold}%"
-      task @name do
-        total_coverage = 0
-
-        File.open(index_html).each_line do |line|
-          if line =~ /<tt class='coverage_total'>\s*(\d+\.\d+)%\s*<\/tt>/
-            total_coverage = $1.to_f
-            break
-          end
-        end
-        puts "Coverage: #{total_coverage}% (threshold: #{threshold}%)" if verbose
-        raise "Coverage must be at least #{threshold}% but was #{total_coverage}%" if total_coverage < threshold
-        raise "Coverage has increased above the threshold of #{threshold}% to #{total_coverage}%. You should update your threshold value." if (total_coverage > threshold) and require_exact_threshold
-      end
-    end
-  end
-end

data/lib/spec/ruby.rb

@@ -1,9 +0,0 @@
-module Spec
-  module Ruby
-    class << self
-      def version
-        RUBY_VERSION
-      end
-    end
-  end
-end

data/lib/spec/runner/backtrace_tweaker.rb

@@ -1,77 +0,0 @@
-module Spec
-  module Runner
-    class BacktraceTweaker
-      def initialize(*patterns)
-        @ignore_patterns = []
-      end
-
-      def clean_up_double_slashes(line)
-        line.gsub!('//','/')
-      end
-
-      def ignore_patterns(*patterns)
-        # do nothing. Only QuietBacktraceTweaker ignores patterns.
-      end
-
-      def ignored_patterns
-        []
-      end
-
-      def tweak_backtrace(error)
-        return if error.backtrace.nil?
-        tweaked = error.backtrace.collect do |message|
-          clean_up_double_slashes(message)
-          kept_lines = message.split("\n").select do |line|
-            ignored_patterns.each do |ignore|
-              break if line =~ ignore
-            end
-          end
-          kept_lines.empty?? nil : kept_lines.join("\n")
-        end
-        error.set_backtrace(tweaked.select {|line| line})
-      end
-    end
-
-    class NoisyBacktraceTweaker < BacktraceTweaker
-    end
-
-    # Tweaks raised Exceptions to mask noisy (unneeded) parts of the backtrace
-    class QuietBacktraceTweaker < BacktraceTweaker
-      unless defined?(IGNORE_PATTERNS)
-        spec_files = Dir["lib/*"].map do |path| 
-          subpath = path[1..-1]
-          /#{subpath}/
-        end
-        IGNORE_PATTERNS = spec_files + [
-          /\/rspec-[^\/]*\/lib\/spec\//,
-          /\/spork-[^\/]*\/lib\/spork\//,
-          /\/lib\/ruby\//,
-          /bin\/spec:/,
-          /bin\/spork:/,
-          /bin\/rcov:/,
-          /lib\/rspec-rails/,
-          /vendor\/rails/,
-          # TextMate's Ruby and RSpec plugins
-          /Ruby\.tmbundle\/Support\/tmruby.rb:/,
-          /RSpec\.tmbundle\/Support\/lib/,
-          /temp_textmate\./,
-          /mock_frameworks\/rspec/,
-          /spec_server/
-        ]
-      end
-
-      def initialize(*patterns)
-        super
-        ignore_patterns(*patterns)
-      end
-
-      def ignore_patterns(*patterns)
-        @ignore_patterns += patterns.flatten.map { |pattern| Regexp.new(pattern) }
-      end
-
-      def ignored_patterns
-        IGNORE_PATTERNS + @ignore_patterns
-      end
-    end
-  end
-end

data/lib/spec/runner/class_and_arguments_parser.rb

@@ -1,14 +0,0 @@
-module Spec
-  module Runner
-    class ClassAndArgumentsParser
-      def self.parse(s)
-        if s =~ /([a-zA-Z_]+(?:::[a-zA-Z_]+)*):?(.*)/
-          arg = $2 == "" ? nil : $2
-          [$1, arg]
-        else
-          raise "Couldn't parse #{s.inspect}"
-        end
-      end
-    end
-  end
-end

data/lib/spec/runner/command_line.rb

@@ -1,15 +0,0 @@
-require 'spec/runner/option_parser'
-
-module Spec
-  module Runner
-    class CommandLine
-      def self.run(tmp_options=Spec::Runner.options)
-        orig_options = Spec::Runner.options
-        Spec::Runner.use tmp_options
-        tmp_options.run_examples
-      ensure
-        Spec::Runner.use orig_options
-      end
-    end
-  end
-end

data/lib/spec/runner/configuration.rb

@@ -1,194 +0,0 @@
-module Spec
-  module Runner
-    class Configuration
-      include Spec::Example::ArgsAndOptions
-      
-      # Chooses what mock framework to use. Example:
-      #
-      #   Spec::Runner.configure do |config|
-      #     config.mock_with :rspec, :mocha, :flexmock, or :rr
-      #   end
-      #
-      # To use any other mock framework, you'll have to provide your own
-      # adapter. This is simply a module that responds to the following
-      # methods:
-      #
-      #   setup_mocks_for_rspec
-      #   verify_mocks_for_rspec
-      #   teardown_mocks_for_rspec.
-      #
-      # These are your hooks into the lifecycle of a given example. RSpec will
-      # call setup_mocks_for_rspec before running anything else in each
-      # Example. After executing the #after methods, RSpec will then call
-      # verify_mocks_for_rspec and teardown_mocks_for_rspec (this is
-      # guaranteed to run even if there are failures in
-      # verify_mocks_for_rspec).
-      #
-      # Once you've defined this module, you can pass that to mock_with:
-      #
-      #   Spec::Runner.configure do |config|
-      #     config.mock_with MyMockFrameworkAdapter
-      #   end
-      #
-      def mock_with(mock_framework)
-        @mock_framework = case mock_framework
-        when Symbol
-          mock_framework_path(mock_framework.to_s)
-        else
-          mock_framework
-        end
-      end
-      
-      def mock_framework # :nodoc:
-        @mock_framework ||= mock_framework_path("rspec")
-      end
-      
-      # :call-seq:
-      #   include(Some::Helpers)
-      #   include(Some::Helpers, More::Helpers)
-      #   include(My::Helpers, :type => :key)
-      #
-      # Declares modules to be included in multiple example groups
-      # (<tt>describe</tt> blocks). With no <tt>:type</tt>, the modules listed
-      # will be included in all example groups.
-      #
-      # Use <tt>:type</tt> to restrict
-      # the inclusion to a subset of example groups. The value assigned to
-      # <tt>:type</tt> should be a key that maps to a class that is either a
-      # subclass of Spec::Example::ExampleGroup or extends
-      # Spec::Example::ExampleGroupMethods and includes
-      # Spec::Example::ExampleMethods.
-      #
-      # For example, the rspec-rails gem/plugin extends Test::Unit::TestCase
-      # with Spec::Example::ExampleGroupMethods and includes
-      # Spec::Example::ExampleMethods in it. So if you have a module of helper
-      # methods for controller examples, you could do this:
-      #
-      #   config.include(ControllerExampleHelpers, :type => :controller)
-      #
-      # Only example groups that have that type will get the modules included:
-      #
-      #   describe Account, :type => :model do
-      #     # Will *not* include ControllerExampleHelpers
-      #   end
-      #
-      #   describe AccountsController, :type => :controller do
-      #     # *Will* include ControllerExampleHelpers
-      #   end
-      #
-      def include(*modules_and_options)
-        include_or_extend(:include, *modules_and_options)
-      end
-      
-      # :call-seq:
-      #   extend(Some::Helpers)
-      #   extend(Some::Helpers, More::Helpers)
-      #   extend(My::Helpers, :type => :key)
-      #
-      # Works just like #include, but extends the example groups
-      # with the modules rather than including them.
-      def extend(*modules_and_options)
-        include_or_extend(:extend, *modules_and_options)
-      end
-      
-      # Appends a global <tt>before</tt> block to all example groups.
-      # <tt>scope</tt> can be any of <tt>:each</tt> (default), <tt>:all</tt>, or
-      # <tt>:suite</tt>. When <tt>:each</tt>, the block is executed before each
-      # example. When <tt>:all</tt>, the block is executed once per example
-      # group, before any of its examples are run. When <tt>:suite</tt> the
-      # block is run once before the entire suite is run.
-      def append_before(scope = :each, options={}, &proc)
-        add_callback(:append_before, scope, options, &proc)
-      end
-      alias_method :before, :append_before
-
-      # Prepends a global <tt>before</tt> block to all example groups.
-      # 
-      # See <tt>append_before</tt> for scoping semantics.
-      def prepend_before(scope = :each, options={}, &proc)
-        add_callback(:prepend_before, scope, options, &proc)
-      end
-      
-      # Prepends a global <tt>after</tt> block to all example groups.
-      # 
-      # See <tt>append_before</tt> for scoping semantics.
-      def prepend_after(scope = :each, options={}, &proc)
-        add_callback(:prepend_after, scope, options, &proc)
-      end
-      alias_method :after, :prepend_after
-      
-      # Appends a global <tt>after</tt> block to all example groups.
-      # 
-      # See <tt>append_before</tt> for scoping semantics.
-      def append_after(scope = :each, options={}, &proc)
-        add_callback(:append_after, scope, options, &proc)
-      end
-
-      # DEPRECATED - use Spec::Matchers::DSL instead
-      #
-      # Defines global predicate matchers. Example:
-      #
-      #   config.predicate_matchers[:swim] = :can_swim?
-      #
-      # This makes it possible to say:
-      #
-      #   person.should swim # passes if person.can_swim? returns true
-      #
-      def predicate_matchers
-        @predicate_matchers ||= Spec::HashWithDeprecationNotice.new("predicate_matchers", "the new Matcher DSL")
-      end
-
-      # Adds patterns to the list of patterns ignored in the backtrace when a
-      # failure is output by rspec. Example:
-      #
-      #   config.ignore_backtrace_patterns /spork/, /shoulda/, "/some/weird/path/"
-      #
-      # When quiet backtraces are turned on (default), this will exclude any
-      # lines that match any of the Regexps and Strings passed.
-      #
-      def ignore_backtrace_patterns(*patterns)
-        @ignored_backtrace_patterns ||= []
-        @ignored_backtrace_patterns += patterns
-      end
-
-      def ignored_backtrace_patterns # :nodoc:
-        @ignored_backtrace_patterns ||= []
-      end
-      
-    private
-    
-      def include_or_extend(action, *args)
-        modules, options = args_and_options(*args)
-        [get_type_from_options(options)].flatten.each do |required_example_group|
-          required_example_group = required_example_group.to_sym if required_example_group
-          modules.each do |mod|
-            Spec::Example::ExampleGroupFactory[required_example_group].__send__(action, mod)
-          end
-        end
-      end
-
-      def add_callback(sym, *args, &proc)
-        scope, options = scope_and_options(*args)
-        example_group = Spec::Example::ExampleGroupFactory[get_type_from_options(options)]
-        example_group.__send__(sym, scope, &proc)
-      end
-
-      def get_type_from_options(options)
-        options[:type] || options[:behaviour_type]
-      end
-    
-      def mock_framework_path(framework_name)
-        "spec/adapters/mock_frameworks/#{framework_name}"
-      end
-
-      def scope_and_options(*args) # :nodoc:
-        args, options = args_and_options(*args)
-        return scope_from(*args), options
-      end
-
-      def scope_from(*args) # :nodoc:
-        args[0] || :each
-      end
-    end
-  end
-end

data/lib/spec/runner/differs/default.rb

@@ -1,93 +0,0 @@
-require 'spec/runner/differs/load-diff-lcs'
-require 'pp'
-
-module Spec
-  module Expectations
-    module Differs
-      unless defined?(Spec::Expectations::Differs::Default)
-        class Default
-          def initialize(options)
-            @options = options
-          end
-
-          # This is snagged from diff/lcs/ldiff.rb (which is a commandline tool)
-          def diff_as_string(data_new, data_old)
-            data_old = data_old.split(/\n/).map! { |e| e.chomp }
-            data_new = data_new.split(/\n/).map! { |e| e.chomp }
-            output = ""
-            diffs = Diff::LCS.diff(data_old, data_new)
-            return output if diffs.empty?
-            oldhunk = hunk = nil  
-            file_length_difference = 0
-            diffs.each do |piece|
-              begin
-                hunk = Diff::LCS::Hunk.new(data_old, data_new, piece, context_lines,
-                                           file_length_difference)
-                file_length_difference = hunk.file_length_difference      
-                next unless oldhunk      
-                # Hunks may overlap, which is why we need to be careful when our
-                # diff includes lines of context. Otherwise, we might print
-                # redundant lines.
-                if (context_lines > 0) and hunk.overlaps?(oldhunk)
-                  hunk.unshift(oldhunk)
-                else
-                  output << oldhunk.diff(format)
-                end
-              ensure
-                oldhunk = hunk
-                output << "\n"
-              end
-            end  
-            #Handle the last remaining hunk
-            output << oldhunk.diff(format) << "\n"
-          end  
-
-          def diff_as_object(target,expected)
-            diff_as_string(PP.pp(target,""), PP.pp(expected,""))
-          end
-          
-          def diff_as_hash(target, expected)
-            contains_hash = false
-            contains_array = false
-            
-            extra_expected_keys = expected.keys - target.keys
-            extra_target_keys = target.keys - expected.keys
-            
-            o = "\n"
-            
-            o << "Expected hash contains keys that target hash does not: " << extra_expected_keys.inspect << "\n" if !extra_expected_keys.empty?
-            o << "Target hash contains keys that expected hash does not: " << extra_target_keys.inspect << "\n" if !extra_target_keys.empty?
-            
-            expected.delete_if do |key, value|
-              contains_hash = true if value.is_a?(Hash)
-              contains_array = true if value.is_a?(Array)
-              target[key]  == value
-            end
-            
-            expected.keys.sort { |a,b| a.to_s <=> b.to_s }.each do |key|
-              o << "Expected the key #{key.inspect} to be #{expected[key].inspect}, but was #{target[key].inspect}\n"
-            end
-            
-            o << "\n"
-
-            if contains_hash || contains_array
-              o << diff_as_object(target, expected)
-            else
-              o
-            end
-          end
-
-          protected
-          def format
-            @options.diff_format
-          end
-
-          def context_lines
-            @options.context_lines
-          end
-        end
-
-      end
-    end
-  end
-end