Convert vud widgets into D8 plugins [#1426398]

Problem/Motivation

Embrace D8 API.

Proposed resolution

Convert d7 vud widgets implemented as ctools plugins into d8 core plugins.

Remaining tasks

Define the new plugin type vud_widget.
Write a test module containing a vud widget.
Write a test that loads and checks plugin metadata from the defined test module.
Convert all vud widgets into d8 plugins.

User interface changes

None, this is not about UI, but about the underlying internal API.

API changes

Any custom vud widget will need to change entirely to be a d8 plugin of the type that will be defined for vud widgets.

Data model changes

Inherent in the d8 plugin conversion.

Original report by marvil07

So it would be easier to create widgets based on a parent widget, and changing i.e. only the sprite.

Patches welcome

Comment	File	Size	Author
#8	0001-created-vud_widgets-and-the-corresponding-plugins.patch	58.56 KB	sudhanshug
#8	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 1 pass
#7	0001-created-vud_widgets-and-the-corresponding-plugins.patch	58.51 KB	sudhanshug
#7	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 1 fail
#6	4.patch	56.65 KB	sudhanshug
#6	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 No tests found
#4	0001-created-vud_widgets-and-the-corresponding-plugins.patch	36.33 KB	sudhanshug
#4	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 Patch Failed to Apply
#3	example-test-running.patch	598 bytes	marvil07
#3	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 1 pass
#2	0001-created-vud_widgets-and-the-corresponding-plugins.patch	56.66 KB	marvil07
#2	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 No tests found

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

marvil07 CreditAttribution: marvil07 as a volunteer commented 29 May 2017 at 16:42

Title:	Move to oop ctools plugins	» Convert vud widgets into D8 plugins
Version:	7.x-1.x-dev	» 8.x-1.x-dev
Issue summary:	View changes
Parent issue:		» #2844432: Port vud to D8

Re-purposing this ticket as the d8 plugins conversion, since d7 ctools oop will not be done at this point.

Comment #2

marvil07 CreditAttribution: marvil07 as a volunteer commented 7 July 2017 at 14:35

File	Size
0001-created-vud_widgets-and-the-corresponding-plugins.patch	56.66 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 No tests found

A patch from Sudhanshu, let's see how tests are going.

Comment #3

marvil07 CreditAttribution: marvil07 as a volunteer commented 7 July 2017 at 16:46

File	Size
example-test-running.patch	598 bytes
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 1 pass

One example test for Sudhanshu reference.

Comment #4

sudhanshug CreditAttribution: sudhanshug as a volunteer and at Google Summer of Code commented 12 July 2017 at 02:06

File	Size
0001-created-vud_widgets-and-the-corresponding-plugins.patch	36.33 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 Patch Failed to Apply

Queuing the latest changes with Unit test for tests

Comment #5

sudhanshug CreditAttribution: sudhanshug as a volunteer and at Google Summer of Code commented 12 July 2017 at 02:06

Status:

Active

» Needs review

Comment #6

sudhanshug CreditAttribution: sudhanshug as a volunteer and at Google Summer of Code commented 12 July 2017 at 02:45

File	Size
4.patch	56.65 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 No tests found

Queing the complete patch for tests

Comment #7

sudhanshug CreditAttribution: sudhanshug as a volunteer and at Google Summer of Code commented 17 July 2017 at 19:05

File	Size
0001-created-vud_widgets-and-the-corresponding-plugins.patch	58.51 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 1 fail

Comment #8

sudhanshug CreditAttribution: sudhanshug as a volunteer and at Google Summer of Code commented 17 July 2017 at 19:44

File	Size
0001-created-vud_widgets-and-the-corresponding-plugins.patch	58.56 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.4 1 pass

Corrected last patch

Comment #9

marvil07 CreditAttribution: marvil07 as a volunteer commented 17 July 2017 at 23:33

Status:

Needs review

» Needs work

More details on the review, see https://github.com/marvil07/vote_up_down/pull/4#pullrequestreview-50456975

Comment #10

16 August 2017 at 04:05

marvil07 committed de9716e on 8.x-1.x authored by sudhanshug

Issue #1426398 by sudhanshug: Converts vud widgets into D8 plugins.

Comment #11

marvil07 CreditAttribution: marvil07 as a volunteer commented 16 August 2017 at 04:08

Status:

Needs work

» Fixed

After some more back and forth on github, I am happy to incorporate the latest code about this.

Here a script I used to test this code and its output, which suggests more work is needed still, but it probably is about passing the right variables to the template.

Code:

if (!\Drupal::hasService('plugin.manager.vud')) {
    die('cannot find service');
}
echo 'service found' . PHP_EOL;
$vud_manager = \Drupal::service('plugin.manager.vud');

if (!$plain_definition = $vud_manager->getDefinition('plain')) {
    die('cannot find plain widget');
}
echo 'plain widget definition found' . PHP_EOL;

if (!$plain_instance = $vud_manager->createInstance('plain')) {
    die('cannot create plain instance');
}
echo 'plain widget instance created' . PHP_EOL;

$built_widget = $plain_instance->build();
echo 'plain widget could be build' . PHP_EOL;

\Drupal::service('renderer')->renderPlain($built_widget);
echo 'plain widget could be rendered' . PHP_EOL;

Output:

service found
plain widget definition found
plain widget instance created
plain widget could be build
plain widget could be rendered
  <div class="vud-widget vud-widget-plain" id="">
        <a href="" rel="nofollow" class="">
            <span class="" title="Vote up!"></span>
      <div class="element-invisible">Vote up!</div>
          </a>
            <a href="" rel="nofollow" class="">
            <span class="" title="Vote down!"></span>
      <div class="element-invisible">Vote down!</div>
          </a>
              <a href="" rel="nofollow" class="" title="">
        <div class="">
          
        </div>
      </a>
      </div>

Let's continue on a follow-up tickets as needed.