Ruby require_relative fixes (OctoLinker#1014)

Co-authored-by: Matt <[email protected]>
apryl489 · Sep 1, 2020 · 710f36e · 710f36e
1 parent 55ea9c8
commit 710f36e
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 9 deletions.
diff --git a/e2e/fixtures/ruby/mystic-wind.rb b/e2e/fixtures/ruby/mystic-wind.rb
@@ -1,2 +1,5 @@
 # @OctoLinkerResolve(https://github.com/rack/rack)
 require "rack"
+
+# @OctoLinkerResolve(<root>/ruby/relative/foo.rb)
+require_relative "relative/foo"
diff --git a/e2e/fixtures/ruby/relative/foo.rb b/e2e/fixtures/ruby/relative/foo.rb
diff --git a/packages/helper-grammar-regex-collection/index.js b/packages/helper-grammar-regex-collection/index.js
@@ -42,7 +42,13 @@ export const NODEJS_RELATIVE_PATH_JOIN = regex`
 `;
 
 export const REQUIRE = regex`
-  ( require(\.resolve)? | proxyquire | import | require_relative )
+  ( require(\.resolve)? | proxyquire | import )
+  \s* ( \s | \( ) \s*
+  ${captureJsQuotedWord}
+`;
+
+export const REQUIRE_RELATIVE = regex`
+  ( require_relative )
   \s* ( \s | \( ) \s*
   ${captureJsQuotedWord}
 `;

diff --git a/packages/helper-grammar-regex-collection/test.js b/packages/helper-grammar-regex-collection/test.js
@@ -86,7 +86,6 @@ const fixtures = {
         ['./foo', './bar'],
       ],
       ['require "foo"', ['foo']],
-      ['require_relative "foo"', ['foo']],
       // require.resolve
       ['require.resolve "foo"', ['foo']],
       ['require.resolve("foo")', ['foo']],
@@ -174,6 +173,18 @@ const fixtures = {
       'var foo = import.resolve("foo")var bar = import.resolve("bar")',
     ],
   },
+  REQUIRE_RELATIVE: {
+    valid: [
+      ['require_relative "foo"', ['foo']],
+      ['require_relative "channel_prefix"', ['channel_prefix']],
+    ],
+    invalid: [
+      'require_relative(foo)',
+      'require_relative"foo"',
+      'require_relative (foo)',
+      'require_relative("fo o")',
+    ],
+  },
   GEM: {
     valid: [
       ['gem "foo"', ['foo']],

diff --git a/packages/helper-insert-link/index.js b/packages/helper-insert-link/index.js
@@ -70,7 +70,7 @@ export default function (blob, regex, plugin, meta = {}) {
       endPosInBlob,
       values,
     }) => {
-      let urls = plugin.resolve(blob.path, values, meta);
+      let urls = plugin.resolve(blob.path, values, meta, regex);
       if (Array.isArray(urls)) {
         urls = urls.filter(Boolean);
       }

diff --git a/packages/plugin-ruby/index.js b/packages/plugin-ruby/index.js
@@ -1,18 +1,33 @@
 import { join } from 'path';
-import { REQUIRE } from '@octolinker/helper-grammar-regex-collection';
+import {
+  REQUIRE,
+  REQUIRE_RELATIVE,
+} from '@octolinker/helper-grammar-regex-collection';
 import liveResolverQuery from '@octolinker/resolver-live-query';
 
 export default {
   name: 'Ruby',
 
-  resolve(path, [target]) {
+  resolve(path, [target], meta, regex) {
     const isPath = !!target.match(/\//);
-
     // https://github.com/github/pages-gem/blob/master/lib/github-pages/dependencies.rb
 
-    if (isPath) {
-      const basePath = join(path.split('/lib/')[0], 'lib');
+    const isRequireRelative = regex.toString() === REQUIRE_RELATIVE.toString();
 
+    if (isRequireRelative) {
+      let resolvedPath = path;
+      const splitPath = path.split('/');
+      const currentFile = splitPath[splitPath.length - 1];
+      resolvedPath = resolvedPath.replace(currentFile, `${target}.rb`);
+      return `{BASE_URL}${resolvedPath}`;
+    }
+
+    if (isPath) {
+      let splitPath = path.split('/lib/');
+      if (splitPath.length < 2) {
+        splitPath = path.split('/test/');
+      }
+      const basePath = join(splitPath[0], 'lib');
       return `{BASE_URL}${join(basePath, `${target}.rb`)}`;
     }
 
@@ -27,6 +42,6 @@ export default {
   },
 
   getLinkRegexes() {
-    return REQUIRE;
+    return [REQUIRE, REQUIRE_RELATIVE];
   },
 };