Fix HTML links generated by special resource names #93
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 commit ensures that the links from the
index
page to theexamples
pages of the generated HTML documentation are not brokenwhen the resource name includes special characters like
:
.I'm aware this pull request needs tests to be accepted; however I was not sure how to write the required tests.
I will explain how to reproduce the bug solved by this PR here and hopefully get some feedback on how to write the test (and update this PR accordingly):
example
spec/acceptance/orders_spec.rb
, changingresource "Orders"
toresource "Super::Orders"
rake docs:generate
doc/api/index.html
in the browserCreating an order
super::orders/creating_an_order.html
, that is, it will interpretsuper
as the URL protocol, rather than linking to an HTML file in a subfolderMy commit replaces any non-ASCII character with an underscore, which generates filesystem-acceptable filenames