Skip to content

feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into from
Sep 5, 2017
Merged

feat(resolve): resolve Object.keys() in PropType.oneOf() #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
600babd
feat(resolve): resolve Object.keys() in PropType.oneOf()
danez Aug 24, 2017
d1abfb9
Use same logic as JS itself and do not ignore setters
danez Sep 5, 2017
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
6 changes: 4 additions & 2 deletions src/utils/__tests__/getPropType-test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

expect(getPropType(propTypeExpression)).toEqual({
name: 'enum',
value: 'Object.keys(TYPES)',
computed: true,
value: [
{value: '"FOO"', computed: false},
{value: '"BAR"', computed: false},
],
});
});

Expand Down
149 changes: 149 additions & 0 deletions src/utils/__tests__/resolveObjectKeysToArray-test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
* 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
builders.arrayExpression(
[builders.literal('bar'), builders.literal('5')]
)
);
});

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

expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
builders.arrayExpression(
[builders.literal('bar'), builders.literal('5')]
)
);
});

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

expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
builders.arrayExpression(
[builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
)
);
});

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

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

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

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

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

expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
builders.arrayExpression(
[builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
)
);
});

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

expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
builders.arrayExpression(
[builders.literal('x')]
)
);
});

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

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

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

expect(resolveObjectKeysToArray(path)).toBeNull();
});
});
16 changes: 11 additions & 5 deletions src/utils/getPropType.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
if (!types.ArrayExpression.check(value.node)) {
// could not easily resolve to an Array, let's print the original value
type.computed = true;
type.value = printValue(argumentPath);
value = resolveObjectKeysToArray(value);
if (value) {
type.value = getEnumValues(value);
} else {
// could not easily resolve to an Array, let's print the original value
type.computed = true;
type.value = printValue(argumentPath);
}
} else {
type.value = getEnumValues(value);
}
Expand Down
105 changes: 105 additions & 0 deletions src/utils/resolveObjectKeysToArray.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
* 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';

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

function isObjectKeysCall(node: ASTNode): bool {
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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
if (
types.ObjectExpression.check(objectExpression.value) &&
objectExpression.value.properties.every(
prop =>
types.Property.check(prop) &&
(
(types.Identifier.check(prop.key) && !prop.computed) ||
types.Literal.check(prop.key)
) ||
types.SpreadProperty.check(prop)
)
) {
let values = [];
let error = false;
objectExpression.get('properties').each(propPath => {
if (error) return;
const prop = propPath.value;

if (types.Property.check(prop)) {
// Key is either Identifier or Literal
const name = prop.key.name || prop.key.value;

values.push(name);
} else if (types.SpreadProperty.check(prop)) {
const spreadObject = resolveToValue(propPath.get('argument'));
const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
if (!spreadValues) {
error = true;
return;
}
values = [...values, ...spreadValues];
}

});

if (!error) {
return 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 keys
*/
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
var node = path.node;

if (isObjectKeysCall(node)) {
const objectExpression = resolveToValue(path.get('arguments').get(0));
const values = resolveObjectExpressionToNameArray(objectExpression);

if (values) {
const nodes = values
.filter((value, index, array) => array.indexOf(value) === index)
.map(value => 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.keys() in PropType.oneOf() by danez · Pull Request #211 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into

from

Sep 5, 2017
 Merged


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
600babd

feat(resolve): resolve Object.keys() in PropType.oneOf()


danez Aug 24, 2017
d1abfb9

Use same logic as JS itself and do not ignore setters


danez Sep 5, 2017

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


6 changes: 4 additions & 2 deletions
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

 expect(getPropType(propTypeExpression)).toEqual({
 name: 'enum',
 value: 'Object.keys(TYPES)',
 computed: true,
 value: [
 {value: '"FOO"', computed: false},
 {value: '"BAR"', computed: false},
 ],
 });
 });

Expand Down

149 changes: 149 additions & 0 deletions
src/utils/__tests__/resolveObjectKeysToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('x')]
 )
 );
 });

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

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

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

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

