rspec 0.0.10 → 0.1.0

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 = nil
-
-        File.open(index_html).each_line do |line|
-          if line =~ /<tt class='coverage_total'>(\d+\.\d+)%<\/tt>/
-            total_coverage = eval($1)
-            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/runner.rb

@@ -1,201 +0,0 @@
-require 'spec/runner/options'
-require 'spec/runner/option_parser'
-require 'spec/runner/example_group_runner'
-require 'spec/runner/command_line'
-require 'spec/runner/drb_command_line'
-require 'spec/runner/backtrace_tweaker'
-require 'spec/runner/reporter'
-require 'spec/runner/spec_parser'
-require 'spec/runner/class_and_arguments_parser'
-
-module Spec
-  # == ExampleGroups and Examples
-  # 
-  # Rather than expressing examples in classes, RSpec uses a custom DSLL (DSL light) to 
-  # describe groups of examples.
-  # 
-  # A ExampleGroup is the equivalent of a fixture in xUnit-speak. It is a metaphor for the context
-  # in which you will run your executable example - a set of known objects in a known starting state.
-  # We begin be describing
-  # 
-  #   describe Account do
-  # 
-  #     before do
-  #       @account = Account.new
-  #     end
-  # 
-  #     it "should have a balance of $0" do
-  #       @account.balance.should == Money.new(0, :dollars)
-  #     end
-  # 
-  #   end
-  # 
-  # We use the before block to set up the Example (given), and then the #it method to
-  # hold the example code that expresses the event (when) and the expected outcome (then).
-  # 
-  # == Helper Methods
-  # 
-  # A primary goal of RSpec is to keep the examples clear. We therefore prefer
-  # less indirection than you might see in xUnit examples and in well factored, DRY production code. We feel
-  # that duplication is OK if removing it makes it harder to understand an example without
-  # having to look elsewhere to understand its context.
-  # 
-  # That said, RSpec does support some level of encapsulating common code in helper
-  # methods that can exist within a context or within an included module.
-  # 
-  # == Setup and Teardown
-  # 
-  # You can use before and after within a Example. Both methods take an optional
-  # scope argument so you can run the block before :each example or before :all examples
-  # 
-  #   describe "..." do
-  #     before :all do
-  #       ...
-  #     end
-  # 
-  #     before :each do
-  #       ...
-  #     end
-  # 
-  #     it "should do something" do
-  #       ...
-  #     end
-  # 
-  #     it "should do something else" do
-  #       ...
-  #     end
-  # 
-  #     after :each do
-  #       ...
-  #     end
-  # 
-  #     after :all do
-  #       ...
-  #     end
-  # 
-  #   end
-  # 
-  # The <tt>before :each</tt> block will run before each of the examples, once for each example. Likewise,
-  # the <tt>after :each</tt> block will run after each of the examples.
-  # 
-  # It is also possible to specify a <tt>before :all</tt> and <tt>after :all</tt>
-  # block that will run only once for each behaviour, respectively before the first <code>before :each</code>
-  # and after the last <code>after :each</code>. The use of these is generally discouraged, because it
-  # introduces dependencies between the examples. Still, it might prove useful for very expensive operations
-  # if you know what you are doing.
-  # 
-  # == Local helper methods
-  # 
-  # You can include local helper methods by simply expressing them within a context:
-  # 
-  #   describe "..." do
-  #   
-  #     it "..." do
-  #       helper_method
-  #     end
-  # 
-  #     def helper_method
-  #       ...
-  #     end
-  # 
-  #   end
-  # 
-  # == Included helper methods
-  # 
-  # You can include helper methods in multiple contexts by expressing them within
-  # a module, and then including that module in your context:
-  # 
-  #   module AccountExampleHelperMethods
-  #     def helper_method
-  #       ...
-  #     end
-  #   end
-  # 
-  #   describe "A new account" do
-  #     include AccountExampleHelperMethods
-  #     before do
-  #       @account = Account.new
-  #     end
-  # 
-  #     it "should have a balance of $0" do
-  #       helper_method
-  #       @account.balance.should eql(Money.new(0, :dollars))
-  #     end
-  #   end
-  # 
-  # == Shared Example Groups
-  # 
-  # You can define a shared Example Group, that may be used on other groups
-  #
-  #  share_examples_for "All Editions" do
-  #    it "all editions behaviour" ...
-  #  end
-  #
-  #  describe SmallEdition do
-  #    it_should_behave_like "All Editions"
-  #  
-  #    it "should do small edition stuff" do
-  #      ...
-  #    end
-  #  end
-  #
-  # You can also assign the shared group to a module and include that
-  #
-  #  share_as :AllEditions do
-  #    it "should do all editions stuff" ...
-  #  end
-  #
-  #  describe SmallEdition do
-  #    it_should_behave_like AllEditions
-  #  
-  #    it "should do small edition stuff" do
-  #      ...
-  #    end
-  #  end
-  #
-  # And, for those of you who prefer to use something more like Ruby, you
-  # can just include the module directly
-  #
-  #  describe SmallEdition do
-  #    include AllEditions
-  #  
-  #    it "should do small edition stuff" do
-  #      ...
-  #    end
-  #  end
-  module Runner
-    class << self
-      def configuration # :nodoc:
-        @configuration ||= Spec::Example::Configuration.new
-      end
-      
-      # Use this to configure various configurable aspects of
-      # RSpec:
-      #
-      #   Spec::Runner.configure do |configuration|
-      #     # Configure RSpec here
-      #   end
-      #
-      # The yielded <tt>configuration</tt> object is a
-      # Spec::Example::Configuration instance. See its RDoc
-      # for details about what you can do with it.
-      #
-      def configure
-        yield configuration
-      end
-      
-      def register_at_exit_hook # :nodoc:
-        $spec_runner_at_exit_hook_registered ||= nil
-        unless $spec_runner_at_exit_hook_registered
-          at_exit do
-            unless $! || Spec.run?
-              success = Spec.run
-              exit success if Spec.exit?
-            end
-          end
-          $spec_runner_at_exit_hook_registered = true
-        end
-      end
-    end
-  end
-end

