Issue #2375589 by larowlan, pameeela, jibran, kim.pepper, Wim Leers, Bojhan:...

Issue #2375589 by larowlan, pameeela, jibran, kim.pepper, Wim Leers, Bojhan: Convert custom block library page to views

core/modules/block_content/src/BlockContentViewsData.php

@@ -28,6 +28,13 @@ public function getViewsData() {
 
     $data['block_content_field_data']['type']['field']['id'] = 'field';
 
+    $data['block_content']['block_content_listing_empty'] = array(
+      'title' => t('Empty block library behavior'),
+      'help' => t('Provides a link to add a new block.'),
+      'area' => array(
+        'id' => 'block_content_listing_empty',
+      ),
+    );
     // Advertise this table as a possible base table.
     $data['block_content_revision']['table']['base']['help'] = $this->t('Block Content revision is a history of changes to block content.');
     $data['block_content_revision']['table']['base']['defaults']['title'] = 'info';

core/modules/block_content/src/Plugin/views/area/ListingEmpty.php

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\block_content\Plugin\views\area\ListingEmpty.
+ */
+
+namespace Drupal\block_content\Plugin\views\area;
+
+use Drupal\Core\Access\AccessManagerInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\Url;
+use Drupal\views\Plugin\views\area\AreaPluginBase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Defines an area plugin to display a block add link.
+ *
+ * @ingroup views_area_handlers
+ *
+ * @ViewsArea("block_content_listing_empty")
+ */
+class ListingEmpty extends AreaPluginBase {
+
+  /**
+   * The access manager.
+   *
+   * @var \Drupal\Core\Access\AccessManagerInterface
+   */
+  protected $accessManager;
+
+  /**
+   * The current user.
+   *
+   * @var \Drupal\Core\Session\AccountInterface
+   */
+  protected $currentUser;
+
+  /**
+   * Constructs a new ListingEmpty.
+   *
+   * @param array $configuration
+   *   A configuration array containing information about the plugin instance.
+   * @param string $plugin_id
+   *   The plugin ID for the plugin instance.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
+   *   The access manager.
+   * @param \Drupal\Core\Session\AccountInterface $current_user
+   *   The current user.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, AccessManagerInterface $access_manager, AccountInterface $current_user) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+
+    $this->accessManager = $access_manager;
+    $this->currentUser = $current_user;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('access_manager'),
+      $container->get('current_user')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function render($empty = FALSE) {
+    if (!$empty || !empty($this->options['empty'])) {
+      /** @var \Drupal\Core\Access\AccessResultInterface|\Drupal\Core\Cache\CacheableDependencyInterface $access_result */
+      $access_result = $this->accessManager->checkNamedRoute('block_content.add_page', array(), $this->currentUser, TRUE);
+      $element = array(
+        '#markup' => $this->t('Add a <a href="!url">custom block</a>.', array('!url' => Url::fromRoute('block_content.add_page')->toString())),
+        '#access' => $access_result->isAllowed(),
+        '#cache' => [
+          'contexts' => $access_result->getCacheContexts(),
+          'tags' => $access_result->getCacheTags(),
+          'max-age' => $access_result->getCacheMaxAge(),
+        ],
+      );
+      return $element;
+    }
+    return array();
+  }
+
+}

core/modules/block_content/src/Tests/BlockContentListTest.php

@@ -7,13 +7,14 @@
 
 namespace Drupal\block_content\Tests;
 
