Add Ui for Rules event handlers and per-bundle entities

.travis.yml

@@ -14,6 +14,7 @@ php:
 env:
   - DRUPAL_CORE=8.0.x
   - DRUPAL_CORE=8.1.x
+  - DRUPAL_CORE=8.2.x
 
 matrix:
   allow_failures:
@@ -59,7 +60,9 @@ before_script:
 
   # Run composer install for Drupal 8.1. We need an up-to-date composer when
   # installing Drupal 8.1.
-  - if [ "$DRUPAL_CORE" = "8.1.x" ]; then composer self-update && composer install; fi
+  # Disabled for now because core still includes the vendor directory, see
+  # https://www.drupal.org/node/1475510
+  # - if [ "$DRUPAL_CORE" = "8.1.x" ]; then composer self-update && composer install; fi
 
   # Start a web server on port 8888, run in the background.
   - php -S localhost:8888 &

config/schema/rules.action.schema.yml

@@ -1,3 +1,10 @@
+# Per default the schema of arbitrary context values of an action cannot be
+# typed. Actions that need translatability or other features of the config
+# system must specify their context value schema explicitly, see examples below.
+rules.action.context_values.*:
+  type: ignore
+  label: Context values
+
 rules.action.context_values.rules_system_message:
   type: mapping
   label: Message action context values

config/schema/rules.context.schema.yml

@@ -25,12 +25,6 @@ rules.context.values:
   # The entries depend on the plugin here. Plugins have to extend this and
   # provide a suiting schema.
 
-rules.context.mapping:
-  type: sequence
-  label: 'Context mapping'
-  sequence:
-    - type: string
-
 rules.context.processors:
   type: sequence
   label: 'Context processors'

config/schema/rules.data_types.schema.yml

@@ -7,11 +7,11 @@ rules_component:
       label: 'Context definitions'
       sequence:
         - type: rules.context.definition
-    provided_context:
+    provided_context_definitions:
       type: sequence
-      label: 'Names of provided context'
+      label: 'Provided context definitions'
       sequence:
-        - type: string
+        - type: rules.context.definition
     expression:
       type: rules_expression.[id]
       label: 'Expression configuration'

config/schema/rules.schema.yml

@@ -35,9 +35,21 @@ rules.reaction.*:
     label:
       type: label
       label: 'Label'
-    event:
-      type: string
-      label: 'Event'
+    events:
+      type: sequence
+      label: 'Events'
+      sequence:
+        type: mapping
+        label: 'Event'
+        mapping:
+          event_name:
+            type: string
+            label: 'Name'
+          configuration:
+            type: sequence
+            label: 'Configuration'
+            sequence:
+              type: mapping
     module:
       type: string
       label: 'Module'

src/Context/ContextAwarePluginInterface.php

@@ -20,7 +20,46 @@ interface ContextAwarePluginInterface extends CoreContextAwarePluginInterface {
    * When a plugin is configured half-way or even fully, some context values are
    * already available upon which the definition of subsequent or provided
    * context can be refined.
+   *
+   * Implement this method, when the plugin's context definitions need to be
+   * refined. When the selected data definitions should be refined, implement
+   * ::assertMetadata() instead.
+   *
+   * Note that context gets refined at configuration and execution time of the
+   * plugin.
+   *
+   * @param \Drupal\Core\TypedData\DataDefinitionInterface[] $selected_data
+   *   An array of data definitions for context that is mapped using a data
+   *   selector, keyed by context name.
+   */
+  public function refineContextDefinitions(array $selected_data);
+
+  /**
+   * Asserts additional metadata for the selected data.
+   *
+   * Allows the plugin to assert additional metadata that is in place when the
+   * plugin has been successfully executed. A typical use-case would be
+   * asserting the node type for a "Node is of type" condition. By doing so,
+   * sub-sequent executed plugins are aware of the metadata and can build upon
+   * it.
+   *
+   * Implement this method, when the selected data definitions need to be
+   * refined. When the plugin's context definitions should be refined, implement
+   * ::refineContextDefinitions() instead.
+   *
+   * Note that metadata is only asserted on configuration time. The plugin has
+   * to ensure that the run-time data matches the asserted configuration if it
+   * has been executed successfully.
+   *
+   * @param \Drupal\Core\TypedData\DataDefinitionInterface[] $selected_data
+   *   An array of data definitions for context that is mapped using a data
+   *   selector, keyed by context name.
+   *
+   * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
+   *   An array of modified data definitions, keyed as the passed array. Note
+   *   data definitions need to be cloned *before* they are modified, such that
+   *   the changes do not propagate unintentionally.
    */
-  public function refineContextDefinitions();
+  public function assertMetadata(array $selected_data);
 
 }

