rspec 1.1.3 → 1.1.4

data/lib/spec/mocks.rb

@@ -1,3 +1,4 @@
+require 'spec/mocks/framework'
 require 'spec/mocks/methods'
 require 'spec/mocks/argument_constraint_matchers'
 require 'spec/mocks/spec_methods'
@@ -11,7 +12,6 @@ require 'spec/mocks/error_generator'
 require 'spec/mocks/extensions/object'
 require 'spec/mocks/space'
 
-
 module Spec
   # == Mocks and Stubs
   #

data/lib/spec/mocks/argument_constraint_matchers.rb

@@ -1,7 +1,7 @@
 module Spec
   module Mocks
     module ArgumentConstraintMatchers
-
+      
       # Shortcut for creating an instance of Spec::Mocks::DuckTypeArgConstraint
       def duck_type(*args)
         DuckTypeArgConstraint.new(*args)
@@ -19,6 +19,10 @@ module Spec
         BooleanArgConstraint.new(nil)
       end
       
+      def hash_including(expected={})
+        HashIncludingConstraint.new(expected)
+      end
+      
       def no_args
         NoArgsConstraint.new
       end

data/lib/spec/mocks/argument_expectation.rb

@@ -108,6 +108,32 @@ module Spec
         "duck_type"
       end
     end
+    
+    class HashIncludingConstraint
+      def initialize(expected)
+        @expected = expected
+      end
+      
+      def ==(actual)
+        @expected.each do | key, value |
+          # check key for case that value evaluates to nil
+          return false unless actual.has_key?(key) && actual[key] == value
+        end
+        true
+      rescue NoMethodError => ex
+        return false
+      end
+      
+      def matches?(value)
+        self == value
+      end
+      
+      def description
+        "hash_including(#{@expected.inspect.sub(/^\{/,"").sub(/\}$/,"")})"
+      end
+      
+    end
+    
 
     class ArgumentExpectation
       attr_reader :args

data/lib/spec/mocks/extensions.rb

@@ -0,0 +1 @@
+require 'spec/mocks/extensions/object'

data/lib/spec/mocks/framework.rb

@@ -0,0 +1,15 @@
+# Require everything except the global extensions of class and object. This
+# supports wrapping rspec's mocking functionality without invading every
+# object in the system.
+
+require 'spec/mocks/methods'
+require 'spec/mocks/argument_constraint_matchers'
+require 'spec/mocks/spec_methods'
+require 'spec/mocks/proxy'
+require 'spec/mocks/mock'
+require 'spec/mocks/argument_expectation'
+require 'spec/mocks/message_expectation'
+require 'spec/mocks/order_group'
+require 'spec/mocks/errors'
+require 'spec/mocks/error_generator'
+require 'spec/mocks/space'

data/lib/spec/mocks/message_expectation.rb

@@ -72,12 +72,18 @@ module Spec
       end
       
       def invoke(args, block)
+        if @expected_received_count == 0
+          @actual_received_count += 1
+          @error_generator.raise_expectation_error @sym, @expected_received_count, @actual_received_count, *args
+        end
+        
         @order_group.handle_order_constraint self
 
         begin
           Kernel::raise @exception_to_raise unless @exception_to_raise.nil?
           Kernel::throw @symbol_to_throw unless @symbol_to_throw.nil?
           
+          
           if !@method_block.nil?
             default_return_val = invoke_method_block(args)
           elsif @args_to_yield.size > 0
@@ -112,12 +118,14 @@ module Spec
         if block.nil?
           @error_generator.raise_missing_block_error @args_to_yield
         end
+        value = nil
         @args_to_yield.each do |args_to_yield_this_time|
           if block.arity > -1 && args_to_yield_this_time.length != block.arity
             @error_generator.raise_wrong_arity_error args_to_yield_this_time, block.arity
           end
-          block.call(*args_to_yield_this_time)
+          value = block.call(*args_to_yield_this_time)
         end
+        value
       end
       
       def invoke_consecutive_return_block(args, block)
@@ -147,9 +155,8 @@ module Spec
         @sym == sym and not @args_expectation.check_args(args)
       end
        
