Leverage metadata to populate gems urls v2

app/controllers/application_controller.rb

@@ -68,6 +68,10 @@ def find_rubygem
     end
   end
 
+  def find_versioned_links
+    @versioned_links = @rubygem.links(@latest_version)
+  end
+
   def set_page
     @page = params[:page].respond_to?(:to_i) ? [1, params[:page].to_i].max : 1
   end

app/controllers/reverse_dependencies_controller.rb

@@ -3,6 +3,7 @@ class ReverseDependenciesController < ApplicationController
   before_action :find_rubygem, only: [:index]
   before_action :latest_version, only: [:index]
   before_action :set_page, only: [:index]
+  before_action :find_versioned_links, only: [:index]
 
   def index
     @reverse_dependencies = @rubygem.reverse_dependencies

app/controllers/rubygems_controller.rb

@@ -4,6 +4,7 @@ class RubygemsController < ApplicationController
   before_action :set_blacklisted_gem, only: [:show], if: :blacklisted?
   before_action :find_rubygem, only: [:edit, :update, :show], unless: :blacklisted?
   before_action :latest_version, only: [:show], unless: :blacklisted?
+  before_action :find_versioned_links, only: [:show], unless: :blacklisted?
   before_action :load_gem, only: [:edit, :update]
   before_action :set_page, only: :index
 

app/controllers/versions_controller.rb

@@ -8,6 +8,7 @@ def index
   def show
     @latest_version = Version.find_from_slug!(@rubygem.id, params[:id])
     @versions = @rubygem.public_versions_with_extra_version(@latest_version)
+    @versioned_links = @rubygem.links(@latest_version)
     render "rubygems/show"
   end
 end

app/helpers/rubygems_helper.rb

@@ -72,19 +72,10 @@ def atom_link(rubygem)
       class: 'gem__link t-list__item', id: :rss
   end
 
-  def download_link(version)
-    link_to_page :download, "/downloads/#{version.full_name}.gem"
-  end
-
   def reverse_dependencies_link(rubygem)
     link_to_page :reverse_dependencies, rubygem_reverse_dependencies_path(rubygem)
   end
 
-  def documentation_link(version, linkset)
-    return unless linkset.nil? || linkset.docs.blank?
-    link_to_page :docs, version.documentation_path
-  end
-
   def badge_link(rubygem)
     badge_url = "https://badge.fury.io/rb/#{rubygem.name}/install"
     link_to t(".links.badge"), badge_url, class: "gem__link t-list__item", id: :badge

app/models/links.rb

@@ -0,0 +1,65 @@
+class Links
+  # Links available for indexed gems
+  LINKS = {
+    'home'     => 'homepage_uri',
+    'code'     => 'source_code_uri',
+    'docs'     => 'documentation_uri',
+    'wiki'     => 'wiki_uri',
+    'mail'     => 'mailing_list_uri',
+    'bugs'     => 'bug_tracker_uri',
+    'download' => 'download_uri'
+  }.freeze
+
+  # Links available for non-indexed gems
+  NON_INDEXED_LINKS = {
+    'docs'     => 'documentation_uri'
+  }.freeze
+
+  attr_accessor :rubygem, :version, :linkset
+
+  def initialize(rubygem, version)
+    self.rubygem = rubygem
+    self.version = version
+    self.linkset = rubygem.linkset
+  end
+
+  def links
+    version.indexed ? LINKS : NON_INDEXED_LINKS
+  end
+
+  delegate :keys, to: :links
+
+  def each
+    return enum_for(:each) unless block_given?
+    links.each do |short, long|
+      value = send(long)
+      yield short, value if value
+    end
+  end
+
+  # documentation uri:
+  # if metadata has it defined, use that
+  # or if linksets has it defined, use that
+  # else, generate one from gem name and version number
+  def documentation_uri
+    version.metadata["documentation_uri"].presence ||
+      linkset&.docs.presence ||
+      "http://www.rubydoc.info/gems/#{rubygem.name}/#{version.number}"
+  end
+
+  # technically this is a path
+  def download_uri
+    "/downloads/#{version.full_name}.gem" if version.indexed
+  end
+
+  # define getters for each of the uris (both short `home` or long `homepage_uri` versions)
+  # don't define for download_uri since it has special logic and is already defined
+  LINKS.each do |short, long|
+    unless method_defined?(long)
+      define_method(long) do
+        version.metadata[long].presence || linkset&.public_send(short)
+      end
+    end
+    alias_method short, long
+  end
+end

app/models/rubygem.rb