src/Engine/IntegrityCheckTrait.php → src/Context/ContextHandlerIntegrityTrait.php

@@ -2,25 +2,26 @@
 
 /**
  * @file
- * Contains \Drupal\rules\Engine\IntegrityCheckTrait.
+ * Contains \Drupal\rules\Engine\ContextHandlerIntegrityTrait.
  */
 
-namespace Drupal\rules\Engine;
+namespace Drupal\rules\Context;
 
-use Drupal\Core\Plugin\Context\ContextDefinitionInterface;
+use Drupal\Core\Plugin\Context\ContextDefinitionInterface as CoreContextDefinitionInterface;
 use Drupal\Core\Plugin\ContextAwarePluginInterface as CoreContextAwarePluginInterface;
-use Drupal\Core\TypedData\ComplexDataInterface;
 use Drupal\Core\TypedData\DataDefinitionInterface;
-use Drupal\Core\TypedData\ListInterface;
-use Drupal\Core\TypedData\PrimitiveInterface;
 use Drupal\rules\Context\ContextDefinitionInterface as RulesContextDefinitionInterface;
-use Drupal\rules\Context\ContextProviderInterface;
+use Drupal\rules\Engine\ExecutionMetadataStateInterface;
+use Drupal\rules\Engine\IntegrityViolation;
+use Drupal\rules\Engine\IntegrityViolationList;
 use Drupal\rules\Exception\RulesIntegrityException;
 
 /**
- * Provides shared integrity checking methods for conditions and actions.
+ * Extends the context handler trait with support for checking integrity.
  */