16 changes: 11 additions & 5 deletions
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 value = resolveObjectKeysToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 }
 } else {
 type.value = getEnumValues(value);
 }
Expand Down

105 changes: 105 additions & 0 deletions
src/utils/resolveObjectKeysToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
 * 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';

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

function isObjectKeysCall(node: ASTNode): bool {
 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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
 if (
 types.ObjectExpression.check(objectExpression.value) &&
 objectExpression.value.properties.every(
 prop =>
 types.Property.check(prop) &&
 (
 (types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key)
 ) ||
 types.SpreadProperty.check(prop)
 )
 ) {
 let values = [];
 let error = false;
 objectExpression.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (types.Property.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || prop.key.value;

 values.push(name);
 } else if (types.SpreadProperty.check(prop)) {
 const spreadObject = resolveToValue(propPath.get('argument'));
 const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 values = [...values, ...spreadValues];
 }

 });

 if (!error) {
 return 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 keys
 */
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
 var node = path.node;

 if (isObjectKeysCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const values = resolveObjectExpressionToNameArray(objectExpression);

 if (values) {
 const nodes = values
 .filter((value, index, array) => array.indexOf(value) === index)
 .map(value => 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.keys() in PropType.oneOf() by danez · Pull Request #211 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into

from

Sep 5, 2017
 Merged


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
600babd

feat(resolve): resolve Object.keys() in PropType.oneOf()


danez Aug 24, 2017
d1abfb9

Use same logic as JS itself and do not ignore setters


danez Sep 5, 2017

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


6 changes: 4 additions & 2 deletions
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

 expect(getPropType(propTypeExpression)).toEqual({
 name: 'enum',
 value: 'Object.keys(TYPES)',
 computed: true,
 value: [
 {value: '"FOO"', computed: false},
 {value: '"BAR"', computed: false},
 ],
 });
 });

Expand Down

149 changes: 149 additions & 0 deletions
src/utils/__tests__/resolveObjectKeysToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('x')]
 )
 );
 });

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

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

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

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

16 changes: 11 additions & 5 deletions
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 value = resolveObjectKeysToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 }
 } else {
 type.value = getEnumValues(value);
 }
Expand Down

105 changes: 105 additions & 0 deletions
src/utils/resolveObjectKeysToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
 * 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';

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

function isObjectKeysCall(node: ASTNode): bool {
 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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
 if (
 types.ObjectExpression.check(objectExpression.value) &&
 objectExpression.value.properties.every(
 prop =>
 types.Property.check(prop) &&
 (
 (types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key)
 ) ||
 types.SpreadProperty.check(prop)
 )
 ) {
 let values = [];
 let error = false;
 objectExpression.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (types.Property.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || prop.key.value;

 values.push(name);
 } else if (types.SpreadProperty.check(prop)) {
 const spreadObject = resolveToValue(propPath.get('argument'));
 const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 values = [...values, ...spreadValues];
 }

 });

 if (!error) {
 return 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 keys
 */
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
 var node = path.node;

 if (isObjectKeysCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const values = resolveObjectExpressionToNameArray(objectExpression);

 if (values) {
 const nodes = values
 .filter((value, index, array) => array.indexOf(value) === index)
 .map(value => 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.keys() in PropType.oneOf() by danez · Pull Request #211 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into

from

Sep 5, 2017
 Merged


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
600babd

feat(resolve): resolve Object.keys() in PropType.oneOf()


danez Aug 24, 2017
d1abfb9

Use same logic as JS itself and do not ignore setters


danez Sep 5, 2017

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


6 changes: 4 additions & 2 deletions
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

 expect(getPropType(propTypeExpression)).toEqual({
 name: 'enum',
 value: 'Object.keys(TYPES)',
 computed: true,
 value: [
 {value: '"FOO"', computed: false},
 {value: '"BAR"', computed: false},
 ],
 });
 });

Expand Down

149 changes: 149 additions & 0 deletions
src/utils/__tests__/resolveObjectKeysToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('x')]
 )
 );
 });

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

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

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

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

