Leverage metadata to populate gems urls v2 #1234

kbrock · 2016-03-28T03:53:39Z

High Level Goals

The app knows too much about the url generation process. Provide a decorator versioned_links to simplify this logic.
More importantly: All metadata for a gem comes from the gemspec file except for urls. Provide a mechanism to put urls into the gemspec.

goal 1 makes the process of fetching the urls out of gemspec trivial - 2 lines of change. If we are unsure about #2, then can we at least focus/agree on the first goal?

Commentary

This is an alternative to #724. It is in response to comment from @qrush [here] For implementing #1127 - take urls from rubygems.metadata and retire linkset.

@arthurnn ~~I thought it would be simpler to keep this separate from #724. Let me know if you want me to add metadata (and/or add change log) support directly to this PR.~~ I added in the metadata as the second commit

before:

Links on the pages are generated from Links and Version objects. This is needed because some urls have version.number.
This logic finds it's way into rss, views, helpers, and models. Mostly in rubygems.rb, rubygems_helper.rb, and links.rb.

after:

A decorator LinkedVersion is introduced to simplify the relationship between these objects. Since rss uses this as well, the decorator is kept in app/model/.

future:

Once rubygems.metadata is used by most (all?) gems, drop linkset. (many years from now)

Thanks,
Keenan

UPDATED: hope this is more readable

kbrock · 2016-03-28T13:36:55Z

fixed cops

homu · 2016-05-29T02:14:10Z

