rspec 1.2.2 → 1.2.3

data/lib/spec.rb

@@ -1,3 +1,4 @@
+require 'spec/deprecation'
 require 'spec/ruby'
 require 'spec/matchers'
 require 'spec/expectations'

data/lib/spec/deprecation.rb

@@ -0,0 +1,40 @@
+module Spec
+  class << self
+    def deprecate(method, alternate_method=nil)
+       message = <<-NOTICE
+
+*****************************************************************
+DEPRECATION WARNING: you are using deprecated behaviour that will
+be removed from a future version of RSpec.
+
+#{caller(0)[2]}
+
+* #{method} is deprecated.
+NOTICE
+      if alternate_method
+        message << <<-ADDITIONAL
+* please use #{alternate_method} instead.
+ADDITIONAL
+      end
+      
+      message << "*****************************************************************"
+      warn(message)
+    end
+    
+    def warn(message)
+      Kernel.warn(message)
+    end
+    
+  end
+
+  class HashWithDeprecationNotice < Hash
+    def initialize(method, alternate_method=nil, &block)
+      @method, @alternate_method = method, alternate_method
+    end
+    def []=(k,v)
+      Spec.deprecate(@method, @alternate_method)
+      super
+    end
+  end
+end
+

data/lib/spec/dsl/main.rb

@@ -1,6 +1,8 @@
 module Spec
   module DSL
     module Main
+      include Spec::Example::ArgsAndOptions
+      
       # Creates and returns a class that includes the ExampleGroupMethods
       # module. Which ExampleGroup type is created depends on the directory of the file
       # calling this method. For example, Spec::Rails will use different
@@ -13,15 +15,16 @@ module Spec
       #
       #   describe "name", :type => :something_special do ...
       #
-      # The reason for using different behaviour classes is to have different
+      # The reason for using different example group classes is to have different
       # matcher methods available from within the <tt>describe</tt> block.
       #
       # See Spec::Example::ExampleGroupFactory#register for details about how to
       # register special implementations.
       #
       def describe(*args, &block)
-        Spec::Example::set_location(args, caller(0)[1])
-        Spec::Example::ExampleGroupFactory.assign_scope(self, args)
+        raise Spec::Example::NoDescriptionError.new("example group", caller(0)[1]) if args.empty?
+        add_options(args, :scope => self)
+        set_location(args.options, caller(0)[1])
         Spec::Example::ExampleGroupFactory.create_example_group(*args, &block)
       end
       alias :context :describe
@@ -42,7 +45,8 @@ module Spec
       #    end
       #  end
       def share_examples_for(*args, &block)
-        Spec::Example::set_location(args, caller(0)[1])
+        add_options(args)
+        set_location(args.options, caller(0)[1])
         Spec::Example::ExampleGroupFactory.create_shared_example_group(*args, &block)
       end
       alias :shared_examples_for :share_examples_for
@@ -74,7 +78,8 @@ module Spec
       def share_as(name, &block)
         begin
           args = [name]
-          Spec::Example::set_location(args, caller(0)[1])
+          add_options(args)
+          set_location(args.options, caller(0)[1])
           Object.const_set(name, Spec::Example::ExampleGroupFactory.create_shared_example_group(*args, &block))
         rescue NameError => e
           raise NameError.new(e.message + "\nThe first argument to share_as must be a legal name for a constant\n")

data/lib/spec/example.rb

@@ -142,37 +142,11 @@ module Spec
   #    end
   #  end
   module Example
-    class << self
-      def args_and_options(*args) # :nodoc:
-        with_options_from(args) do |options|
-          return args, options
-        end
-      end
-
-      def scope_from(*args) # :nodoc:
-        args[0] || :each
-      end
-
-      def scope_and_options(*args) # :nodoc:
-        args, options = args_and_options(*args)
-        return scope_from(*args), options
-      end
-
-      def set_location(args, location) # :nodoc:
-        args << {} unless Hash === args.last
-        args.last[:location] ||= location
-      end
-
-    private
-    
-      def with_options_from(args)
-        yield Hash === args.last ? args.pop : {} if block_given?
-      end
-    end
   end
 end
 
 require 'timeout'
+require 'spec/example/args_and_options'
 require 'spec/example/predicate_matchers'
 require 'spec/example/example_group_proxy'
 require 'spec/example/example_proxy'

data/lib/spec/example/args_and_options.rb

