Rector 0.10 with minimal changes. #144

damontgomery · 2021-05-03T21:45:15Z

This is the work in #134, but without the developer tool changes.

Remaining work

If people want to merge this in as a beta release while we work on documentation / support, I'm open to suggestions. See below for a bit more questions around that.

Review from an end user perspective
Review of the README from a getting started perspective
Review of the README from an update perspective
- This needs to be added, particularly moving from .yml to .php for the configuration file
Review of README from a developer perspective
- I think some of the classes have shifted and we should check if any of the documentation in the README references these old processes. I know we had code examples on various videos / blog posts, but not sure about in the repo.
Adding comments back to the default configuration file

Release process request for feedback

Does this make sense as a beta release?

With the changes to the end user and developer experiences, should we coordinate a blog post / video about changes?

Users are often coming across this tool for the first and only time and supporting resources have been helpful in making that a good experience.

Testing notes

Requirements

Drupal Rector needs to be installed as a package on a Drupal 8 site. If you would like to use the drupal-rector-sandbox project, this may make testing easier since it includes a step to link the examples into the modules folder and creates a drupal-rector folder inside the repository where you can use Git to check out branches. If you want to use an existing Drupal 8 project to test this, you will need to update repositories in composer.json and make sure you download this branch.

Set up a local testing environment

Use the drupal-rector-sandbox project, https://github.com/palantirnet/drupal-rector-sandbox
Check out this branch in the drupal-rector-sandbox/drupal-rector folder.
- From within drupal-rector-sandbox, cd drupal-rector
- Use this feature branch
  - git fetch --all
  - git checkout origin/rector-0.10-minimal-changes
Update composer packages on drupal-rector-sandbox
- composer update palantirnet/drupal-rector -W
Copy the new .php configuration file into the sandbox
- rm rector.yml from the drupal-rector-sandbox folder
- cp drupal-rector/rector.php . from the drupal-rector-sandbox folder

End user testing notes

Run vendor/bin/rector process --dry-run web/modules/custom/rector_examples/db_select.php or something similar from drupal-rector-sandbox.

Developer testing notes

Run composer install from the drupal-rector folder
Run vendor/bin/behat from the drupal-rector folder

Attributions

This is all Matt Glaman's work that was built on the work by Tomas Votruba.

Matt also included a lot of great automated testing / developer tools. Unfortunately, I was not able to get them to work myself, so I wanted to include the work I could verify and keep the (probably temporary) functional Behat tests so that I could test locally / on Github Actions.

If anyone would like to help with the update to the tools that Matt worked on including testing and documentation, it would be greatly appreciated.

# Conflicts: # .editorconfig # composer.json # config/drupal-8/drupal-8.0-deprecations.yml

Also adds PHPStan workflow to catch unused calls.

Trying to see if this may work with just the rector changes.

Remove ones missed in the last commit and update the functional test.

/drupal-rector /web

goba · 2021-05-05T07:29:43Z

Not sure of the status of this. I see it was cut back, which I generally agree makes reviewing easier. There was lots of testing of the other PR though at DrupalCon, etc. Do we consider that covered this or does this need more eyes?

damontgomery · 2021-05-05T14:51:01Z

@goba,

I think it would be good to get a few additional people to run the tool locally to see if it works as expected.

It sounds like people were able to provide feedback from the end user perspective.

I'll add a few remaining tasks to the description and I can probably take a look next week.

KarinG · 2021-05-10T15:31:29Z

@damontgomery - I am a dev and a user: I'm a Drupal module maintainer.

I successfully used Drupal rector last year to help get our code base from D8->D9 and I was able to easily install @mglaman 's #134 PR during DrupalCon -> and with that PR I was able to successfully run rector on a number of Drupal module projects - including a sizeable one like Webform module and our own Webform CiviCRM module. And yes I did this on a Drupal 8 site (same infra/dev I had previously used Matt's PR on).

I really just tried testing this PR b/c @goba asked me to do so. Sorry I couldn't get it working.

damontgomery · 2021-05-10T15:53:48Z

Thanks again for the feedback, @KarinG.

shaal · 2021-05-10T18:52:40Z

👍
I tested this PR the same way I tested #134 before, and it ran successfully 💯

Testing Instructions

Open a Drupal project (I used DDEV + Gitpod)
https://gitpod.io/#https://github.com/shaal/ddev-gitpod

Important: Make sure it's Drupal 8 (and NOT Drupal 9)

ddev composer require "drupal/core-recommended:^8.9" "drupal/core-project-message:^8.9" "drupal/core-composer-scaffold:^8.9"

Configure it to use latest drupal-rector

ddev composer config repositories.1 vcs https://github.com/palantirnet/drupal-rector.git

Require the specific branch for this PR

ddev composer require palantirnet/drupal-rector:dev-rector-0.10-minimal-changes

Configure it