16 changes: 11 additions & 5 deletions
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 value = resolveObjectKeysToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 }
 } else {
 type.value = getEnumValues(value);
 }
Expand Down

105 changes: 105 additions & 0 deletions
src/utils/resolveObjectKeysToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
 * 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';

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

function isObjectKeysCall(node: ASTNode): bool {
 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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
 if (
 types.ObjectExpression.check(objectExpression.value) &&
 objectExpression.value.properties.every(
 prop =>
 types.Property.check(prop) &&
 (
 (types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key)
 ) ||
 types.SpreadProperty.check(prop)
 )
 ) {
 let values = [];
 let error = false;
 objectExpression.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (types.Property.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || prop.key.value;

 values.push(name);
 } else if (types.SpreadProperty.check(prop)) {
 const spreadObject = resolveToValue(propPath.get('argument'));
 const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 values = [...values, ...spreadValues];
 }

 });

 if (!error) {
 return 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 keys
 */
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
 var node = path.node;

 if (isObjectKeysCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const values = resolveObjectExpressionToNameArray(objectExpression);

 if (values) {
 const nodes = values
 .filter((value, index, array) => array.indexOf(value) === index)
 .map(value => 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.keys() in PropType.oneOf() by danez · Pull Request #211 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into

from

Sep 5, 2017
 Merged


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
600babd

feat(resolve): resolve Object.keys() in PropType.oneOf()


danez Aug 24, 2017
d1abfb9

Use same logic as JS itself and do not ignore setters


danez Sep 5, 2017

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


6 changes: 4 additions & 2 deletions
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

 expect(getPropType(propTypeExpression)).toEqual({
 name: 'enum',
 value: 'Object.keys(TYPES)',
 computed: true,
 value: [
 {value: '"FOO"', computed: false},
 {value: '"BAR"', computed: false},
 ],
 });
 });

Expand Down

149 changes: 149 additions & 0 deletions
src/utils/__tests__/resolveObjectKeysToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('x')]
 )
 );
 });

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

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

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

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

16 changes: 11 additions & 5 deletions
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 value = resolveObjectKeysToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 }
 } else {
 type.value = getEnumValues(value);
 }
Expand Down

105 changes: 105 additions & 0 deletions
src/utils/resolveObjectKeysToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
 * 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';

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

function isObjectKeysCall(node: ASTNode): bool {
 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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
 if (
 types.ObjectExpression.check(objectExpression.value) &&
 objectExpression.value.properties.every(
 prop =>
 types.Property.check(prop) &&
 (
 (types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key)
 ) ||
 types.SpreadProperty.check(prop)
 )
 ) {
 let values = [];
 let error = false;
 objectExpression.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (types.Property.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || prop.key.value;

 values.push(name);
 } else if (types.SpreadProperty.check(prop)) {
 const spreadObject = resolveToValue(propPath.get('argument'));
 const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 values = [...values, ...spreadValues];
 }

 });

 if (!error) {
 return 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 keys
 */
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
 var node = path.node;

 if (isObjectKeysCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const values = resolveObjectExpressionToNameArray(objectExpression);

 if (values) {
 const nodes = values
 .filter((value, index, array) => array.indexOf(value) === index)
 .map(value => 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.keys() in PropType.oneOf() by danez · Pull Request #211 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into

from

Sep 5, 2017
 Merged


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
600babd

feat(resolve): resolve Object.keys() in PropType.oneOf()


danez Aug 24, 2017
d1abfb9

Use same logic as JS itself and do not ignore setters


danez Sep 5, 2017

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


6 changes: 4 additions & 2 deletions
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

 expect(getPropType(propTypeExpression)).toEqual({
 name: 'enum',
 value: 'Object.keys(TYPES)',
 computed: true,
 value: [
 {value: '"FOO"', computed: false},
 {value: '"BAR"', computed: false},
 ],
 });
 });

Expand Down

149 changes: 149 additions & 0 deletions
src/utils/__tests__/resolveObjectKeysToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('x')]
 )
 );
 });

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

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

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

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