☔ The latest upstream changes (presumably #1294) made this pull request unmergeable. Please resolve the merge conflicts.

kbrock · 2016-05-30T01:56:27Z

@arthurnn / @dwradcliffe Any thoughts on this PR?

I separated this into 2 commits.

The first one is consolidating the version specific knowledge while the second one is moving forward on the meta-data route.

If you want me to pull out the first one for now (as it will not actually change any behavior) just let me know.

djberg96 · 2016-07-26T16:02:44Z

@drbrain @qrush @dwradcliffe @bf4 @arthurnn @mpapis @segiddins Any objections?

simi · 2016-07-27T23:17:29Z

What about to move Links model under Rubygem namespace aka Rubygem::Links?

djberg96 · 2016-08-04T14:07:43Z

@simi None of the other models do this.

homu · 2016-11-06T17:12:55Z

☔ The latest upstream changes (presumably #1433) made this pull request unmergeable. Please resolve the merge conflicts.

homu · 2016-11-12T15:59:15Z

☔ The latest upstream changes (presumably #1487) made this pull request unmergeable. Please resolve the merge conflicts.

homu · 2016-11-19T19:44:44Z

☔ The latest upstream changes (presumably #1506) made this pull request unmergeable. Please resolve the merge conflicts.

kbrock · 2016-12-05T23:38:35Z

updated to fix conflict. (had extracted a commit into the separate PR)
also added tests around indexed.

kbrock · 2016-12-22T16:48:37Z

@sonalkr132 / @dwradcliffe would you like me to introduce the Links set as a single pr

This PR is 2 commits:

Create a single model that has the data necessary to represent Links (linkset, version.number, and gemset.name).
Allow Links to also read from version.metadata.

I had thought just consolidating the 2 commits into a single PR would make things simpler for all. But after 10 months, I'm not so sure. And the original PR is even older.

Question: Since the first commit does not change any business logic, would you prefer I pull that out?

homu · 2017-01-06T21:59:27Z

⌛ Testing commit 5c37cc9 with merge 22e08a8...

@qrush

Leverage metadata to populate gems urls v2 ## High Level Goals 1. The app knows too much about the url generation process. Provide a decorator `versioned_links` to simplify this logic. 2. More importantly: All metadata for a gem comes from the `gemspec` file except for urls. Provide a mechanism to put urls into the `gemspec`. goal 1 makes the process of fetching the urls out of gemspec trivial - 2 lines of change. If we are unsure about #2, then can we at least focus/agree on the first goal? ## Commentary This is an alternative to #724. It is in response to comment from @qrush [[here]](#1127 (comment)) For implementing #1127 - take urls from `rubygems.metadata` and retire `linkset`. @arthurnn ~~I thought it would be simpler to keep this separate from #724. Let me know if you want me to add metadata (and/or add change log) support directly to this PR.~~ I added in the metadata as the second commit ## before: Links on the pages are generated from `Links` and `Version` objects. This is needed because some urls have `version.number`. This logic finds it's way into rss, views, helpers, and models. Mostly in `rubygems.rb`, `rubygems_helper.rb`, and `links.rb`. ## after: A decorator `LinkedVersion` is introduced to simplify the relationship between these objects. Since rss uses this as well, the decorator is kept in `app/model/`. ## future: Once `rubygems.metadata` is used by most (all?) gems, drop linkset. (many years from now) Thanks, Keenan **UPDATED:** hope this is more readable

homu · 2017-01-06T22:04:07Z

☀️ Test successful - status

simi · 2017-01-08T03:15:16Z

🎊

Validate metadata link keys # Description: We intend to deprecate form used to edit linkset of gems. Metadata will be the only way to specify homepage, codebase, documentation, wiki, mailing list and issue tracker urls. Related: rubygems/rubygems.org#1234 rubygems/rubygems.org#1557 # Tasks: - [x] Describe the problem / feature - [ ] Write tests - [ ] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md).

sonalkr132 · 2017-04-17T09:35:11Z

@kbrock Can you please explain your reasoning for using metadata specs named *_uri? I understand the need for a long method, however, I think using the shorter version (home, code etc) in metadata would be easier to use.

spec.metadata = {
    "home"      => "https://some.github.io",
    "code"      => "https://github.com/some/gem",
    "docs"      => "https://www.rubydoc.info/gems/some/0.0.1",
  }

vs:

spec.metadata = {
    "homepage_uri"       => "https://some.github.io",
    "source_code_uri"    => "https://github.com/some/gem",
    "documentation_uri"  => "https://www.rubydoc.info/gems/some/0.0.1"
  }

mpapis · 2017-04-17T15:37:25Z

@sonalkr132 the key names must be informative, there is more names https://github.com/rubygems/rubygems.org/pull/1234/files#diff-b77c80170c3a1963bb4915b58c139b43R3 and they could be confusing, long versions do not leave place for misinterpretation

Fix metadata link key names # Description: I had used incorrect names for metadata link keys. Related: rubygems/rubygems.org#1234 (comment) Good thing it wasn't released with 2.6.11. Is there anything I can do to make sure that my commits are in next release? I need to update guides. # Tasks: - [x] Describe the problem / feature - [ ] Write tests - [x] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md).

Makes it easy to programatically find the source code and changelog for rubocop, using the rubygems API. Also adds a changelog link etc. to https://rubygems.org/gems/rubocop See rubygems/rubygems.org#1234 and https://github.com/rubygems/rubygems.org/blob/master/app/models/links.rb for more details. I did not add `wiki_uri`, `mailing_list_uri` and `download_uri` because 1) the only wiki I could find (https://github.com/bbatsov/rubocop/wiki) looks abandoned; 2) there is no mailing list that I know of, and 3) rubygems.org will add a download link, e.g. https://rubygems.org/downloads/rubocop-0.49.1.gem if we don't add one. Also changing `s.homepage` to use https protocol.

kbrock force-pushed the versioned_links branch from 6ecd053 to 87373ac Compare March 28, 2016 13:36

kbrock force-pushed the versioned_links branch from 87373ac to 20853b7 Compare March 29, 2016 03:54

kbrock mentioned this pull request Mar 29, 2016

Move metadata from Linkset(rubygems.org table) to gemspec #1127

Closed

4 tasks

kbrock changed the title ~~Introduce Links - version specific linkset~~ Leverage metadata to populate gems urls v2 Mar 29, 2016

dwradcliffe added this to the Metadata milestone May 26, 2016

kbrock force-pushed the versioned_links branch 2 times, most recently from 6ed35c6 to 091e70a Compare May 30, 2016 01:51

kbrock force-pushed the versioned_links branch 2 times, most recently from b4de6be to 1639cbf Compare May 30, 2016 12:15

kbrock mentioned this pull request Jul 13, 2016

Leverage metadata to populate gems urls #724

Closed

sonalkr132 added the needs-more-merging label Sep 14, 2016

sonalkr132 added the backlog label Oct 27, 2016

kbrock force-pushed the versioned_links branch from 1639cbf to 4ad9e26 Compare November 7, 2016 20:11

kbrock mentioned this pull request Nov 7, 2016

consolidate code that generates links #1487

Merged

kbrock force-pushed the versioned_links branch from 4ad9e26 to b06fa26 Compare November 15, 2016 15:39

kbrock force-pushed the versioned_links branch 2 times, most recently from 37059a4 to a1903e3 Compare December 5, 2016 23:36

sonalkr132 removed the needs-more-merging label Dec 22, 2016

kbrock force-pushed the versioned_links branch from a1903e3 to 9655855 Compare December 22, 2016 17:05

homu merged commit 5c37cc9 into rubygems:master Jan 6, 2017

kbrock deleted the versioned_links branch January 6, 2017 23:20

kbrock mentioned this pull request Jan 6, 2017

Add change log links to gem page #728

Closed

sonalkr132 mentioned this pull request Jan 7, 2017

Remove useless assignments and correct rubygem metadata test #1537

Merged

sonalkr132 mentioned this pull request Feb 5, 2017

Validate metadata link keys rubygems/rubygems#1834

Merged

4 tasks

sonalkr132 mentioned this pull request Apr 18, 2017

Fix metadata link key names rubygems/rubygems#1896

Merged

4 tasks

This was referenced Jun 22, 2017

Add source code and changelog links to gemspec macournoyer/thin#339

Merged

Add source code and changelog links to gemspec alexreisner/geocoder#1192

Merged

Add source code and changelog links to gemspecs rails/rails#29588

Merged

greysteil mentioned this pull request Jun 29, 2017

Add source code link to gemspec guard/rb-fsevent#75

Merged

This was referenced Jul 22, 2017

Add source_code_uri to gemspec sumoheavy/jira-ruby#247

Merged

Add gemspec metadata restforce/restforce#315

Merged

greysteil mentioned this pull request Aug 30, 2017

Tell Rubygems correct sourcecode and changelog links aws/aws-sdk-ruby#1585

Closed

bquorning mentioned this pull request Sep 12, 2017

Add gemspec metadata rubocop/rubocop#4724

Merged

11 tasks

lostapathy mentioned this pull request Oct 7, 2017

Document gemspec metadata rubygems/guides#195

Closed

This was referenced Oct 30, 2017

Add source code and changelog links to gemspec MiniProfiler/rack-mini-profiler#318

Merged

Add source code link to gemspec test-unit/test-unit#157

Merged

sonalkr132 mentioned this pull request Dec 23, 2018

Remove update of linkset through UI #1815

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Leverage metadata to populate gems urls v2 #1234

Leverage metadata to populate gems urls v2 #1234

kbrock commented Mar 28, 2016 •

edited

Loading

kbrock commented Mar 28, 2016

homu commented May 29, 2016

kbrock commented May 30, 2016

djberg96 commented Jul 26, 2016 •

edited

Loading

simi commented Jul 27, 2016 •

edited

Loading

djberg96 commented Aug 4, 2016

homu commented Nov 6, 2016

homu commented Nov 12, 2016

homu commented Nov 19, 2016

kbrock commented Dec 5, 2016

kbrock commented Dec 22, 2016 •

edited

Loading

homu commented Jan 6, 2017

homu commented Jan 6, 2017

simi commented Jan 8, 2017

sonalkr132 commented Apr 17, 2017

mpapis commented Apr 17, 2017

Leverage metadata to populate gems urls v2 #1234

Leverage metadata to populate gems urls v2 #1234

Conversation

kbrock commented Mar 28, 2016 • edited Loading

High Level Goals

Commentary

before:

after:

future:

kbrock commented Mar 28, 2016

homu commented May 29, 2016

kbrock commented May 30, 2016

djberg96 commented Jul 26, 2016 • edited Loading

simi commented Jul 27, 2016 • edited Loading

djberg96 commented Aug 4, 2016

homu commented Nov 6, 2016

homu commented Nov 12, 2016

homu commented Nov 19, 2016

kbrock commented Dec 5, 2016

kbrock commented Dec 22, 2016 • edited Loading

homu commented Jan 6, 2017

homu commented Jan 6, 2017

simi commented Jan 8, 2017

sonalkr132 commented Apr 17, 2017

mpapis commented Apr 17, 2017

kbrock commented Mar 28, 2016 •

edited

Loading

djberg96 commented Jul 26, 2016 •

edited

Loading

simi commented Jul 27, 2016 •

edited

Loading

kbrock commented Dec 22, 2016 •

edited

Loading