cp vendor/palantirnet/drupal-rector/rector.php .

Grab the example

cp -r vendor/palantirnet/drupal-rector/rector_examples web/modules/
php vendor/bin/rector process web/modules/rector_examples --dry-run

Or test with your own modules

php vendor/bin/rector process web/modules/custom --dry-run

damontgomery · 2021-05-10T18:56:28Z

Thanks for testing @shaal and for the testing notes!

mglaman

Cursory overview, it contains the right stuff 👍

agentrickard · 2021-06-04T15:35:56Z

I have created a Drupal.org issue to cover this PR, and recommend that we merge it as a 0.10.x branch, pinned to main here.

https://www.drupal.org/project/rector/issues/3217419

TomasVotruba and others added 30 commits September 12, 2020 22:32

composer: update rector to 0.8

17b36a4

switch configs from YML to PHP

9732bf1

drop duplicated info in editorconfig

e1e09b0

Add phpstan and rector dev trunk

b6ad9c8

Merge branch 'rector-08' into rector-0.10

4964e07

# Conflicts: # .editorconfig # composer.json # config/drupal-8/drupal-8.0-deprecations.yml

Add back EntityDeleteMultipleRector

c043b05

Update rule definitions for Rector 0.10

e02f8cc

Fix remaining usages of Option::EXCLUDE_PATHS

541584c

Also adds PHPStan workflow to catch unused calls.

PHPStan workflow to catch unused calls.

f29c567

Add PHPUnit and initial test

669038d

Update local packages flow

7c81ed4

Handle ~/drupal in specific workflow

ece4915

Normalize GitHub flows

d763416

Add PHPUnit flow, move deprecation-index tests to PHPUnit

f72dfaa

Move away from Behat and to specific commands

dcb66ff

Must add php suffix

41e9587

Run with debug, remove duplicated core discovery

6a58e12

Add missing 8.4 deprecation Rector rules config

c1d9e48

Ensure we load the PHPUnit bootstrap for test class autoloading

4f4c56a

Update the integration test

0eb9c38

Expect dry-run exit code 1

bfacd7d

Remove phpunit bootstrap

3bea584

Update examples_updated for db_*

1d08f2b

Fix comments: parentNode is now just parent

02c49a5

nextNode is just next

9df523a

Fix remaining diff errors

f03df1b

rector/rector:0.10.4 stopped returning applied rectors

ee7c775

Use constants for accessing attribute values

71b077f

Remove include of "core/tests/bootstrap.php"

bd16f1a

0.10.6 restores ability to check file_diffs for applied rules

abd687d

damontgomery added 13 commits May 3, 2021 15:41

Remove skip option since it doesn't have any values.

48a6b0d

Revert dev tools updates.

d67c9d8

Trying to see if this may work with just the rector changes.

Update Github Actions workflows.

a57d96c

Remove ones missed in the last commit and update the functional test.

DEBUG ENABLED

2a1da72

Remove more pieces that have to do with PhpUnit.

a4b21b1

Get funcitonal test working with config file.

8298f58

Remove debug.

d8d83a1

Enable debug.

cb77631

Have the Github Actions workflow mimic the sandbox.

a1101a5

/drupal-rector /web

debug again...

b804754

Add back the fix for not finding classes.

58539fe

Remove debug...

a4288ea

Remove Behat config since it isn't used.

0e3acf5

damontgomery mentioned this pull request May 3, 2021

Rector 0.10 #134

Closed

2 tasks

damontgomery added the needs-review label May 5, 2021

damontgomery added the work-in-progress label May 5, 2021

This comment has been minimized.

Sign in to view

mglaman approved these changes May 10, 2021

View reviewed changes

damontgomery added the help wanted Extra attention is needed label Jun 3, 2021

agentrickard merged commit a2a0a38 into master Jun 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rector 0.10 with minimal changes. #144

Rector 0.10 with minimal changes. #144

damontgomery commented May 3, 2021 •

edited

Loading

goba commented May 5, 2021

damontgomery commented May 5, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

KarinG commented May 10, 2021

damontgomery commented May 10, 2021

shaal commented May 10, 2021

damontgomery commented May 10, 2021

mglaman left a comment

agentrickard commented Jun 4, 2021

Rector 0.10 with minimal changes. #144

Rector 0.10 with minimal changes. #144

Conversation

damontgomery commented May 3, 2021 • edited Loading

Remaining work

Release process request for feedback

Testing notes

Requirements

Set up a local testing environment

End user testing notes

Developer testing notes

Attributions

goba commented May 5, 2021

damontgomery commented May 5, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

KarinG commented May 10, 2021

damontgomery commented May 10, 2021

shaal commented May 10, 2021

Testing Instructions

damontgomery commented May 10, 2021

mglaman left a comment

Choose a reason for hiding this comment

agentrickard commented Jun 4, 2021

damontgomery commented May 3, 2021 •

edited

Loading