Autolink package names in podspec.json

4 files changed, 137 insertions, 0 deletions

diff --git a/lib/gitlab/dependency_linker.rb b/lib/gitlab/dependency_linker.rb
index ffd6ab8e2f8..ac16b9bde2f 100644
--- a/lib/gitlab/dependency_linker.rb
+++ b/lib/gitlab/dependency_linker.rb
@@ -7,6 +7,7 @@ module Gitlab
       ComposerJsonLinker,
       PodfileLinker,
       PodspecLinker,
+      PodspecJsonLinker,
     ].freeze
 
     def self.linker(blob_name)
diff --git a/lib/gitlab/dependency_linker/podspec_json_linker.rb b/lib/gitlab/dependency_linker/podspec_json_linker.rb
new file mode 100644
index 00000000000..d82237ed3f1
--- /dev/null
+++ b/lib/gitlab/dependency_linker/podspec_json_linker.rb
@@ -0,0 +1,32 @@
+module Gitlab
+  module DependencyLinker
+    class PodspecJsonLinker < JsonLinker
+      include Cocoapods
+
+      self.file_type = :podspec_json
+
+      private
+
+      def link_dependencies
+        link_json('name', json["name"], &method(:package_url))
+        link_json('license', &method(:license_url))
+        link_json(%w[homepage git], URL_REGEX, &:itself)
+
+        link_packages_at_key("dependencies", &method(:package_url))
+
+        json["subspecs"]&.each do |subspec|
+          link_packages_at_key("dependencies", subspec, &method(:package_url))
+        end
+      end
+
+      def link_packages_at_key(key, root = json, &url_proc)
+        dependencies = root[key]
+        return unless dependencies
+
+        dependencies.each do |name, _|
+          link_regex(/"(?<name>#{Regexp.escape(name)})":\s*\[/, &url_proc)
+        end
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/dependency_linker/podspec_json_linker_spec.rb b/spec/lib/gitlab/dependency_linker/podspec_json_linker_spec.rb
new file mode 100644
index 00000000000..d722865264b
--- /dev/null
+++ b/spec/lib/gitlab/dependency_linker/podspec_json_linker_spec.rb
@@ -0,0 +1,96 @@
+require 'rails_helper'
+
+describe Gitlab::DependencyLinker::PodspecJsonLinker, lib: true do
+  describe '.support?' do
+    it 'supports *.podspec.json' do
+      expect(described_class.support?('Reachability.podspec.json')).to be_truthy
+    end
+
+    it 'does not support other files' do
+      expect(described_class.support?('.podspec.json.example')).to be_falsey
+    end
+  end
+
+  describe '#link' do
+    let(:file_name) { "AFNetworking.podspec.json" }
+
+    let(:file_content) do
+      <<-CONTENT.strip_heredoc
+        {
+          "name": "AFNetworking",
+          "version": "2.0.0",
+          "license": "MIT",
+          "summary": "A delightful iOS and OS X networking framework.",
+          "homepage": "https://github.com/AFNetworking/AFNetworking",
+          "authors": {
+            "Mattt Thompson": "m@mattt.me"
+          },
+          "source": {
+            "git": "https://github.com/AFNetworking/AFNetworking.git",
+            "tag": "2.0.0",
+            "submodules": true
+          },
+          "requires_arc": true,
+          "platforms": {
+            "ios": "6.0",
+            "osx": "10.8"
+          },
+          "public_header_files": "AFNetworking/*.h",
+          "subspecs": [
+            {
+              "name": "NSURLConnection",
+              "dependencies": {
+                "AFNetworking/Serialization": [
+
+                ],
+                "AFNetworking/Reachability": [
+
+                ],
+                "AFNetworking/Security": [
+
+                ]
+              },
+              "source_files": [
+                "AFNetworking/AFURLConnectionOperation.{h,m}",
+                "AFNetworking/AFHTTPRequestOperation.{h,m}",
+                "AFNetworking/AFHTTPRequestOperationManager.{h,m}"
+              ]
+            }
+          ]
+        }
+      CONTENT
+    end
+
+    subject { Gitlab::Highlight.highlight(file_name, file_content) }
+
+    def link(name, url)
+      %{<a href="#{url}" rel="nofollow noreferrer noopener" target="_blank">#{name}</a>}
+    end
+
+    it 'links the gem name' do
+      expect(subject).to include(link('AFNetworking', 'https://cocoapods.org/pods/AFNetworking'))
+    end
+
+    it 'links the license' do
+      expect(subject).to include(link('MIT', 'http://choosealicense.com/licenses/mit/'))
+    end
+
+    it 'links the homepage' do
+      expect(subject).to include(link('https://github.com/AFNetworking/AFNetworking', 'https://github.com/AFNetworking/AFNetworking'))
+    end
+
+    it 'links the source URL' do
+      expect(subject).to include(link('https://github.com/AFNetworking/AFNetworking.git', 'https://github.com/AFNetworking/AFNetworking.git'))
+    end
+
+    it 'links dependencies' do
+      expect(subject).to include(link('AFNetworking/Serialization', 'https://cocoapods.org/pods/AFNetworking'))
+      expect(subject).to include(link('AFNetworking/Reachability', 'https://cocoapods.org/pods/AFNetworking'))
+      expect(subject).to include(link('AFNetworking/Security', 'https://cocoapods.org/pods/AFNetworking'))
+    end
+
+    it 'does not link subspec names' do
+      expect(subject).not_to include(link('NSURLConnection', 'https://cocoapods.org/pods/NSURLConnection'))
+    end
+  end
+end
diff --git a/spec/lib/gitlab/dependency_linker_spec.rb b/spec/lib/gitlab/dependency_linker_spec.rb
index b6ec756adeb..9fc539b604a 100644
--- a/spec/lib/gitlab/dependency_linker_spec.rb
+++ b/spec/lib/gitlab/dependency_linker_spec.rb
@@ -49,5 +49,13 @@ describe Gitlab::DependencyLinker, lib: true do
 
       described_class.link(blob_name, nil, nil)
     end
+
+    it 'links using PodspecJsonLinker' do
+      blob_name = 'AFNetworking.podspec.json'
+
+      expect(described_class::PodspecJsonLinker).to receive(:link)
+
+      described_class.link(blob_name, nil, nil)
+    end
   end
 end