-      def verify_messages_received        
-        return if ignoring_args? || matches_exact_count? ||
-           matches_at_least_count? || matches_at_most_count?
+      def verify_messages_received   
+        return if expected_messages_received?
     
         generate_error
       rescue Spec::Mocks::MockExpectationError => error
@@ -157,6 +164,11 @@ module Spec
         Kernel::raise error
       end
       
+      def expected_messages_received?
+        ignoring_args? || matches_exact_count? ||
+           matches_at_least_count? || matches_at_most_count?
+      end
+      
       def ignoring_args?
         @expected_received_count == :any
       end
@@ -173,8 +185,20 @@ module Spec
         @expected_received_count == @actual_received_count
       end
       
+      def similar_messages
+        @similar_messages ||= []
+      end
+
+      def advise(args, block)
+        similar_messages << args
+      end
+      
       def generate_error
-        @error_generator.raise_expectation_error(@sym, @expected_received_count, @actual_received_count, *@args_expectation.args)
+        if similar_messages.empty?
+          @error_generator.raise_expectation_error(@sym, @expected_received_count, @actual_received_count, *@args_expectation.args)
+        else
+          @error_generator.raise_unexpected_message_args_error(self, *@similar_messages.first)
+        end
       end
 
       def with(*args, &block)

data/lib/spec/mocks/mock.rb

@@ -3,19 +3,21 @@ module Spec
     class Mock
       include Methods
 
-      # Creates a new mock with a +name+ (that will be used in error messages only)
-      # == Options:
-      # * <tt>:null_object</tt> - if true, the mock object acts as a forgiving null object allowing any message to be sent to it.
+      # Creates a new mock with a +name+ (that will be used in error messages
+      # only) == Options:
+      # * <tt>:null_object</tt> - if true, the mock object acts as a forgiving
+      #   null object allowing any message to be sent to it.
       def initialize(name, stubs_and_options={})
         @name = name
         @options = parse_options(stubs_and_options)
         assign_stubs(stubs_and_options)
       end
       
-      # This allows for comparing the mock to other objects that proxy
-      #  such as ActiveRecords belongs_to proxy objects
-      #  By making the other object run the comparison, we're sure the call gets delegated to the proxy target
-      # This is an unfortunate side effect from ActiveRecord, but this should be safe unless the RHS redefines == in a nonsensical manner
+      # This allows for comparing the mock to other objects that proxy such as
+      # ActiveRecords belongs_to proxy objects By making the other object run
+      # the comparison, we're sure the call gets delegated to the proxy target
+      # This is an unfortunate side effect from ActiveRecord, but this should
+      # be safe unless the RHS redefines == in a nonsensical manner
       def ==(other)
         other == __mock_proxy
       end

data/lib/spec/mocks/proxy.rb

@@ -63,10 +63,14 @@ module Spec
       def message_received(sym, *args, &block)
         if expectation = find_matching_expectation(sym, *args)
           expectation.invoke(args, block)
-        elsif stub = find_matching_method_stub(sym, *args)
+        elsif (stub = find_matching_method_stub(sym, *args))
+          if expectation = find_almost_matching_expectation(sym, *args)
+            expectation.advise(args, block) unless expectation.expected_messages_received?
+          end
           stub.invoke([], block)
         elsif expectation = find_almost_matching_expectation(sym, *args)
-          raise_unexpected_message_args_error(expectation, *args) unless has_negative_expectation?(sym) unless null_object?
+          expectation.advise(args, block) if null_object? unless expectation.expected_messages_received?
+          raise_unexpected_message_args_error(expectation, *args) unless (has_negative_expectation?(sym) or null_object?)
         else
           @target.send :method_missing, sym, *args, &block
         end
@@ -88,18 +92,20 @@ module Spec
       end
       
       def define_expected_method(sym)
-        if target_responds_to?(sym) && !metaclass.method_defined?(munge(sym))
+        visibility_string = "#{visibility(sym)} :#{sym}"
+        if target_responds_to?(sym) && !target_metaclass.method_defined?(munge(sym))
           munged_sym = munge(sym)
-          metaclass.instance_eval do
+          target_metaclass.instance_eval do
             alias_method munged_sym, sym if method_defined?(sym.to_s)
           end
           @proxied_methods << sym
         end
         