16 changes: 11 additions & 5 deletions
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 value = resolveObjectKeysToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 }
 } else {
 type.value = getEnumValues(value);
 }
Expand Down

105 changes: 105 additions & 0 deletions
src/utils/resolveObjectKeysToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
 * 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';

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

function isObjectKeysCall(node: ASTNode): bool {
 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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
 if (
 types.ObjectExpression.check(objectExpression.value) &&
 objectExpression.value.properties.every(
 prop =>
 types.Property.check(prop) &&
 (
 (types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key)
 ) ||
 types.SpreadProperty.check(prop)
 )
 ) {
 let values = [];
 let error = false;
 objectExpression.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (types.Property.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || prop.key.value;

 values.push(name);
 } else if (types.SpreadProperty.check(prop)) {
 const spreadObject = resolveToValue(propPath.get('argument'));
 const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 values = [...values, ...spreadValues];
 }

 });

 if (!error) {
 return 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 keys
 */
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
 var node = path.node;

 if (isObjectKeysCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const values = resolveObjectExpressionToNameArray(objectExpression);

 if (values) {
 const nodes = values
 .filter((value, index, array) => array.indexOf(value) === index)
 .map(value => 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.keys() in PropType.oneOf() by danez · Pull Request #211 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into

from

Sep 5, 2017
 Merged


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
600babd

feat(resolve): resolve Object.keys() in PropType.oneOf()


danez Aug 24, 2017
d1abfb9

Use same logic as JS itself and do not ignore setters


danez Sep 5, 2017

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


6 changes: 4 additions & 2 deletions
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

 expect(getPropType(propTypeExpression)).toEqual({
 name: 'enum',
 value: 'Object.keys(TYPES)',
 computed: true,
 value: [
 {value: '"FOO"', computed: false},
 {value: '"BAR"', computed: false},
 ],
 });
 });

Expand Down

149 changes: 149 additions & 0 deletions
src/utils/__tests__/resolveObjectKeysToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('x')]
 )
 );
 });

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

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

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

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

16 changes: 11 additions & 5 deletions
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 value = resolveObjectKeysToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 }
 } else {
 type.value = getEnumValues(value);
 }
Expand Down

105 changes: 105 additions & 0 deletions
src/utils/resolveObjectKeysToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
 * 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';

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

