rspec 0.9.4 → 1.0.0

data/lib/spec/dsl/behaviour_factory.rb

@@ -6,27 +6,37 @@ module Spec
 
         BEHAVIOUR_CLASSES = {:default => Spec::DSL::Behaviour}
         
-        def add_behaviour_class(key, value)
-          BEHAVIOUR_CLASSES[key] = value
+        # Registers a behaviour class +klass+ with the symbol
+        # +behaviour_type+. For example:
+        #
+        #   Spec::DSL::BehaviourFactory.add_behaviour_class(:farm, Spec::Farm::DSL::FarmBehaviour)
+        #
+        # This will cause Kernel#describe from a file living in 
+        # <tt>spec/farm</tt> to create behaviour instances of type
+        # Spec::Farm::DSL::FarmBehaviour.
+        def add_behaviour_class(behaviour_type, klass)
+          BEHAVIOUR_CLASSES[behaviour_type] = klass
         end
 
-        def remove_behaviour_class(key)
-          BEHAVIOUR_CLASSES.delete(key)
+        def remove_behaviour_class(behaviour_type)
+          BEHAVIOUR_CLASSES.delete(behaviour_type)
         end
 
         def create(*args, &block)
-          return BEHAVIOUR_CLASSES[behaviour_type(*args)].new(*args, &block)
-        end
-        
-      private
-      
-        def behaviour_type(*args)
           opts = Hash === args.last ? args.last : {}