-        metaclass_eval(<<-EOF, __FILE__, __LINE__)
+        target_metaclass.class_eval(<<-EOF, __FILE__, __LINE__)
           def #{sym}(*args, &block)
             __mock_proxy.message_received :#{sym}, *args, &block
           end
+          #{visibility_string}
         EOF
       end
 
@@ -109,6 +115,18 @@ module Spec
         return @target.respond_to?(sym)
       end
 
+      def visibility(sym)
+        if Mock === @target
+          'public'
+        elsif target_metaclass.private_method_defined?(sym)
+          'private'
+        elsif target_metaclass.protected_method_defined?(sym)
+          'protected'
+        else
+          'public'
+        end
+      end
+
       def munge(sym)
         "proxied_by_rspec__#{sym.to_s}".to_sym
       end
@@ -125,12 +143,8 @@ module Spec
         @proxied_methods.clear
       end
 
-      def metaclass_eval(str, filename, lineno)
-        metaclass.class_eval(str, filename, lineno)
-      end
-      
-      def metaclass
-        (class << @target; self; end)
+      def target_metaclass
+        class << @target; self; end
       end
 
       def verify_expectations
@@ -142,7 +156,7 @@ module Spec
       def reset_proxied_methods
         @proxied_methods.each do |sym|
           munged_sym = munge(sym)
-          metaclass.instance_eval do
+          target_metaclass.instance_eval do
             if method_defined?(munged_sym.to_s)
               alias_method sym, munged_sym
               undef_method munged_sym

data/lib/spec/rake/spectask.rb

@@ -11,7 +11,7 @@ module Spec
     # A Rake task that runs a set of specs.
     #
     # Example:
-    #  
+    #
     #   Spec::Rake::SpecTask.new do |t|
     #     t.warning = true
     #     t.rcov = true
@@ -87,7 +87,7 @@ module Spec
       # Whether or not to use RCov (default is false)
       # See http://eigenclass.org/hiki.rb?rcov
       attr_accessor :rcov
-      
+
       # Array of commandline options to pass to RCov. Defaults to ['--exclude', 'lib\/spec,bin\/spec'].
       # Ignored if rcov=false
       # Setting the RCOV_OPTS environment variable overrides this.
@@ -117,7 +117,7 @@ module Spec
       # used, then the list of spec files is the union of the two.
       # Setting the SPEC environment variable overrides this.
       attr_accessor :spec_files
-      
+
       # Use verbose output. If this is set to true, the task will print
       # the executed spec command to stdout. Defaults to false.
       attr_accessor :verbose
@@ -155,7 +155,7 @@ module Spec
               # ruby [ruby_opts] -Ilib -S rcov [rcov_opts] bin/spec -- examples [spec_opts]
               # or
               # ruby [ruby_opts] -Ilib bin/spec examples [spec_opts]
-              cmd = "ruby "
+              cmd = "#{File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])} "
 
               rb_opts = ruby_opts.clone
               rb_opts << "-I\"#{lib_path}\""
@@ -210,7 +210,7 @@ module Spec
         STDERR.puts "RSPECOPTS is DEPRECATED and will be removed in a future version. Use SPEC_OPTS instead." if ENV['RSPECOPTS']
         ENV['SPEC_OPTS'] || ENV['RSPECOPTS'] || spec_opts.join(" ") || ""
       end
-      
+
       def evaluate(o) # :nodoc:
         case o
           when Proc then o.call

data/lib/spec/runner/backtrace_tweaker.rb

@@ -27,7 +27,7 @@ module Spec
           /\/lib\/ruby\//,
           /bin\/spec:/,
           /bin\/rcov:/,
-          /lib\/rspec_on_rails/,
+          /lib\/rspec-rails/,
           /vendor\/rails/,
           # TextMate's Ruby and RSpec plugins
           /Ruby\.tmbundle\/Support\/tmruby.rb:/,

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

@@ -19,8 +19,7 @@ module Spec
         end
 
         # This method is invoked at the beginning of the execution of each example_group.
-        # +name+ is the name of the example_group and +first+ is true if it is the
-        # first example_group - otherwise it's false.
+        # +example_group+ is the example_group.
         #
         # The next method to be invoked after this is #example_failed or #example_finished
         def add_example_group(example_group)
