Add contextual_links_example module for Drupal 8

Started working on this.

Just cleaning. If there is a patch please add it.

Looking into it.

Added the patch for porting contextual links example.

I've rerolled the patch.

Added tests and did a significant amount changes to patch #7, added theme functions, removed unwanted code, corrected code and now it's fully working !

Thanks!

Here's some review. More to come on the test.

1. +++ b/contextual_links_example/contextual_links_example.info.yml
   @@ -0,0 +1,7 @@
   +dependencies:
   +  - drupal:examples
   

   Should require contextual.

2. +++ b/contextual_links_example/src/Entity/CLEEntity.php
   @@ -0,0 +1,48 @@
   + *   handlers = {
   + *     "storage" = "Drupal\contextual_links_example\Storage\CLEStorage"
   + *   },
   
   +++ b/contextual_links_example/src/Storage/CLEStorage.php
   @@ -0,0 +1,117 @@
   +class CLEStorage implements EntityStorageInterface {
   ...
   +    // TODO: Implement resetCache() method.
   ...
   +    // TODO: Implement loadMultiple() method.
   ...
   +    // TODO: Implement load() method.
   ...
   +    // TODO: Implement loadUnchanged() method.
   ...
   +    // TODO: Implement loadRevision() method.
   ...
   +    // TODO: Implement deleteRevision() method.
   ...
   +    // TODO: Implement loadByProperties() method.
   ...
   +    // TODO: Implement create() method.
   ...
   +    // TODO: Implement delete() method.
   ...
   +    // TODO: Implement save() method.
   ...
   +    // TODO: Implement getQuery() method.
   ...
   +    // TODO: Implement getAggregateQuery() method.
   ...
   +    // TODO: Implement getEntityTypeId() method.
   ...
   +    // TODO: Implement getEntityType() method.
   

   Why do we have a storage class if it's just a stub implementation?

3. +++ b/contextual_links_example/tests/src/Functional/ContextualLinksExampleTest.php
   @@ -0,0 +1,79 @@
   +  public static $modules = ['contextual', 'contextual_links_example'];
   

   Should not require contextual here.

1. +++ b/contextual_links_example/src/Controller/CLEController.php
   @@ -0,0 +1,55 @@
   +  public function cleContent(int $entity_id) {
   

   Can't typehint int for PHP 5.5.

2. +++ b/contextual_links_example/src/Plugin/Block/CLEBlock.php
   @@ -0,0 +1,40 @@
   +class CLEBlock extends BlockBase {
   

   This block never shows up in the block admin page.

As for the tests.... Based on Drupal\Tests\contextual\FunctionalJavascript\ContextualLinksTest, it seems we'll need to inherit from JavascriptTestBase to get the click that opens the contextual menu.

That needs some local dev environment setup: https://www.drupal.org/docs/8/phpunit/phpunit-javascript-testing-tutorial

Hey @Mile23, thank you very much your review.

Yes, Storage class is just a stub implementation.

I will work upon for other changes.

@Mile23

+++ b/contextual_links_example/src/Plugin/Block/CLEBlock.php
@@ -0,0 +1,40 @@
+class CLEBlock extends BlockBase {
This block never shows up in the block admin page.

This does show up. You will have to place it using Block Interface UI.

I am doing something wrong here,

@Mil23, after observing html results of tests, I observed that contextual links doesn't render on minimal profile . I having less knowledge on how to proceed in this scenario. How can we proceed with tests ?

See #15. Contextual menus are javascript-based, so we have to use functional javascript tests. Here's a test from core: http://cgit.drupalcode.org/drupal/tree/core/modules/contextual/tests/src...

First attempt for javascript functional test.

+++ b/contextual_links_example/tests/src/FunctionalJavascript/ContextualLinksExampleTest.php
@@ -0,0 +1,77 @@
+    $actionContextualLink = $assert->waitForElement('css', '.contextual-links-exampleexample-action');

Are you sure this class exists?

@Mile23 yes! I am attaching a screenshot of HTML output of JS test.

Everything needs to be perfect for tests to pass !

A minor adjustment

I have dropped t() in favour of $this->t().

+++ b/contextual_links_example/contextual_links_example.info.yml
@@ -0,0 +1,10 @@
+  - drupal:examples

Thank you @martin. Oops! My bad. Updating it to examples:examples

Coming along...

1. +++ b/contextual_links_example/contextual_links_example.module
   @@ -0,0 +1,30 @@
   +/**
   + * @file
   + * Shows how to use Drupal's contextual links functionality.
   + *
   + * @see https://www.drupal.org/docs/8/api/menu-api/providing-module-defined-contextual-links
   + */
   

   Needs @defgroup, and an explanation of what this module does and how it does it.

2. +++ b/contextual_links_example/src/Controller/CLEController.php
   @@ -0,0 +1,55 @@
   +  public function clePage() {
   

   We should have some text on this page to explain what's being accomplished, generally how it works, and what to look at next for specifics.

3. +++ b/contextual_links_example/src/Controller/CLEController.php
   @@ -0,0 +1,55 @@
   +    // For simplicity we hardcode an array of CLEEntity ids.
   +    $entity_ids = [1, 2, 3, 4, 5];
   

   I doubt these ids will always be the same. We should just load all the CLEEntity objects that are available.

4. +++ b/contextual_links_example/src/Controller/CLEController.php
   @@ -0,0 +1,55 @@
   +      // See \Drupal\contextual\Element\ContextualLinks.
   

   Should be @see and not have a period at the end.

5. +++ b/contextual_links_example/src/Entity/CLEEntity.php
   @@ -0,0 +1,48 @@
   + *     "storage" = "Drupal\contextual_links_example\Storage\CLEStorage"
   
   +++ b/contextual_links_example/src/Storage/CLEStorage.php
   @@ -0,0 +1,117 @@
   +    // TODO: Implement resetCache() method.
   ...
   +    // TODO: Implement loadMultiple() method.
   ...
   +    // TODO: Implement load() method.
   ...
   +    // TODO: Implement loadUnchanged() method.
   ...
   +    // TODO: Implement loadRevision() method.
   ...
   +    // TODO: Implement deleteRevision() method.
   ...
   +    // TODO: Implement loadByProperties() method.
   ...
   +    // TODO: Implement create() method.
   ...
   +    // TODO: Implement delete() method.
   ...
   +    // TODO: Implement save() method.
   ...
   +    // TODO: Implement getQuery() method.
   ...
   +    // TODO: Implement getAggregateQuery() method.
   ...
   +    // TODO: Implement getEntityTypeId() method.
   ...
   +    // TODO: Implement getEntityType() method.
   

   Is there not a generic entity base implementation we can use instead?

6. +++ b/contextual_links_example/src/Form/ContextualLinksExampleNodeActionForm.php
   @@ -0,0 +1,129 @@
   + * @package Drupal\contextual_links_example\Form
   

   We don't use @package.

working on it

Still stuck with issue #5 and #3

+++ b/contextual_links_example/src/Controller/CLEController.php
@@ -0,0 +1,68 @@
+    $build[]=[

Not a correct way of doing this.

Use DescriptionTemplateTrait and $this->description to add in build array.

+++ a/examples.module
@@ -39,7 +39,6 @@
-    'contextual_links_example' => 'contextual_links_example.contextual_links_object_list',

Please do not remove this.

+++ b/contextual_links_example/tests/src/Functional/ContextualLinksExampleTest.php
@@ -0,0 +1,79 @@
+<?php
+
+namespace Drupal\Tests\contextual_links_example\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+
+/**
+ * Tests the behavior of the contextual links provided by the module.

Did you change something in tests ?

Need to fix few more issues

Just fixed a few coding standard nits while reading along.

OK, so we have way too much stuff here just to implement an entity that we can't edit.

The storage class doesn't actually do anything.

This patch adds a test that demonstrates that we can't save our new entity.

So let's rescope a bit.

Let's add a contextual link implementation to the content entity example.

This means we can get rid of all the entity implementation details from this patch, and worry instead about adding contextual links.

Hah. Forgot the patch.

Moving to new examples meta