-          opts[:behaviour_type] ? opts[:behaviour_type] : :default
+          if opts[:shared]
+            behaviour_type = :default
+          elsif opts[:behaviour_type]
+            behaviour_type = opts[:behaviour_type]
+          elsif opts[:spec_path] =~ /spec\/(#{BEHAVIOUR_CLASSES.keys.join('|')})/
+            behaviour_type = $1.to_sym
+          else
+            behaviour_type = :default
+          end
+          return BEHAVIOUR_CLASSES[behaviour_type].new(*args, &block)
         end
-        
+
       end
-      
     end
   end
 end

data/lib/spec/dsl/configuration.rb

@@ -2,6 +2,27 @@ module Spec
   module DSL
     class Configuration
       
+      # Chooses what mock framework to use. Example:
+      #
+      #   Spec::Runner.configure do |config|
+      #     config.mock_with :rspec # or :mocha, or :flexmock
+      #   end
+      #
+      # To use any other mock framework, you'll have to provide
+      # your own adapter. This is simply a module that responds to
+      # setup_mocks_for_rspec, verify_mocks_for_rspec and teardown_mocks_for_rspec.
+      # These are your hooks into the lifecycle of a given example. RSpec will
+      # call setup_mocks_for_rspec before running anything else in each Example.
+      # After executing the #after methods, RSpec will then call verify_mocks_for_rspec
+      # and teardown_mocks_for_rspec (this is guaranteed to run even if there are
+      # failures in verify_mocks_for_rspec).
+      #
+      # Once you've defined this module, you can pass that to mock_with:
+      #
+      #   Spec::Runner.configure do |config|
+      #     config.mock_with MyMockFrameworkAdapter
+      #   end
+      #
       def mock_with(mock_framework)
         @mock_framework = case mock_framework
         when Symbol
@@ -11,23 +32,82 @@ module Spec
         end
       end
       
-      def mock_framework
+      def mock_framework # :nodoc:
         @mock_framework ||= mock_framework_path("rspec")
       end
       
-      def include(*mods)
-        # mods.each {|mod|included_modules << mod}
-        included_modules.push(*mods)
+      # Declares modules to be included in all behaviours (<tt>describe</tt> blocks).
+      #
+      #   config.include(My::Bottle, My::Cup)
+      #
+      # If you want to restrict the inclusion to a subset of all the behaviours then
+      # specify this in a Hash as the last argument:
+      #
+      #   config.include(My::Pony, My::Horse, :behaviour_type => :farm)
+      #
+      # Only behaviours that have that type will get the modules included:
+      #
+      #   describe "Downtown", :behaviour_type => :city do
+      #     # Will *not* get My::Pony and My::Horse included
+      #   end
+      #
+      #   describe "Old Mac Donald", :behaviour_type => :farm do
+      #     # *Will* get My::Pony and My::Horse included
+      #   end
+      #
+      def include(*args)
+        included_modules.push(*args)
       end
       
-      def included_modules
+      def included_modules # :nodoc:
         @included_modules ||= []
       end
       
+      # Defines global predicate matchers. Example:
+      #
+      #   config.predicate_matchers[:swim] = :can_swim?
+      #
+      # This makes it possible to say:
+      #
+      #   person.should swim # passes if person.should_swim? returns true
+      #
       def predicate_matchers
         @predicate_matchers ||= {}
       end
       
+      # Prepends a global <tt>before</tt> block to all behaviours.
+      # See #append_before for filtering semantics.
+      def prepend_before(*args, &proc)
+        Behaviour.prepend_before(*args, &proc)
+      end
+      # Appends a global <tt>before</tt> block to all behaviours.
+      #
+      # If you want to restrict the block to a subset of all the behaviours then
+      # specify this in a Hash as the last argument:
+      #
+      #   config.prepend_before(:all, :behaviour_type => :farm)
+      #
+      # or
+      #
+      #   config.prepend_before(:behaviour_type => :farm)
+      #
+      def append_before(*args, &proc)
+        Behaviour.append_before(*args, &proc)
+      end
+      alias_method :before, :append_before
+
+      # Prepends a global <tt>after</tt> block to all behaviours.
+      # See #append_before for filtering semantics.
+      def prepend_after(*args, &proc)
+        Behaviour.prepend_after(*args, &proc)
+      end
+      alias_method :after, :prepend_after
+      # Appends a global <tt>after</tt> block to all behaviours.
+      # See #append_before for filtering semantics.
+      def append_after(*args, &proc)
+        Behaviour.append_after(*args, &proc)
+      end
+
     private
     
       def mock_framework_path(framework_name)

data/lib/spec/dsl/description.rb

@@ -1,17 +1,25 @@
 module Spec
   module DSL
     class Description
+      module ClassMethods
+        def generate_description(*args)
+          description = args.shift.to_s
+          unless args.empty?
+            suffix = args.shift.to_s
+            description << " " unless suffix =~ /^\s|\.|#/
+            description << suffix
+          end
+          description
+        end
+      end
+      extend ClassMethods
+
       attr_reader :description, :described_type
       
       def initialize(*args)
         args, @options = args_and_options(*args)
         @described_type = args.first unless args.first.is_a?(String)
-        @description = args.shift.to_s
-        unless args.empty?
-          suffix = args.shift.to_s 
-            @description << " " unless suffix =~ /^\s|\.|#/
-          @description << suffix
-        end
+        @description = self.class.generate_description(*args)
       end
   
       def [](key)

data/lib/spec/dsl/example.rb

@@ -26,7 +26,7 @@ module Spec
         end
 
         ExampleShouldRaiseHandler.new(@from, @options).handle(errors)
-        reporter.example_finished(description, errors.first, location) if reporter
+        reporter.example_finished(description, errors.first, location, @example_block.nil?) if reporter
       end
       
       def matches?(matcher, specified_examples)
@@ -70,7 +70,7 @@ module Spec
 
       def run_example(execution_context, errors)
         begin
-          execution_context.instance_eval(&@example_block)
+          execution_context.instance_eval(&@example_block) if @example_block
           return true
         rescue Exception => e
           @failed = true

data/lib/spec/matchers.rb

@@ -86,15 +86,15 @@ module Spec
   #     def initialize(expected)
   #       @expected = expected
   #     end
-  #     def matches?(actual)
-  #       @actual = actual
-  #       bob.current_zone.eql?(Zone.new(@expected))
+  #     def matches?(target)
+  #       @target = target
+  #       @target.current_zone.eql?(Zone.new(@expected))
   #     end
   #     def failure_message
-  #       "expected #{@actual.inspect} to be in Zone #{@expected}"
+  #       "expected #{@target.inspect} to be in Zone #{@expected}"
   #     end
   #     def negative_failure_message
-  #       "expected #{@actual.inspect} not to be in Zone #{@expected}"
+  #       "expected #{@target.inspect} not to be in Zone #{@expected}"
   #     end
   #   end
   #

data/lib/spec/matchers/be.rb

@@ -57,8 +57,24 @@ module Spec
         return @actual <= @expected if @less_than_or_equal
         return @actual >= @expected if @greater_than_or_equal
         return @actual > @expected if @greater_than
+        return @actual == @expected if @double_equal
+        return @actual === @expected if @triple_equal
         return @actual.equal?(@expected)
       end
+      
+      def ==(expected)
+        @double_equal = true
+        @comparison = "== "
+        @expected = expected
+        self
+      end
+
+      def ===(expected)
+        @triple_equal = true
+        @comparison = "=== "
+        @expected = expected
+        self
+      end
 
       def <(expected)
         @less_than = true

data/lib/spec/matchers/operator_matcher.rb

@@ -21,6 +21,26 @@ module Spec
         __delegate_method_missing_to_target("=~", expected)
       end
 
+      def >(expected)
+        @expected = expected
+        __delegate_method_missing_to_target(">", expected)
+      end
+
+      def >=(expected)
+        @expected = expected
+        __delegate_method_missing_to_target(">=", expected)
+      end
+
+      def <(expected)
+        @expected = expected
+        __delegate_method_missing_to_target("<", expected)
+      end
+
+      def <=(expected)
+        @expected = expected
+        __delegate_method_missing_to_target("<=", expected)
+      end
+
       def fail_with_message(message)
         Spec::Expectations.fail_with(message, @expected, @target)
       end
@@ -33,7 +53,7 @@ module Spec
         ::Spec::Matchers.generated_description = "should #{operator} #{expected.inspect}"
         return if @target.send(operator, expected)
         return fail_with_message("expected #{expected.inspect}, got #{@target.inspect} (using #{operator})") if ['==','==='].include?(operator)
-        return fail_with_message("expected =~ #{expected.inspect}, got #{@target.inspect}")
+        return fail_with_message("expected #{operator} #{expected.inspect}, got #{@target.inspect}")
       end
 
     end

data/lib/spec/matchers/raise_error.rb

@@ -24,7 +24,7 @@ module Spec
                 @raised_other = true
               end
             else
-              if @actual_error.message == @expected_message
+              if @expected_message == @actual_error.message
                 @raised_expected_error = true
               else
                 @raised_other = true

data/lib/spec/rake/verify_rcov.rb

@@ -19,10 +19,14 @@ module RCov
     # 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
@@ -41,7 +45,7 @@ module RCov
         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
+        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

data/lib/spec/runner.rb

@@ -147,38 +147,18 @@ module Spec
       end
       
       # Use this to configure various configurable aspects of
-      # RSpec. For example, to choose a mock framework from
-      # RSpec, mocha and flexmock, you can do this:
+      # RSpec:
       #
-      #   Spec::Runner.configure do |config|
-      #     config.mock_with :rspec #or :mocha, or :flexmock
+      #   Spec::Runner.configure do |configuration|
+      #     # Configure RSpec here
       #   end
       #
-      # To use any other mock framework, you'll have to provide
-      # your own adapter. This is simply a module that responds to
-      # setup_mocks_for_rspec, verify_mocks_for_rspec and teardown_mocks_for_rspec.
-      # These are your hooks into the lifecycle of a given example. RSpec will
-      # call setup_mocks_for_rspec before running anything else in each Example.
-      # After executing the #after methods, RSpec will then call verify_mocks_for_rspec
-      # and teardown_mocks_for_rspec (this is guaranteed to run even if there are
-      # failures in verify_mocks_for_rspec).
+      # The yielded <tt>configuration</tt> object is a
+      # Spec::DSL::Configuration instance. See its RDoc
+      # for details about what you can do with it.
       #
-      # Once you've defined this module, you can pass that to mock_with:
-      #
-      #   Spec::Runner.configure do |config|
-      #     config.mock_with MyMockFrameworkAdapter
-      #   end
-      #
-      # You can also configure the following items:
-      #
-      #   # include SomeModule in every Behaviour
-      #   config.include SomeModule
-      #
-      #   # generate a do_something predicate_matcher for every Behaviour
-      #   # - See Spec::DSL::Behaviour#predicate_matchers
-      #   config.predicate_matchers[:does_something?] = :do_something
       def configure
-        yield configuration
+        yield configuration if @configuration.nil?
       end
     end
   end

data/lib/spec/runner/behaviour_runner.rb

@@ -82,7 +82,7 @@ module Spec
       
       def load_specs(paths)
         paths.each do |path|
-          load path
+          require path
         end
       end
       

data/lib/spec/runner/extensions/kernel.rb

@@ -1,6 +1,26 @@
 module Kernel
+  # Creates and registers an instance of a Spec::DSL::Behaviour (or a subclass).
+  # The instantiated behaviour class depends on the directory of the file
+  # calling this method. For example, Spec::Rails will use different
+  # classes for specs living in <tt>spec/models</tt>, <tt>spec/helpers</tt>, 
+  # <tt>spec/views</tt> and <tt>spec/controllers</tt>.
+  #
+  # It is also possible to override autodiscovery of the behaviour class 
+  # with an options Hash as the last argument:
+  #
+  #   describe "name", :behaviour_type => :something_special do ...
+  #
+  # The reason for using different behaviour classes is to have
+  # different matcher methods available from within the <tt>describe</tt>
+  # block.
+  #
+  # See Spec::DSL::BehaviourFactory#add_behaviour_class for details about 
+  # how to register special Spec::DSL::Behaviour implementations.
+  #
   def describe(*args, &block)
     raise ArgumentError if args.empty?
+    args << {} unless Hash === args.last
+    args.last[:spec_path] = caller(0)[1]
     register_behaviour(Spec::DSL::BehaviourFactory.create(*args, &block))
   end
   alias :context :describe

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

@@ -40,6 +40,11 @@ module Spec
         # (starting at 1) and +failure+ is the associated Failure object.
         def example_failed(name, counter, failure)
         end
+        
+        # This method is invoked when an example is not yet implemented (i.e. has not been provided a block). 
+        # +name+ is the name of the example.
+        def example_not_implemented(name)
+        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),
@@ -54,7 +59,7 @@ module Spec
         end
       
         # This method is invoked at the very end.
-        def dump_summary(duration, example_count, failure_count)
+        def dump_summary(duration, example_count, failure_count, not_implemented_count)
         end
 
       end

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

@@ -46,14 +46,21 @@ module Spec
           @output.flush
         end
       
-        def dump_summary(duration, example_count, failure_count)
+        def dump_summary(duration, example_count, failure_count, not_implemented_count)
           return if @dry_run
           @output.puts
           @output.puts "Finished in #{duration} seconds"
           @output.puts
+
           summary = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
+          summary << ", #{not_implemented_count} not implemented" if not_implemented_count > 0  
+
           if failure_count == 0
-            @output.puts green(summary)
+            if not_implemented_count > 0
+              @output.puts yellow(summary)
+            else
+              @output.puts green(summary)
+            end
           else
             @output.puts red(summary)
           end
@@ -87,6 +94,7 @@ module Spec
         def red(text); colour(text, "\e[31m"); end
         def green(text); colour(text, "\e[32m"); end
         def magenta(text); colour(text, "\e[35m"); end
+        def yellow(text); colour(text, "\e[33m"); end
         
       end
     end