module Spec
  module Runner
    class Configuration
      include Spec::Example::ArgsAndOptions
      
      # Chooses what mock framework to use. Example:
      #
      #   Spec::Runner.configure do |config|
      #     config.mock_with :rspec, :mocha, :flexmock, or :rr
      #   end
      #
      # To use any other mock framework, you'll have to provide your own
      # adapter. This is simply a module that responds to the following
      # methods:
      #
      #   setup_mocks_for_rspec
      #   verify_mocks_for_rspec
      #   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
          mock_framework_path(mock_framework.to_s)
        else
          mock_framework
        end
      end
      
      def mock_framework # :nodoc:
        @mock_framework ||= mock_framework_path("rspec")
      end
      
      # :call-seq:
      #   include(Some::Helpers)
      #   include(Some::Helpers, More::Helpers)
      #   include(My::Helpers, :type => :key)
      #
      # Declares modules to be included in multiple example groups
      # (<tt>describe</tt> blocks). With no <tt>:type</tt>, the modules listed
      # will be included in all example groups.
      #
      # Use <tt>:type</tt> to restrict
      # the inclusion to a subset of example groups. The value assigned to
      # <tt>:type</tt> should be a key that maps to a class that is either a
      # subclass of Spec::Example::ExampleGroup or extends
      # Spec::Example::ExampleGroupMethods and includes
      # Spec::Example::ExampleMethods.
      #
      # For example, the rspec-rails gem/plugin extends Test::Unit::TestCase
      # with Spec::Example::ExampleGroupMethods and includes
      # Spec::Example::ExampleMethods in it. So if you have a module of helper
      # methods for controller examples, you could do this:
      #
      #   config.include(ControllerExampleHelpers, :type => :controller)
      #
      # Only example groups that have that type will get the modules included:
      #
      #   describe Account, :type => :model do
      #     # Will *not* include ControllerExampleHelpers
      #   end
      #
      #   describe AccountsController, :type => :controller do
      #     # *Will* include ControllerExampleHelpers
      #   end
      #
      def include(*modules_and_options)
        include_or_extend(:include, *modules_and_options)
      end
      
      # :call-seq:
      #   extend(Some::Helpers)
      #   extend(Some::Helpers, More::Helpers)
      #   extend(My::Helpers, :type => :key)
      #
      # Works just like #include, but extends the example groups
      # with the modules rather than including them.
      def extend(*modules_and_options)
        include_or_extend(:extend, *modules_and_options)
      end
      
      # Appends a global <tt>before</tt> block to all example groups.
      # <tt>scope</tt> can be any of <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 once per example
      # group, before any of its examples are run. When <tt>:suite</tt> the
      # block is run once before the entire suite is run.
      def append_before(scope = :each, options={}, &proc)
        add_callback(:append_before, scope, options, &proc)
      end
      alias_method :before, :append_before

      # Prepends a global <tt>before</tt> block to all example groups.
      # 
      # See <tt>append_before</tt> for scoping semantics.
      def prepend_before(scope = :each, options={}, &proc)
        add_callback(:prepend_before, scope, options, &proc)
      end
      
      # Prepends a global <tt>after</tt> block to all example groups.
      # 
      # See <tt>append_before</tt> for scoping semantics.
      def prepend_after(scope = :each, options={}, &proc)
        add_callback(:prepend_after, scope, options, &proc)
      end
      alias_method :after, :prepend_after
      
      # Appends a global <tt>after</tt> block to all example groups.
      # 
      # See <tt>append_before</tt> for scoping semantics.
      def append_after(scope = :each, options={}, &proc)
        add_callback(:append_after, scope, options, &proc)
      end

      # DEPRECATED - use Spec::Matchers::DSL instead
      #
      # Defines global predicate matchers. Example:
      #
      #   config.predicate_matchers[:swim] = :can_swim?
      #
      # This makes it possible to say:
      #
      #   person.should swim # passes if person.can_swim? returns true
      #
      def predicate_matchers
        @predicate_matchers ||= Spec::HashWithDeprecationNotice.new("predicate_matchers", "the new Matcher DSL")
      end

      # Adds patterns to the list of patterns ignored in the backtrace when a
      # failure is output by rspec. Example:
      #
      #   config.ignore_backtrace_patterns /spork/, /shoulda/, "/some/weird/path/"
      #
      # When quiet backtraces are turned on (default), this will exclude any
      # lines that match any of the Regexps and Strings passed.
      #
      def ignore_backtrace_patterns(*patterns)
        @ignored_backtrace_patterns ||= []
        @ignored_backtrace_patterns += patterns
      end

      def ignored_backtrace_patterns # :nodoc:
        @ignored_backtrace_patterns ||= []
      end
      
    private
    
      def include_or_extend(action, *args)
        modules, options = args_and_options(*args)
        [get_type_from_options(options)].flatten.each do |required_example_group|
          required_example_group = required_example_group.to_sym if required_example_group
          modules.each do |mod|
            Spec::Example::ExampleGroupFactory[required_example_group].__send__(action, mod)
          end
        end
      end

      def add_callback(sym, *args, &proc)
        scope, options = scope_and_options(*args)
        example_group = Spec::Example::ExampleGroupFactory[get_type_from_options(options)]
        example_group.__send__(sym, scope, &proc)
      end

      def get_type_from_options(options)
        options[:type] || options[:behaviour_type]
      end
    
      def mock_framework_path(framework_name)
        "spec/adapters/mock_frameworks/#{framework_name}"
      end

      def scope_and_options(*args) # :nodoc:
        args, options = args_and_options(*args)
        return scope_from(*args), options
      end

      def scope_from(*args) # :nodoc:
        args[0] || :each
      end
    end
  end
end
