+++ /dev/null
-<?php
-
-/*
- * This file is part of the Behat.
- * (c) Konstantin Kudryashov <ever.zet@gmail.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Behat\Behat\Context\ServiceContainer;
-
-use Behat\Behat\Definition\ServiceContainer\DefinitionExtension;
-use Behat\Behat\Snippet\ServiceContainer\SnippetExtension;
-use Behat\Testwork\Argument\ServiceContainer\ArgumentExtension;
-use Behat\Testwork\Autoloader\ServiceContainer\AutoloaderExtension;
-use Behat\Testwork\Cli\ServiceContainer\CliExtension;
-use Behat\Testwork\Environment\ServiceContainer\EnvironmentExtension;
-use Behat\Testwork\Filesystem\ServiceContainer\FilesystemExtension;
-use Behat\Testwork\ServiceContainer\Extension;
-use Behat\Testwork\ServiceContainer\ExtensionManager;
-use Behat\Testwork\ServiceContainer\ServiceProcessor;
-use Behat\Testwork\Suite\ServiceContainer\SuiteExtension;
-use Behat\Testwork\Translator\ServiceContainer\TranslatorExtension;
-use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
-
-/**
- * Behat context extension.
- *
- * Extends Behat with context services.
- *
- * @author Konstantin Kudryashov <ever.zet@gmail.com>
- */
-final class ContextExtension implements Extension
-{
- /**
- * Available services
- */
- const FACTORY_ID = 'context.factory';
- const CONTEXT_SNIPPET_GENERATOR_ID = 'snippet.generator.context';
- const AGGREGATE_RESOLVER_FACTORY_ID = 'context.argument.aggregate_resolver_factory';
-
- /*
- * Available extension points
- */
- const CLASS_RESOLVER_TAG = 'context.class_resolver';
- const ARGUMENT_RESOLVER_TAG = 'context.argument_resolver';
- const INITIALIZER_TAG = 'context.initializer';
- const READER_TAG = 'context.reader';
- const ANNOTATION_READER_TAG = 'context.annotation_reader';
- const CLASS_GENERATOR_TAG = 'context.class_generator';
- const SUITE_SCOPED_RESOLVER_FACTORY_TAG = 'context.argument.suite_resolver_factory';
-
- /**
- * @var ServiceProcessor
- */
- private $processor;
-
- /**
- * Initializes compiler pass.
- *
- * @param null|ServiceProcessor $processor
- */
- public function __construct(ServiceProcessor $processor = null)
- {
- $this->processor = $processor ? : new ServiceProcessor();
- }
-
- /**
- * {@inheritdoc}
- */
- public function getConfigKey()
- {
- return 'contexts';
- }
-
- /**
- * {@inheritdoc}
- */
- public function initialize(ExtensionManager $extensionManager)
- {
- }
-
- /**
- * {@inheritdoc}
- */
- public function configure(ArrayNodeDefinition $builder)
- {
- }
-
- /**
- * {@inheritdoc}
- */
- public function load(ContainerBuilder $container, array $config)
- {
- $this->loadFactory($container);
- $this->loadArgumentResolverFactory($container);
- $this->loadEnvironmentHandler($container);
- $this->loadEnvironmentReader($container);
- $this->loadSuiteSetup($container);
- $this->loadSnippetAppender($container);
- $this->loadSnippetGenerators($container);
- $this->loadSnippetsController($container);
- $this->loadDefaultClassGenerators($container);
- $this->loadDefaultContextReaders($container);
- }
-
- /**
- * {@inheritdoc}
- */
- public function process(ContainerBuilder $container)
- {
- $this->processClassResolvers($container);
- $this->processArgumentResolverFactories($container);
- $this->processArgumentResolvers($container);
- $this->processContextInitializers($container);
- $this->processContextReaders($container);
- $this->processClassGenerators($container);
- $this->processAnnotationReaders($container);
- }
-
- /**
- * Loads context factory.
- *
- * @param ContainerBuilder $container
- */
- private function loadFactory(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\ContextFactory', array(
- new Reference(ArgumentExtension::CONSTRUCTOR_ARGUMENT_ORGANISER_ID)
- ));
- $container->setDefinition(self::FACTORY_ID, $definition);
- }
-
- /**
- * Loads argument resolver factory used in the environment handler.
- *
- * @param ContainerBuilder $container
- */
- private function loadArgumentResolverFactory(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Argument\CompositeArgumentResolverFactory');
- $container->setDefinition(self::AGGREGATE_RESOLVER_FACTORY_ID, $definition);
- }
-
- /**
- * Loads context environment handlers.
- *
- * @param ContainerBuilder $container
- */
- private function loadEnvironmentHandler(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Environment\Handler\ContextEnvironmentHandler', array(
- new Reference(self::FACTORY_ID),
- new Reference(self::AGGREGATE_RESOLVER_FACTORY_ID)
- ));
- $definition->addTag(EnvironmentExtension::HANDLER_TAG, array('priority' => 50));
- $container->setDefinition(self::getEnvironmentHandlerId(), $definition);
- }
-
- /**
- * Loads context environment readers.
- *
- * @param ContainerBuilder $container
- */
- private function loadEnvironmentReader(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Environment\Reader\ContextEnvironmentReader');
- $definition->addTag(EnvironmentExtension::READER_TAG, array('priority' => 50));
- $container->setDefinition(self::getEnvironmentReaderId(), $definition);
- }
-
- /**
- * Loads context environment setup.
- *
- * @param ContainerBuilder $container
- */
- private function loadSuiteSetup(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Suite\Setup\SuiteWithContextsSetup', array(
- new Reference(AutoloaderExtension::CLASS_LOADER_ID),
- new Reference(FilesystemExtension::LOGGER_ID)
- ));
- $definition->addTag(SuiteExtension::SETUP_TAG, array('priority' => 20));
- $container->setDefinition(self::getSuiteSetupId(), $definition);
- }
-
- /**
- * Loads context snippet appender.
- *
- * @param ContainerBuilder $container
- */
- private function loadSnippetAppender(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Snippet\Appender\ContextSnippetAppender', array(
- new Reference(FilesystemExtension::LOGGER_ID)
- ));
- $definition->addTag(SnippetExtension::APPENDER_TAG, array('priority' => 50));
- $container->setDefinition(SnippetExtension::APPENDER_TAG . '.context', $definition);
- }
-
- /**
- * Loads context snippet generators.
- *
- * @param ContainerBuilder $container
- */
- private function loadSnippetGenerators(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Snippet\Generator\ContextSnippetGenerator', array(
- new Reference(DefinitionExtension::PATTERN_TRANSFORMER_ID)
- ));
- $definition->addTag(SnippetExtension::GENERATOR_TAG, array('priority' => 50));
- $container->setDefinition(self::CONTEXT_SNIPPET_GENERATOR_ID, $definition);
- }
-
- /**
- * @param ContainerBuilder $container
- */
- protected function loadSnippetsController(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Cli\ContextSnippetsController', array(
- new Reference(self::CONTEXT_SNIPPET_GENERATOR_ID),
- new Reference(TranslatorExtension::TRANSLATOR_ID)
- ));
- $definition->addTag(CliExtension::CONTROLLER_TAG, array('priority' => 410));
- $container->setDefinition(CliExtension::CONTROLLER_TAG . '.context_snippets', $definition);
- }
-
- /**
- * Loads default context class generators.
- *
- * @param ContainerBuilder $container
- */
- private function loadDefaultClassGenerators(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\ContextClass\SimpleClassGenerator');
- $definition->addTag(self::CLASS_GENERATOR_TAG, array('priority' => 50));
- $container->setDefinition(self::CLASS_GENERATOR_TAG . '.simple', $definition);
- }
-
- /**
- * Loads default context readers.
- *
- * @param ContainerBuilder $container
- */
- private function loadDefaultContextReaders(ContainerBuilder $container)
- {
- $definition = new Definition('Behat\Behat\Context\Reader\AnnotatedContextReader');
- $container->setDefinition(self::getAnnotatedContextReaderId(), $definition);
-
- $definition = new Definition('Behat\Behat\Context\Reader\ContextReaderCachedPerContext', array(
- new Reference(self::getAnnotatedContextReaderId())
- ));
- $definition->addTag(self::READER_TAG, array('priority' => 50));
- $container->setDefinition(self::getAnnotatedContextReaderId() . '.cached', $definition);
-
- $definition = new Definition('Behat\Behat\Context\Reader\TranslatableContextReader', array(
- new Reference(TranslatorExtension::TRANSLATOR_ID)
- ));
- $container->setDefinition(self::READER_TAG . '.translatable', $definition);
-
- $definition = new Definition('Behat\Behat\Context\Reader\ContextReaderCachedPerSuite', array(
- new Reference(self::READER_TAG . '.translatable')
- ));
- $definition->addTag(self::READER_TAG, array('priority' => 50));
- $container->setDefinition(self::READER_TAG . '.translatable.cached', $definition);
- }
-
- /**
- * Processes all class resolvers.
- *
- * @param ContainerBuilder $container
- */
- private function processClassResolvers(ContainerBuilder $container)
- {
- $references = $this->processor->findAndSortTaggedServices($container, self::CLASS_RESOLVER_TAG);
- $definition = $container->getDefinition(self::getEnvironmentHandlerId());
-
- foreach ($references as $reference) {
- $definition->addMethodCall('registerClassResolver', array($reference));
- }
- }
-
- /**
- * Processes all argument resolver factories.
- *
- * @param ContainerBuilder $container
- */
- private function processArgumentResolverFactories($container)
- {
- $references = $this->processor->findAndSortTaggedServices($container, self::SUITE_SCOPED_RESOLVER_FACTORY_TAG);
- $definition = $container->getDefinition(self::AGGREGATE_RESOLVER_FACTORY_ID);
-
- foreach ($references as $reference) {
- $definition->addMethodCall('registerFactory', array($reference));
- }
- }
-
- /**
- * Processes all argument resolvers.
- *
- * @param ContainerBuilder $container
- */
- private function processArgumentResolvers(ContainerBuilder $container)
- {
- $references = $this->processor->findAndSortTaggedServices($container, self::ARGUMENT_RESOLVER_TAG);
- $definition = $container->getDefinition(self::FACTORY_ID);
-
- foreach ($references as $reference) {
- $definition->addMethodCall('registerArgumentResolver', array($reference));
- }
- }
-
- /**
- * Processes all context initializers.
- *
- * @param ContainerBuilder $container
- */
- private function processContextInitializers(ContainerBuilder $container)
- {
- $references = $this->processor->findAndSortTaggedServices($container, self::INITIALIZER_TAG);
- $definition = $container->getDefinition(self::FACTORY_ID);
-
- foreach ($references as $reference) {
- $definition->addMethodCall('registerContextInitializer', array($reference));
- }
- }
-
- /**
- * Processes all context readers.
- *
- * @param ContainerBuilder $container
- */
- private function processContextReaders(ContainerBuilder $container)
- {
- $references = $this->processor->findAndSortTaggedServices($container, self::READER_TAG);
- $definition = $container->getDefinition(self::getEnvironmentReaderId());
-
- foreach ($references as $reference) {
- $definition->addMethodCall('registerContextReader', array($reference));
- }
- }
-
- /**
- * Processes all class generators.
- *
- * @param ContainerBuilder $container
- */
- private function processClassGenerators(ContainerBuilder $container)
- {
- $references = $this->processor->findAndSortTaggedServices($container, self::CLASS_GENERATOR_TAG);
- $definition = $container->getDefinition(self::getSuiteSetupId());
-
- foreach ($references as $reference) {
- $definition->addMethodCall('registerClassGenerator', array($reference));
- }
- }
-
- /**
- * Processes all annotation readers.
- *
- * @param ContainerBuilder $container
- */
- private function processAnnotationReaders(ContainerBuilder $container)
- {
- $references = $this->processor->findAndSortTaggedServices($container, self::ANNOTATION_READER_TAG);
- $definition = $container->getDefinition(self::getAnnotatedContextReaderId());
-
- foreach ($references as $reference) {
- $definition->addMethodCall('registerAnnotationReader', array($reference));
- }
- }
-
- /**
- * Returns context environment handler service id.
- *
- * @return string
- */
- private static function getEnvironmentHandlerId()
- {
- return EnvironmentExtension::HANDLER_TAG . '.context';
- }
-
- /**
- * Returns context environment reader id.
- *
- * @return string
- */
- private static function getEnvironmentReaderId()
- {
- return EnvironmentExtension::READER_TAG . '.context';
- }
-
- /**
- * Returns context suite setup id.
- *
- * @return string
- */
- private static function getSuiteSetupId()
- {
- return SuiteExtension::SETUP_TAG . '.suite_with_contexts';
- }
-
- /**
- * Returns annotated context reader id.
- *
- * @return string
- */
- private static function getAnnotatedContextReaderId()
- {
- return self::READER_TAG . '.annotated';
- }
-}