data/lib/spec/runner/backtrace_tweaker.rb

@@ -1,57 +0,0 @@
-module Spec
-  module Runner
-    class BacktraceTweaker
-      def clean_up_double_slashes(line)
-        line.gsub!('//','/')
-      end
-    end
-
-    class NoisyBacktraceTweaker < BacktraceTweaker
-      def tweak_backtrace(error)
-        return if error.backtrace.nil?
-        error.backtrace.each do |line|
-          clean_up_double_slashes(line)
-        end
-      end
-    end
-
-    # Tweaks raised Exceptions to mask noisy (unneeded) parts of the backtrace
-    class QuietBacktraceTweaker < BacktraceTweaker
-      unless defined?(IGNORE_PATTERNS)
-        root_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', '..'))
-        spec_files = Dir["#{root_dir}/lib/*"].map do |path| 
-          subpath = path[root_dir.length..-1]
-          /#{subpath}/
-        end
-        IGNORE_PATTERNS = spec_files + [
-          /\/lib\/ruby\//,
-          /bin\/spec:/,
-          /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 tweak_backtrace(error)
-        return if error.backtrace.nil?
-        error.backtrace.collect! do |line|
-          clean_up_double_slashes(line)
-          IGNORE_PATTERNS.each do |ignore|
-            if line =~ ignore
-              line = nil
-              break
-            end
-          end
-          line
-        end
-        error.backtrace.compact!
-      end
-    end
-  end
-end

data/lib/spec/runner/class_and_arguments_parser.rb

@@ -1,16 +0,0 @@
-module Spec
-  module Runner
-    class ClassAndArgumentsParser
-      class << self
-        def 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
-end

data/lib/spec/runner/command_line.rb

@@ -1,28 +0,0 @@
-require 'spec/runner/option_parser'
-
-module Spec
-  module Runner
-    # Facade to run specs without having to fork a new ruby process (using `spec ...`)
-    class CommandLine
-      class << self
-        # Runs specs. +argv+ is the commandline args as per the spec commandline API, +err+
-        # and +out+ are the streams output will be written to.
-        def run(instance_rspec_options)
-          # NOTE - this call to init_rspec_options is not spec'd, but neither is any of this
-          # swapping of $rspec_options. That is all here to enable rspec to run against itself
-          # and maintain coverage in a single process. Therefore, DO NOT mess with this stuff
-          # unless you know what you are doing!
-          init_rspec_options(instance_rspec_options)
-          orig_rspec_options = rspec_options
-          begin
-            $rspec_options = instance_rspec_options
-            return $rspec_options.run_examples
-          ensure
-            ::Spec.run = true
-            $rspec_options = orig_rspec_options
-          end
-        end
-      end
-    end
-  end
-end

data/lib/spec/runner/drb_command_line.rb

@@ -1,20 +0,0 @@
-require "drb/drb"
-
-module Spec
-  module Runner
-    # Facade to run specs by connecting to a DRB server
-    class DrbCommandLine
-      # Runs specs on a DRB server. Note that this API is similar to that of
-      # CommandLine - making it possible for clients to use both interchangeably.
-      def self.run(options)
-        begin
-          DRb.start_service
-          spec_server = DRbObject.new_with_uri("druby://127.0.0.1:8989")
-          spec_server.run(options.argv, options.error_stream, options.output_stream)
-        rescue DRb::DRbConnError => e
-          options.error_stream.puts "No server is running"
-        end
-      end
-    end
-  end
-end

data/lib/spec/runner/example_group_runner.rb

@@ -1,59 +0,0 @@
-module Spec
-  module Runner
-    class ExampleGroupRunner
-      def initialize(options)
-        @options = options
-      end
-
-      def load_files(files)
-        # It's important that loading files (or choosing not to) stays the
-        # responsibility of the ExampleGroupRunner. Some implementations (like)
-        # the one using DRb may choose *not* to load files, but instead tell
-        # someone else to do it over the wire.
-        files.each do |file|
-          load file
-        end
-      end
-
-      def run
-        prepare
-        success = true
-        example_groups.each do |example_group|
-          success = success & example_group.run
-        end
-        return success
-      ensure
-        finish
-      end
-
-      protected
-      def prepare
-        reporter.start(number_of_examples)
-        example_groups.reverse! if reverse
-      end
-
-      def finish
-        reporter.end
-        reporter.dump
-      end
-
-      def reporter
-        @options.reporter
-      end
-
-      def reverse
-        @options.reverse
-      end
-
-      def example_groups
-        @options.example_groups
-      end
-
-      def number_of_examples
-        @options.number_of_examples
-      end
-    end
-    # TODO: BT - Deprecate BehaviourRunner?
-    BehaviourRunner = ExampleGroupRunner
-  end
-end

data/lib/spec/runner/formatter/base_formatter.rb

@@ -1,77 +0,0 @@
-module Spec
-  module Runner
-    module Formatter
-      # Baseclass for formatters that implements all required methods as no-ops. 
-      class BaseFormatter
-        attr_accessor :example_group, :options, :where
-        def initialize(options, where)
-          @options = options
-          @where = where
-        end
-        
-        # This method is invoked before any examples are run, right after
-        # they have all been collected. This can be useful for special
-        # formatters that need to provide progress on feedback (graphical ones)
-        #
-        # This method will only be invoked once, and the next one to be invoked
-        # is #add_example_group
-        def start(example_count)
-        end
-
-        # This method is invoked at the beginning of the execution of each example_group.
-        # +example_group+ is the example_group.
-        #
-        # The next method to be invoked after this is #example_failed or #example_finished
-        def add_example_group(example_group)
-          @example_group = example_group
-        end
-
-        # This method is invoked when an +example+ starts.
-        def example_started(example)
-        end
-
-        # This method is invoked when an +example+ passes.
-        def example_passed(example)
-        end
-
-        # This method is invoked when an +example+ fails, i.e. an exception occurred
-        # inside it (such as a failed should or other exception). +counter+ is the 
-        # sequence number of the failure (starting at 1) and +failure+ is the associated 
-        # Failure object.
-        def example_failed(example, counter, failure)
-        end
-        
-        # This method is invoked when an example is not yet implemented (i.e. has not
-        # been provided a block), or when an ExamplePendingError is raised.
-        # +message+ is the message from the ExamplePendingError, if it exists, or the
-        # default value of "Not Yet Implemented"
-        def example_pending(example, message)
-        end
-
-        # This method is invoked after all of the examples have executed. The next method
-        # to be invoked after this one is #dump_failure (once for each failed example),
-        def start_dump
-        end
-
-        # Dumps detailed information about an example failure.
-        # This method is invoked for each failed example after all examples have run. +counter+ is the sequence number
-        # of the associated example. +failure+ is a Failure object, which contains detailed
-        # information about the failure.
-        def dump_failure(counter, failure)
-        end
-      
-        # This method is invoked after the dumping of examples and failures.
-        def dump_summary(duration, example_count, failure_count, pending_count)
-        end
-        
-        # This gets invoked after the summary if option is set to do so.
-        def dump_pending
-        end
-
-        # This method is invoked at the very end. Allows the formatter to clean up, like closing open streams.
-        def close
-        end
-      end
-    end
-  end
-end