rspec-core 2.11.1 → 2.12.0

data/lib/rspec/core/configuration.rb

@@ -405,17 +405,21 @@ MESSAGE
         @backtrace_clean_patterns = true_or_false ? [] : DEFAULT_BACKTRACE_PATTERNS
       end
 
-      def color
-        return false unless output_to_tty?
+      def color(output=output_stream)
+        # rspec's built-in formatters all call this with the output argument,
+        # but defaulting to output_stream for backward compatibility with
+        # formatters in extension libs
+        return false unless output_to_tty?(output)
         value_for(:color, @color)
       end
 
       def color=(bool)
         if bool
-          @color = true
           if RSpec.windows_os? and not ENV['ANSICON']
-            warn "You must use ANSICON 1.31 or later (http://adoxa.110mb.com/ansicon/) to use colour on Windows"
+            warn "You must use ANSICON 1.31 or later (http://adoxa.3eeweb.com/ansicon/) to use colour on Windows"
             @color = false
+          else
+            @color = true
           end
         end
       end
@@ -500,7 +504,7 @@ EOM
       # @private
       def files_or_directories_to_run=(*files)
         files = files.flatten
-        files << default_path if command == 'rspec' && default_path && files.empty?
+        files << default_path if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?
         self.files_to_run = get_files_to_run(files)
       end
 
@@ -777,10 +781,29 @@ EOM
 
       # @private
       def load_spec_files
-        files_to_run.uniq.map {|f| load File.expand_path(f) }
+        files_to_run.uniq.each {|f| load File.expand_path(f) }
         raise_if_rspec_1_is_loaded
       end
 
+      # @private
+      DEFAULT_FORMATTER = lambda { |string| string }
+
+      # Formats the docstring output using the block provided.
+      #
+      # @example
+      #   # This will strip the descriptions of both examples and example groups.
+      #   RSpec.configure do |config|
+      #     config.format_docstrings { |s| s.strip }
+      #   end
+      def format_docstrings(&block)
+        @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER
+      end
+
+      # @private
+      def format_docstrings_block
+        @format_docstrings_block ||= DEFAULT_FORMATTER
+      end
+
       # @api
       #
       # Sets the seed value and sets `order='rand'`
@@ -799,6 +822,79 @@ EOM
         order.to_s.match(/rand/)
       end
 
+      # @private
+      DEFAULT_ORDERING = lambda { |list| list }
+
+      # @private
+      RANDOM_ORDERING = lambda do |list|
+        Kernel.srand RSpec.configuration.seed
+        list.sort_by { Kernel.rand(list.size) }
+      end
+
+      # Sets a strategy by which to order examples.
+      #
+      # @example
+      #   RSpec.configure do |config|
+      #     config.order_examples do |examples|
+      #       examples.reverse
+      #     end
+      #   end
+      #
+      # @see #order_groups
+      # @see #order_groups_and_examples
+      # @see #order=
+      # @see #seed=
+      def order_examples(&block)
+        @example_ordering_block = block
+        @order = "custom" unless built_in_orderer?(block)
+      end
+
+      # @private
+      def example_ordering_block
+        @example_ordering_block ||= DEFAULT_ORDERING
+      end
+
+      # Sets a strategy by which to order groups.
+      #
+      # @example
+      #   RSpec.configure do |config|
+      #     config.order_groups do |groups|
+      #       groups.reverse
+      #     end
+      #   end
+      #
+      # @see #order_examples
+      # @see #order_groups_and_examples
+      # @see #order=
+      # @see #seed=
+      def order_groups(&block)
+        @group_ordering_block = block
+        @order = "custom" unless built_in_orderer?(block)
+      end
+
+      # @private
+      def group_ordering_block
+        @group_ordering_block ||= DEFAULT_ORDERING
+      end
+
+      # Sets a strategy by which to order groups and examples.
+      #
+      # @example
+      #   RSpec.configure do |config|
+      #     config.order_groups_and_examples do |groups_or_examples|
+      #       groups_or_examples.reverse
+      #     end
+      #   end
+      #
+      # @see #order_groups
+      # @see #order_examples
+      # @see #order=
+      # @see #seed=
+      def order_groups_and_examples(&block)
+        order_groups(&block)
+        order_examples(&block)
+      end
+
     private
 
       def get_files_to_run(paths)
@@ -806,12 +902,12 @@ EOM
         paths.map do |path|
           path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
           File.directory?(path) ? gather_directories(path, patterns) : extract_location(path)
-        end.flatten
+        end.flatten.sort
       end
 
       def gather_directories(path, patterns)
         patterns.map do |pattern|