function isObjectKeysCall(node: ASTNode): bool {
 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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
 if (
 types.ObjectExpression.check(objectExpression.value) &&
 objectExpression.value.properties.every(
 prop =>
 types.Property.check(prop) &&
 (
 (types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key)
 ) ||
 types.SpreadProperty.check(prop)
 )
 ) {
 let values = [];
 let error = false;
 objectExpression.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (types.Property.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || prop.key.value;

 values.push(name);
 } else if (types.SpreadProperty.check(prop)) {
 const spreadObject = resolveToValue(propPath.get('argument'));
 const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 values = [...values, ...spreadValues];
 }

 });

 if (!error) {
 return 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 keys
 */
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
 var node = path.node;

 if (isObjectKeysCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const values = resolveObjectExpressionToNameArray(objectExpression);

 if (values) {
 const nodes = values
 .filter((value, index, array) => array.indexOf(value) === index)
 .map(value => 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.keys() in PropType.oneOf() by danez · Pull Request #211 · reactjs/react-docgen · GitHub
Skip to content
feat(resolve): resolve Object.keys() in PropType.oneOf()#211

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 2 commits into

from

Sep 5, 2017
 Merged


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
600babd

feat(resolve): resolve Object.keys() in PropType.oneOf()


danez Aug 24, 2017
d1abfb9

Use same logic as JS itself and do not ignore setters


danez Sep 5, 2017

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


6 changes: 4 additions & 2 deletions
src/utils/__tests__/getPropType-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -236,8 +236,10 @@ describe('getPropType', () => {

 expect(getPropType(propTypeExpression)).toEqual({
 name: 'enum',
 value: 'Object.keys(TYPES)',
 computed: true,
 value: [
 {value: '"FOO"', computed: false},
 {value: '"BAR"', computed: false},
 ],
 });
 });

Expand Down

149 changes: 149 additions & 0 deletions
src/utils/__tests__/resolveObjectKeysToArray-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
/*
 * 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 resolveObjectKeysToArray from '../resolveObjectKeysToArray';
import * as utils from '../../../tests/utils';

describe('resolveObjectKeysToArray', () => {

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('bar'), builders.literal('5')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

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

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

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

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('boo'), builders.literal('foo'), builders.literal('doo')]
 )
 );
 });

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

 expect(resolveObjectKeysToArray(path).node).toEqualASTNode(
 builders.arrayExpression(
 [builders.literal('x')]
 )
 );
 });

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

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

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

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

16 changes: 11 additions & 5 deletions
src/utils/getPropType.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import isRequiredPropType from '../utils/isRequiredPropType';
import printValue from './printValue';
import recast from 'recast';
import resolveToValue from './resolveToValue';
import resolveObjectKeysToArray from './resolveObjectKeysToArray';

var {types: {namedTypes: types}} = recast;

Expand DownExpand Up@@ -54,12 +55,17 @@ function getEnumValues(path) {
}

function getPropTypeOneOf(argumentPath) {
var type: PropTypeDescriptor = {name: 'enum'};
const value = resolveToValue(argumentPath);
const type: PropTypeDescriptor = {name: 'enum'};
let value = resolveToValue(argumentPath);
 if (!types.ArrayExpression.check(value.node)) {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 value = resolveObjectKeysToArray(value);
 if (value) {
 type.value = getEnumValues(value);
 } else {
 // could not easily resolve to an Array, let's print the original value
 type.computed = true;
 type.value = printValue(argumentPath);
 }
 } else {
 type.value = getEnumValues(value);
 }
Expand Down

105 changes: 105 additions & 0 deletions
src/utils/resolveObjectKeysToArray.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
/*
 * 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';

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

function isObjectKeysCall(node: ASTNode): bool {
 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 === 'keys';
}

function resolveObjectExpressionToNameArray(objectExpression: NodePath): ?Array<string> {
 if (
 types.ObjectExpression.check(objectExpression.value) &&
 objectExpression.value.properties.every(
 prop =>
 types.Property.check(prop) &&
 (
 (types.Identifier.check(prop.key) && !prop.computed) ||
 types.Literal.check(prop.key)
 ) ||
 types.SpreadProperty.check(prop)
 )
 ) {
 let values = [];
 let error = false;
 objectExpression.get('properties').each(propPath => {
 if (error) return;
 const prop = propPath.value;

 if (types.Property.check(prop)) {
 // Key is either Identifier or Literal
 const name = prop.key.name || prop.key.value;

 values.push(name);
 } else if (types.SpreadProperty.check(prop)) {
 const spreadObject = resolveToValue(propPath.get('argument'));
 const spreadValues = resolveObjectExpressionToNameArray(spreadObject);
 if (!spreadValues) {
 error = true;
 return;
 }
 values = [...values, ...spreadValues];
 }

 });

 if (!error) {
 return 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 keys
 */
export default function resolveObjectKeysToArray(path: NodePath): ?NodePath {
 var node = path.node;

 if (isObjectKeysCall(node)) {
 const objectExpression = resolveToValue(path.get('arguments').get(0));
 const values = resolveObjectExpressionToNameArray(objectExpression);

 if (values) {
 const nodes = values
 .filter((value, index, array) => array.indexOf(value) === index)
 .map(value => builders.literal(value))

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

 return null;
}