Add support fo " use function" statements

OctoLinker · Sep 24, 2020 · 87a137a · 87a137a
1 parent 47c763b
commit 87a137a
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 9 deletions.
diff --git a/e2e/fixtures/php/foo.php b/e2e/fixtures/php/foo.php
@@ -9,6 +9,12 @@
 // @OctoLinkerResolve(https://www.php.net/manual/en/class.arrayaccess.php)
 use ArrayAccess;
 
+// @OctoLinkerResolve(https://www.php.net/manual/en/function.is-array.php)
+use function is_array;
+
+// @OctoLinkerResolve(https://www.php.net/manual/en/function.preg-last-error.php)
+use function preg_last_error;
+
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Contracts\Container\Container as ContainerContract;
 

diff --git a/packages/helper-grammar-regex-collection/index.js b/packages/helper-grammar-regex-collection/index.js
@@ -114,6 +114,14 @@ export const PHP = regex`
  ${diffSigns}
  use
  \s
+ (?!function\s)
+ (?<$1>[^;\s]+)
+`;
+
+export const PHP_FUNC = regex`
+ ${diffSigns}
+ use
+ \sfunction\s
  (?<$1>[^;\s]+)
 `;
 

diff --git a/packages/helper-grammar-regex-collection/test.js b/packages/helper-grammar-regex-collection/test.js
@@ -519,7 +519,18 @@ const fixtures = {
  ['Illuminate\\Contracts\\Container\\BindingResolutionException'],
  ],
  ],
- invalid: [''],
+ invalid: ['use function is_array'],
+ },
+ PHP_FUNC: {
+ valid: [
+ ['use function is_array', ['is_array']],
+ ['use function preg_last_error', ['preg_last_error']],
+ ],
+ invalid: [
+ 'use Closure',
+ 'use Illuminate\\Contracts\\Container\\BindingResolutionException',
+ ['Illuminate\\Contracts\\Container\\BindingResolutionException'],
+ ],
  },
  NET_PROJ_SDK: {
  valid: [['<Project Sdk="foo">', ['foo']]],

diff --git a/packages/plugin-php/__tests__/index.js b/packages/plugin-php/__tests__/index.js
@@ -1,12 +1,28 @@
+import { PHP_FUNC } from '@octolinker/helper-grammar-regex-collection';
 import php from '../index';
 
 describe('rust-crate', () => {
  const path = '/blob/path/dummy';
 
- it('resolves php using the live-resolver', () => {
- expect(php.resolve(path, ['ArrayAccess'])).toEqual({
+ it('resolves classes', () => {
+ expect(php.resolve(path, ['FooBar'])).toEqual({
  registry: 'ping',
- target: 'https://www.php.net/manual/en/class.arrayaccess.php',
+ target: 'https://www.php.net/manual/en/class.foobar.php',
  });
  });
+
+ it('resolves functions', () => {
+ expect(php.resolve(path, ['Foo_Bar'], {}, PHP_FUNC)).toEqual({
+ registry: 'ping',
+ target: 'https://www.php.net/manual/en/function.foo-bar.php',
+ });
+ });
+
+ it('does not try to resolve packages', () => {
+ expect(
+ php.resolve(path, [
+ 'Illuminate\\Contracts\\Container\\BindingResolutionException',
+ ]),
+ ).toEqual(undefined);
+ });
 });
diff --git a/packages/plugin-php/index.js b/packages/plugin-php/index.js
@@ -1,16 +1,27 @@
-import { PHP } from '@octolinker/helper-grammar-regex-collection';
+import { PHP, PHP_FUNC } from '@octolinker/helper-grammar-regex-collection';
 import liveResolverQuery from '@octolinker/resolver-live-query';
 
 export default {
  name: 'PHP',
 
- resolve(path, [target]) {
+ resolve(path, [target], meta, regExp) {
  if (target.includes('\\')) {
  return;
  }
 
- const docsUrl = `https://www.php.net/manual/en/class.${target.toLowerCase()}.php`;
- return liveResolverQuery({ type: 'ping', target: docsUrl });
+ if (regExp === PHP_FUNC) {
+ return liveResolverQuery({
+ type: 'ping',
+ target: `https://www.php.net/manual/en/function.${target
+ .toLowerCase()
+ .replace(/_/g, '-')}.php`,
+ });
+ }
+
+ return liveResolverQuery({
+ type: 'ping',
+ target: `https://www.php.net/manual/en/class.${target.toLowerCase()}.php`,
+ });
  },
 
  getPattern() {
@@ -21,6 +32,6 @@ export default {
  },
 
  getLinkRegexes() {
- return PHP;
+ return [PHP, PHP_FUNC];
  },
 };