@@ -0,0 +1,27 @@
+module Spec
+  module Example
+    module ArgsAndOptions
+      def args_and_options(*args) # :nodoc:
+        options = Hash === args.last ? args.pop : {}
+        return args, options
+      end
+
+      def add_options(args, options={}) # :nodoc:
+        args << {} unless Hash === args.last
+        args.extend WithOptions
+        args.options.merge!(options)
+        args.options
+      end
+      
+      def set_location(options, location) # :nodoc:
+        options[:location] ||= location
+      end
+
+      module WithOptions # :nodoc:
+        def options
+          last
+        end
+      end
+    end
+  end
+end

data/lib/spec/example/before_and_after_hooks.rb

@@ -2,39 +2,48 @@ module Spec
   module Example
     module BeforeAndAfterHooks
       class << self
-        def before_suite_parts
+        def before_suite_parts # :nodoc:
           @before_suite_parts ||= []
         end
         
-        def after_suite_parts
+        def after_suite_parts # :nodoc:
           @after_suite_parts ||= []
         end
       end
       
-      # Registers a block to be executed before each example.
-      # This method prepends +block+ to existing before blocks.
-      def prepend_before(*args, &block)
-        before_parts(*args).unshift(block)
+      # Registers a block to be executed before examples. <tt>scope</tt> can be
+      # <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 only once before any examples are
+      # run.
+      def append_before(scope = :each, &block)
+        before_parts(scope) << block
       end
+      alias_method :before, :append_before
 
       # Registers a block to be executed before each example.
-      # This method appends +block+ to existing before blocks.
-      def append_before(*args, &block)
-        before_parts(*args) << block
+      # This method prepends +block+ to existing before blocks.
+      # 
+      # See <tt>append_before</tt> for scoping semantics.
+      def prepend_before(scope = :each, &block)
+        before_parts(scope).unshift(block)
       end
-      alias_method :before, :append_before
 
       # Registers a block to be executed after each example.
       # This method prepends +block+ to existing after blocks.
-      def prepend_after(*args, &block)
-        after_parts(*args).unshift(block)
+      # 
+      # See <tt>append_before</tt> for scoping semantics.
+      def prepend_after(scope = :each, &block)
+        after_parts(scope).unshift(block)
       end
       alias_method :after, :prepend_after
 
       # Registers a block to be executed after each example.
       # This method appends +block+ to existing after blocks.
-      def append_after(*args, &block)
-        after_parts(*args) << block
+      # 
+      # See <tt>append_before</tt> for scoping semantics.
+      def append_after(scope = :each, &block)
+        after_parts(scope) << block
       end
 
       def before_each_parts # :nodoc:
@@ -53,26 +62,26 @@ module Spec
         @after_all_parts ||= []
       end
 
-      def before_suite_parts
+      def before_suite_parts # :nodoc:
         BeforeAndAfterHooks.before_suite_parts
       end
       
-      def after_suite_parts
+      def after_suite_parts # :nodoc:
         BeforeAndAfterHooks.after_suite_parts
       end
       
-    private  
+    private
       
-      def before_parts(*args)
-        case Spec::Example.scope_from(*args)
+      def before_parts(scope)
+        case scope
         when :each; before_each_parts
         when :all; before_all_parts
         when :suite; before_suite_parts
         end
       end
 
-      def after_parts(*args)
-        case Spec::Example.scope_from(*args)
+      def after_parts(scope)
+        case scope
         when :each; after_each_parts
         when :all; after_all_parts
         when :suite; after_suite_parts

data/lib/spec/example/errors.rb

@@ -1,30 +1,20 @@
 module Spec
   module Example
-    class ExamplePendingError < StandardError
-      attr_reader :pending_caller
-
-      def initialize(message=nil, pending_caller=nil)
-        super(message)
-        @pending_caller = pending_caller || caller[2]
-      end
-    end
+    class ExamplePendingError < StandardError; end
     
     class NotYetImplementedError < ExamplePendingError
       MESSAGE = "Not Yet Implemented"
-      RSPEC_ROOT_LIB = File.expand_path(File.dirname(__FILE__) + "/../..")
-      
-      def initialize(backtrace)
+      def initialize
         super(MESSAGE)
-        @pending_caller = pending_caller_from(backtrace)
-      end
-      
-    private
-      
-      def pending_caller_from(backtrace)
-        backtrace.detect {|line| !line.include?(RSPEC_ROOT_LIB) }
       end
     end
 
     class PendingExampleFixedError < StandardError; end
+    
+    class NoDescriptionError < ArgumentError
+      def initialize(kind, location)
+        super("No description supplied for #{kind} declared on #{location}")
+      end
+    end
   end
 end

data/lib/spec/example/example_group_factory.rb

