port_remove_user_role-2471645-6.patch

src/Plugin/Action/UserRoleRemove.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Drupal\rules\Plugin\Action;
+
+use Drupal\rules\Core\RulesActionBase;
+
+/**
+ * Provides a 'Remove user role' action.
+ *
+ * @action(
+ *   id = "rules_user_role_remove",
+ *   label = @Translation("Remove user role"),
+ *   category = @Translation("User"),
+ *   context = {
+ *     "user" = @ContextDefinition("entity:user",
+ *       label = @Translation("User")
+ *     ),
+ *     "roles" = @ContextDefinition("entity:user_role",
+ *       label = @Translation("Roles"),
+ *       multiple = TRUE
+ *     )
+ *   }
+ * )
+ *
+ */
+class UserRoleRemove extends RulesActionBase
+{
+
+  /**
+   * Flag that indicates if the entity should be auto-saved later.
+   *
+   * @var bool
+   */
+  protected $saveLater = FALSE;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function summary()
+  {
+    return $this->t('Remove roles of particular users');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function execute()
+  {
+
+    /** @var \Drupal\user\Entity\User $account */
+    $account = $this->getContextValue('user');
+
+    /** @var \Drupal\user\RoleInterface $roles */
+    $roles = $this->getContextValue('roles');
+    foreach ($roles as $role) {
+      // Check if user has role.
+      if ($account->hasRole($role->id())) {
+        // Remove role
+        $account->removeRole($role->id());
+        // Set flag that indicates if the entity should be auto-saved later.
+        $this->saveLater = TRUE;
+      }
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function autoSaveContext()
+  {
+    if ($this->saveLater) {
+      return ['user'];
+    }
+    return [];
+  }
+}

tests/src/Integration/Action/UserRoleRemoveTest.php

@@ -0,0 +1,110 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\Tests\rules\Integration\Action\UserRoleRemoveTest.
+ */
+
+namespace Drupal\Tests\rules\Integration\Action;
+
+use Drupal\Tests\rules\Integration\RulesEntityIntegrationTestBase;
+use Drupal\Tests\rules\Integration\RulesUserIntegrationTestTrait;
+
+/**
+ * @coversDefaultClass \Drupal\rules\Plugin\Action\UserRoleRemove
+ * @group rules_actions
+ */
+class UserRoleRemoveTest extends RulesEntityIntegrationTestBase
+{
+
+  use RulesUserIntegrationTestTrait;
+  /**
+   * The action that is being tested.
+   *
+   * @var \Drupal\rules\Core\RulesActionInterface
+   */
+  protected $action;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setUp()
+  {
+    parent::setUp();
+    $this->enableModule('user');
+    $this->action = $this->actionManager->createInstance('rules_user_role_remove');
+  }
+
+  /**
+   * Tests the summary.
+   *
+   * @covers ::summary
+   */
+  public function testSummary()
+  {
+    $this->assertEquals('Remove roles of particular users', $this->action->summary());
+  }
+
+  /**
+   * Tests removing existing role from user.
+   *
+   * @covers ::execute
+   * @dataProvider rolesProvider
+   * @param $account
+   * @param $user
+   */
+  public function testRemoveExistingRole($account, $user)
+  {
+    // Set-up a mock user with role 'editor'.
+    $editor = $this->getMockedUserRole('editor');
+
+    // Test removing one role.
+    $this->action
+      ->setContextValue('user', $account)
+      ->setContextValue('roles', [$editor])
+      ->execute();
+
+    $this->assertEquals($this->action->autoSaveContext(), $user, 'Action returns nothing for auto saving since the user has been saved already.');
+  }
+
+  /**
+   * @return array
+   */
+  public function rolesProvider()
+  {
+
+    $account1 = $this->getMockedUser();
+    $account1->expects($this->once())
+      ->method('hasRole')
+      ->with(
+        $this->equalTo('editor')
+      )
+      ->will($this->returnValue(TRUE));
+
+    $account1->expects($this->once())
+      ->method('removeRole')
+      ->with(
+        $this->equalTo('editor')
+      );
+
+    $account2 = $this->getMockedUser();
+    $account2->expects($this->once())
+      ->method('hasRole')
+      ->with(
+        $this->equalTo('editor')
+      )
+      ->will($this->returnValue(FALSE));
+
+    $account2->expects($this->never())
+      ->method('removeRole')
+      ->with(
+        $this->equalTo('editor')
+      );
+
+    return array(
+      'removing of one role' => array($account1, ['user']),
+      'removing of none role' => array($account2, []),
+    );
+  }
+
+}
+

tests/src/Integration/RulesUserIntegrationTestTrait.php

@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Tests\rules\Integration\RulesUserIntegrationTestTrait.
+ */
+
+namespace Drupal\Tests\rules\Integration;
+
+/**
+ * Base class for Rules integration tests with user entities.
+ */
+trait RulesUserIntegrationTestTrait {
+
+  /**
+   * Creates a mocked user.
+   *
+   * @return \Drupal\user\UserInterface
+   *   The mocked user.
+   */
+  protected function getMockedUser() {
+    return $this->getMock('Drupal\user\UserInterface');
+  }
+
+  /**
+   * Creates a mocked user role.
+   *
+   * @param string $name
+   *   The machine-readable name of the mocked role.
+   *
+   * @return \Drupal\user\RoleInterface|\PHPUnit_Framework_MockObject_MockBuilder
+   *   The mocked role.
+   */
+  protected function getMockedUserRole($name) {
+    $role = $this->getMockBuilder('Drupal\user\RoleInterface')
+      ->getMock();
+
+    $role->expects($this->any())
+      ->method('id')
+      ->will($this->returnValue($name));
+
+    return $role;
+  }
+
+}