dchelimsky-rspec 1.1.10 → 1.1.11

data/lib/spec/example/example_group_methods.rb

@@ -48,9 +48,9 @@ module Spec
           options = args.last
           options[:spec_path] = eval("caller(0)[1]", example_group_block) unless options[:spec_path]
           if options[:shared]
-            create_shared_example_group(args, example_group_block)
+            create_shared_example_group(*args, &example_group_block)
           else
-            create_nested_example_group(args, example_group_block)
+            create_nested_example_group(*args, &example_group_block)
           end
         else
           set_description(*args)
@@ -58,13 +58,13 @@ module Spec
       end
       alias :context :describe
       
-      def create_shared_example_group(args, example_group_block)
-        SharedExampleGroup.new(*args, &example_group_block)
+      def create_shared_example_group(*args, &example_group_block)
+        SharedExampleGroup.register(*args, &example_group_block)
       end
       
-      def create_nested_example_group(args, example_group_block)
+      def create_nested_example_group(*args, &example_group_block)
         self.subclass("Subclass") do
-          describe(*args)
+          set_description(*args)
           module_eval(&example_group_block)
         end
       end
@@ -144,15 +144,31 @@ module Spec
 
       def description
         result = ExampleGroupMethods.description_text(*description_parts)
-        if result.nil? || result == ""
-          return to_s
-        else
-          result
-        end
+        (result.nil? || result == "") ? to_s : result
       end
-
+      
       def described_type
-        description_parts.find {|part| part.is_a?(Module)}
+        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)
+        if block
+          @_subject_block = block
+        else
+          @_subject_block.call if @_subject_block
+        end
       end
 
       def description_parts #:nodoc:
@@ -164,7 +180,7 @@ module Spec
       end
 
       def set_description(*args)
-        args, options = args_and_options(*args)
+        args, options = Spec::Example.args_and_options(*args)
         @description_args = args
         @description_options = options
         @description_text = ExampleGroupMethods.description_text(*args)
@@ -354,7 +370,7 @@ module Spec
         when SharedExampleGroup
           include shared_example_group
         else
-          example_group = SharedExampleGroup.find_shared_example_group(shared_example_group)
+          example_group = SharedExampleGroup.find(shared_example_group)
           unless example_group
             raise RuntimeError.new("Shared Example Group '#{shared_example_group}' can not be found")
           end

data/lib/spec/example/example_methods.rb

@@ -4,6 +4,42 @@ module Spec
       
       extend ModuleReopeningFix
       
