Skip to content

Fix metadata link key names #1896

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.

Sign up for GitHub

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

Merged
homu merged 1 commit into from
Apr 19, 2017
Merged

Fix metadata link key names #1896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions lib/rubygems/specification.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,13 +459,13 @@ def files
# documentation, wiki, mailing list, issue tracker and changelog.
#
# s.metadata = {
# "home" => "https://bestgemever.example.io",
# "code" => "https://example.com/user/bestgemever",
# "docs" => "https://www.example.info/gems/bestgemever/0.0.1",
# "wiki" => "https://example.com/user/bestgemever/wiki",
# "mail" => "https://groups.example.com/bestgemever",
# "bugs" => "https://example.com/user/bestgemever/issues",
# "changelog" => "https://example.com/user/bestgemever/CHANGELOG.md"
# "bug_tracker_uri" => "https://example.com/user/bestgemever/issues",
# "changelog_uri" => "https://example.com/user/bestgemever/CHANGELOG.md",
# "documentation_uri" => "https://www.example.info/gems/bestgemever/0.0.1",
# "homepage_uri" => "https://bestgemever.example.io",
# "mailing_list_uri" => "https://groups.example.com/bestgemever",
# "source_code_uri" => "https://example.com/user/bestgemever",
# "wiki_uri" => "https://example.com/user/bestgemever/wiki"
# }
#
# These links will be used on your gem's page on rubygems.org and must pass
Expand Down Expand Up @@ -2846,7 +2846,15 @@ def validate packaging = true

def validate_metadata
url_validation_regex = %r{\Ahttps?:\/\/([^\s:@]+:[^\s:@]*@)?[A-Za-z\d\-]+(\.[A-Za-z\d\-]+)+\.?(:\d{1,5})?([\/?]\S*)?\z}
link_keys = ["home", "code", "docs", "wiki", "mail", "bugs", "changelog"]
link_keys = %w(
bug_tracker_uri
changelog_uri
documentation_uri
homepage_uri
mailing_list_uri
source_code_uri
wiki_uri
)

metadata.each do|key, value|
if !key.kind_of?(String)
Expand Down
10 changes: 7 additions & 3 deletions test/rubygems/test_gem_specification.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3251,7 +3251,11 @@ def test_metadata_validates_ok
Dir.chdir @tempdir do
@m1 = quick_gem 'm', '1' do |s|
s.files = %w[lib/code.rb]
s.metadata = { "one" => "two", "home" => "https://example.com/user/repo" }
s.metadata = {
"one" => "two",
"home" => "three",
"homepage_uri" => "https://example.com/user/repo"
}
end

use_ui @ui do
Expand Down Expand Up @@ -3334,14 +3338,14 @@ def test_metadata_link_validation_fails
Dir.chdir @tempdir do
@m2 = quick_gem 'm', '2' do |s|
s.files = %w[lib/code.rb]
s.metadata = { 'home' => 'http:/example.com' }
s.metadata = { 'homepage_uri' => 'http:/example.com' }
end

e = assert_raises Gem::InvalidSpecificationException do
@m2.validate
end

assert_equal "metadata['home'] has invalid link: \"http:/example.com\"", e.message
assert_equal "metadata['homepage_uri'] has invalid link: \"http:/example.com\"", e.message
end
end

Expand Down