Skip to content
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

AF-3082: transform static meta fields #200

Merged
merged 3 commits into from
Nov 16, 2018
Merged

AF-3082: transform static meta fields #200

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb80f72
AF-3082: transform static meta fields
sebastianmalysa-wf Nov 13, 2018
1f9c3c1
AF-3082: combine PropsMeta and StateMeta test, add test for meta decl…
sebastianmalysa-wf Nov 14, 2018
e248bf4
AF-3082: add test for StateMeta declaration in StateMixin
sebastianmalysa-wf Nov 14, 2018
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
25 changes: 25 additions & 0 deletions lib/src/transformer/impl_generation.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,31 @@ class ImplGenerator {
Map keyConstants = {};
Map constants = {};

typedMap.node.members
.where((member) => member is FieldDeclaration && member.isStatic)
.forEach((_field) {
final field = _field as FieldDeclaration; // ignore: avoid_as

annotations.Accessor accessorMeta = instantiateAnnotation(field, annotations.Accessor);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we skip lines 417-425? I don't think there should ever be an instance where a doNotGenerate() annotation is added to a meta field


if (accessorMeta?.doNotGenerate == true) {
logger.fine('Skipping generation of field `$field`.',
span: getSpan(sourceFile, field)
);

return;
}

final name = typedMap.node.name.name;
final metaType = type == AccessorType.props ? 'Props' : 'State';

field.fields.variables.forEach((VariableDeclaration variable) {
if (variable.name.toString() == 'meta' && variable.initializer != null) {
transformedFile.replace(sourceFile.span(variable.initializer.offset, variable.initializer.end), '\$$metaType($name)');
}
});
});

typedMap.node.members
.where((member) => member is FieldDeclaration && !member.isStatic)
.forEach((_field) {
Expand Down
49 changes: 49 additions & 0 deletions test/vm_tests/transformer/impl_generation_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,55 @@ main() {
reason: 'should preserve existing inheritance');
});

test('with static PropsMeta declaration', () {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should also have a test which verifies this functionality on props/state mixins:

test('with static PropsMeta declaration in PropsMixin', () {
  final transformedLine = 'static const PropsMeta meta = \$Props(FooPropsMixin);';
  setUpAndGenerate('''
    @PropsMixin()
    class FooPropsMixin {
      static const PropsMeta meta = \$metaForFooPropsMixin;
    }
    '''
  );
  var transformedSource = transformedFile.getTransformedText();
  expect(transformedSource, contains(transformedLine));
});

final transformedLine = 'static const PropsMeta meta = \$Props(FooProps);';

setUpAndGenerate('''
@Factory()
UiFactory<FooProps> Foo;

@Props()
class FooProps {
static const PropsMeta meta = \$metaForFooProps;
}

@Component()
class FooComponent {
render() => null;
}
'''
);

var transformedSource = transformedFile.getTransformedText();
expect(transformedSource, contains(transformedLine));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might make sense to also verify that the original meta line is not longer present to ensure that the transformer is replacing and not simply adding a line.

});

test('with static StateMeta declaration', () {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can combine the StateMeta and PropsMeta tests into 1 test, since any instance of a component will have at least a props class with a meta field.

final transformedLine = 'static const StateMeta meta = \$State(FooState);';

setUpAndGenerate('''
@Factory()
UiFactory<FooProps> Foo;

@Props()
class FooProps {}

@State()
class FooState {
static const StateMeta meta = \$metaForFooState;
}

@Component()
class FooComponent {
render() => null;
}
'''
);

var transformedSource = transformedFile.getTransformedText();
expect(transformedSource, contains(transformedLine));
});

group('that subtypes another component, referencing the component class via', () {
test('a simple identifier', () {
preservedLineNumbersTest('''
Expand Down