rspec-core 2.0.0.beta.9 → 2.0.0.beta.10

data/VERSION

@@ -1 +1 @@
-2.0.0.beta.9
+2.0.0.beta.10

data/features/configuration/custom_settings.feature

@@ -0,0 +1,86 @@
+Feature: custom settings
+
+  In order to seamlessly provide users more configuration settings
+  As an RSpec extenstion-library author
+  I want to define new settings on the RSpec.configuration object
+
+  Scenario: simple setting
+    Given a file named "additional_setting_spec.rb" with:
+      """
+      RSpec.configure do |c|
+        c.add_setting :custom_setting
+      end
+
+      describe "custom setting" do
+        it "is nil by default" do
+          RSpec.configuration.custom_setting.should be_nil
+        end
+
+        it "acts false by default" do
+          RSpec.configuration.custom_setting.should be_false
+        end
+
+        it "is exposed as a predicate" do
+          RSpec.configuration.custom_setting?.should be_false
+        end
+
+        it "can be overridden" do
+          RSpec.configuration.custom_setting = true
+          RSpec.configuration.custom_setting.should be_true
+          RSpec.configuration.custom_setting?.should be_true
+        end
+      end
+      """
+    When I run "rspec ./additional_setting_spec.rb"
+    Then I should see "0 failures"
+
+  Scenario: default to true
+    Given a file named "additional_setting_spec.rb" with:
+      """
+      RSpec.configure do |c|
+        c.add_setting :custom_setting, :default => true
+      end
+
+      describe "custom setting" do
+        it "is true by default" do
+          RSpec.configuration.custom_setting.should be_true
+        end
+
+        it "is exposed as a predicate" do
+          RSpec.configuration.custom_setting?.should be_true
+        end
+
+        it "can be overridden" do
+          RSpec.configuration.custom_setting = false
+          RSpec.configuration.custom_setting.should be_false
+          RSpec.configuration.custom_setting?.should be_false
+        end
+      end
+      """
+    When I run "rspec ./additional_setting_spec.rb"
+    Then I should see "0 failures"
+
+  Scenario: overridden in a subsequent RSpec.configure block
+    Given a file named "additional_setting_spec.rb" with:
+      """
+      RSpec.configure do |c|
+        c.add_setting :custom_setting
+      end
+
+      RSpec.configure do |c|
+        c.custom_setting = true
+      end
+
+      describe "custom setting" do
+        it "returns the value set in the last cofigure block to get eval'd" do
+          RSpec.configuration.custom_setting.should be_true
+        end
+
+        it "is exposed as a predicate" do
+          RSpec.configuration.custom_setting?.should be_true
+        end
+      end
+      """
+    When I run "rspec ./additional_setting_spec.rb"
+    Then I should see "0 failures"
+

data/features/formatters/custom_formatter.feature

