dchelimsky-rspec 1.1.12 → 1.1.99.1

data/lib/spec/example/example_group_methods.rb

@@ -4,23 +4,18 @@ module Spec
     module ExampleGroupMethods
       class << self
         attr_accessor :matcher_class
-
-        def description_text(*args)
-          args.inject("") do |description, arg|
-            description << " " unless (description == "" || arg.to_s =~ /^(\s|\.|#)/)
-            description << arg.to_s
-          end
-        end
-
-        def example_group_creation_listeners
-          @example_group_creation_listeners ||= []
-        end
       end
 
       include Spec::Example::BeforeAndAfterHooks
+      include Spec::Example::Subject::ExampleGroupMethods
+      include Spec::Example::PredicateMatchers
 
-      attr_reader :description_options, :spec_path
-      alias :options :description_options
+      attr_reader :options, :spec_path
+      
+      def inherited(klass) # :nodoc:
+        super
+        ExampleGroupFactory.register_example_group(klass)
+      end
       
       # Provides the backtrace up to where this example_group was declared.
       def backtrace
@@ -36,21 +31,6 @@ WARNING
         backtrace
       end
       
-      def description_args
-        @description_args ||= []
-      end
-
-      def inherited(klass)
-        super
-        register_example_group(klass)
-      end
-      
-      def register_example_group(klass)
-        ExampleGroupMethods.example_group_creation_listeners.each do |l|
-          l.register_example_group(klass)
-        end
-      end
-      
       # Makes the describe/it syntax available from a class. For example:
       #
       #   class StackSpec < Spec::ExampleGroup
@@ -70,9 +50,9 @@ WARNING
           Spec::Example::add_spec_path_to(args)
           options = args.last
           if options[:shared]
-            create_shared_example_group(*args, &example_group_block)
+            ExampleGroupFactory.create_shared_example_group(*args, &example_group_block)
           else
-            create_example_group_subclass(*args, &example_group_block)
+            subclass(*args, &example_group_block)
           end
         else
           set_description(*args)
@@ -80,26 +60,6 @@ WARNING
       end
       alias :context :describe
       
-      def create_shared_example_group(*args, &example_group_block) # :nodoc:
-        SharedExampleGroup.register(*args, &example_group_block)
-      end
-      
-      # Creates a new subclass of self, with a name "under" our own name.
-      # Example:
-      #
-      #   x = Foo::Bar.subclass('Zap'){}
-      #   x.name # => Foo::Bar::Zap_1
-      #   x.superclass.name # => Foo::Bar
-      def create_example_group_subclass(*args, &example_group_block) # :nodoc:
-        @class_count ||= 0
-        @class_count += 1
-        klass = const_set("Subclass_#{@class_count}", Class.new(self))
-        klass.set_description(*args)
-        example_group_block = ExampleGroupFactory.include_constants_in(args.last[:scope], &example_group_block)
-        klass.module_eval(&example_group_block)
-        klass
-      end
-      
       # Use this to pull in examples from shared example groups.
       def it_should_behave_like(*shared_example_groups)
         shared_example_groups.each do |group|
@@ -107,44 +67,13 @@ WARNING
         end
       end
       
-      # :call-seq:
-      #   predicate_matchers[matcher_name] = method_on_object
-      #   predicate_matchers[matcher_name] = [method1_on_object, method2_on_object]
-      #
-      # Dynamically generates a custom matcher that will match
-      # a predicate on your class. RSpec provides a couple of these
-      # out of the box:
-      #
-      #   exist (for state expectations)
-      #     File.should exist("path/to/file")
-      #
-      #   an_instance_of (for mock argument matchers)
-      #     mock.should_receive(:message).with(an_instance_of(String))
-      #
-      # == Examples
-      #
-      #   class Fish
-      #     def can_swim?
-      #       true
-      #     end
-      #   end
-      #
-      #   describe Fish do
-      #     predicate_matchers[:swim] = :can_swim?
-      #     it "should swim" do
-      #       Fish.new.should swim
-      #     end
-      #   end
-      def predicate_matchers
-        @predicate_matchers ||= {}
-      end
-
       # Creates an instance of the current example group class and adds it to
       # a collection of examples of the current example group.
-      def example(description=nil, options={}, &implementation)
-        e = new(description, options, &implementation)
-        example_objects << e
-        e
+      def example(description=nil, options={}, backtrace=nil, &implementation)
+        example_description = ExampleDescription.new(description, options, backtrace || caller(0)[1])
+        example_descriptions << example_description
+        example_implementations[example_description] = implementation
+        example_description
       end
 
       alias_method :it, :example
@@ -157,105 +86,101 @@ WARNING
       
       alias_method :xit, :xexample
       alias_method :xspecify, :xexample
-
+      
       def run(run_options)
         examples = examples_to_run(run_options)
-        run_options.reporter.add_example_group(self) unless examples.empty?
+        notify(run_options.reporter) unless examples.empty?
         return true if examples.empty?
         return dry_run(examples, run_options) if run_options.dry_run?
 
-        plugin_mock_framework(run_options)
-        define_methods_from_predicate_matchers(run_options)
+        define_methods_from_predicate_matchers
 
         success, before_all_instance_variables = run_before_all(run_options)
         success, after_all_instance_variables  = execute_examples(success, before_all_instance_variables, examples, run_options)
         success                                = run_after_all(success, after_all_instance_variables, run_options)
       end
 
+      def set_description(*args)
+        @description_args, @options = Spec::Example.args_and_options(*args)
+        @backtrace = caller(1)
+        @spec_path = File.expand_path(options[:spec_path]) if options[:spec_path]
+        self
+      end
+      
+      def notify(listener) # :nodoc:
+        listener.add_example_group(self)
+      end
+
       def description
-        result = ExampleGroupMethods.description_text(*description_parts)
-        (result.nil? || result == "") ? to_s : result
+        @description ||= build_description_from(*description_parts) || to_s
       end
       
       def described_type
-        description_parts.reverse.find {|part| part.is_a?(Module)}
+        @described_type ||= description_parts.reverse.find {|part| part.is_a?(Module)}
       end
       
-      # Defines an explicit subject for an example group which can then be the
-      # implicit receiver (through delegation) of calls to +should+.
-      #
-      # == Examples
-      #
-      #   describe CheckingAccount, "with $50" do
-      #     subject { CheckingAccount.new(:amount => 50, :currency => :USD) }
-      #     it { should have_a_balance_of(50, :USD)}
-      #     it { should_not be_overdrawn}
-      #   end
-      #
-      # See +ExampleMethods#should+ for more information about this approach.
-      def subject(&block)
-        @_subject_block = block
+      def described_class
+        @described_class ||= Class === described_type ? described_type : nil
       end
       
-      def subject_block
-        @_subject_block || lambda {nil}
+      def description_args
+        @description_args ||= []
       end
       
       def description_parts #:nodoc:
-        example_group_hierarchy.inject([]) do |parts, example_group_class|
+        @description_parts ||= example_group_hierarchy.inject([]) do |parts, example_group_class|
           [parts << example_group_class.description_args].flatten
         end
       end
-
-      def set_description(*args)
-        args, options = Spec::Example.args_and_options(*args)
-        @description_args = args
-        @description_options = options
-        @description_text = ExampleGroupMethods.description_text(*args)
-        @backtrace = caller(1)
-        @spec_path = File.expand_path(options[:spec_path]) if options[:spec_path]
-        self
+      
+      def example_descriptions # :nodoc:
+        @example_descriptions ||= []
       end
       
+      def example_implementations # :nodoc:
+        @example_implementations ||= {}
+      end
+            
       def examples(run_options=nil) #:nodoc:
-        examples = example_objects.dup
-        add_method_examples(examples)
-        (run_options && run_options.reverse) ? examples.reverse : examples
+        (run_options && run_options.reverse) ? example_descriptions.reverse : example_descriptions
       end
 
       def number_of_examples #:nodoc:
-        examples.length
-      end
-
-      # Only used from RSpec's own examples
-      def reset # :nodoc:
-        @before_all_parts = nil
-        @after_all_parts = nil
-        @before_each_parts = nil
-        @after_each_parts = nil
+        example_descriptions.length
       end
 
-      def run_before_each(example)
-        example.eval_each_fail_fast(all_before_each_parts)
+      def example_group_hierarchy
+        @example_group_hierarchy ||= ExampleGroupHierarchy.new(self)
       end
       
-      def all_before_each_parts
-        unless @all_before_each_parts
-          @all_before_each_parts = []
-          example_group_hierarchy.each do |example_group_class|
-            @all_before_each_parts += example_group_class.before_each_parts
+      def filtered_description(filter)
+        build_description_from(
+          *nested_descriptions.collect do |description|
+            description =~ filter ? $1 : description
           end
-        end
-        @all_before_each_parts
+        )
       end
+      
+      def nested_descriptions
+        example_group_hierarchy.nested_descriptions
+      end
+      
+      def include_constants_in(mod)
+        include mod if (Spec::Ruby.version.to_f >= 1.9) & (Module === mod) & !(Class === mod)
+      end
+      
+    private
 
-      def run_after_each(example)
-        example_group_hierarchy.reverse.each do |example_group_class|
-          example.eval_each_fail_slow(example_group_class.after_each_parts)
-        end
+      def subclass(*args, &example_group_block)
+        @class_count ||= 0
+        @class_count += 1
+        klass = const_set("Subclass_#{@class_count}", Class.new(self))
+        klass.set_description(*args)
+        klass.include_constants_in(args.last[:scope])
+        klass.module_eval(&example_group_block)
+        klass
       end
 
-    private
       def dry_run(examples, run_options)
         examples.each do |example|
           run_options.reporter.example_started(example)
@@ -264,14 +189,13 @@ WARNING
       end
 
       def run_before_all(run_options)
+        return [true,{}] if example_group_hierarchy.before_all_parts.empty?
         before_all = new("before(:all)")
         begin
-          example_group_hierarchy.each do |example_group_class|
-            before_all.eval_each_fail_fast(example_group_class.before_all_parts)
-          end
+          example_group_hierarchy.run_before_all(before_all)
           return [true, before_all.instance_variable_hash]
         rescue Exception => e
-          run_options.reporter.failure(before_all, e)
+          run_options.reporter.example_failed(ExampleDescription.new("before(:all)"), e)
           return [false, before_all.instance_variable_hash]
         end
       end
@@ -280,29 +204,30 @@ WARNING
         return [success, instance_variables] unless success
 
         after_all_instance_variables = instance_variables
-        examples.each do |example_group_instance|
+        
+        examples.each do |example|
+          example_group_instance = new(example.description,example.options,&example_implementations[example])
           success &= example_group_instance.execute(run_options, instance_variables)
           after_all_instance_variables = example_group_instance.instance_variable_hash
         end
+        
         return [success, after_all_instance_variables]
       end
-
+      
       def run_after_all(success, instance_variables, run_options)
+        return success if example_group_hierarchy.after_all_parts.empty?
         after_all = new("after(:all)")
         after_all.set_instance_variables_from_hash(instance_variables)
-        example_group_hierarchy.reverse.each do |example_group_class|
-          after_all.eval_each_fail_slow(example_group_class.after_all_parts)
-        end
+        example_group_hierarchy.run_after_all(after_all)
         return success
       rescue Exception => e
-        run_options.reporter.failure(after_all, e)
+        run_options.reporter.example_failed(ExampleDescription.new("after(:all)"), e)
         return false
       end
-
+      
       def examples_to_run(run_options)
-        all_examples = examples(run_options)
-        return all_examples unless specified_examples?(run_options)
-        all_examples.reject do |example|
+        return example_descriptions unless specified_examples?(run_options)
+        example_descriptions.reject do |example|
           matcher = ExampleGroupMethods.matcher_class.
             new(description.to_s, example.description)
           !matcher.matches?(run_options.examples)
@@ -310,68 +235,21 @@ WARNING
       end
 
       def specified_examples?(run_options)
-        run_options.examples && !run_options.examples.empty?
+        !run_options.examples.empty?
       end
 
-      def example_objects
-        @example_objects ||= []
-      end
-
-      class ExampleGroupHierarchy < Array
-        def initialize(example_group_class)
-          current_class = example_group_class
-          while current_class.kind_of?(ExampleGroupMethods)
-            unshift(current_class)
-            break unless current_class.respond_to? :superclass
-            current_class = current_class.superclass
-          end
-        end
+      def method_added(name) # :nodoc:
+        example(name.to_s, {}, caller(0)[1]) {__send__ name.to_s} if example_method?(name.to_s)
       end
       
-      def example_group_hierarchy
-        @example_group_hierarchy ||= ExampleGroupHierarchy.new(self)
-      end
-
-      def plugin_mock_framework(run_options)
-        case mock_framework = run_options.mock_framework
-        when Module
-          include mock_framework
-        else
-          require mock_framework
-          include Spec::Adapters::MockFramework
-        end
-      end
-
-      def define_methods_from_predicate_matchers(run_options) # :nodoc:
-        all_predicate_matchers = predicate_matchers.merge(
-          run_options.predicate_matchers
-        )
-        all_predicate_matchers.each_pair do |matcher_method, method_on_object|
-          define_method matcher_method do |*args|
-            eval("be_#{method_on_object.to_s.gsub('?','')}(*args)")
-          end
-        end
-      end
-
-      def add_method_examples(examples)
-        instance_methods.each do |method_name|
-          if example_method?(method_name)
-            examples << new(method_name) do
-              __send__(method_name)
-            end
-          end
-        end
-      end
-
       def example_method?(method_name)
         should_method?(method_name)
       end
 
       def should_method?(method_name)
         !(method_name =~ /^should(_not)?$/) &&
-        method_name =~ /^should/ && (
-          [-1,0].include?(instance_method(method_name).arity)
-        )
+        method_name =~ /^should/ &&
+        instance_method(method_name).arity < 1
       end
 
       def include_shared_example_group(shared_example_group)
@@ -387,6 +265,13 @@ WARNING
         end
       end
 
+      def build_description_from(*args)
+        text = args.inject("") do |description, arg|
+          description << " " unless (description == "" || arg.to_s =~ /^(\s|\.|#)/)
+          description << arg.to_s
+        end
+        text == "" ? nil : text
+      end
     end
 
   end

data/lib/spec/example/example_methods.rb

@@ -2,54 +2,41 @@ module Spec
   module Example
     module ExampleMethods
       
-      extend ModuleReopeningFix
-      
-      def subject # :nodoc: this is somewhat experimental
-        @subject ||= ( instance_variable_get(subject_variable_name) ||
-                       instance_eval(&self.class.subject_block) ||
-                       (described_class ? described_class.new : nil) )
-      end
-
-      # When +should+ is called with no explicit receiver, the call is
-      # delegated to the *subject* of the example group. This could be either
-      # an explicit subject generated by calling the block passed to
-      # +ExampleGroupMethods#subject+, or, if the group is describing a class,
-      # an implicitly generated instance of that class.
-      def should(matcher=nil)
-        if matcher
-          subject.should(matcher)
-        else
-          subject.should
-        end
-      end
-
-      # Just like +should+, +should_not+ delegates to the subject (implicit or
-      # explicit) of the example group.
-      def should_not(matcher)
-        subject.should_not(matcher)
-      end
+      extend  Spec::Example::ModuleReopeningFix
+      include Spec::Example::Subject::ExampleMethods
       
       def violated(message="")
         raise Spec::Expectations::ExpectationNotMetError.new(message)
       end
 
+      # Declared description for this example:
+      #
+      #   describe Account do
+      #     it "should start with a balance of 0" do
+      #     ...
+      #
+      #   description
+      #   => "should start with a balance of 0"
       def description
         @_defined_description || ::Spec::Matchers.generated_description || "NO NAME"
       end
       
-      def options
+      def options # :nodoc:
         @_options
       end
 
-      def execute(options, instance_variables)
-        options.reporter.example_started(self)
+      def execute(run_options, instance_variables) # :nodoc:
+        # FIXME - there is no reason to have example_started pass a name
+        # - in fact, it would introduce bugs in cases where no docstring
+        # is passed to it()
+        run_options.reporter.example_started("")
         set_instance_variables_from_hash(instance_variables)
         
         execution_error = nil
-        Timeout.timeout(options.timeout) do
+        Timeout.timeout(run_options.timeout) do
           begin
             before_each_example
-            eval_block
+            instance_eval(&@_implementation)
           rescue Exception => e
             execution_error ||= e
           end
@@ -60,28 +47,19 @@ module Spec
           end
         end
 
-        options.reporter.example_finished(self, execution_error)
+        run_options.reporter.example_finished(ExampleDescription.new(description, options), execution_error)
         success = execution_error.nil? || ExamplePendingError === execution_error
       end
 
-      def instance_variable_hash # :nodoc:
-        instance_variables.inject({}) do |variable_hash, variable_name|
-          variable_hash[variable_name] = instance_variable_get(variable_name)
-          variable_hash
-        end
+      def eval_each_fail_fast(blocks) # :nodoc:
+        blocks.each {|block| instance_eval(&block)}
       end
 
-      def eval_each_fail_fast(examples) # :nodoc:
-        examples.each do |example|
-          instance_eval(&example)
-        end
-      end
-
-      def eval_each_fail_slow(examples) # :nodoc:
+      def eval_each_fail_slow(blocks) # :nodoc:
         first_exception = nil
-        examples.each do |example|
+        blocks.each do |block|
           begin
-            instance_eval(&example)
+            instance_eval(&block)
           rescue Exception => e
             first_exception ||= e
           end
@@ -89,31 +67,22 @@ module Spec
         raise first_exception if first_exception
       end
 
-      # Concats the class description with the example description.
-      #
-      #   describe Account do
-      #     it "should start with a balance of 0" do
-      #     ...
-      #
-      #   full_description
-      #   => "Account should start with a balance of 0"
-      def full_description
-        "#{self.class.description} #{self.description}"
+      def instance_variable_hash # :nodoc:
+        instance_variables.inject({}) do |variable_hash, variable_name|
+          variable_hash[variable_name] = instance_variable_get(variable_name)
+          variable_hash
+        end
       end
-      
+
       def set_instance_variables_from_hash(ivars) # :nodoc:
         ivars.each do |variable_name, value|
           # Ruby 1.9 requires variable.to_s on the next line
-          unless ['@_implementation', '@_defined_description', '@_matcher_description', '@method_name'].include?(variable_name.to_s)
+          unless ['@_defined_description', '@_options', '@_implementation', '@method_name'].include?(variable_name.to_s)
             instance_variable_set variable_name, value
           end
         end
       end
 
-      def eval_block # :nodoc:
-        instance_eval(&@_implementation)
-      end
-
       # Provides the backtrace up to where this example was declared.
       def backtrace
         @_backtrace
@@ -127,42 +96,54 @@ from a future version. Please use ExampleMethods#backtrace instead.
 WARNING
         backtrace
       end
+      
+      # Run all the before(:each) blocks for this example
+      def run_before_each
+        example_group_hierarchy.run_before_each(self)
+      end
+
+      # Run all the after(:each) blocks for this example
+      def run_after_each
+        example_group_hierarchy.run_after_each(self)
+      end
 
-      private
+      def initialize(description, options={}, &implementation)
+        @_options = options
+        @_defined_description = description
+        @_implementation = implementation || pending_implementation
+        @_backtrace = caller
+      end
+
+    private
+    
       include Matchers
       include Pending
       
-      def before_each_example
+      def before_each_example # :nodoc:
         setup_mocks_for_rspec
-        self.class.run_before_each(self)
+        run_before_each
       end
 
-      def after_each_example
-        self.class.run_after_each(self)
+      def after_each_example # :nodoc:
+        run_after_each
         verify_mocks_for_rspec
       ensure
         teardown_mocks_for_rspec
       end
 
-      def subject_variable_name
-        '@' << (described_class ? underscore(described_class.name) : '__this_does_not_exist')
+      def described_class # :nodoc:
+        self.class.described_class
       end
-      
-      def described_class
-        Class === described_type ? described_type : nil
+
+      def example_group_hierarchy
+        self.class.example_group_hierarchy
       end
       
-      def described_type
-        self.class.described_type
+      def pending_implementation
+        error = Spec::Example::NotYetImplementedError.new(caller)
+        lambda { raise(error) }
       end
 
-      def underscore(camel_cased_word)
-        camel_cased_word.to_s.gsub(/::/, '_').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          tr("-", "_").
-          downcase
-      end
     end
   end
 end