@@ -60,10 +60,6 @@ module Spec
           @example_group_types[key]
         end
 
-        def assign_scope(scope, args)
-          args.last[:scope] = scope
-        end
-
       protected
 
         def determine_superclass(opts)

data/lib/spec/example/example_group_methods.rb

@@ -1,14 +1,23 @@
 module Spec
   module Example
 
-    module ExampleGroupMethods
+    module ExampleGroupMethods      
       class << self
         attr_accessor :matcher_class
+
+        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
 
       include Spec::Example::BeforeAndAfterHooks
       include Spec::Example::Subject::ExampleGroupMethods
       include Spec::Example::PredicateMatchers
+      include Spec::Example::ArgsAndOptions
 
       attr_reader :options, :location
       
@@ -17,20 +26,6 @@ module Spec
         ExampleGroupFactory.register_example_group(klass)
       end
       
-      # Provides the backtrace up to where this example_group was declared.
-      def backtrace
-        defined?(@backtrace) ? @backtrace : nil
-      end
-
-      # Deprecated - use +backtrace()+
-      def example_group_backtrace
-        Kernel.warn <<-WARNING
-ExampleGroupMethods#example_group_backtrace is deprecated and will be removed
-from a future version. Please use ExampleGroupMethods#backtrace instead.
-WARNING
-        backtrace
-      end
-      
       # Makes the describe/it syntax available from a class. For example:
       #
       #   class StackSpec < Spec::ExampleGroup
@@ -46,9 +41,10 @@ WARNING
       #   end
       #
       def describe(*args, &example_group_block)
+        raise Spec::Example::NoDescriptionError.new("example group", caller(0)[1]) if args.empty?
         if example_group_block
-          Spec::Example::set_location(args, caller(0)[1])
-          options = args.last
+          options = add_options(args)
+          set_location(options, caller(0)[1])
           if options[:shared]
             ExampleGroupFactory.create_shared_example_group(*args, &example_group_block)
           else
@@ -77,8 +73,7 @@ WARNING
       end
       
       def pending_implementation
-        error = Spec::Example::NotYetImplementedError.new(caller)
-        lambda { raise(error) }
+        lambda { raise(Spec::Example::NotYetImplementedError) }
       end
 
       alias_method :it, :example
@@ -101,23 +96,23 @@ WARNING
         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, after_all_instance_variables  = run_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)
+        @description_args, @options = args_and_options(*args)
         @backtrace = caller(1)
         @location = File.expand_path(options[:location]) if options[:location]
         self
       end
       
-      def notify(listener) # :nodoc:
-        listener.add_example_group(ExampleGroupProxy.new(self))
+      def notify(reporter) # :nodoc:
+        reporter.example_group_started(ExampleGroupProxy.new(self))
       end
 
       def description
-        @description ||= build_description_from(*description_parts) || to_s
+        @description ||= ExampleGroupMethods.build_description_from(*description_parts) || to_s
       end
       
       def described_type
@@ -198,7 +193,7 @@ WARNING
         end
       end
 
-      def execute_examples(success, instance_variables, examples, run_options)
+      def run_examples(success, instance_variables, examples, run_options)
         return [success, instance_variables] unless success
 
         after_all_instance_variables = instance_variables
@@ -218,22 +213,22 @@ WARNING
         after_all = new(example_proxy)
         after_all.set_instance_variables_from_hash(instance_variables)
         example_group_hierarchy.run_after_all(after_all)
-        return success
+        success
       rescue Exception => e
         run_options.reporter.example_failed(example_proxy, e)
-        return false
+        false
       end
       
       def examples_to_run(run_options)
-        return example_proxies unless specified_examples?(run_options)
-        example_proxies.reject do |example|
+        return example_proxies unless examples_were_specified?(run_options)
+        example_proxies.reject do |proxy|
           matcher = ExampleGroupMethods.matcher_class.
-            new(description.to_s, example.description)
+            new(description.to_s, proxy.description)
           !matcher.matches?(run_options.examples)
         end
       end
 
-      def specified_examples?(run_options)
+      def examples_were_specified?(run_options)
         !run_options.examples.empty?
       end
 
@@ -256,21 +251,12 @@ WARNING
         when SharedExampleGroup
           include shared_example_group
         else
-          example_group = SharedExampleGroup.find(shared_example_group)
-          unless example_group
+          unless example_group = SharedExampleGroup.find(shared_example_group)
             raise RuntimeError.new("Shared Example Group '#{shared_example_group}' can not be found")
           end
           include(example_group)
         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