+      def subject # :nodoc:
+        @subject ||= (instance_variable_get(subject_variable_name) || self.class.subject ||
+          (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
+      
+      def violated(message="")
+        raise Spec::Expectations::ExpectationNotMetError.new(message)
+      end
+
+      def description
+        @_defined_description || ::Spec::Matchers.generated_description || "NO NAME"
+      end
+      
+      def options
+        @_options
+      end
+
       def execute(options, instance_variables)
         options.reporter.example_started(self)
         set_instance_variables_from_hash(instance_variables)
@@ -34,21 +70,17 @@ module Spec
         end
       end
 
-      def violated(message="")
-        raise Spec::Expectations::ExpectationNotMetError.new(message)
-      end
-
-      def eval_each_fail_fast(procs) #:nodoc:
-        procs.each do |proc|
-          instance_eval(&proc)
+      def eval_each_fail_fast(examples) #:nodoc:
+        examples.each do |example|
+          instance_eval(&example)
         end
       end
 
-      def eval_each_fail_slow(procs) #:nodoc:
+      def eval_each_fail_slow(examples) #:nodoc:
         first_exception = nil
-        procs.each do |proc|
+        examples.each do |example|
           begin
-            instance_eval(&proc)
+            instance_eval(&example)
           rescue Exception => e
             first_exception ||= e
           end
@@ -56,19 +88,19 @@ module Spec
         raise first_exception if first_exception
       end
 
-      def description
-        @_defined_description || ::Spec::Matchers.generated_description || "NO NAME"
-      end
-      
-      def options
-        @_options
-      end
-
-      def __full_description
+      # 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}"
       end
       
-      def set_instance_variables_from_hash(ivars)
+      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)
@@ -84,8 +116,8 @@ module Spec
       def implementation_backtrace
         eval("caller", @_implementation)
       end
-      
-      protected
+
+      private
       include Matchers
       include Pending
       
@@ -100,6 +132,26 @@ module Spec
       ensure
         teardown_mocks_for_rspec
       end
+
+      def subject_variable_name
+        '@' << (described_class ? underscore(described_class.name) : '__this_does_not_exist')
+      end
+      
+      def described_class
+        Class === described_type ? described_type : nil
+      end
+      
+      def described_type
+        self.class.described_type
+      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

data/lib/spec/example/shared_example_group.rb

@@ -2,27 +2,39 @@ module Spec
   module Example
     class SharedExampleGroup < Module
       module ClassMethods
-        def add_shared_example_group(new_example_group)
-          guard_against_redefining_existing_example_group(new_example_group)
-          shared_example_groups << new_example_group
+        def register(*args, &block)
+          new_example_group = new(*args, &block)
+          shared_example_groups << new_example_group unless already_registered?(new_example_group)
+          new_example_group
+        end
+        
+        def find(example_group_description)
+          shared_example_groups.find {|b| b.description == example_group_description}
         end
 
-        def find_shared_example_group(example_group_description)
-          shared_example_groups.find do |b|
-            b.description == example_group_description
-          end
+        def clear
+          shared_example_groups.clear
+        end
+        
+        def include?(group)
+          shared_example_groups.include?(group)
+        end
+        
+        def count
+          shared_example_groups.length
         end
 
+      private
+      
         def shared_example_groups
           @shared_example_groups ||= []
         end
-
-        private
-        def guard_against_redefining_existing_example_group(new_example_group)
-          existing_example_group = find_shared_example_group(new_example_group.description)
-          return unless existing_example_group
-          return if new_example_group.equal?(existing_example_group)
-          return if spec_path(new_example_group) == spec_path(existing_example_group)
+      
+        def already_registered?(new_example_group)
+          existing_example_group = find(new_example_group.description)
+          return false unless existing_example_group
+          return true if new_example_group.equal?(existing_example_group)
+          return true if spec_path(new_example_group) == spec_path(existing_example_group)
           raise ArgumentError.new("Shared Example '#{existing_example_group.description}' already exists")
         end
 
@@ -35,9 +47,8 @@ module Spec
       include ExampleGroupMethods
 
       def initialize(*args, &example_group_block)
-        describe(*args)
+        set_description(*args)
         @example_group_block = example_group_block
-        self.class.add_shared_example_group(self)
       end
 
       def included(mod) # :nodoc:

data/lib/spec/example.rb

@@ -1,3 +1,30 @@
+module Spec
+  module Example
+    class << self
+      def args_and_options(*args)
+        with_options_from(args) do |options|
+          return args, options
+        end
+      end
+
+      def scope_from(*args)
+        args[0] || :each
+      end
+
+      def scope_and_options(*args)
+        args, options = args_and_options(*args)
+        return scope_from(*args), options
+      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/before_and_after_hooks'
 require 'spec/example/pending'
@@ -10,3 +37,4 @@ require 'spec/example/example_group_factory'
 require 'spec/example/errors'
 require 'spec/example/configuration'
 require 'spec/example/example_matcher'
+

data/lib/spec/expectations.rb

@@ -2,6 +2,7 @@ require 'spec/matchers'
 require 'spec/expectations/errors'
 require 'spec/expectations/extensions'
 require 'spec/expectations/handler'
+require 'spec/expectations/wrap_expectation'
 
 module Spec
   

data/lib/spec/extensions.rb

@@ -1,4 +1,2 @@
-require 'spec/extensions/object'
 require 'spec/extensions/class'
-require 'spec/extensions/main'
 require 'spec/extensions/metaclass'

data/lib/spec/matchers/be.rb

@@ -3,137 +3,115 @@ module Spec
     
     class Be #:nodoc:
       def initialize(*args)
-        if args.empty?
-          @expected = :satisfy_if
-        else
-          @expected = parse_expected(args.shift)
-        end
+        @expected = args.empty? ? true : set_expected(args.shift)
         @args = args
-        @comparison = ""
       end
       
-      def matches?(given)
-        @given = given
-        if handling_predicate?
-          begin
-            return @result = given.__send__(predicate, *@args)
-          rescue => predicate_error
-            # This clause should be empty, but rcov will not report it as covered
-            # unless something (anything) is executed within the clause
-            rcov_error_report = "http://eigenclass.org/hiki.rb?rcov-0.8.0"
-          end
+      def matches?(actual)
+        @actual = actual
+        handling_predicate? ? run_predicate_on(actual) : match_or_compare(actual)
+      end
+      
+      def run_predicate_on(actual)
+        begin
+          return @result = actual.__send__(predicate, *@args)
+        rescue NameError => predicate_missing_error
+          "this needs to be here or rcov will not count this branch even though it's executed in a code example"
+        end
 
-          begin
-            return @result = given.__send__(present_tense_predicate, *@args)
-          rescue
-            raise predicate_error
-          end
-        else
-          return match_or_compare
+        begin
+          return @result = actual.__send__(present_tense_predicate, *@args)
+        rescue NameError
+          raise predicate_missing_error
         end
       end
       
       def failure_message
-        return "expected #{@comparison}#{expected}, got #{@given.inspect}" unless handling_predicate?
-        return "expected #{predicate}#{args_to_s} to return true, got #{@result.inspect}"
+        handling_predicate? ?
+          "expected #{predicate}#{args_to_s} to return true, got #{@result.inspect}" :
+          "expected #{@comparison_method} #{expected}, got #{@actual.inspect}".gsub('  ',' ')
       end
       
       def negative_failure_message
-        return "expected not #{expected}, got #{@given.inspect}" unless handling_predicate?
-        return "expected #{predicate}#{args_to_s} to return false, got #{@result.inspect}"
-      end
-      
-      def expected
-        return "if to be satisfied" if @expected == :satisfy_if
-        return true if @expected == :true
-        return false if @expected == :false
-        return "nil" if @expected == :nil
-        return @expected.inspect
-      end
-      
-      def match_or_compare
-        return @given ? true : false if @expected == :satisfy_if
-        return @given == true if @expected == :true
-        return @given == false if @expected == :false
-        return @given.nil? if @expected == :nil
-        return @given < @expected if @less_than
-        return @given <= @expected if @less_than_or_equal
-        return @given >= @expected if @greater_than_or_equal
-        return @given > @expected if @greater_than
-        return @given == @expected if @double_equal
-        return @given === @expected if @triple_equal
-        return @given.equal?(@expected)
+        if handling_predicate?
+          "expected #{predicate}#{args_to_s} to return false, got #{@result.inspect}"
+        else
+          message = <<-MESSAGE
+'should_not be #{@comparison_method} #{expected}' not only FAILED,
+it reads really poorly.
+          MESSAGE
+          
+          raise message << ([:===,:==].include?(@comparison_method) ?
+            "Why don't you try expressing it without the \"be\"?" :
+            "Why don't you try expressing it in the positive?")
+        end
       end
       
-      def ==(expected)
-        @prefix = "be "
-        @double_equal = true
-        @comparison = "== "
-        @expected = expected
-        self
-      end
-
-      def ===(expected)
-        @prefix = "be "
-        @triple_equal = true
-        @comparison = "=== "
-        @expected = expected
-        self
-      end
-
-      def <(expected)
-        @prefix = "be "
-        @less_than = true
-        @comparison = "< "
-        @expected = expected
-        self
-      end
-
-      def <=(expected)
-        @prefix = "be "
-        @less_than_or_equal = true
-        @comparison = "<= "
-        @expected = expected
-        self
+      def description
+        "#{prefix_to_sentence}#{comparison} #{expected_to_sentence}#{args_to_sentence}".gsub(/\s+/,' ')
       end
 
-      def >=(expected)
-        @prefix = "be "
-        @greater_than_or_equal = true
-        @comparison = ">= "
-        @expected = expected
-        self
+      [:==, :<, :<=, :>=, :>, :===].each do |method|
+        define_method method do |expected|
+          compare_to(expected, :using => method)
+          self
+        end
       end
 
-      def >(expected)
-        @prefix = "be "
-        @greater_than = true
-        @comparison = "> "
-        @expected = expected
-        self
-      end
+      private
+        def match_or_compare(actual)
+          case @expected
+          when TrueClass
+            @actual
+          else
+            @actual.__send__(comparison_method, @expected)
+          end
+        end
       
-      def description
-        "#{prefix_to_sentence}#{comparison}#{expected_to_sentence}#{args_to_sentence}"
-      end
+        def comparison_method
+          @comparison_method || :equal?
+        end
+      
+        def expected
+          @expected
+        end
 
-      private
+        def compare_to(expected, opts)
+          @expected, @comparison_method = expected, opts[:using]
+        end
+
+        def set_expected(expected)
+          Symbol === expected ? parse_expected(expected) : expected
+        end
+        
         def parse_expected(expected)
-          if Symbol === expected
-            @handling_predicate = true
-            ["be_an_","be_a_","be_"].each do |prefix|
-              if expected.starts_with?(prefix)
-                @prefix = prefix
-                return "#{expected.to_s.sub(@prefix,"")}".to_sym
+          ["be_an_","be_a_","be_"].each do |prefix|
+            handling_predicate!
+            if expected.starts_with?(prefix)
+              set_prefix(prefix)
+              expected = expected.to_s.sub(prefix,"")
+              [true, false, nil].each do |val|
+                return val if val.to_s == expected
               end
+              return expected.to_sym
             end
           end
-          @prefix = ""
-          return expected
+        end
+        
+        def set_prefix(prefix)
+          @prefix = prefix
+        end
+        
+        def prefix
+          @prefix
+        end
+
+        def handling_predicate!
+          @handling_predicate = true
         end
         
         def handling_predicate?
-          return false if [:true, :false, :nil].include?(@expected)
+          return false if [true, false, nil].include?(expected)
           return @handling_predicate
         end
 
@@ -146,21 +124,27 @@ module Spec
         end
         
         def args_to_s
-          return "" if @args.empty?
-          inspected_args = @args.collect{|a| a.inspect}
-          return "(#{inspected_args.join(', ')})"
+          @args.empty? ? "" : parenthesize(inspected_args.join(', '))
+        end
+        
+        def parenthesize(string)
+          return "(#{string})"
+        end
+        
+        def inspected_args
+          @args.collect{|a| a.inspect}
         end
         
         def comparison
-          @comparison
+          @comparison_method.nil? ? " " : "be #{@comparison_method.to_s} "
         end
         
         def expected_to_sentence
-          split_words(@expected)
+          split_words(expected)
         end
         
         def prefix_to_sentence
-          split_words(@prefix)
+          split_words(prefix)
         end
 
         def split_words(sym)
@@ -181,7 +165,6 @@ module Spec
     end
  
     # :call-seq:
-    #   should be
     #   should be_true
     #   should be_false
     #   should be_nil
@@ -189,7 +172,7 @@ module Spec
     #   should_not be_nil
     #   should_not be_arbitrary_predicate(*args)
     #
-    # Given true, false, or nil, will pass if given value is
+    # Given true, false, or nil, will pass if actual value is
     # true, false or nil (respectively). Given no args means
     # the caller should satisfy an if condition (to be or not to be). 
     #
@@ -203,7 +186,6 @@ module Spec
     #
     # == Examples 
     #
-    #   target.should be
     #   target.should be_true
     #   target.should be_false
     #   target.should be_nil

data/lib/spec/matchers/operator_matcher.rb

@@ -1,44 +1,35 @@
 module Spec
   module Matchers
     class BaseOperatorMatcher
-      attr_reader :generated_description
-      
       def initialize(given)
         @given = given
       end
 
       def ==(expected)
-        @expected = expected
         __delegate_method_missing_to_given("==", expected)
       end
 
       def ===(expected)
-        @expected = expected
         __delegate_method_missing_to_given("===", expected)
       end
 
       def =~(expected)
-        @expected = expected
         __delegate_method_missing_to_given("=~", expected)
       end
 
       def >(expected)
-        @expected = expected
         __delegate_method_missing_to_given(">", expected)
       end
 
       def >=(expected)
-        @expected = expected
         __delegate_method_missing_to_given(">=", expected)
       end
 
       def <(expected)
-        @expected = expected
         __delegate_method_missing_to_given("<", expected)
       end
 
       def <=(expected)
-        @expected = expected
         __delegate_method_missing_to_given("<=", expected)
       end
 
@@ -55,6 +46,7 @@ module Spec
     class PositiveOperatorMatcher < BaseOperatorMatcher #:nodoc:
 
       def __delegate_method_missing_to_given(operator, expected)
+        @expected = expected
         @operator = operator
         ::Spec::Matchers.last_matcher = self
         return true if @given.__send__(operator, expected)
@@ -67,6 +59,7 @@ module Spec
     class NegativeOperatorMatcher < BaseOperatorMatcher #:nodoc:
 
       def __delegate_method_missing_to_given(operator, expected)
+        @expected = expected
         @operator = operator
         ::Spec::Matchers.last_matcher = self
         return true unless @given.__send__(operator, expected)