Support Whitehall blockquote changes #81
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # will be formatted to: | ||
| # > test | ||
| def self.remove(source) | ||
| return nil if source.nil? |
This introduces a PostProcessor class which can perform the post processing tasks. The first task in this is one to add set the last <p> within a blockquote to have a class of 'last-child'
Notably nokogiri converts HTML entities into UTF-8 characters where appropriate and changes numeric entities into symbolic ones. This has left us with a broken test.
Importing the blockquote extra removal class from Whitehall. The tests have been maintained as per those in Whitehall. It does look like there are likely a number of problems within this function and tests: - It likely catches items on a single line which would not be rendered in a blockquote if there is not a line break before them - It seems to handle quotes within the blockquote outside of the condition here poorly. In a number of cases it looks like tests have been planned for them to work properly but wasn't implemented. Due to this being planned for consistency with Whitehall I'm reluctant to change behaviour here in case that causes backwards compatibility issues.
This isn't particularly nice as unlike the other extensions this is applied to the whole body rather than a matched section. Thus this is applied outside of the extension system.
Prior to post-processing being introduced to govspeak we had the ability to specify the entity_output of the HTML. By using nokogiri to format to format the HTML we lose the ability to do this as nokogiri will automatically perform conversions to the entities. In cases where nokogiri encounters a encoded HTML entity that it can safely output as a utf-8 character it will automatically replace the entity with the character. For example: `¥` is converted to `¥` In cases where nokogiri encounters a numeric HTML entity it will convert that into a symbolic one. For example: `>` is converted to `>` I haven't found any instances where our applications are using the `:numeric` option and believe it was only introduced as an option as a side effect of a different change, rather than being something that was required: 74ea8c7
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces two features of whitehall related to blockquotes, both are somewhat interesting and potentially contentious.
1. Removing quotes from blockquotes
These are removed as quotes are added automatically as part of styling on the frontend. It will change markdown of
> "test"to> test.As this was a global applying of a function I placed it outside the extension system as it didn't have a regexp to match - this doesn't feel a very nice way to handle it though, so I welcome suggestions on how to improve this.
This also may not work particularly well. I've used the same code as Whitehall so it has full compatibility, but it does look like there are some dodgy ways it can run.
2. adding a class to the last
<p>element within a blockquote.For example:
becomes:
To achieve this we've used nokogiri as per the implementation on Whitehall. This has had a number of side effects:
¥is returned as¥>is returned as>For this feature I've added a PostProcessor class which has a similar extension system to that of the extensions within the main govspeak class, a key difference however being that these are performed on the entire body rather than a matched section. It has the potential though that this could be changed to match a css selector to scope the nokogiri elements coming in.