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.

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

Refactor DashToSeparator Filter #184

Merged
merged 3 commits into from
Oct 23, 2024
Merged

Conversation

ramchale
Copy link
Contributor

@ramchale ramchale commented Oct 23, 2024

Q A
Documentation no
Bugfix no
BC Break yes
New Feature no
RFC no
QA no

Description

Refactoring DashToSeparator based on #177

@ramchale
Copy link
Contributor Author

ramchale commented Oct 23, 2024

Opening a Draft to seek feedback before I progress this any further. Could you let me know if this is broadly what you had in mind please?

Copy link
Member

@gsteel gsteel left a comment

Choose a reason for hiding this comment

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

Thanks @ramchale :)

Ideally, each filter refactor should be accompanied by changes to the docs too - Here's an example and a companion patch targeting the next 2.x minor with the relevant deprecations, like this one

src/Word/DashToSeparator.php Outdated Show resolved Hide resolved
src/Word/DashToSeparator.php Outdated Show resolved Hide resolved
src/Word/DashToSeparator.php Outdated Show resolved Hide resolved
src/Word/DashToSeparator.php Outdated Show resolved Hide resolved
src/Word/DashToSeparator.php Outdated Show resolved Hide resolved
@gsteel gsteel added this to the 3.0.0 milestone Oct 23, 2024
- Use ScalarOrArrayFilterCallback::applyRecursively
- Remove setSeparator and getSeparator
- Add to migration doc
- Update usage doc to remove construction without Options array

Signed-off-by: ramchale <[email protected]>
@ramchale
Copy link
Contributor Author

Thanks. I've updated that in line with the suggestions, let me know if further changes are needed. I'll open a corresponding deprecation branch against the current minor branch when I get a little bit of time

Copy link
Member

@gsteel gsteel left a comment

Choose a reason for hiding this comment

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

Just one tweak to the docs, otherwise LGTM!

docs/book/v3/word.md Outdated Show resolved Hide resolved
@gsteel gsteel changed the title Remove inheritance chain from DashToSeparator Refactor DashToSeparator Filter Oct 23, 2024
Co-authored-by: George Steel <[email protected]>
Signed-off-by: Richard McHale <[email protected]>
@ramchale ramchale marked this pull request as ready for review October 23, 2024 10:31
Copy link
Member

@gsteel gsteel left a comment

Choose a reason for hiding this comment

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

Thank you @ramchale :)

@gsteel gsteel self-assigned this Oct 23, 2024
@gsteel gsteel merged commit dbad5e6 into laminas:3.0.x Oct 23, 2024
16 of 17 checks passed
@gsteel gsteel mentioned this pull request Oct 25, 2024
54 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants