Skip to content

feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danez merged 1 commit into from
Jan 25, 2019
Merged

feat(resolve): resolve Object.values() in PropType.oneOf() #318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions src/utils/__tests__/__snapshots__/getPropType-test.js.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
"computed": true,
"name": "enum",
"value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
"name": "enum",
"value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
"computed": true,
"name": "enum",
"value": "TYPES",
"value": Array [
Object {
"computed": false,
"value": "\\"bar\\"",
},
Object {
"computed": false,
"value": "\\"foo\\"",
},
],
}
`;

Expand Down
11 changes: 10 additions & 1 deletion src/utils/__tests__/getPropType-test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
expect(getPropType(propTypeExpression)).toMatchSnapshot();
});

it('does not resolve computed values', () => {
it('does resolve object keys values', () => {
const propTypeExpression = statement(`
PropTypes.oneOf(Object.keys(TYPES));
var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
expect(getPropType(propTypeExpression)).toMatchSnapshot();
});

it('does resolve object values', () => {
const propTypeExpression = statement(`
PropTypes.oneOf(Object.values(TYPES));
var TYPES = { FOO: "foo", BAR: "bar" };
`).get('expression');

expect(getPropType(propTypeExpression)).toMatchSnapshot();
});

it('does not resolve external values', () => {
const propTypeExpression = statement(`
PropTypes.oneOf(TYPES);
Expand Down
156 changes: 156 additions & 0 deletions src/utils/__tests__/resolveObjectValuesToArray-test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
* Copyright (c) 2015, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
*/

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
function parse(src) {
const root = utils.parse(src);
return root.get('body', root.node.body.length - 1, 'expression');
}

it('resolves Object.values with strings', () => {
const path = parse(
['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([
builders.literal('bar'),
builders.literal('foo'),
]),
);
});

it('resolves Object.values with numbers', () => {
const path = parse(
['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([builders.literal(0), builders.literal(5)]),
);
});

it('resolves Object.values with undefined or null', () => {
const path = parse(
['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
'\n',
),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([
builders.literal(null),
builders.literal(null),
]),
);
});

it('resolves Object.values with literals as computed key', () => {
const path = parse(
['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([builders.literal(2), builders.literal(1)]),
);
});

it('resolves Object.values when using resolvable spread', () => {
const path = parse(
[
'var bar = { doo: 4 }',
'var foo = { boo: 1, foo: 2, ...bar };',
'Object.values(foo);',
].join('\n'),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([
builders.literal(1),
builders.literal(4),
builders.literal(2),
]),
);
});

it('resolves Object.values when using getters', () => {
const path = parse(
[
'var foo = { boo: 1, foo: 2, get bar() {} };',
'Object.values(foo);',
].join('\n'),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([builders.literal(1), builders.literal(2)]),
);
});

it('resolves Object.values when using setters', () => {
const path = parse(
[
'var foo = { boo: 1, foo: 2, set bar(e) {} };',
'Object.values(foo);',
].join('\n'),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([builders.literal(1), builders.literal(2)]),
);
});

it('resolves Object.values but ignores duplicates', () => {
const path = parse(
[
'var bar = { doo: 4, doo: 5 }',
'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
'Object.values(foo);',
].join('\n'),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([
builders.literal(1),
builders.literal(5),
builders.literal(2),
]),
);
});

it('resolves Object.values but ignores duplicates with getter and setter', () => {
const path = parse(
['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
'\n',
),
);

expect(resolveObjectValuesToArray(path)).toEqualASTNode(
builders.arrayExpression([]),
);
});

it('does not resolve Object.values when using unresolvable spread', () => {
const path = parse(
['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
'\n',
),
);

expect(resolveObjectValuesToArray(path)).toBeNull();
});
});
4 changes: 3 additions & 1 deletion src/utils/getPropType.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
const type: PropTypeDescriptor = { name: 'enum' };
let value = resolveToValue(argumentPath);
if (!types.ArrayExpression.check(value.node)) {
value = resolveObjectKeysToArray(value);
value =
resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
if (value) {
type.value = getEnumValues(value);
} else {
Expand Down
149 changes: 149 additions & 0 deletions src/utils/resolveObjectValuesToArray.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
* Copyright (c) 2017, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @flow
*
*/

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
properties: Array<string>,
values: Object,
};

const {
types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
return (
types.CallExpression.check(node) &&
node.arguments.length === 1 &&
types.MemberExpression.check(node.callee) &&
types.Identifier.check(node.callee.object) &&
node.callee.object.name === 'Object' &&
types.Identifier.check(node.callee.property) &&
node.callee.property.name === 'values'
);
}

function isWhitelistedObjectProperty(prop) {
return (
(types.Property.check(prop) &&
((types.Identifier.check(prop.key) && !prop.computed) ||
types.Literal.check(prop.key))) ||
types.SpreadElement.check(prop)
);
}

function isWhiteListedObjectTypeProperty(prop) {
return (
types.ObjectTypeProperty.check(prop) ||
types.ObjectTypeSpreadProperty.check(prop)
);
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
object: NodePath,
raw: boolean = false,
): ?ObjectPropMap {
if (
(types.ObjectExpression.check(object.value) &&
object.value.properties.every(isWhitelistedObjectProperty)) ||
(types.ObjectTypeAnnotation.check(object.value) &&
object.value.properties.every(isWhiteListedObjectTypeProperty))
) {
const properties = [];
let values = {};
let error = false;
object.get('properties').each(propPath => {
if (error) return;
const prop = propPath.value;

if (prop.kind === 'get' || prop.kind === 'set') return;

if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
// Key is either Identifier or Literal
const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
const propValue = propPath.get(name).parentPath.value;
const value =
propValue.value.value ||
(raw ? propValue.value.raw : propValue.value.value);

if (properties.indexOf(name) === -1) {
properties.push(name);
}
values[name] = value;
} else if (
types.SpreadElement.check(prop) ||
types.ObjectTypeSpreadProperty.check(prop)
) {
let spreadObject = resolveToValue(propPath.get('argument'));
if (types.GenericTypeAnnotation.check(spreadObject.value)) {
const typeAlias = resolveToValue(spreadObject.get('id'));
if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
spreadObject = resolveToValue(typeAlias.get('right'));
}
}

const spreadValues = resolveObjectToPropMap(spreadObject);
if (!spreadValues) {
error = true;
return;
}
spreadValues.properties.forEach(spreadProp => {
if (properties.indexOf(spreadProp) === -1) {
properties.push(spreadProp);
}
});
values = { ...values, ...spreadValues.values };
}
});

if (!error) {
return { properties: properties.sort(), values };
}
}

return null;
}

/**
* Returns an ArrayExpression which contains all the keys resolved from an object
*
* Ignores setters in objects
*
* Returns null in case of
* unresolvable spreads
* computed identifier values
*/
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
const node = path.node;

if (isObjectValuesCall(node)) {
const objectExpression = resolveToValue(path.get('arguments').get(0));
const propMap = resolveObjectToPropMap(objectExpression);

if (propMap) {
const nodes = propMap.properties.map(prop => {
const value = propMap.values[prop];

return typeof value === 'undefined'
? builders.literal(null)
: builders.literal(value);
});

return new NodePath(builders.arrayExpression(nodes));
}
}

return null;
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(resolve): resolve Object.values() in PropType.oneOf() by gatsbimantico · Pull Request #318 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

danez
merged 1 commit into

from

Jan 25, 2019
 Merged


feat(resolve): resolve Object.values() in PropType.oneOf()
#318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 20 additions & 4 deletions
src/utils/__tests__/__snapshots__/getPropType-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
 "name": "enum",
 "value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
 "value": Array [
 Object {
 "computed": false,
 "value": "\\"bar\\"",
 },
 Object {
 "computed": false,
 "value": "\\"foo\\"",
 },
 ],
}
`;

Expand Down

11 changes: 10 additions & 1 deletion
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve computed values', () => {
 it('does resolve object keys values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.keys(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does resolve object values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.values(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
 `).get('expression');

 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve external values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(TYPES);
Expand Down

156 changes: 156 additions & 0 deletions
src/utils/__tests__/resolveObjectValuesToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 */

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
 function parse(src) {
 const root = utils.parse(src);
 return root.get('body', root.node.body.length - 1, 'expression');
 }

 it('resolves Object.values with strings', () => {
 const path = parse(
 ['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal('bar'),
 builders.literal('foo'),
 ]),
 );
 });

 it('resolves Object.values with numbers', () => {
 const path = parse(
 ['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(0), builders.literal(5)]),
 );
 });

 it('resolves Object.values with undefined or null', () => {
 const path = parse(
 ['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(null),
 builders.literal(null),
 ]),
 );
 });

 it('resolves Object.values with literals as computed key', () => {
 const path = parse(
 ['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(2), builders.literal(1)]),
 );
 });

 it('resolves Object.values when using resolvable spread', () => {
 const path = parse(
 [
 'var bar = { doo: 4 }',
 'var foo = { boo: 1, foo: 2, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(4),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values when using getters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, get bar() {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values when using setters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, set bar(e) {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values but ignores duplicates', () => {
 const path = parse(
 [
 'var bar = { doo: 4, doo: 5 }',
 'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(5),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values but ignores duplicates with getter and setter', () => {
 const path = parse(
 ['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([]),
 );
 });

 it('does not resolve Object.values when using unresolvable spread', () => {
 const path = parse(
 ['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toBeNull();
 });
});

4 changes: 3 additions & 1 deletion
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
 const type: PropTypeDescriptor = { name: 'enum' };
 let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 value = resolveObjectKeysToArray(value);
 value =
 resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
Expand Down

149 changes: 149 additions & 0 deletions
src/utils/resolveObjectValuesToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * Copyright (c) 2017, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @flow
 *
 */

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
 properties: Array<string>,
 values: Object,
};

const {
 types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
 return (
 types.CallExpression.check(node) &&
 node.arguments.length === 1 &&
 types.MemberExpression.check(node.callee) &&
 types.Identifier.check(node.callee.object) &&
 node.callee.object.name === 'Object' &&
 types.Identifier.check(node.callee.property) &&
 node.callee.property.name === 'values'
 );
}

function isWhitelistedObjectProperty(prop) {
 return (
 (types.Property.check(prop) &&
 ((types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key))) ||
 types.SpreadElement.check(prop)
 );
}

function isWhiteListedObjectTypeProperty(prop) {
 return (
 types.ObjectTypeProperty.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 );
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
 object: NodePath,
 raw: boolean = false,
): ?ObjectPropMap {
 if (
 (types.ObjectExpression.check(object.value) &&
 object.value.properties.every(isWhitelistedObjectProperty)) ||
 (types.ObjectTypeAnnotation.check(object.value) &&
 object.value.properties.every(isWhiteListedObjectTypeProperty))
 ) {
 const properties = [];
 let values = {};
 let error = false;
 object.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (prop.kind === 'get' || prop.kind === 'set') return;

 if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
 const propValue = propPath.get(name).parentPath.value;
 const value =
 propValue.value.value ||
 (raw ? propValue.value.raw : propValue.value.value);

 if (properties.indexOf(name) === -1) {
 properties.push(name);
 }
 values[name] = value;
 } else if (
 types.SpreadElement.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 ) {
 let spreadObject = resolveToValue(propPath.get('argument'));
 if (types.GenericTypeAnnotation.check(spreadObject.value)) {
 const typeAlias = resolveToValue(spreadObject.get('id'));
 if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
 spreadObject = resolveToValue(typeAlias.get('right'));
 }
 }

 const spreadValues = resolveObjectToPropMap(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 spreadValues.properties.forEach(spreadProp => {
 if (properties.indexOf(spreadProp) === -1) {
 properties.push(spreadProp);
 }
 });
 values = { ...values, ...spreadValues.values };
 }
 });

 if (!error) {
 return { properties: properties.sort(), values };
 }
 }

 return null;
}

/**
 * Returns an ArrayExpression which contains all the keys resolved from an object
 *
 * Ignores setters in objects
 *
 * Returns null in case of
 * unresolvable spreads
 * computed identifier values
 */
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
 const node = path.node;

 if (isObjectValuesCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const propMap = resolveObjectToPropMap(objectExpression);

 if (propMap) {
 const nodes = propMap.properties.map(prop => {
 const value = propMap.values[prop];

 return typeof value === 'undefined'
 ? builders.literal(null)
 : builders.literal(value);
 });

 return new NodePath(builders.arrayExpression(nodes));
 }
 }

 return null;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(resolve): resolve Object.values() in PropType.oneOf() by gatsbimantico · Pull Request #318 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

danez
merged 1 commit into

from

Jan 25, 2019
 Merged


feat(resolve): resolve Object.values() in PropType.oneOf()
#318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 20 additions & 4 deletions
src/utils/__tests__/__snapshots__/getPropType-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
 "name": "enum",
 "value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
 "value": Array [
 Object {
 "computed": false,
 "value": "\\"bar\\"",
 },
 Object {
 "computed": false,
 "value": "\\"foo\\"",
 },
 ],
}
`;

Expand Down

11 changes: 10 additions & 1 deletion
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve computed values', () => {
 it('does resolve object keys values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.keys(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does resolve object values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.values(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
 `).get('expression');

 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve external values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(TYPES);
Expand Down

156 changes: 156 additions & 0 deletions
src/utils/__tests__/resolveObjectValuesToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 */

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
 function parse(src) {
 const root = utils.parse(src);
 return root.get('body', root.node.body.length - 1, 'expression');
 }

 it('resolves Object.values with strings', () => {
 const path = parse(
 ['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal('bar'),
 builders.literal('foo'),
 ]),
 );
 });

 it('resolves Object.values with numbers', () => {
 const path = parse(
 ['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(0), builders.literal(5)]),
 );
 });

 it('resolves Object.values with undefined or null', () => {
 const path = parse(
 ['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(null),
 builders.literal(null),
 ]),
 );
 });

 it('resolves Object.values with literals as computed key', () => {
 const path = parse(
 ['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(2), builders.literal(1)]),
 );
 });

 it('resolves Object.values when using resolvable spread', () => {
 const path = parse(
 [
 'var bar = { doo: 4 }',
 'var foo = { boo: 1, foo: 2, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(4),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values when using getters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, get bar() {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values when using setters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, set bar(e) {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values but ignores duplicates', () => {
 const path = parse(
 [
 'var bar = { doo: 4, doo: 5 }',
 'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(5),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values but ignores duplicates with getter and setter', () => {
 const path = parse(
 ['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([]),
 );
 });

 it('does not resolve Object.values when using unresolvable spread', () => {
 const path = parse(
 ['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toBeNull();
 });
});

4 changes: 3 additions & 1 deletion
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
 const type: PropTypeDescriptor = { name: 'enum' };
 let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 value = resolveObjectKeysToArray(value);
 value =
 resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
Expand Down

149 changes: 149 additions & 0 deletions
src/utils/resolveObjectValuesToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * Copyright (c) 2017, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @flow
 *
 */

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
 properties: Array<string>,
 values: Object,
};

const {
 types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
 return (
 types.CallExpression.check(node) &&
 node.arguments.length === 1 &&
 types.MemberExpression.check(node.callee) &&
 types.Identifier.check(node.callee.object) &&
 node.callee.object.name === 'Object' &&
 types.Identifier.check(node.callee.property) &&
 node.callee.property.name === 'values'
 );
}

function isWhitelistedObjectProperty(prop) {
 return (
 (types.Property.check(prop) &&
 ((types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key))) ||
 types.SpreadElement.check(prop)
 );
}

function isWhiteListedObjectTypeProperty(prop) {
 return (
 types.ObjectTypeProperty.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 );
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
 object: NodePath,
 raw: boolean = false,
): ?ObjectPropMap {
 if (
 (types.ObjectExpression.check(object.value) &&
 object.value.properties.every(isWhitelistedObjectProperty)) ||
 (types.ObjectTypeAnnotation.check(object.value) &&
 object.value.properties.every(isWhiteListedObjectTypeProperty))
 ) {
 const properties = [];
 let values = {};
 let error = false;
 object.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (prop.kind === 'get' || prop.kind === 'set') return;

 if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
 const propValue = propPath.get(name).parentPath.value;
 const value =
 propValue.value.value ||
 (raw ? propValue.value.raw : propValue.value.value);

 if (properties.indexOf(name) === -1) {
 properties.push(name);
 }
 values[name] = value;
 } else if (
 types.SpreadElement.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 ) {
 let spreadObject = resolveToValue(propPath.get('argument'));
 if (types.GenericTypeAnnotation.check(spreadObject.value)) {
 const typeAlias = resolveToValue(spreadObject.get('id'));
 if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
 spreadObject = resolveToValue(typeAlias.get('right'));
 }
 }

 const spreadValues = resolveObjectToPropMap(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 spreadValues.properties.forEach(spreadProp => {
 if (properties.indexOf(spreadProp) === -1) {
 properties.push(spreadProp);
 }
 });
 values = { ...values, ...spreadValues.values };
 }
 });

 if (!error) {
 return { properties: properties.sort(), values };
 }
 }

 return null;
}

/**
 * Returns an ArrayExpression which contains all the keys resolved from an object
 *
 * Ignores setters in objects
 *
 * Returns null in case of
 * unresolvable spreads
 * computed identifier values
 */
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
 const node = path.node;

 if (isObjectValuesCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const propMap = resolveObjectToPropMap(objectExpression);

 if (propMap) {
 const nodes = propMap.properties.map(prop => {
 const value = propMap.values[prop];

 return typeof value === 'undefined'
 ? builders.literal(null)
 : builders.literal(value);
 });

 return new NodePath(builders.arrayExpression(nodes));
 }
 }

 return null;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(resolve): resolve Object.values() in PropType.oneOf() by gatsbimantico · Pull Request #318 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

danez
merged 1 commit into

from

Jan 25, 2019
 Merged


feat(resolve): resolve Object.values() in PropType.oneOf()
#318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 20 additions & 4 deletions
src/utils/__tests__/__snapshots__/getPropType-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
 "name": "enum",
 "value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
 "value": Array [
 Object {
 "computed": false,
 "value": "\\"bar\\"",
 },
 Object {
 "computed": false,
 "value": "\\"foo\\"",
 },
 ],
}
`;

Expand Down

11 changes: 10 additions & 1 deletion
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve computed values', () => {
 it('does resolve object keys values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.keys(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does resolve object values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.values(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
 `).get('expression');

 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve external values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(TYPES);
Expand Down

156 changes: 156 additions & 0 deletions
src/utils/__tests__/resolveObjectValuesToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 */

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
 function parse(src) {
 const root = utils.parse(src);
 return root.get('body', root.node.body.length - 1, 'expression');
 }

 it('resolves Object.values with strings', () => {
 const path = parse(
 ['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal('bar'),
 builders.literal('foo'),
 ]),
 );
 });

 it('resolves Object.values with numbers', () => {
 const path = parse(
 ['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(0), builders.literal(5)]),
 );
 });

 it('resolves Object.values with undefined or null', () => {
 const path = parse(
 ['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(null),
 builders.literal(null),
 ]),
 );
 });

 it('resolves Object.values with literals as computed key', () => {
 const path = parse(
 ['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(2), builders.literal(1)]),
 );
 });

 it('resolves Object.values when using resolvable spread', () => {
 const path = parse(
 [
 'var bar = { doo: 4 }',
 'var foo = { boo: 1, foo: 2, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(4),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values when using getters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, get bar() {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values when using setters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, set bar(e) {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values but ignores duplicates', () => {
 const path = parse(
 [
 'var bar = { doo: 4, doo: 5 }',
 'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(5),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values but ignores duplicates with getter and setter', () => {
 const path = parse(
 ['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([]),
 );
 });

 it('does not resolve Object.values when using unresolvable spread', () => {
 const path = parse(
 ['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toBeNull();
 });
});

4 changes: 3 additions & 1 deletion
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
 const type: PropTypeDescriptor = { name: 'enum' };
 let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 value = resolveObjectKeysToArray(value);
 value =
 resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
Expand Down

149 changes: 149 additions & 0 deletions
src/utils/resolveObjectValuesToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * Copyright (c) 2017, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @flow
 *
 */

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
 properties: Array<string>,
 values: Object,
};

const {
 types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
 return (
 types.CallExpression.check(node) &&
 node.arguments.length === 1 &&
 types.MemberExpression.check(node.callee) &&
 types.Identifier.check(node.callee.object) &&
 node.callee.object.name === 'Object' &&
 types.Identifier.check(node.callee.property) &&
 node.callee.property.name === 'values'
 );
}

function isWhitelistedObjectProperty(prop) {
 return (
 (types.Property.check(prop) &&
 ((types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key))) ||
 types.SpreadElement.check(prop)
 );
}

function isWhiteListedObjectTypeProperty(prop) {
 return (
 types.ObjectTypeProperty.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 );
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
 object: NodePath,
 raw: boolean = false,
): ?ObjectPropMap {
 if (
 (types.ObjectExpression.check(object.value) &&
 object.value.properties.every(isWhitelistedObjectProperty)) ||
 (types.ObjectTypeAnnotation.check(object.value) &&
 object.value.properties.every(isWhiteListedObjectTypeProperty))
 ) {
 const properties = [];
 let values = {};
 let error = false;
 object.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (prop.kind === 'get' || prop.kind === 'set') return;

 if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
 const propValue = propPath.get(name).parentPath.value;
 const value =
 propValue.value.value ||
 (raw ? propValue.value.raw : propValue.value.value);

 if (properties.indexOf(name) === -1) {
 properties.push(name);
 }
 values[name] = value;
 } else if (
 types.SpreadElement.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 ) {
 let spreadObject = resolveToValue(propPath.get('argument'));
 if (types.GenericTypeAnnotation.check(spreadObject.value)) {
 const typeAlias = resolveToValue(spreadObject.get('id'));
 if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
 spreadObject = resolveToValue(typeAlias.get('right'));
 }
 }

 const spreadValues = resolveObjectToPropMap(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 spreadValues.properties.forEach(spreadProp => {
 if (properties.indexOf(spreadProp) === -1) {
 properties.push(spreadProp);
 }
 });
 values = { ...values, ...spreadValues.values };
 }
 });

 if (!error) {
 return { properties: properties.sort(), values };
 }
 }

 return null;
}

/**
 * Returns an ArrayExpression which contains all the keys resolved from an object
 *
 * Ignores setters in objects
 *
 * Returns null in case of
 * unresolvable spreads
 * computed identifier values
 */
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
 const node = path.node;

 if (isObjectValuesCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const propMap = resolveObjectToPropMap(objectExpression);

 if (propMap) {
 const nodes = propMap.properties.map(prop => {
 const value = propMap.values[prop];

 return typeof value === 'undefined'
 ? builders.literal(null)
 : builders.literal(value);
 });

 return new NodePath(builders.arrayExpression(nodes));
 }
 }

 return null;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(resolve): resolve Object.values() in PropType.oneOf() by gatsbimantico · Pull Request #318 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

danez
merged 1 commit into

from

Jan 25, 2019
 Merged


feat(resolve): resolve Object.values() in PropType.oneOf()
#318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 20 additions & 4 deletions
src/utils/__tests__/__snapshots__/getPropType-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
 "name": "enum",
 "value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
 "value": Array [
 Object {
 "computed": false,
 "value": "\\"bar\\"",
 },
 Object {
 "computed": false,
 "value": "\\"foo\\"",
 },
 ],
}
`;

Expand Down

11 changes: 10 additions & 1 deletion
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve computed values', () => {
 it('does resolve object keys values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.keys(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does resolve object values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.values(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
 `).get('expression');

 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve external values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(TYPES);
Expand Down

156 changes: 156 additions & 0 deletions
src/utils/__tests__/resolveObjectValuesToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 */

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
 function parse(src) {
 const root = utils.parse(src);
 return root.get('body', root.node.body.length - 1, 'expression');
 }

 it('resolves Object.values with strings', () => {
 const path = parse(
 ['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal('bar'),
 builders.literal('foo'),
 ]),
 );
 });

 it('resolves Object.values with numbers', () => {
 const path = parse(
 ['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(0), builders.literal(5)]),
 );
 });

 it('resolves Object.values with undefined or null', () => {
 const path = parse(
 ['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(null),
 builders.literal(null),
 ]),
 );
 });

 it('resolves Object.values with literals as computed key', () => {
 const path = parse(
 ['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(2), builders.literal(1)]),
 );
 });

 it('resolves Object.values when using resolvable spread', () => {
 const path = parse(
 [
 'var bar = { doo: 4 }',
 'var foo = { boo: 1, foo: 2, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(4),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values when using getters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, get bar() {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values when using setters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, set bar(e) {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values but ignores duplicates', () => {
 const path = parse(
 [
 'var bar = { doo: 4, doo: 5 }',
 'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(5),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values but ignores duplicates with getter and setter', () => {
 const path = parse(
 ['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([]),
 );
 });

 it('does not resolve Object.values when using unresolvable spread', () => {
 const path = parse(
 ['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toBeNull();
 });
});

4 changes: 3 additions & 1 deletion
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
 const type: PropTypeDescriptor = { name: 'enum' };
 let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 value = resolveObjectKeysToArray(value);
 value =
 resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
Expand Down

149 changes: 149 additions & 0 deletions
src/utils/resolveObjectValuesToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * Copyright (c) 2017, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @flow
 *
 */

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
 properties: Array<string>,
 values: Object,
};

const {
 types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
 return (
 types.CallExpression.check(node) &&
 node.arguments.length === 1 &&
 types.MemberExpression.check(node.callee) &&
 types.Identifier.check(node.callee.object) &&
 node.callee.object.name === 'Object' &&
 types.Identifier.check(node.callee.property) &&
 node.callee.property.name === 'values'
 );
}

function isWhitelistedObjectProperty(prop) {
 return (
 (types.Property.check(prop) &&
 ((types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key))) ||
 types.SpreadElement.check(prop)
 );
}

function isWhiteListedObjectTypeProperty(prop) {
 return (
 types.ObjectTypeProperty.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 );
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
 object: NodePath,
 raw: boolean = false,
): ?ObjectPropMap {
 if (
 (types.ObjectExpression.check(object.value) &&
 object.value.properties.every(isWhitelistedObjectProperty)) ||
 (types.ObjectTypeAnnotation.check(object.value) &&
 object.value.properties.every(isWhiteListedObjectTypeProperty))
 ) {
 const properties = [];
 let values = {};
 let error = false;
 object.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (prop.kind === 'get' || prop.kind === 'set') return;

 if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
 const propValue = propPath.get(name).parentPath.value;
 const value =
 propValue.value.value ||
 (raw ? propValue.value.raw : propValue.value.value);

 if (properties.indexOf(name) === -1) {
 properties.push(name);
 }
 values[name] = value;
 } else if (
 types.SpreadElement.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 ) {
 let spreadObject = resolveToValue(propPath.get('argument'));
 if (types.GenericTypeAnnotation.check(spreadObject.value)) {
 const typeAlias = resolveToValue(spreadObject.get('id'));
 if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
 spreadObject = resolveToValue(typeAlias.get('right'));
 }
 }

 const spreadValues = resolveObjectToPropMap(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 spreadValues.properties.forEach(spreadProp => {
 if (properties.indexOf(spreadProp) === -1) {
 properties.push(spreadProp);
 }
 });
 values = { ...values, ...spreadValues.values };
 }
 });

 if (!error) {
 return { properties: properties.sort(), values };
 }
 }

 return null;
}

/**
 * Returns an ArrayExpression which contains all the keys resolved from an object
 *
 * Ignores setters in objects
 *
 * Returns null in case of
 * unresolvable spreads
 * computed identifier values
 */
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
 const node = path.node;

 if (isObjectValuesCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const propMap = resolveObjectToPropMap(objectExpression);

 if (propMap) {
 const nodes = propMap.properties.map(prop => {
 const value = propMap.values[prop];

 return typeof value === 'undefined'
 ? builders.literal(null)
 : builders.literal(value);
 });

 return new NodePath(builders.arrayExpression(nodes));
 }
 }

 return null;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(resolve): resolve Object.values() in PropType.oneOf() by gatsbimantico · Pull Request #318 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

danez
merged 1 commit into

from

Jan 25, 2019
 Merged


feat(resolve): resolve Object.values() in PropType.oneOf()
#318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 20 additions & 4 deletions
src/utils/__tests__/__snapshots__/getPropType-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
 "name": "enum",
 "value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
 "value": Array [
 Object {
 "computed": false,
 "value": "\\"bar\\"",
 },
 Object {
 "computed": false,
 "value": "\\"foo\\"",
 },
 ],
}
`;

Expand Down

11 changes: 10 additions & 1 deletion
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve computed values', () => {
 it('does resolve object keys values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.keys(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does resolve object values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.values(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
 `).get('expression');

 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve external values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(TYPES);
Expand Down

156 changes: 156 additions & 0 deletions
src/utils/__tests__/resolveObjectValuesToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 */

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
 function parse(src) {
 const root = utils.parse(src);
 return root.get('body', root.node.body.length - 1, 'expression');
 }

 it('resolves Object.values with strings', () => {
 const path = parse(
 ['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal('bar'),
 builders.literal('foo'),
 ]),
 );
 });

 it('resolves Object.values with numbers', () => {
 const path = parse(
 ['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(0), builders.literal(5)]),
 );
 });

 it('resolves Object.values with undefined or null', () => {
 const path = parse(
 ['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(null),
 builders.literal(null),
 ]),
 );
 });

 it('resolves Object.values with literals as computed key', () => {
 const path = parse(
 ['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(2), builders.literal(1)]),
 );
 });

 it('resolves Object.values when using resolvable spread', () => {
 const path = parse(
 [
 'var bar = { doo: 4 }',
 'var foo = { boo: 1, foo: 2, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(4),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values when using getters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, get bar() {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values when using setters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, set bar(e) {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values but ignores duplicates', () => {
 const path = parse(
 [
 'var bar = { doo: 4, doo: 5 }',
 'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(5),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values but ignores duplicates with getter and setter', () => {
 const path = parse(
 ['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([]),
 );
 });

 it('does not resolve Object.values when using unresolvable spread', () => {
 const path = parse(
 ['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toBeNull();
 });
});

4 changes: 3 additions & 1 deletion
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
 const type: PropTypeDescriptor = { name: 'enum' };
 let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 value = resolveObjectKeysToArray(value);
 value =
 resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
Expand Down

149 changes: 149 additions & 0 deletions
src/utils/resolveObjectValuesToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * Copyright (c) 2017, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @flow
 *
 */

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
 properties: Array<string>,
 values: Object,
};

const {
 types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
 return (
 types.CallExpression.check(node) &&
 node.arguments.length === 1 &&
 types.MemberExpression.check(node.callee) &&
 types.Identifier.check(node.callee.object) &&
 node.callee.object.name === 'Object' &&
 types.Identifier.check(node.callee.property) &&
 node.callee.property.name === 'values'
 );
}

function isWhitelistedObjectProperty(prop) {
 return (
 (types.Property.check(prop) &&
 ((types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key))) ||
 types.SpreadElement.check(prop)
 );
}

function isWhiteListedObjectTypeProperty(prop) {
 return (
 types.ObjectTypeProperty.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 );
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
 object: NodePath,
 raw: boolean = false,
): ?ObjectPropMap {
 if (
 (types.ObjectExpression.check(object.value) &&
 object.value.properties.every(isWhitelistedObjectProperty)) ||
 (types.ObjectTypeAnnotation.check(object.value) &&
 object.value.properties.every(isWhiteListedObjectTypeProperty))
 ) {
 const properties = [];
 let values = {};
 let error = false;
 object.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (prop.kind === 'get' || prop.kind === 'set') return;

 if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
 const propValue = propPath.get(name).parentPath.value;
 const value =
 propValue.value.value ||
 (raw ? propValue.value.raw : propValue.value.value);

 if (properties.indexOf(name) === -1) {
 properties.push(name);
 }
 values[name] = value;
 } else if (
 types.SpreadElement.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 ) {
 let spreadObject = resolveToValue(propPath.get('argument'));
 if (types.GenericTypeAnnotation.check(spreadObject.value)) {
 const typeAlias = resolveToValue(spreadObject.get('id'));
 if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
 spreadObject = resolveToValue(typeAlias.get('right'));
 }
 }

 const spreadValues = resolveObjectToPropMap(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 spreadValues.properties.forEach(spreadProp => {
 if (properties.indexOf(spreadProp) === -1) {
 properties.push(spreadProp);
 }
 });
 values = { ...values, ...spreadValues.values };
 }
 });

 if (!error) {
 return { properties: properties.sort(), values };
 }
 }

 return null;
}

/**
 * Returns an ArrayExpression which contains all the keys resolved from an object
 *
 * Ignores setters in objects
 *
 * Returns null in case of
 * unresolvable spreads
 * computed identifier values
 */
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
 const node = path.node;

 if (isObjectValuesCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const propMap = resolveObjectToPropMap(objectExpression);

 if (propMap) {
 const nodes = propMap.properties.map(prop => {
 const value = propMap.values[prop];

 return typeof value === 'undefined'
 ? builders.literal(null)
 : builders.literal(value);
 });

 return new NodePath(builders.arrayExpression(nodes));
 }
 }

 return null;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(resolve): resolve Object.values() in PropType.oneOf() by gatsbimantico · Pull Request #318 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

danez
merged 1 commit into

from

Jan 25, 2019
 Merged


feat(resolve): resolve Object.values() in PropType.oneOf()
#318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 20 additions & 4 deletions
src/utils/__tests__/__snapshots__/getPropType-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
 "name": "enum",
 "value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
 "value": Array [
 Object {
 "computed": false,
 "value": "\\"bar\\"",
 },
 Object {
 "computed": false,
 "value": "\\"foo\\"",
 },
 ],
}
`;

Expand Down

11 changes: 10 additions & 1 deletion
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve computed values', () => {
 it('does resolve object keys values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.keys(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does resolve object values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.values(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
 `).get('expression');

 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve external values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(TYPES);
Expand Down

156 changes: 156 additions & 0 deletions
src/utils/__tests__/resolveObjectValuesToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 */

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
 function parse(src) {
 const root = utils.parse(src);
 return root.get('body', root.node.body.length - 1, 'expression');
 }

 it('resolves Object.values with strings', () => {
 const path = parse(
 ['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal('bar'),
 builders.literal('foo'),
 ]),
 );
 });

 it('resolves Object.values with numbers', () => {
 const path = parse(
 ['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(0), builders.literal(5)]),
 );
 });

 it('resolves Object.values with undefined or null', () => {
 const path = parse(
 ['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(null),
 builders.literal(null),
 ]),
 );
 });

 it('resolves Object.values with literals as computed key', () => {
 const path = parse(
 ['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(2), builders.literal(1)]),
 );
 });

 it('resolves Object.values when using resolvable spread', () => {
 const path = parse(
 [
 'var bar = { doo: 4 }',
 'var foo = { boo: 1, foo: 2, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(4),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values when using getters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, get bar() {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values when using setters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, set bar(e) {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values but ignores duplicates', () => {
 const path = parse(
 [
 'var bar = { doo: 4, doo: 5 }',
 'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(5),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values but ignores duplicates with getter and setter', () => {
 const path = parse(
 ['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([]),
 );
 });

 it('does not resolve Object.values when using unresolvable spread', () => {
 const path = parse(
 ['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toBeNull();
 });
});

4 changes: 3 additions & 1 deletion
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
 const type: PropTypeDescriptor = { name: 'enum' };
 let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 value = resolveObjectKeysToArray(value);
 value =
 resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
Expand Down

149 changes: 149 additions & 0 deletions
src/utils/resolveObjectValuesToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * Copyright (c) 2017, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @flow
 *
 */

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
 properties: Array<string>,
 values: Object,
};

const {
 types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
 return (
 types.CallExpression.check(node) &&
 node.arguments.length === 1 &&
 types.MemberExpression.check(node.callee) &&
 types.Identifier.check(node.callee.object) &&
 node.callee.object.name === 'Object' &&
 types.Identifier.check(node.callee.property) &&
 node.callee.property.name === 'values'
 );
}

function isWhitelistedObjectProperty(prop) {
 return (
 (types.Property.check(prop) &&
 ((types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key))) ||
 types.SpreadElement.check(prop)
 );
}

function isWhiteListedObjectTypeProperty(prop) {
 return (
 types.ObjectTypeProperty.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 );
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
 object: NodePath,
 raw: boolean = false,
): ?ObjectPropMap {
 if (
 (types.ObjectExpression.check(object.value) &&
 object.value.properties.every(isWhitelistedObjectProperty)) ||
 (types.ObjectTypeAnnotation.check(object.value) &&
 object.value.properties.every(isWhiteListedObjectTypeProperty))
 ) {
 const properties = [];
 let values = {};
 let error = false;
 object.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (prop.kind === 'get' || prop.kind === 'set') return;

 if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
 const propValue = propPath.get(name).parentPath.value;
 const value =
 propValue.value.value ||
 (raw ? propValue.value.raw : propValue.value.value);

 if (properties.indexOf(name) === -1) {
 properties.push(name);
 }
 values[name] = value;
 } else if (
 types.SpreadElement.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 ) {
 let spreadObject = resolveToValue(propPath.get('argument'));
 if (types.GenericTypeAnnotation.check(spreadObject.value)) {
 const typeAlias = resolveToValue(spreadObject.get('id'));
 if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
 spreadObject = resolveToValue(typeAlias.get('right'));
 }
 }

 const spreadValues = resolveObjectToPropMap(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 spreadValues.properties.forEach(spreadProp => {
 if (properties.indexOf(spreadProp) === -1) {
 properties.push(spreadProp);
 }
 });
 values = { ...values, ...spreadValues.values };
 }
 });

 if (!error) {
 return { properties: properties.sort(), values };
 }
 }

 return null;
}

/**
 * Returns an ArrayExpression which contains all the keys resolved from an object
 *
 * Ignores setters in objects
 *
 * Returns null in case of
 * unresolvable spreads
 * computed identifier values
 */
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
 const node = path.node;

 if (isObjectValuesCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const propMap = resolveObjectToPropMap(objectExpression);

 if (propMap) {
 const nodes = propMap.properties.map(prop => {
 const value = propMap.values[prop];

 return typeof value === 'undefined'
 ? builders.literal(null)
 : builders.literal(value);
 });

 return new NodePath(builders.arrayExpression(nodes));
 }
 }

 return null;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(resolve): resolve Object.values() in PropType.oneOf() by gatsbimantico · Pull Request #318 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.values() in PropType.oneOf()#318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

danez
merged 1 commit into

from

Jan 25, 2019
 Merged


feat(resolve): resolve Object.values() in PropType.oneOf()
#318
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


24 changes: 20 additions & 4 deletions
src/utils/__tests__/__snapshots__/getPropType-test.js.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve computed values 1`] = `
exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
}
`;

exports[`getPropType resolve identifier to their values does resolve object keys values 1`] = `
Object {
 "name": "enum",
 "value": Array [
Expand All@@ -150,11 +158,19 @@ Object {
}
`;

exports[`getPropType resolve identifier to their values does not resolve external values 1`] = `
exports[`getPropType resolve identifier to their values does resolve object values 1`] = `
Object {
 "computed": true,
 "name": "enum",
 "value": "TYPES",
 "value": Array [
 Object {
 "computed": false,
 "value": "\\"bar\\"",
 },
 Object {
 "computed": false,
 "value": "\\"foo\\"",
 },
 ],
}
`;

Expand Down

11 changes: 10 additions & 1 deletion
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -222,7 +222,7 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve computed values', () => {
 it('does resolve object keys values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.keys(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
Expand All@@ -231,6 +231,15 @@ describe('getPropType', () => {
 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does resolve object values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(Object.values(TYPES));
 var TYPES = { FOO: "foo", BAR: "bar" };
 `).get('expression');

 expect(getPropType(propTypeExpression)).toMatchSnapshot();
 });

 it('does not resolve external values', () => {
 const propTypeExpression = statement(`
 PropTypes.oneOf(TYPES);
Expand Down

156 changes: 156 additions & 0 deletions
src/utils/__tests__/resolveObjectValuesToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
/*
 * Copyright (c) 2015, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 */

/* eslint-env jest */

import recast from 'recast';

const builders = recast.types.builders;
import resolveObjectValuesToArray from '../resolveObjectValuesToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectValuesToArray', () => {
 function parse(src) {
 const root = utils.parse(src);
 return root.get('body', root.node.body.length - 1, 'expression');
 }

 it('resolves Object.values with strings', () => {
 const path = parse(
 ['var foo = { 1: "bar", 2: "foo" };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal('bar'),
 builders.literal('foo'),
 ]),
 );
 });

 it('resolves Object.values with numbers', () => {
 const path = parse(
 ['var foo = { 1: 0, 2: 5 };', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(0), builders.literal(5)]),
 );
 });

 it('resolves Object.values with undefined or null', () => {
 const path = parse(
 ['var foo = { 1: null, 2: undefined };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(null),
 builders.literal(null),
 ]),
 );
 });

 it('resolves Object.values with literals as computed key', () => {
 const path = parse(
 ['var foo = { ["bar"]: 1, [5]: 2};', 'Object.values(foo);'].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(2), builders.literal(1)]),
 );
 });

 it('resolves Object.values when using resolvable spread', () => {
 const path = parse(
 [
 'var bar = { doo: 4 }',
 'var foo = { boo: 1, foo: 2, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(4),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values when using getters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, get bar() {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values when using setters', () => {
 const path = parse(
 [
 'var foo = { boo: 1, foo: 2, set bar(e) {} };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([builders.literal(1), builders.literal(2)]),
 );
 });

 it('resolves Object.values but ignores duplicates', () => {
 const path = parse(
 [
 'var bar = { doo: 4, doo: 5 }',
 'var foo = { boo: 1, foo: 2, doo: 1, ...bar };',
 'Object.values(foo);',
 ].join('\n'),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([
 builders.literal(1),
 builders.literal(5),
 builders.literal(2),
 ]),
 );
 });

 it('resolves Object.values but ignores duplicates with getter and setter', () => {
 const path = parse(
 ['var foo = { get x() {}, set x(a) {} };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toEqualASTNode(
 builders.arrayExpression([]),
 );
 });

 it('does not resolve Object.values when using unresolvable spread', () => {
 const path = parse(
 ['var foo = { bar: 1, foo: 2, ...bar };', 'Object.values(foo);'].join(
 '\n',
 ),
 );

 expect(resolveObjectValuesToArray(path)).toBeNull();
 });
});

4 changes: 3 additions & 1 deletion
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';
import resolveObjectValuesToArray from './resolveObjectValuesToArray';
import type { PropTypeDescriptor, PropDescriptor } from '../types';

const {
Expand DownExpand Up@@ -60,7 +61,8 @@ function getPropTypeOneOf(argumentPath) {
 const type: PropTypeDescriptor = { name: 'enum' };
 let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 value = resolveObjectKeysToArray(value);
 value =
 resolveObjectKeysToArray(value) || resolveObjectValuesToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
Expand Down

149 changes: 149 additions & 0 deletions
src/utils/resolveObjectValuesToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * Copyright (c) 2017, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *
 * @flow
 *
 */

import recast from 'recast';
import resolveToValue from './resolveToValue';

type ObjectPropMap = {
 properties: Array<string>,
 values: Object,
};

const {
 types: { ASTNode, NodePath, builders, namedTypes: types },
} = recast;

function isObjectValuesCall(node: ASTNode): boolean {
 return (
 types.CallExpression.check(node) &&
 node.arguments.length === 1 &&
 types.MemberExpression.check(node.callee) &&
 types.Identifier.check(node.callee.object) &&
 node.callee.object.name === 'Object' &&
 types.Identifier.check(node.callee.property) &&
 node.callee.property.name === 'values'
 );
}

function isWhitelistedObjectProperty(prop) {
 return (
 (types.Property.check(prop) &&
 ((types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key))) ||
 types.SpreadElement.check(prop)
 );
}

function isWhiteListedObjectTypeProperty(prop) {
 return (
 types.ObjectTypeProperty.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 );
}

// Resolves an ObjectExpression or an ObjectTypeAnnotation
export function resolveObjectToPropMap(
 object: NodePath,
 raw: boolean = false,
): ?ObjectPropMap {
 if (
 (types.ObjectExpression.check(object.value) &&
 object.value.properties.every(isWhitelistedObjectProperty)) ||
 (types.ObjectTypeAnnotation.check(object.value) &&
 object.value.properties.every(isWhiteListedObjectTypeProperty))
 ) {
 const properties = [];
 let values = {};
 let error = false;
 object.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (prop.kind === 'get' || prop.kind === 'set') return;

 if (types.Property.check(prop) || types.ObjectTypeProperty.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || (raw ? prop.key.raw : prop.key.value);
 const propValue = propPath.get(name).parentPath.value;
 const value =
 propValue.value.value ||
 (raw ? propValue.value.raw : propValue.value.value);

 if (properties.indexOf(name) === -1) {
 properties.push(name);
 }
 values[name] = value;
 } else if (
 types.SpreadElement.check(prop) ||
 types.ObjectTypeSpreadProperty.check(prop)
 ) {
 let spreadObject = resolveToValue(propPath.get('argument'));
 if (types.GenericTypeAnnotation.check(spreadObject.value)) {
 const typeAlias = resolveToValue(spreadObject.get('id'));
 if (types.ObjectTypeAnnotation.check(typeAlias.get('right').value)) {
 spreadObject = resolveToValue(typeAlias.get('right'));
 }
 }

 const spreadValues = resolveObjectToPropMap(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 spreadValues.properties.forEach(spreadProp => {
 if (properties.indexOf(spreadProp) === -1) {
 properties.push(spreadProp);
 }
 });
 values = { ...values, ...spreadValues.values };
 }
 });

 if (!error) {
 return { properties: properties.sort(), values };
 }
 }

 return null;
}

/**
 * Returns an ArrayExpression which contains all the keys resolved from an object
 *
 * Ignores setters in objects
 *
 * Returns null in case of
 * unresolvable spreads
 * computed identifier values
 */
export default function resolveObjectValuesToArray(path: NodePath): ?NodePath {
 const node = path.node;

 if (isObjectValuesCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const propMap = resolveObjectToPropMap(objectExpression);

 if (propMap) {
 const nodes = propMap.properties.map(prop => {
 const value = propMap.values[prop];

 return typeof value === 'undefined'
 ? builders.literal(null)
 : builders.literal(value);
 });

 return new NodePath(builders.arrayExpression(nodes));
 }
 }

 return null;
}