-          pattern =~ /^#{path}/ ? Dir[pattern.strip] : Dir["#{path}/{#{pattern.strip}}"]
+          pattern =~ /^#{path}/ ? Dir[pattern.strip].sort : Dir["#{path}/{#{pattern.strip}}"].sort
         end
       end
 
@@ -856,12 +952,8 @@ MESSAGE
         end
       end
 
-      def output_to_tty?
-        begin
-          output_stream.tty? || tty?
-        rescue NoMethodError
-          false
-        end
+      def output_to_tty?(output=output_stream)
+        tty? || (output.respond_to?(:tty?) && output.tty?)
       end
 
       def built_in_formatter(key)
@@ -878,6 +970,9 @@ MESSAGE
         when 'p', 'progress'
           require 'rspec/core/formatters/progress_formatter'
           RSpec::Core::Formatters::ProgressFormatter
+        when 'j', 'json'
+          require 'rspec/core/formatters/json_formatter'
+          RSpec::Core::Formatters::JsonFormatter
         end
       end
 
@@ -923,7 +1018,9 @@ MESSAGE
       end
 
       def order_and_seed_from_seed(value)
+        order_groups_and_examples(&RANDOM_ORDERING)
         @order, @seed = 'rand', value.to_i
+        [@order, @seed]
       end
 
       def set_order_and_seed(hash)
@@ -935,10 +1032,21 @@ MESSAGE
         order, seed = type.to_s.split(':')
         @order = order
         @seed  = seed = seed.to_i if seed
-        @order, @seed = nil, nil if order == 'default'
+
+        if randomize?
+          order_groups_and_examples(&RANDOM_ORDERING)
+        elsif order == 'default'
+          @order, @seed = nil, nil
+          order_groups_and_examples(&DEFAULT_ORDERING)
+        end
+
         return order, seed
       end
 
+      def built_in_orderer?(block)
+        [DEFAULT_ORDERING, RANDOM_ORDERING].include?(block)
+      end
+
     end
   end
 end

data/lib/rspec/core/configuration_options.rb

@@ -9,6 +9,13 @@ module RSpec
 
       def initialize(args)
         @args = args
+        if args.include?("--default_path")
+          args[args.index("--default_path")] = "--default-path"
+        end
+
+        if args.include?("--line_number")
+          args[args.index("--line_number")] = "--line-number"
+        end
       end
 
       def configure(config)
@@ -71,7 +78,7 @@ module RSpec
       end
 
       def file_options
-        custom_options_file ? [custom_options] : [global_options, local_options]
+        custom_options_file ? [custom_options] : [global_options, project_options, local_options]
       end
 
       def env_options
@@ -90,6 +97,10 @@ module RSpec
         @local_options ||= options_from(local_options_file)
       end
 
+      def project_options
+        @project_options ||= options_from(project_options_file)
+      end
+
       def global_options
         @global_options ||= options_from(global_options_file)
       end
@@ -112,10 +123,14 @@ module RSpec
         command_line_options[:custom_options_file]
       end
 
-      def local_options_file
+      def project_options_file
         ".rspec"
       end
 
+      def local_options_file
+        ".rspec-local"
+      end
+
       def global_options_file
         begin
           File.join(File.expand_path("~"), ".rspec")

data/lib/rspec/core/example.rb

@@ -49,7 +49,8 @@ module RSpec
       # there is one, otherwise returns a message including the location of the
       # example.
       def description
-        metadata[:description].to_s.empty? ? "example at #{location}" : metadata[:description]
+        description = metadata[:description].to_s.empty? ? "example at #{location}" : metadata[:description]
+        RSpec.configuration.format_docstrings_block.call(description)
       end
 
       # @attr_reader
@@ -260,7 +261,7 @@ An error occurred #{context}
 
       def start(reporter)
         reporter.example_started(self)
-        record :started_at => Time.now
+        record :started_at => RSpec::Core::Time.now
       end
 
       # @private
@@ -290,8 +291,8 @@ An error occurred #{context}
       end
 
       def record_finished(status, results={})
-        finished_at = Time.now
-        record results.merge(:status => status, :finished_at => finished_at, :run_time => (finished_at - execution_result[:started_at]))
+        finished_at = RSpec::Core::Time.now
+        record results.merge(:status => status, :finished_at => finished_at, :run_time => (finished_at - execution_result[:started_at]).to_f)
       end
 
       def run_before_each

data/lib/rspec/core/example_group.rb

@@ -22,6 +22,7 @@ module RSpec
       include Subject::ExampleMethods
       include Pending
       include Let
+      include SharedExampleGroup
 
       # @private
       def self.world
@@ -43,7 +44,12 @@ module RSpec
           end
         end
 
-        delegate_to_metadata :description, :described_class, :file_path
+        def description
+          description = metadata[:example_group][:description]
+          RSpec.configuration.format_docstrings_block.call(description)
+        end
+
+        delegate_to_metadata :described_class, :file_path
         alias_method :display_name, :description
         # @private
         alias_method :describes, :described_class