@@ -46,7 +45,7 @@ module Spec
         # been provided a block), or when an ExamplePendingError is raised.
         # +message+ is the message from the ExamplePendingError, if it exists, or the
         # default value of "Not Yet Implemented"
-        def example_pending(example_group_description, example, message)
+        def example_pending(example, message)
         end
 
         # This method is invoked after all of the examples have executed. The next method

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

@@ -26,8 +26,8 @@ module Spec
           @pending_examples = []
         end
         
-        def example_pending(example_group_description, example, message)
-          @pending_examples << ["#{example_group_description} #{example.description}", message]
+        def example_pending(example, message)
+          @pending_examples << [example.__full_description, message]
         end
         
         def dump_failure(counter, failure)

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

@@ -4,19 +4,15 @@ module Spec
   module Runner
     module Formatter
       class FailingExampleGroupsFormatter < BaseTextFormatter
-        def add_example_group(example_group)
-          super
-          @example_group_description_parts = example_group.description_parts
-        end
-
         def example_failed(example, counter, failure)
-          if @example_group_description_parts
-            description_parts = @example_group_description_parts.collect do |description|
+          if @example_group
+            description_parts = @example_group.description_parts.collect do |description|
               description =~ /(.*) \(druby.*\)$/ ? $1 : description
             end
             @output.puts ::Spec::Example::ExampleGroupMethods.description_text(*description_parts)
+
             @output.flush
-            @example_group_description_parts = nil
+            @example_group = nil
           end
         end
 

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

@@ -9,18 +9,22 @@ module Spec
         
         def initialize(options, output)
           super
-          @current_example_group_number = 0
-          @current_example_number = 0
+          @example_group_number = 0
+          @example_number = 0
+        end
+        
+        def method_missing(sym, *args)
+          # no-op
         end
 
         # The number of the currently running example_group
-        def current_example_group_number
-          @current_example_group_number
+        def example_group_number
+          @example_group_number
         end
         
         # The number of the currently running example (a global counter)
-        def current_example_number
-          @current_example_number
+        def example_number
+          @example_number
         end
         
         def start(example_count)
@@ -35,14 +39,14 @@ module Spec
           super
           @example_group_red = false
           @example_group_red = false
-          @current_example_group_number += 1
-          unless current_example_group_number == 1
+          @example_group_number += 1
+          unless example_group_number == 1
             @output.puts "  </dl>"
             @output.puts "</div>"
           end
           @output.puts "<div class=\"example_group\">"
           @output.puts "  <dl>"
-          @output.puts "  <dt id=\"example_group_#{current_example_group_number}\">#{h(example_group.description)}</dt>"
+          @output.puts "  <dt id=\"example_group_#{example_group_number}\">#{h(example_group.description)}</dt>"
           @output.flush
         end
 
@@ -53,7 +57,7 @@ module Spec
         end
 
         def example_started(example)
-          @current_example_number += 1
+          @example_number += 1
         end
 
         def example_passed(example)
@@ -67,7 +71,7 @@ module Spec
           failure_style = failure.pending_fixed? ? 'pending_fixed' : 'failed'
           @output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>" unless @header_red
           @header_red = true
-          @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{current_example_group_number}');</script>" unless @example_group_red
+          @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{example_group_number}');</script>" unless @example_group_red
           @example_group_red = true
           move_progress
           @output.puts "    <dd class=\"spec #{failure_style}\">"
@@ -81,9 +85,9 @@ module Spec
           @output.flush
         end
 
-        def example_pending(example_group_description, example, message)
+        def example_pending(example, message)
           @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>" unless @header_red
-          @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{current_example_group_number}');</script>" unless @example_group_red
+          @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{example_group_number}');</script>" unless @example_group_red
           move_progress
           @output.puts "    <dd class=\"spec not_implemented\"><span class=\"not_implemented_spec_name\">#{h(example.description)} (PENDING: #{h(message)})</span></dd>"
           @output.flush
@@ -106,7 +110,7 @@ module Spec
         def percent_done
           result = 100.0
           if @example_count != 0
-            result = ((current_example_number).to_f / @example_count.to_f * 1000).to_i / 10.0
+            result = ((example_number).to_f / @example_count.to_f * 1000).to_i / 10.0
           end
           result
         end