-
Notifications
You must be signed in to change notification settings - Fork 454
Fix page links returning 404 in server mode #1671
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
Open
st0012
wants to merge
2
commits into
master
Choose a base branch
from
fix-server-pages-404
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+86
−5
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # frozen_string_literal: true | ||
| require_relative 'support/test_case' | ||
|
|
||
| class RDocServerTest < RDoc::TestCase | ||
|
|
||
| def setup | ||
| super | ||
|
|
||
| @dir = Dir.mktmpdir("test_rdoc_server_") | ||
|
|
||
| File.write File.join(@dir, "PAGE.md"), "# A Page\n\nSome content.\n" | ||
| File.write File.join(@dir, "NOTES.rdoc"), "= Notes\n\nSome notes.\n" | ||
| File.write File.join(@dir, "example.rb"), "# A class\nclass Example; end\n" | ||
|
|
||
| @options.files = [@dir] | ||
| @options.op_dir = File.join(@dir, "_site") | ||
| @options.root = Pathname(@dir) | ||
| @options.verbosity = 0 | ||
| @options.finish | ||
|
|
||
| @rdoc.options = @options | ||
| @rdoc.store = RDoc::Store.new(@options) | ||
|
|
||
| capture_output do | ||
| @rdoc.parse_files @options.files | ||
| end | ||
| @rdoc.store.complete @options.visibility | ||
|
|
||
| @server = RDoc::Server.new(@rdoc, 0) | ||
| end | ||
|
|
||
| def teardown | ||
| FileUtils.rm_rf @dir | ||
| super | ||
| end | ||
|
|
||
| def test_route_serves_text_page | ||
| status, content_type, body = @server.send(:route, '/PAGE_md.html') | ||
|
|
||
| assert_equal 200, status | ||
| assert_equal 'text/html', content_type | ||
| assert_include body, 'A Page' | ||
| end | ||
|
|
||
| def test_route_serves_rdoc_text_page | ||
| status, content_type, body = @server.send(:route, '/NOTES_rdoc.html') | ||
|
|
||
| assert_equal 200, status | ||
| assert_equal 'text/html', content_type | ||
| assert_include body, 'Notes' | ||
| end | ||
|
|
||
| def test_route_serves_class_page | ||
| status, content_type, body = @server.send(:route, '/Example.html') | ||
|
|
||
| assert_equal 200, status | ||
| assert_equal 'text/html', content_type | ||
| assert_include body, 'Example' | ||
| end | ||
|
|
||
| def test_route_serves_index | ||
| status, content_type, _body = @server.send(:route, '/') | ||
|
|
||
| assert_equal 200, status | ||
| assert_equal 'text/html', content_type | ||
| end | ||
|
|
||
| def test_route_returns_404_for_missing_page | ||
| status, content_type, _body = @server.send(:route, '/nonexistent.html') | ||
|
|
||
| assert_equal 404, status | ||
| assert_equal 'text/html', content_type | ||
| end | ||
| end |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The method comment is inaccurate/grammatically incorrect:
update_parser_of_filedoes not “set the parser”, it only updates@text_files_hashbased ontop_level.text?(and the sentence is missing “is”: “unless it is from ...”). Also, theparserparameter is unused; consider removing it or renaming to_parserto make the intent clear.