newbamboo-rspec 1.1.12

data/lib/spec/example/example_group_methods.rb

@@ -0,0 +1,376 @@
+module Spec
+  module Example
+
+    module ExampleGroupMethods
+      class << self
+        attr_accessor :matcher_class
+
+        def description_text(*args)
+          text = args.inject("") do |description, arg|
+            description << " " unless (description == "" || arg.to_s =~ /^(\s|\.|#)/)
+            description << arg.to_s
+          end
+          text == "" ? nil : text
+        end
+        
+        def example_group_creation_listeners
+          @example_group_creation_listeners ||= []
+        end
+      end
+
+      include Spec::Example::BeforeAndAfterHooks
+      include Spec::Example::Subject::ExampleGroupMethods
+
+      attr_reader :description_options, :spec_path
+      alias :options :description_options
+      
+      def inherited(klass)
+        super
+        register_example_group(klass)
+      end
+      
+      def register_example_group(klass)
+        ExampleGroupMethods.example_group_creation_listeners.each do |listener|
+          listener.register_example_group(klass)
+        end
+      end
+      
+      # Provides the backtrace up to where this example_group was declared.
+      def backtrace
+        @backtrace
+      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
+      
+      def description_args
+        @description_args ||= []
+      end
+      
+      # Makes the describe/it syntax available from a class. For example:
+      #
+      #   class StackSpec < Spec::ExampleGroup
+      #     describe Stack, "with no elements"
+      #
+      #     before
+      #       @stack = Stack.new
+      #     end
+      #
+      #     it "should raise on pop" do
+      #       lambda{ @stack.pop }.should raise_error
+      #     end
+      #   end
+      #
+      def describe(*args, &example_group_block)
+        if example_group_block
+          Spec::Example::add_spec_path_to(args)
+          options = args.last
+          if options[:shared]
+            create_shared_example_group(*args, &example_group_block)
+          else
+            create_example_group_subclass(*args, &example_group_block)
+          end
+        else
+          set_description(*args)
+        end
+      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|
+          include_shared_example_group(group)
+        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
+      end
+
+      alias_method :it, :example
+      alias_method :specify, :example
+
+      # Use this to temporarily disable an example.
+      def xexample(description=nil, opts={}, &block)
+        Kernel.warn("Example disabled: #{description}")
+      end
+      
+      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?
+        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)
+
+        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 description
+        @description ||= ExampleGroupMethods.description_text(*description_parts) || to_s
+      end
+      
+      def described_type
+        @described_type ||= description_parts.reverse.find {|part| part.is_a?(Module)}
+      end
+      
+      def described_class
+        Class === described_type ? described_type : nil
+      end
+      
+      def description_parts #:nodoc:
+        @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
+      end
+      
+      def examples(run_options=nil) #:nodoc:
+        examples = example_objects.dup
+        add_method_examples(examples)
+        (run_options && run_options.reverse) ? examples.reverse : examples
+      end
+
+      def number_of_examples #:nodoc:
+        examples.length
+      end
+
+      def run_before_each(example)
+        example.eval_each_fail_fast(all_before_each_parts)
+      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
+          end
+        end
+        @all_before_each_parts
+      end
+
+      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
+      end
+
+    private
+      def dry_run(examples, run_options)
+        examples.each do |example|
+          run_options.reporter.example_started(example)
+          run_options.reporter.example_finished(example)
+        end
+      end
+
+      def run_before_all(run_options)
+        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
+          return [true, before_all.instance_variable_hash]
+        rescue Exception => e
+          run_options.reporter.failure(before_all, e)
+          return [false, before_all.instance_variable_hash]
+        end
+      end
+
+      def execute_examples(success, instance_variables, examples, run_options)
+        return [success, instance_variables] unless success
+
+        after_all_instance_variables = instance_variables
+        examples.each do |example_group_instance|
+          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)
+        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
+        return success
+      rescue Exception => e
+        run_options.reporter.failure(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|
+          matcher = ExampleGroupMethods.matcher_class.
+            new(description.to_s, example.description)
+          !matcher.matches?(run_options.examples)
+        end
+      end
+
+      def specified_examples?(run_options)
+        run_options.examples && !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
+      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)
+        example_methods.each do |method_name|
+          examples << new(method_name) do
+            __send__(method_name)
+          end
+        end
+      end
+      
+      def method_added(name)
+        example_methods << name.to_s if example_method?(name.to_s)
+      end
+      
+      def example_methods
+        @example_methods ||= []
+      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)
+        )
+      end
+
+      def include_shared_example_group(shared_example_group)
+        case shared_example_group
+        when SharedExampleGroup
+          include shared_example_group
+        else
+          example_group = SharedExampleGroup.find(shared_example_group)
+          unless example_group
+            raise RuntimeError.new("Shared Example Group '#{shared_example_group}' can not be found")
+          end
+          include(example_group)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/spec/example/example_matcher.rb

