Rewrite http:// URLs to https:// - #1669
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to modernize references by rewriting http:// URLs to https:// across the gemspec, docs, templates, and specs.
Changes:
- Updated project metadata/documentation links from
http://tohttps://. - Updated various test fixtures/specs to expect
https://URLs. - Updated several templates and server messaging to display
https://URLs.
Reviewed changes
Copilot reviewed 34 out of 34 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| yard.gemspec | Updates gem homepage URL to HTTPS. |
| templates/guide/layout/html/layout.erb | Rewrites W3C identifiers/namespace to HTTPS (includes an XHTML namespace change). |
| templates/default/onefile/html/layout.erb | Rewrites W3C identifiers/namespace to HTTPS (includes an XHTML namespace change). |
| lib/yard/server/templates/doc_server/library_list/html/library_list.erb | Rewrites W3C identifiers/namespace to HTTPS (includes an XHTML namespace change). |
| lib/yard/server/rack_adapter.rb | Changes the printed server URL scheme to HTTPS. |
| lib/yard/cli/diff.rb | Uses HTTPS for rubygems download URLs. |
| lib/yard/server/library_version.rb | Updates example download URL to HTTPS. |
| lib/yard/parser/ruby/ruby_parser.rb | Updates referenced bug tracker URL to HTTPS. |
| lib/yard/i18n/pot_generator.rb | Updates gettext manual URL to HTTPS. |
| lib/yard/i18n/locale.rb | Updates IETF reference URL to HTTPS. |
| lib/yard/code_objects/proxy.rb | Updates referenced gist URL to HTTPS. |
| lib/yard/templates/helpers/base_helper.rb | Updates doc example URL to HTTPS. |
| lib/yard/tags/library.rb | Updates doc example URLs to HTTPS. |
| README.md | Updates badge/documentation links to HTTPS and changes yard server example URL to HTTPS. |
| docs/WhatsNew.md | Updates various links to HTTPS and changes yard server default URL to HTTPS. |
| docs/Tags.md | Updates yardoc.org/types link to HTTPS (and removes trailing blank line). |
| docs/GettingStarted.md | Updates multiple reference/example URLs to HTTPS. |
| CONTRIBUTING.md | Updates contributor reference links to HTTPS. |
| CHANGELOG.md | Updates tadpole link to HTTPS. |
| spec/templates/tag_spec.rb | Updates @see URL examples to HTTPS. |
| spec/templates/markup_processor_integrations/markdown_spec.rb | Updates autolink expectation to HTTPS. |
| spec/templates/helpers/markup/rdoc_markup_spec.rb | Updates href example to HTTPS. |
| spec/templates/helpers/html_syntax_highlight_helper_spec.rb | Updates URL in syntax highlight expectation to HTTPS. |
| spec/templates/helpers/html_helper_spec.rb | Updates various link expectations to HTTPS (introduces a duplicated “https” wording and duplicate assertion). |
| spec/templates/helpers/base_helper_spec.rb | Updates URL scheme expectations to HTTPS. |
| spec/templates/examples/tag001.txt | Updates fixture URLs to HTTPS. |
| spec/templates/examples/class001.txt | Updates fixture URLs to HTTPS. |
| spec/templates/examples/class001.html | Updates fixture URLs to HTTPS. |
| spec/templates/class_spec.rb | Updates @see URL example to HTTPS. |
| spec/tags/library_spec.rb | Updates URL parsing expectations to HTTPS. |
| spec/spec_helper.rb | Updates RSpec reference links in comments to HTTPS. |
| spec/parser/examples/array.c.txt | Updates embedded reference links to HTTPS. |
| spec/cli/diff_spec.rb | Updates expected rubygems download URLs to HTTPS. |
| po/ja.po | Updates many embedded URLs to HTTPS (also changes yard server default URL and contains a gist-id mismatch between msgid/msgstr). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | ||
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | ||
| "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
There was a problem hiding this comment.
The XHTML namespace URI should remain http://www.w3.org/1999/xhtml. Changing xmlns to an https URL changes the document namespace and can break XHTML tooling/validation and consumers that expect the standard XHTML namespace.
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | ||
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | ||
| "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
There was a problem hiding this comment.
The XHTML namespace URI should remain http://www.w3.org/1999/xhtml. Switching the xmlns attribute to https://... changes the namespace (it’s an identifier, not a fetch URL) and can break XHTML consumers/validation.
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | ||
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | ||
| "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
There was a problem hiding this comment.
The XHTML namespace URI should remain http://www.w3.org/1999/xhtml. Updating the xmlns value to https://... changes the namespace and can break XHTML validation/consumers.
| msgid "" | ||
| "The new `yard server` command spawns a documentation server that can serve\n" | ||
| "either documentation for a local project or installed RubyGems. The server\n" | ||
| "will host (by default) on http://localhost:8808." | ||
| "will host (by default) on https://localhost:8808." | ||
| msgstr "" | ||
| "新しい`yard server`コマンドは\n" | ||
| "ローカルプロジェクトや既存のRubyGems用の全てのドキュメントを提供できる\n" | ||
| "ドキュメントサーバーを生みだす。\n" | ||
| "サーバーはhttp://localhost:8808のホスト(デフォルトで)になる。" | ||
| "サーバーはhttps://localhost:8808のホスト(デフォルトで)になる。" |
There was a problem hiding this comment.
The translated strings now state the default yard server URL is https://localhost:8808, but the server is plain HTTP by default. This should remain http://localhost:8808 (or be reworded to indicate HTTPS only applies with external TLS).
| # @note | ||
| #: ../lib/yard/code_objects/proxy.rb:218 | ||
| msgid "this method fixes a bug in 1.9.2: http://gist.github.com/437136" | ||
| msgid "this method fixes a bug in 1.9.2: https://gist.github.com/437136" | ||
| msgstr "" | ||
| "このメソッドはバグを修正する。\n" | ||
| "(in 1.9.2: http://gist.github.com/4371369)" | ||
| "(in 1.9.2: https://gist.github.com/4371369)" |
There was a problem hiding this comment.
The msgid URL (https://gist.github.com/437136) and the msgstr URL (https://gist.github.com/4371369) now disagree. This looks like a typo in one of the gist IDs; they should refer to the same URL so translations don’t diverge unexpectedly.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
References: #1601, #1675, #1656, #1665, #1666, #1655, #1582, #1674, #1673, #1664, #1652, #1622, #1672, #1116, #1671, #1547, #1547, #1670, #1669, #1661, #1668, #1661, #1661, #1660, #1639, #1627, #1636, #1528, #1, #1434, #1385, #1294, #1019, #1007, #955, #929, #623, #474, #467, #456, #467, #443, #467, #478, #479, #467, #477, #467, #458, #467, #397, #467, #461, #467, #458, #467, #457, #467, #465, #467, #464, #467, #466, #467, #446, #467, #445, #467, #432, #467
Description
Rewrite http:// to https://