@@ -10,7 +10,7 @@ Feature: custom formatters
       """
       require "rspec/runner/formatter/base_formatter"
 
-      class CustomFormatter < Spec::Runner::Formatter::BaseFormatter
+      class CustomFormatter < RSpec::Runner::Formatter::BaseFormatter
         def initialize(options, output)
           @output = output
         end

data/lib/rspec/core.rb

@@ -2,6 +2,7 @@ require 'rspec/core/kernel_extensions'
 require 'rspec/core/object_extensions'
 require 'rspec/core/load_path'
 require 'rspec/core/deprecation'
+require 'rspec/core/formatters'
 
 require 'rspec/core/hooks'
 require 'rspec/core/subject'
@@ -12,12 +13,14 @@ require 'rspec/core/pending'
 require 'rspec/core/around_proxy'
 require 'rspec/core/world'
 require 'rspec/core/configuration'
+require 'rspec/core/option_parser'
 require 'rspec/core/configuration_options'
+require 'rspec/core/command_line'
+require 'rspec/core/drb_command_line'
 require 'rspec/core/runner'
 require 'rspec/core/example'
 require 'rspec/core/shared_example_group'
 require 'rspec/core/example_group'
-require 'rspec/core/formatters'
 require 'rspec/core/version'
 require 'rspec/core/errors'
 
@@ -62,3 +65,5 @@ require 'rspec/core/backward_compatibility'
 
 # TODO - make this configurable with default 'on'
 require 'rspec/expectations'
+
+require 'rspec/monkey'

data/lib/rspec/core/backward_compatibility.rb

@@ -9,15 +9,13 @@ module RSpec
     module ConstMissing
       def const_missing(name)
         case name
-        when :Rspec
-          RSpec
-        when :Spec
-          RSpec.warn <<-WARNING
+        when :Rspec, :Spec
+          RSpec.warn_deprecation <<-WARNING
 *****************************************************************
 DEPRECATION WARNING: you are using a deprecated constant that will
 be removed from a future version of RSpec.
 
-* Spec is deprecated.
+* #{name} is deprecated.
 * RSpec is the new top-level module in RSpec-2
 
 #{caller(0)[1]}

data/lib/rspec/core/command_line.rb

@@ -0,0 +1,52 @@
+module RSpec
+  module Core
+    class CommandLine
+      def initialize(argv)
+        @options = RSpec::Core::ConfigurationOptions.new(argv)
+        @options.configure(configuration)
+        configuration.require_files_to_run
+        configuration.configure_mock_framework
+      end
+
+      def run(err, out)
+        configuration.error_stream = err
+        configuration.output_stream = out
+        world.announce_inclusion_filter
+
+        configuration.reporter.report(example_count) do |reporter|
+          example_groups.run_examples(reporter)
+        end
+        
+        example_groups.success?
+      end
+
+    private
+
+      def example_count
+        world.example_count
+      end
+
+      module ExampleGroups
+        def run_examples(reporter)
+          @success = self.inject(true) {|success, group| success &= group.run(reporter)}
+        end
+
+        def success?
+          @success ||= false
+        end
+      end
+
+      def example_groups
+        world.example_groups.extend(ExampleGroups)
+      end
+
+      def configuration
+        RSpec.configuration
+      end
+
+      def world
+        RSpec.world
+      end
+    end
+  end
+end

data/lib/rspec/core/configuration.rb

@@ -1,66 +1,109 @@
 module RSpec
   module Core
     class Configuration
-      attr_reader :hooks # :nodoc:
-
-      # Control what examples are run by filtering 
-      attr_accessor :filter
-
-      # Control what examples are not run by filtering 
-      attr_accessor :exclusion_filter
-
-      # Run all examples if the run is filtered, and no examples were found.
-      attr_writer :run_all_when_everything_filtered
-
-      attr_reader :options
+      def self.add_setting(name, opts={})
+        if opts[:alias]
+          alias_method name, opts[:alias]
+          alias_method "#{name}=", "#{opts[:alias]}="
+          alias_method "#{name}?", "#{opts[:alias]}?"
+        else
+          define_method("#{name}=") {|val| settings[name] = val}
+          define_method(name) { settings.has_key?(name) ? settings[name] : opts[:default] }
+          define_method("#{name}?") { !!(send name) }
+        end
+      end
 
-      def initialize
-        @run_all_when_everything_filtered = false
-        @hooks = { 
+      add_setting :error_stream
+      add_setting :output_stream
+      add_setting :output, :alias => :output_stream
+      add_setting :drb_port
+      add_setting :color_enabled
+      add_setting :profile_examples
+      add_setting :run_all_when_everything_filtered
+      add_setting :mock_framework, :default => :rspec
+      add_setting :filter
+      add_setting :exclusion_filter
+      add_setting :filename_pattern, :default => '**/*_spec.rb'
+      add_setting :files_to_run, :default => []
+      add_setting :include_or_extend_modules, :default => []
+      add_setting :formatter_class, :default => RSpec::Core::Formatters::ProgressFormatter
+      add_setting :backtrace_clean_patterns, :default => [
+        /\/lib\/ruby\//, 
+        /bin\/rcov:/, 
+        /vendor\/rails/, 
+        /bin\/rspec/, 
+        /bin\/spec/,
+        /lib\/rspec\/(core|expectations|matchers|mocks)/
+      ]
+    
+      # :call-seq:
+      #   add_setting(:name)
+      #   add_setting(:name, :default => "default_value")
+      #   add_setting(:name, :alias => :other_setting)
+      #
+      # Use this to add custom settings to the RSpec.configuration object. 
+      #
+      #   RSpec.configuration.add_setting :foo
+      #
+      # Creates three methods on the configuration object, a setter, a getter,
+      # and a predicate:
+      #
+      #   RSpec.configuration.foo=(value)
+      #   RSpec.configuration.foo()
+      #   RSpec.configuration.foo?() # returns !!foo
+      #
+      # Intended for extension frameworks like rspec-rails, so they can add config
+      # settings that are domain specific. For example:
+      #
+      #   RSpec.configure do |c|
+      #     c.add_setting :use_transactional_fixtures, :default => true
+      #     c.add_setting :use_transactional_examples, :alias => :use_transactional_fixtures
+      #   end
+      #
+      # == Options
+      # 
+      # +add_setting+ takes an optional hash that supports the following
+      # keys:
+      #
+      #   :default => "default value"
+      #
+      # This sets the default value for the getter and the predicate (which
+      # will return +true+ as long as the value is not +false+ or +nil+).
+      #
+      #   :alias => :other_setting
+      #
+      # Aliases its setter, getter, and predicate, to those for the
+      # +other_setting+.
+      def add_setting(name, opts={})
+        self.class.add_setting(name, opts)
+      end
+
+      def puts(message)
+        output_stream.puts(message)
+      end
+
+      def hooks
+        @hooks ||= { 
           :before => { :each => [], :all => [], :suite => [] }, 
           :after => { :each => [], :all => [], :suite => [] } 
         }
-        @include_or_extend_modules = []
-        @filter, @exclusion_filter = nil, nil
-        @options = default_options
       end
-      
-      def default_options
-        {
-          :color_enabled => false,
-          :mock_framework => nil,
-          :profile_examples => false,
-          :files_to_run => [],
-          :filename_pattern => '**/*_spec.rb',
-          :formatter_class => RSpec::Core::Formatters::ProgressFormatter,
-          :backtrace_clean_patterns => [/\/lib\/ruby\//, 
-                                        /bin\/rcov:/, 
-                                        /vendor\/rails/, 
-                                        /bin\/rspec/, 
-                                        /bin\/spec/,
-                                        /lib\/rspec\/(core|expectations|matchers|mocks)/]
-        }
+
+      def settings
+        @settings ||= {}
       end
 
       def clear_inclusion_filter
         self.filter = nil
       end
-      
-      def cleaned_from_backtrace?(line)
-        @options[:backtrace_clean_patterns].any? { |regex| line =~ regex }
-      end
-
-      def backtrace_clean_patterns
-        @options[:backtrace_clean_patterns]
-      end
 
-      def mock_framework=(use_me_to_mock)
-        @options[:mock_framework] = use_me_to_mock
+      def cleaned_from_backtrace?(line)
+        backtrace_clean_patterns.any? { |regex| line =~ regex }
       end
 
       def require_mock_framework_adapter
-        require case @options[:mock_framework].to_s
-        when "", /rspec/i
+        require case mock_framework.to_s
+        when /rspec/i
           'rspec/core/mocking/with_rspec'
         when /mocha/i
           'rspec/core/mocking/with_mocha'
@@ -73,20 +116,8 @@ module RSpec
         end 
       end
 
-      def filename_pattern
-        @options[:filename_pattern]
-      end
-
-      def filename_pattern=(new_pattern)
-        @options[:filename_pattern] = new_pattern
-      end 
-
-      def color_enabled=(on_or_off)
-        @options[:color_enabled] = on_or_off
-      end
-
       def full_backtrace=(bool)
-        @options[:backtrace_clean_patterns].clear
+        backtrace_clean_patterns.clear
       end
 
       def libs=(libs)
@@ -111,10 +142,6 @@ EOM
         end
       end
 
-      def color_enabled?
-        @options[:color_enabled]
-      end
-
       def line_number=(line_number)
         filter_run :line_number => line_number.to_i
       end
@@ -123,19 +150,6 @@ EOM
         filter_run :full_description => /#{description}/
       end
       
-      # Enable profiling of example run - defaults to false
-      def profile_examples
-        @options[:profile_examples]
-      end
-      
-      def profile_examples=(on_or_off)
-        @options[:profile_examples] = on_or_off
-      end
-     
-      def formatter_class
-        @options[:formatter_class]
-      end
-     
       def formatter=(formatter_to_use)
         formatter_class = case formatter_to_use.to_s
         when 'd', 'doc', 'documentation', 's', 'n', 'spec', 'nested'
@@ -145,19 +159,17 @@ EOM
         else 
           raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?."
         end
-        @options[:formatter_class] = formatter_class
+        self.formatter_class = formatter_class
       end
-        
+
       def formatter
-        @formatter ||= formatter_class.new
+        @formatter ||= formatter_class.new(output)
       end
-      
-      def files_to_run
-        @options[:files_to_run]
-      end
-      
+
+      alias_method :reporter, :formatter
+
       def files_or_directories_to_run=(*files)
-        @options[:files_to_run] = files.flatten.inject([]) do |result, file|
+        self.files_to_run = files.flatten.inject([]) do |result, file|
           if File.directory?(file)
             filename_pattern.split(",").each do |pattern|
               result += Dir["#{file}/#{pattern.strip}"]
@@ -178,45 +190,33 @@ EOM
       end
 
       def filter_run(options={})
-        @filter = options unless @filter and @filter[:line_number] || @filter[:full_description]
+        self.filter = options unless filter and filter[:line_number] || filter[:full_description]
       end
 
-      def run_all_when_everything_filtered?
-        @run_all_when_everything_filtered
+      def include(mod, filters={})
+        include_or_extend_modules << [:include, mod, filters]
       end
 
-      def output
-        $stdout
-      end
-
-      def puts(msg="")
-        output.puts(msg)    
-      end
-
-      def include(mod, options={})
-        @include_or_extend_modules << [:include, mod, options]
-      end
-
-      def extend(mod, options={})
-        @include_or_extend_modules << [:extend, mod, options]
+      def extend(mod, filters={})
+        include_or_extend_modules << [:extend, mod, filters]
       end
 
       def find_modules(group)
-        @include_or_extend_modules.select do |include_or_extend, mod, filters|
+        include_or_extend_modules.select do |include_or_extend, mod, filters|
           group.all_apply?(filters)
         end
       end
 
       def before(each_or_all=:each, options={}, &block)
-        @hooks[:before][each_or_all] << [options, block]
+        hooks[:before][each_or_all] << [options, block]
       end
 
       def after(each_or_all=:each, options={}, &block)
-        @hooks[:after][each_or_all] << [options, block]
+        hooks[:after][each_or_all] << [options, block]
       end
 
       def find_hook(hook, each_or_all, group)
-        @hooks[hook][each_or_all].select do |filters, block|
+        hooks[hook][each_or_all].select do |filters, block|
           group.all_apply?(filters)
         end.map { |filters, block| block }
       end
@@ -229,18 +229,6 @@ EOM
       def require_files_to_run
         files_to_run.map {|f| require File.expand_path(f) }
       end
-
-      def add_option(mname, options)
-        case options[:type]
-        when :boolean
-          (class << self; self; end).class_eval do
-            attr_accessor mname
-            define_method("#{mname}?") { !!(send mname) }
-          end
-          instance_variable_set "@#{mname}", options[:default]
-        end
-      end
-
     end
   end
 end