(PDOC-25) Fix mangled puppet namespaces #27
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
Prior to this commit, puppet namespaces would be totally mangled when processed by YARD since YARD is looking for Ruby namespaces where the first letter of each segment must be uppercase. In order to fix this, patch the relevant regular expression constants in YARD so that they will accept segments that begin with uppercase and lowercase letters. An upstream pull request has been accepted into YARD to add another regex constant which is necessary to complete this patch. However until the next version of the YARD gem is released, we must include a temporary hack to fix the problematic method in question (as it is not yet using the added variable). Once the new version is released, the conditional statement in code_ext/yard.rb can be removed entirely and all we will need to do is patch the two regex constants.
|
Actually, please don't merge this just yet. I want to add a quick test to prevent regressions. |
Prior to this commit, there were no tests to check if namespaces were being properly generated (which was why we did not catch the bug earlier). Add a test for defined type and host class handlers to ensure that namespaces are properly generated in code objects.
|
Okay, this is ready for review! 👍 |
hlindberg
added a commit
that referenced
this pull request
Mar 13, 2015
…d_namespaces (PDOC-25) Fix mangled puppet namespaces
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Prior to this commit, puppet namespaces would be totally mangled when
processed by YARD since YARD is looking for Ruby namespaces where the
first letter of each segment must be uppercase.
In order to fix this, patch the relevant regular expression constants
in YARD so that they will accept segments that begin with uppercase
and lowercase letters.
An upstream pull request has been accepted into YARD to add another
regex constant which is necessary to complete this patch. However until
the next version of the YARD gem is released, we must include a temporary
hack to fix the problematic method in question (as it is not yet using
the added variable). Once the new version is released, the conditional
statement in code_ext/yard.rb can be removed entirely and all we will
need to do is patch the two regex constants.