@@ -141,7 +141,12 @@ def downloads
     gem_download.try(:count) || 0
   end
 
+  def links(version = versions.most_recent)
+    Links.new(self, version)
+  end
+
   def payload(version = versions.most_recent, protocol = Gemcutter::PROTOCOL, host_with_port = Gemcutter::HOST)
+    versioned_links = links(version)
     deps = version.dependencies.to_a
     {
       'name'              => name,
@@ -156,12 +161,12 @@ def payload(version = versions.most_recent, protocol = Gemcutter::PROTOCOL, host
       'sha'               => version.sha256_hex,
       'project_uri'       => "#{protocol}://#{host_with_port}/gems/#{name}",
       'gem_uri'           => "#{protocol}://#{host_with_port}/gems/#{version.full_name}.gem",
-      'homepage_uri'      => linkset.try(:home),
-      'wiki_uri'          => linkset.try(:wiki),
-      'documentation_uri' => linkset.try(:docs).presence || version.documentation_path,
-      'mailing_list_uri'  => linkset.try(:mail),
-      'source_code_uri'   => linkset.try(:code),
-      'bug_tracker_uri'   => linkset.try(:bugs),
+      'homepage_uri'      => versioned_links.homepage_uri,
+      'wiki_uri'          => versioned_links.wiki_uri,
+      'documentation_uri' => versioned_links.documentation_uri,
+      'mailing_list_uri'  => versioned_links.mailing_list_uri,
+      'source_code_uri'   => versioned_links.source_code_uri,
+      'bug_tracker_uri'   => versioned_links.bug_tracker_uri,
       'dependencies'      => {
         'development' => deps.select { |r| r.rubygem && 'development' == r.scope },
         'runtime'     => deps.select { |r| r.rubygem && 'runtime' == r.scope }

app/models/version.rb

@@ -350,10 +350,6 @@ def assign_required_rubygems_version!
     update_column(:required_rubygems_version, required_rubygems_version.to_s)
   end
 
-  def documentation_path
-    "http://www.rubydoc.info/gems/#{rubygem.name}/#{number}"
-  end
-
   private
 
   def get_spec_attribute(attribute_name)

app/views/rubygems/_aside.html.erb

@@ -61,17 +61,9 @@
   <div class="t-list__items">
     <%= link_to t('edit'), edit_rubygem_path(@rubygem), :class => "gem__link t-list__item", :id => "edit" if @rubygem.owned_by?(current_user) %>
 
-    <% if @latest_version.indexed %>
-      <% if @rubygem.linkset.present? %>
-        <%- Linkset::LINKS.each do |link| %>
-          <%= link_to_page link, @rubygem.linkset.public_send(link) %>
-        <%- end %>
-      <% end %>
-
-      <%= download_link(@latest_version) %>
-    <% end %>
-
-    <%= documentation_link(@latest_version, @rubygem.linkset) %>
+    <%- @versioned_links.each do |name, link| %>
+      <%= link_to_page name, link %>
+    <%- end %>
     <%= badge_link(@rubygem) %>
     <%= subscribe_link(@rubygem) if @latest_version.indexed %>
     <%= unsubscribe_link(@rubygem) %>

test/functional/rubygems_controller_test.rb

@@ -267,6 +267,7 @@ class RubygemsControllerTest < ActionController::TestCase
     setup do
       @latest_version = create(:version, created_at: 1.minute.ago)
       @rubygem = @latest_version.rubygem
+      @versioned_links = @rubygem.links(@latest_version)
       get :show, id: @rubygem.to_param
     end
 
@@ -285,6 +286,7 @@ class RubygemsControllerTest < ActionController::TestCase
     setup do
       @latest_version = create(:version)
       @rubygem = @latest_version.rubygem
+      @versioned_links = @rubygem.links(@latest_version)
     end
     should "render plural licenses header for other than one license" do
       @latest_version.update_attributes(licenses: nil)

test/functional/versions_controller_test.rb

@@ -69,6 +69,7 @@ class VersionsControllerTest < ActionController::TestCase
     setup do
       @latest_version = create(:version, built_at: 1.week.ago, created_at: 1.day.ago)
       @rubygem = @latest_version.rubygem
+      @versioned_links = @rubygem.links(@latest_version)
       @versions = (1..5).map do
         FactoryGirl.create(:version, rubygem: @rubygem)
       end

test/unit/helpers/rubygems_helper_test.rb

@@ -56,23 +56,6 @@ class RubygemsHelperTest < ActionView::TestCase
     assert_equal "March 18, 2011", nice_date_for(time)
   end
 
-  should "link to docs if no docs link is set" do
-    version = build(:version)
-    linkset = build(:linkset, docs: nil)
-
-    @virtual_path = "rubygems.show"
-    link = documentation_link(version, linkset)
-    assert link.include?(version.documentation_path)
-  end
-
-  should "not link to docs if docs link is set" do
-    version = build(:version)
-    linkset = build(:linkset)
-
-    link = documentation_link(version, linkset)
-    assert link.blank?
-  end
-
   should "link to the badge" do
     rubygem = create(:rubygem)
     url = "https://badge.fury.io/rb/#{rubygem.name}/install"

test/unit/links_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class LinksTest < ActiveSupport::TestCase
+  # #documentation_uri
+  should "use linkset documentation_uri" do
+    version = build(:version)
+    rubygem = build(:rubygem, linkset: build(:linkset, docs: "http://example.com/doc"), versions: [version])
+    links = rubygem.links(version)
+
+    assert_match "http://example.com/doc", links.documentation_uri
+  end
+
+  should "fallback to rubygems documentation_uri" do
+    version = build(:version)
+    rubygem = build(:rubygem, linkset: build(:linkset, docs: nil), versions: [version])
+    links = rubygem.links(version)
+
+    assert_equal "http://www.rubydoc.info/gems/#{rubygem.name}/#{version.number}", links.documentation_uri
+  end
+
+  should "use all fields when indexed" do
+    version = build(:version, indexed: true)
+    rubygem = build(:rubygem, linkset: build(:linkset, docs: nil), versions: [version])
+    links = rubygem.links(version)
+
+    assert links.links.keys.include?('home')
+    assert links.links.keys.include?('docs')
+  end
+
+  should "use partial fields when not indexed" do
+    version = build(:version, indexed: false)
+    rubygem = build(:rubygem, linkset: build(:linkset, docs: nil), versions: [version])
+    links = rubygem.links(version)
+
+    refute links.links.keys.include?('home')
+    assert links.links.keys.include?('docs')
+  end
+end

test/unit/rubygem_test.rb

@@ -454,6 +454,44 @@ class RubygemTest < ActiveSupport::TestCase
       assert_equal run_dep.name, doc.at_css("dependencies runtime dependency name").content
     end
 
+    context "with metadata" do
+      setup do
+        @version = create(:version, rubygem: @rubygem)
+        @rubygem = build(:rubygem, versions: [@version])
+      end
+
+      should "prefer metadata over links in JSON" do
+        @version.update_attributes!(
+          metadata: {
+            "homepage_uri" => "http://example.com/home",
+            "wiki_uri" => "http://example.com/wiki",
+            "documentation_uri" => "http://example.com/docs",
+            "mailing_list_uri" => "http://example.com/mail",
+            "source_code_uri" => "http://example.com/code",
+            "bug_tracker_uri" => "http://example.com/bugs"
+          }
+        )
+
+        hash = MultiJson.load(@rubygem.to_json)
+
+        assert_equal "http://example.com/home", hash["homepage_uri"]
+        assert_equal "http://example.com/wiki", hash["wiki_uri"]
+        assert_equal "http://example.com/docs", hash["documentation_uri"]
+        assert_equal "http://example.com/mail", hash["mailing_list_uri"]
+        assert_equal "http://example.com/code", hash["source_code_uri"]
+        assert_equal "http://example.com/bugs", hash["bug_tracker_uri"]
+      end
+
+      should "return version documentation url if metadata and linkset docs is empty" do
+        @version.update_attributes!(metadata: {})
+        @rubygem.linkset&.update_attributes(:docs, "")
+        @rubygem.reload
+        hash = JSON.load(@rubygem.to_json)
+
+        assert_equal "http://www.rubydoc.info/gems/#{@rubygem.name}/#{@version.number}", hash["documentation_uri"]
+      end
+    end
+
     context "with a linkset" do
       setup do
         @rubygem = build(:rubygem)
@@ -471,12 +509,11 @@ class RubygemTest < ActiveSupport::TestCase
         assert_equal @rubygem.linkset.bugs, hash["bug_tracker_uri"]
       end
 
-      should "return version documentation url if linkset docs is empty" do
+      should "return version documentation uri if linkset docs is empty" do
         @rubygem.linkset.docs = ""
-        @rubygem.save
         hash = JSON.load(@rubygem.to_json)
 
-        assert_equal @version.documentation_path, hash["documentation_uri"]
+        assert_equal "http://www.rubydoc.info/gems/#{@rubygem.name}/#{@version.number}", hash["documentation_uri"]
       end
 
       should "return a bunch of XML" do