@@ -0,0 +1,44 @@
+module Spec
+  module Example
+    class ExampleMatcher
+      def initialize(example_group_description, example_name)
+        @example_group_description = example_group_description
+        @example_name = example_name
+      end
+      
+      def matches?(specified_examples)
+        specified_examples.each do |specified_example|
+          return true if matches_literal_example?(specified_example) || matches_example_not_considering_modules?(specified_example)
+        end
+        false
+      end
+      
+      protected
+      def matches_literal_example?(specified_example)
+        specified_example =~ /(^#{example_group_regex} #{example_regexp}$|^#{example_group_regex}$|^#{example_group_with_before_all_regexp}$|^#{example_regexp}$)/
+      end
+
+      def matches_example_not_considering_modules?(specified_example)
+        specified_example =~ /(^#{example_group_regex_not_considering_modules} #{example_regexp}$|^#{example_group_regex_not_considering_modules}$|^#{example_regexp}$)/
+      end
+
+      def example_group_regex
+        Regexp.escape(@example_group_description)
+      end
+
+      def example_group_with_before_all_regexp
+        Regexp.escape("#{@example_group_description} before(:all)")
+      end
+
+      def example_group_regex_not_considering_modules
+        Regexp.escape(@example_group_description.split('::').last)
+      end
+
+      def example_regexp
+        Regexp.escape(@example_name)
+      end
+    end
+
+    ExampleGroupMethods.matcher_class = ExampleMatcher
+  end
+end

data/lib/spec/example/example_methods.rb

@@ -0,0 +1,137 @@
+module Spec
+  module Example
+    module ExampleMethods
+      
+      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
+
+      # 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 options # :nodoc:
+        @_options
+      end
+
+      def execute(options, instance_variables) # :nodoc:
+        options.reporter.example_started(self)
+        set_instance_variables_from_hash(instance_variables)
+        
+        execution_error = nil
+        Timeout.timeout(options.timeout) do
+          begin
+            before_each_example
+            eval_block
+          rescue Exception => e
+            execution_error ||= e
+          end
+          begin
+            after_each_example
+          rescue Exception => e
+            execution_error ||= e
+          end
+        end
+
+        options.reporter.example_finished(self, 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
+      end
+
+      def eval_each_fail_fast(blocks) # :nodoc:
+        blocks.each do |block|
+          instance_eval(&block)
+        end
+      end
+
+      def eval_each_fail_slow(blocks) # :nodoc:
+        first_exception = nil
+        blocks.each do |block|
+          begin
+            instance_eval(&block)
+          rescue Exception => e
+            first_exception ||= e
+          end
+        end
+        raise first_exception if first_exception
+      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)
+            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
+      end
+      
+      # Deprecated - use +backtrace()+
+      def implementation_backtrace
+        Kernel.warn <<-WARNING
+ExampleMethods#implementation_backtrace is deprecated and will be removed
+from a future version. Please use ExampleMethods#backtrace instead.
+WARNING
+        backtrace
+      end
+
+      private
+      include Matchers
+      include Pending
+      
+      def before_each_example # :nodoc:
+        setup_mocks_for_rspec
+        self.class.run_before_each(self)
+      end
+
+      def after_each_example # :nodoc:
+        self.class.run_after_each(self)
+        verify_mocks_for_rspec
+      ensure
+        teardown_mocks_for_rspec
+      end
+
+      def described_class # :nodoc:
+        self.class.described_class
+      end
+    end
+  end
+end

data/lib/spec/example/module_reopening_fix.rb

@@ -0,0 +1,21 @@
+module Spec
+  module Example
+    # This is a fix for ...Something in Ruby 1.8.6??... (Someone fill in here please - Aslak)
+    module ModuleReopeningFix
+      def child_modules
+        @child_modules ||= []
+      end
+
+      def included(mod)
+        child_modules << mod
+      end
+
+      def include(mod)
+        super
+        child_modules.each do |child_module|
+          child_module.__send__(:include, mod)
+        end
+      end
+    end
+  end
+end

data/lib/spec/example/pending.rb

@@ -0,0 +1,18 @@
+module Spec
+  module Example      
+    module Pending
+      def pending(message = "TODO")
+        if block_given?
+          begin
+            yield
+          rescue Exception => e
+            raise Spec::Example::ExamplePendingError.new(message)
+          end
+          raise Spec::Example::PendingExampleFixedError.new("Expected pending '#{message}' to fail. No Error was raised.")
+        else
+          raise Spec::Example::ExamplePendingError.new(message)
+        end
+      end
+    end
+  end
+end

data/lib/spec/example/shared_example_group.rb

@@ -0,0 +1,59 @@
+module Spec
+  module Example
+    class SharedExampleGroup < Module
+      module ClassMethods
+        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 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
+      
+        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 expanded_path(new_example_group) == expanded_path(existing_example_group)
+          raise ArgumentError.new("Shared Example '#{existing_example_group.description}' already exists")
+        end
+
+        def expanded_path(example_group)
+          File.expand_path(example_group.spec_path)
+        end
+      end
+
+      extend ClassMethods
+      include ExampleGroupMethods
+
+      def initialize(*args, &example_group_block)
+        set_description(*args)
+        @example_group_block = example_group_block
+      end
+
+      def included(mod) # :nodoc:
+        mod.module_eval(&@example_group_block)
+      end
+    end
+  end
+end