@@ -241,7 +247,7 @@ module RSpec
 
       # @private
       def self.children
-        @children ||= [].extend(Extensions::Ordered)
+        @children ||= [].extend(Extensions::Ordered::ExampleGroups)
       end
 
       # @private
@@ -249,9 +255,9 @@ module RSpec
         @_descendants ||= [self] + children.inject([]) {|list, c| list + c.descendants}
       end
 
-      # @private
-      def self.ancestors
-        @_ancestors ||= super().select {|a| a < RSpec::Core::ExampleGroup}
+      ## @private
+      def self.parent_groups
+        @parent_groups ||= ancestors.select {|a| a < RSpec::Core::ExampleGroup}
       end
 
       # @private
@@ -308,9 +314,12 @@ module RSpec
       # @private
       def self.run_before_all_hooks(example_group_instance)
         return if descendant_filtered_examples.empty?
-        assign_before_all_ivars(superclass.before_all_ivars, example_group_instance)
-        run_hook(:before, :all, example_group_instance)
-        store_before_all_ivars(example_group_instance)
+        begin
+          assign_before_all_ivars(superclass.before_all_ivars, example_group_instance)
+          run_hook(:before, :all, example_group_instance)
+        ensure
+          store_before_all_ivars(example_group_instance)
+        end
       end
 
       # @private
@@ -361,6 +370,7 @@ An error occurred in an after(:all) hook.
           results_for_descendants = children.ordered.map {|child| child.run(reporter)}.all?
           result_for_this_group && results_for_descendants
         rescue Exception => ex
+          RSpec.wants_to_quit = true if fail_fast?
           fail_filtered_examples(ex, reporter)
         ensure
           run_after_all_hooks(new)
@@ -417,7 +427,7 @@ An error occurred in an after(:all) hook.
 
       # @private
       def self.top_level_description
-        ancestors.last.description
+        parent_groups.last.description
       end
 
       # @private

data/lib/rspec/core/extensions/ordered.rb

@@ -7,12 +7,18 @@ module RSpec
       # strategies like randomization.
       module Ordered
         # @private
-        def ordered
-          if RSpec.configuration.randomize?
-            Kernel.srand RSpec.configuration.seed
-            sort_by { Kernel.rand size }
-          else
-            self
+        module ExampleGroups
+          # @private
+          def ordered
+            RSpec.configuration.group_ordering_block.call(self)
+          end
+        end
+
+        # @private
+        module Examples
+          # @private
+          def ordered
+            RSpec.configuration.example_ordering_block.call(self)
           end
         end
       end

data/lib/rspec/core/formatters.rb

@@ -0,0 +1,55 @@
+# ## Built-in Formatters
+#
+# * progress (default) - prints dots for passing examples, `F` for failures, `*` for pending
+# * documentation - prints the docstrings passed to `describe` and `it` methods (and their aliases)
+# * html
+# * textmate - html plus links to editor
+# * json - useful for archiving data for subsequent analysis
+#
+# The progress formatter is the default, but you can choose any one or more of
+# the other formatters by passing with the `--format` (or `-f` for short)
+# command-line option, e.g.
+#
+#     rspec --format documentation
+#
+# You can also send the output of multiple formatters to different streams, e.g.
+#
+#     rspec --format documentation --format html --out results.html
+#
+# This example sends the output of the documentation formatter to `STDOUT`, and
+# the output of the html formatter to results.html.
+#
+# ## Custom Formatters
+#
+# You can tell RSpec to use a custom formatter by passing its path and name to
+# the `rspec` commmand. For example, if you define MyCustomFormatter in
+# path/to/my_custom_formatter.rb, you would type this command:
+#
+#     rspec --require path/to/my_custom_formatter.rb --format MyCustomFormatter
+#
+# The reporter calls every formatter with this protocol:
+#
+# * `start(expected_example_count)`
+# * zero or more of the following
+#   * `example_group_started(group)`
+#   * `example_started(example)`
+#   * `example_passed(example)`
+#   * `example_failed(example)`
+#   * `example_pending(example)`
+#   * `message(string)`
+# * `stop`
+# * `start_dump`
+# * `dump_pending`
+# * `dump_failures`
+# * `dump_summary(duration, example_count, failure_count, pending_count)`
+# * `seed(value)`
+# * `close`
+#
+# You can either implement all of those methods or subclass
+# `RSpec::Core::Formatters::BaseTextFormatter` and override the methods you want
+# to enhance.
+#
+# @see RSpec::Core::Formatters::BaseTextFormatter
+# @see RSpec::Core::Reporter
+module RSpec::Core::Formatters
+end