Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rich Text: Apply attributes properly #15070

Merged
merged 10 commits into from
Apr 24, 2019
Merged

Rich Text: Apply attributes properly #15070

merged 10 commits into from
Apr 24, 2019

Conversation

technote-space
Copy link
Contributor

@technote-space technote-space commented Apr 19, 2019 •
edited
Loading

Description

This PR fixes #14858

How has this been tested?

  • I added a test case
    • Both current and future include node which
      • is same node name
      • is not text node
      • has multiple attributes
const cases = [

...

	{
		current: 'test1 <span data-current-attribute1="current1" data-current-attribute2="current2">test2</span> <span>test3</span>',
		future: 'test1 test2 <span data-future-attribute1="future1" data-future-attribute2="future2">test3</span>',
		movedCount: 1,
		description: 'should apply attributes',
	},
];

This test will cover this section
https://github.com/WordPress/gutenberg/blob/release/5.5/packages/rich-text/src/to-dom.js#L206-L230

before fix:

    Difference:

    - Expected
    + Received

    - test1 test2 <span data-future-attribute1="future1" data-future-attribute2="future2">test3</span>
    + test1 test2 <span data-current-attribute2="current2" data-future-attribute1="future1" data-future-attribute2="future2">test3</span>

after fix:

  applyValue
    ✓ should remove nodes (1ms)
    ✓ should add nodes (1ms)
    ✓ should not modify (1ms)
    ✓ should apply attributes (4ms)

Screenshots

before
before

after
after

Types of changes

Bug fix

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.

@technote-space technote-space mentioned this pull request Apr 19, 2019
Closed
@ellatrix ellatrix added the [Package] Rich text /packages/rich-text label Apr 19, 2019
ellatrix
ellatrix reviewed Apr 24, 2019
View reviewed changes
packages/rich-text/src/test/to-dom.js
},
{
current: '<span data-1="" data-2="">b</span>',
future: '<span>b</span>',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case anyone was wondering, this test case would fail in master. Added a comment: https://github.com/WordPress/gutenberg/pull/15070/files#diff-829f9f4e942450ee8c33f082c016b173R212.

ellatrix
ellatrix approved these changes Apr 24, 2019
View reviewed changes
Copy link
Member

@ellatrix ellatrix left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @technote-space! I cleaned up the tests a bit so it's easier to see what is happening. I also swapped out the reverse for loop for a simpler while loop.

@ellatrix
Copy link
Member

Alternatively we could have copied the attributes to an array, but the reverse loop is faster. :)

@ellatrix ellatrix merged commit e5c1b8c into WordPress:master Apr 24, 2019
@technote-space technote-space deleted the fix/14858 branch April 24, 2019 13:31
@aduth aduth added the [Type] Bug An existing feature does not function as intended label Apr 29, 2019
This was referenced Apr 29, 2019
Merged
Merged
@youknowriad youknowriad added this to the 5.6 (Gutenberg) milestone May 13, 2019
This was referenced Sep 12, 2024
Open
Open
This was referenced Sep 14, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ellatrix ellatrix ellatrix approved these changes

@aduth aduth Awaiting requested review from aduth

@jorgefilipecosta jorgefilipecosta Awaiting requested review from jorgefilipecosta

@youknowriad youknowriad Awaiting requested review from youknowriad

Assignees
No one assigned
Labels
[Package] Rich text /packages/rich-text [Type] Bug An existing feature does not function as intended
Projects
None yet
Milestone
5.6 (Gutenberg)
Development

Successfully merging this pull request may close these issues.

Rich Text: Unrelated attributes are applied to Rich Text FormatType
4 participants
@technote-space @ellatrix @youknowriad @aduth