(PDOC-122) Properly parse newfunction calls with newlines
#110
Conversation
This file contains hidden or 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
When `newfunction` is separated from the Puppet::Parser::Functions module name by a newline, YARD ignores the namespace and uses `newfunction` as the source of the first statement. Prior to this commit, strings didn't recognize this case, and 3.x functions written in this way were not parsed as functions. This commit updates the ruby function handler to identify and properly parse 3.x functions that include a newline between the Puppet::Parser::Function namespace and the newfunction method call.
|
/cc @peterhuene (I'm only picking on you because Jesse is out on vacation :)) Note also that this weird newline business is actually how we still document writing 3.x functions: https://docs.puppet.com/guides/custom_functions.html#first-function-----small-steps |
whopper
commented
Oct 10, 2016
| return unless statement.count > 1 | ||
| module_name = statement[0].source | ||
| return unless module_name == 'Puppet::Functions' || module_name == 'Puppet::Parser::Functions' | ||
| return unless module_name == 'Puppet::Functions' || module_name == 'Puppet::Parser::Functions' || module_name == 'newfunction' |
There was a problem hiding this comment.
Naming is hard. If statement[0] is newfunction, it's not really a module name. Worth renaming?
peterhuene
approved these changes
Oct 10, 2016
| return unless statement.count > 1 | ||
| module_name = statement[0].source | ||
| return unless module_name == 'Puppet::Functions' || module_name == 'Puppet::Parser::Functions' | ||
| return unless module_name == 'Puppet::Functions' || module_name == 'Puppet::Parser::Functions' || module_name == 'newfunction' |
|
👍 although Ruby developers that open a module to invoke a function on it... |
|
We should open a ticket to update the documentation to rid ourselves of that bad style. |
er0ck
reviewed
Oct 11, 2016
| expect(tags[0].text).to eq('public') | ||
| end | ||
| end | ||
|
|
There was a problem hiding this comment.
yay. looks good to me. no need for acceptance
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.
When
newfunctionis separated from the Puppet::Parser::Functions module name by anewline, YARD ignores the namespace and uses
newfunctionas the source of thefirst statement.
Prior to this commit, strings didn't recognize this case, and 3.x functions written
in this way were not parsed as functions. This commit updates the ruby function handler
to identify and properly parse 3.x functions that include a newline between the
Puppet::Parser::Function namespace and the newfunction method call.