-trait IntegrityCheckTrait {
+trait ContextHandlerIntegrityTrait {
+
+  use ContextHandlerTrait;
 
   /**
    * Performs the integrity check.
@@ -34,16 +35,19 @@ trait IntegrityCheckTrait {
    * @return \Drupal\rules\Engine\IntegrityViolationList
    *   The list of integrity violations.
    */
-  protected function doCheckIntegrity(CoreContextAwarePluginInterface $plugin, ExecutionMetadataStateInterface $metadata_state) {
+  protected function checkContextConfigIntegrity(CoreContextAwarePluginInterface $plugin, ExecutionMetadataStateInterface $metadata_state) {
     $violation_list = new IntegrityViolationList();
     $context_definitions = $plugin->getContextDefinitions();
 
+    // Make sure that all provided variables by this plugin are added to the
+    // execution metadata state.
+    $this->addProvidedContextDefinitions($plugin, $metadata_state);
+
     foreach ($context_definitions as $name => $context_definition) {
       // Check if a data selector is configured that maps to the state.
       if (isset($this->configuration['context_mapping'][$name])) {
         try {
-          $data_definition = $metadata_state->fetchDefinitionByPropertyPath($this->configuration['context_mapping'][$name]);
-
+          $data_definition = $this->getMappedDefinition($name, $metadata_state);
           $this->checkDataTypeCompatible($context_definition, $data_definition, $name, $violation_list);
         }
         catch (RulesIntegrityException $e) {
@@ -83,7 +87,7 @@ protected function doCheckIntegrity(CoreContextAwarePluginInterface $plugin, Exe
           $violation_list->add($violation);
         }
       }
-      elseif ($context_definition->isRequired()) {
+      elseif ($context_definition->isRequired() && $context_definition->getDefaultValue() === NULL) {
         $violation = new IntegrityViolation();
         $violation->setMessage($this->t('The required context %context_name is missing.', [
           '%context_name' => $context_definition->getLabel(),
@@ -112,10 +116,6 @@ protected function doCheckIntegrity(CoreContextAwarePluginInterface $plugin, Exe
       }
     }
 
-    // Make sure that all provided variables by this plugin are added to the
-    // execution metadata state.
-    $this->addProvidedVariablesToExecutionMetadataState($plugin, $metadata_state);
-
     return $violation_list;
   }
 
@@ -131,28 +131,17 @@ protected function doCheckIntegrity(CoreContextAwarePluginInterface $plugin, Exe
    * @param \Drupal\rules\Engine\IntegrityViolationList $violation_list
    *   The list of violations where new ones will be added.
    */
-  protected function checkDataTypeCompatible(ContextDefinitionInterface $context_definition, DataDefinitionInterface $provided, $context_name, IntegrityViolationList $violation_list) {
-    $expected_class = $context_definition->getDataDefinition()->getClass();
-    $provided_class = $provided->getClass();
-    $expected_type_problem = NULL;
-
-    if (is_subclass_of($expected_class, PrimitiveInterface::class)
-      && !is_subclass_of($provided_class, PrimitiveInterface::class)
-    ) {
-      $expected_type_problem = $this->t('primitive');
-    }
-    elseif (is_subclass_of($expected_class, ListInterface::class)
-      && !is_subclass_of($provided_class, ListInterface::class)
-    ) {
-      $expected_type_problem = $this->t('list');
-    }
-    elseif (is_subclass_of($expected_class, ComplexDataInterface::class)
-      && !is_subclass_of($provided_class, ComplexDataInterface::class)
-    ) {
-      $expected_type_problem = $this->t('complex');
+  protected function checkDataTypeCompatible(CoreContextDefinitionInterface $context_definition, DataDefinitionInterface $provided, $context_name, IntegrityViolationList $violation_list) {
+    // Compare data types. For now, fail if they are not equal.
+    // @todo: Add support for matching based upon type-inheritance.
+    $target_type = $context_definition->getDataDefinition()->getDataType();
+
+    // Special case any and entity target types for now.
+    if ($target_type == 'any' || ($target_type == 'entity' && strpos($provided->getDataType(), 'entity:') !== FALSE)) {
+      return;
     }
-
-    if ($expected_type_problem) {
+    if ($target_type != $provided->getDataType()) {
+      $expected_type_problem = $context_definition->getDataDefinition()->getDataType();
       $violation = new IntegrityViolation();
       $violation->setMessage($this->t('Expected a @expected_type data type for context %context_name but got a @provided_type data type instead.', [
         '@expected_type' => $expected_type_problem,
@@ -165,33 +154,4 @@ protected function checkDataTypeCompatible(ContextDefinitionInterface $context_d
     }
   }
 
-  /**
-   * Adds provided variables to the execution metadata state.
-   *
-   * @param CoreContextAwarePluginInterface $plugin
-   *   The action or condition plugin that may provide variables.
-   * @param \Drupal\rules\Engine\ExecutionMetadataStateInterface $metadata_state
-   *   The excution metadata state to add variables to.
-   */
-  public function addProvidedVariablesToExecutionMetadataState(CoreContextAwarePluginInterface $plugin, ExecutionMetadataStateInterface $metadata_state) {
-    if ($plugin instanceof ContextProviderInterface) {
-      $provided_context_definitions = $plugin->getProvidedContextDefinitions();
-
-      foreach ($provided_context_definitions as $name => $context_definition) {
-        if (isset($this->configuration['provides_mapping'][$name])) {
-          // Populate the state with the new variable that is provided by this
-          // plugin. That is necessary so that the integrity check in subsequent
-          // actions knows about the variable and does not throw violations.
-          $metadata_state->setDataDefinition(
-            $this->configuration['provides_mapping'][$name],
-            $context_definition->getDataDefinition()
-          );
-        }
-        else {
-          $metadata_state->setDataDefinition($name, $context_definition->getDataDefinition());
-        }
-      }
-    }
-  }
-
 }