-use Drupal\simpletest\WebTestBase;
-
 /**
  * Tests the listing of custom blocks.
  *
+ * Tests the fallback block content list when Views is disabled.
+ *
  * @group block_content
  * @see \Drupal\block\BlockContentListBuilder
+ * @see \Drupal\block_content\Tests\BlockContentListViewsTest
  */
 class BlockContentListTest extends BlockContentTestBase {
 

core/modules/block_content/src/Tests/BlockContentListViewsTest.php

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\block_content\Tests\BlockContentListViewsTest.
+ */
+
+namespace Drupal\block_content\Tests;
+
+/**
+ * Tests the Views-powered listing of custom blocks.
+ *
+ * @group block_content
+ * @see \Drupal\block\BlockContentListBuilder
+ * @see \Drupal\block_content\Tests\BlockContentListTest
+ */
+class BlockContentListViewsTest extends BlockContentTestBase {
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  public static $modules = ['block', 'block_content', 'config_translation', 'views'];
+
+  /**
+   * Tests the custom block listing page.
+   */
+  public function testListing() {
+    $this->drupalLogin($this->drupalCreateUser(array('administer blocks', 'translate configuration')));
+    $this->drupalGet('admin/structure/block/block-content');
+
+    // Test for the page title.
+    $this->assertTitle(t('Custom block library') . ' | Drupal');
+
+    // Test for the table.
+    $element = $this->xpath('//div[@class="layout-content"]//table');
+    $this->assertTrue($element, 'Views table found.');
+
+    // Test the table header.
+    $elements = $this->xpath('//div[@class="layout-content"]//table/thead/tr/th');
+    $this->assertEqual(count($elements), 4, 'Correct number of table header cells found.');
+
+    // Test the contents of each th cell.
+    $expected_items = [t('Block description'), t('Block type'), t('Updated'), t('Operations')];
+    foreach ($elements as $key => $element) {
+      if ($element->xpath('a')) {
+        $this->assertIdentical(trim((string) $element->xpath('a')[0]), $expected_items[$key]);
+      }
+      else {
+        $this->assertIdentical(trim((string) $element[0]), $expected_items[$key]);
+      }
+    }
+
+    $label = 'Antelope';
+    $new_label = 'Albatross';
+    // Add a new entity using the operations link.
+    $link_text = t('Add custom block');
+    $this->assertLink($link_text);
+    $this->clickLink($link_text);
+    $this->assertResponse(200);
+    $edit = array();
+    $edit['info[0][value]'] = $label;
+    $edit['body[0][value]'] = $this->randomMachineName(16);
+    $this->drupalPostForm(NULL, $edit, t('Save'));
+
+    // Confirm that once the user returns to the listing, the text of the label
+    // (versus elsewhere on the page).
+    $this->assertFieldByXpath('//td/a', $label, 'Label found for added block.');
+
+    // Check the number of table row cells.
+    $elements = $this->xpath('//div[@class="layout-content"]//table/tbody/tr/td');
+    $this->assertEqual(count($elements), 4, 'Correct number of table row cells found.');
+    // Check the contents of each row cell. The first cell contains the label,
+    // the second contains the machine name, and the third contains the
+    // operations list.
+    $this->assertIdentical((string) $elements[0]->xpath('a')[0], $label);
+
+    // Edit the entity using the operations link.
+    $blocks = $this->container
+      ->get('entity.manager')
+      ->getStorage('block_content')
+      ->loadByProperties(array('info' => $label));
+    $block = reset($blocks);
+    if (!empty($block)) {
+      $this->assertLinkByHref('block/' . $block->id());
+      $this->clickLink(t('Edit'));
+      $this->assertResponse(200);
+      $this->assertTitle(strip_tags(t('Edit custom block %label', array('%label' => $label)) . ' | Drupal'));
+      $edit = array('info[0][value]' => $new_label);
+      $this->drupalPostForm(NULL, $edit, t('Save'));
+    }
+    else {
+      $this->fail('Did not find Albatross block in the database.');
+    }
+
+    // Confirm that once the user returns to the listing, the text of the label
+    // (versus elsewhere on the page).
+    $this->assertFieldByXpath('//td/a', $new_label, 'Label found for updated custom block.');
+
+    // Delete the added entity using the operations link.
+    $this->assertLinkByHref('block/' . $block->id() . '/delete');
+    $delete_text = t('Delete');
+    $this->clickLink($delete_text);
+    $this->assertResponse(200);
+    $this->assertTitle(strip_tags(t('Are you sure you want to delete the custom block %label?', array('%label' => $new_label)) . ' | Drupal'));
+    $this->drupalPostForm(NULL, array(), $delete_text);
+
+    // Verify that the text of the label and machine name does not appear in
+    // the list (though it may appear elsewhere on the page).
+    $this->assertNoFieldByXpath('//td', $new_label, 'No label found for deleted custom block.');
+
+    // Confirm that the empty text is displayed.
+    $this->assertText('There are no custom blocks available.');
+    $this->assertLink('custom block');
+  }
+
+}