Merge pull request #345 from jonathanhefner/version-rubyonrails-links

Version explicit links to `api.rubyonrails.org`
rails · Nov 14, 2023 · e26cca7 · e26cca7
2 parents aa00bf0 + 87683a1
commit e26cca7
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 6 deletions.
diff --git a/lib/sdoc/postprocessor.rb b/lib/sdoc/postprocessor.rb
@@ -10,7 +10,7 @@ def process(rendered)
     document = Nokogiri::HTML5.parse(rendered)
 
     rebase_urls!(document)
-    version_rails_guides_urls!(document)
+    version_rubyonrails_urls!(document)
     add_ref_link_classes!(document)
     unify_h1_headings!(document)
     highlight_code_blocks!(document)
@@ -49,9 +49,12 @@ def rebase_url(url, current_path)
     end
   end
 
-  def version_rails_guides_urls!(document)
+  def version_rubyonrails_urls!(document)
     if ENV["HORO_PROJECT_NAME"] == "Ruby on Rails" && version = ENV["HORO_PROJECT_VERSION"]
-      document.css("a[href^='https://guides.rubyonrails.org/']").each do |element|
+      document.css(
+        "a[href^='https://api.rubyonrails.org/']",
+        "a[href^='https://guides.rubyonrails.org/']"
+      ).each do |element|
         element["href"] = version_url(element["href"], version)
       end
     end

diff --git a/spec/postprocessor_spec.rb b/spec/postprocessor_spec.rb
@@ -29,6 +29,24 @@
       _(postprocessed).must_include expected_body
     end
 
+    it "versions Rails API Docs URLs based on ENV['HORO_PROJECT_VERSION']" do
+      rendered = <<~HTML
+        <a href="https://api.rubyonrails.org/classes/ActiveRecord/Base.html">Learn more</a>
+      HTML
+
+      {
+        "3.2.1" => %(<a href="https://api.rubyonrails.org/v3.2.1/classes/ActiveRecord/Base.html">Learn more</a>),
+        "v3.2.1" => %(<a href="https://api.rubyonrails.org/v3.2.1/classes/ActiveRecord/Base.html">Learn more</a>),
+        "main@1337c0d3" => %(<a href="https://edgeapi.rubyonrails.org/classes/ActiveRecord/Base.html">Learn more</a>),
+        "edge" => %(<a href="https://edgeapi.rubyonrails.org/classes/ActiveRecord/Base.html">Learn more</a>),
+        nil => %(<a href="https://api.rubyonrails.org/classes/ActiveRecord/Base.html">Learn more</a>),
+      }.each do |version, expected|
+        with_env("HORO_PROJECT_VERSION" => version, "HORO_PROJECT_NAME" => "Ruby on Rails") do
+          _(SDoc::Postprocessor.process(rendered)).must_include expected
+        end
+      end
+    end
+
     it "versions Rails guides URLs based on ENV['HORO_PROJECT_VERSION']" do
       rendered = <<~HTML
         <a href="https://guides.rubyonrails.org/testing.html">Testing</a>
@@ -47,14 +65,16 @@
       end
     end
 
-    it "does not version Rails guides URLs when ENV['HORO_PROJECT_NAME'] is not Ruby on Rails" do
+    it "does not version rubyonrails.org URLs when ENV['HORO_PROJECT_NAME'] is not Ruby on Rails" do
       rendered = <<~HTML
+        <a href="https://api.rubyonrails.org/classes/ActiveRecord/Base.html">Learn more</a>
         <a href="https://guides.rubyonrails.org/testing.html">Testing</a>
       HTML
 
       with_env("HORO_PROJECT_VERSION" => "3.2.1", "HORO_PROJECT_NAME" => "My Rails Gem") do
-        _(SDoc::Postprocessor.process(rendered)).
-          must_include %(<a href="https://guides.rubyonrails.org/testing.html">Testing</a>)
+        postprocessed = _(SDoc::Postprocessor.process(rendered))
+        postprocessed.must_include %(<a href="https://api.rubyonrails.org/classes/ActiveRecord/Base.html">Learn more</a>)
+        postprocessed.must_include %(<a href="https://guides.rubyonrails.org/testing.html">Testing</a>)
       end
     end