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

Jump to bottom

feat(map): Add Introspection for Map Type #646

Merged
merged 43 commits into from
May 22, 2023
Merged

feat(map): Add Introspection for Map Type #646

merged 43 commits into from
May 22, 2023

Conversation

jonathan-casey
Copy link
Member

Closes #

This change adds the specified classes for runtime introspection of a MapType - MapDeclaration,MapKeyType and a general AggregateValueType. Each class is responsible for processing of an AST representation of a MapDeclaration before instantiation, exposing various functionality, as well as correct validation for each of its parts.

For more information on the design specification see here

Changes

  • Added classes for MapDeclaration,MapKeyType and AggregateValueType
  • Added test coverage
  • Added type definitions

Related Issues

Author Checklist

  • Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
  • Vital features and changes captured in unit and/or integration tests
  • Commits messages follow AP format
  • Extend the documentation, if necessary
  • Merging to main from fork:branchname

@jonathan-casey
feat(map): add Type classes
dd93b2b 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add test coverage
2b57690 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): update ModelFile with MapDeclaration
8efdf47 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): update BaseModelManager - add getMapDeclarations()
c1cd778 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add type definitions
5ab62ec 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
chore(changelog): updates change log
4bf1068 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
test(map): add more test cov for introspection
8eebc93 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
test(map): add test cov for modelmanager
88c7bef 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
chore(build): update package-lock
ff4271c 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey jonathan-casey marked this pull request as ready for review May 16, 2023 13:53
@jonathan-casey jonathan-casey requested a review from a team May 16, 2023 13:53
@mttrbrts mttrbrts requested review from dselman and mttrbrts May 17, 2023 10:59
mttrbrts
mttrbrts requested changes May 18, 2023
View reviewed changes
Copy link
Member

@mttrbrts mttrbrts left a comment

Choose a reason for hiding this comment

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

Love all of the test cases.

Mostly minor comments, happy to chat about the best inheritance hierarchy for MapDeclarations and if FQNs make sense for Keys/Values.

@jonathan-casey
feat(map): use descriptive names for key, value, property
a558f27 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): extend from declaration
8f7b9d1 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): remove fqn reference from MapKey and MapValue
7999490 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): cleanup nested if
5a85ab0 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add isMapDeclaration method
aece13f 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): cleanup
236a27c 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): remove unused test file
6d26f6e 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add feature flag
7f9fdb0 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): MapKey & MapValue extend decorated
f8a717e 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): remove this.name references from MapKey & MapValue
3700e52 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): support Asset, Participant, Transaction for MapValue
4e4f110 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add more test coverage
d5ece58 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add test case for derived concept as MapValue
57a3dc3 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add getFQN method to MapDeclaration
40f777b 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): update type definitions
91f9521 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): update changelog.txt, api.txt
009d02f 
Signed-off-by: jonathan.casey <[email protected]>
@dselman
Copy link
Contributor

dselman commented May 19, 2023

Please ensure that the latest metamodel is publish to the public model repo: https://models.accordproject.org/concerto/[email protected]

dselman
dselman previously requested changes May 19, 2023
View reviewed changes
Copy link
Contributor

@dselman dselman left a comment

Choose a reason for hiding this comment

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

Looking good - a few nits to pick!

@jonathan-casey
feat(map): bump test coverage
2e86cef 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add getParent to api for MapKey and MapValue
5398660 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): improve comment, fix typo
a9dedf1 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): update type definitions
a541ce9 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): update changelog.txt, api.txt
13ff265 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): remove hardcode metamodel version
8191232 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): fix comments
b2c27e9 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): type assignment moved to constructor
c99f584 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): add explicit validation for MapValue
6d3f966 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): update changelog.txt, api.txt
b428e1c 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): remove boolean as a valid MapKey
ed2b303 
Signed-off-by: jonathan.casey <[email protected]>
@jonathan-casey
feat(map): bump test cov
4aeb247 
Signed-off-by: jonathan.casey <[email protected]>
@mttrbrts mttrbrts requested review from mttrbrts and dselman May 19, 2023 20:24
@mttrbrts mttrbrts dismissed dselman’s stale review May 19, 2023 20:25

All feedback address, requesting re-review

@mttrbrts mttrbrts merged commit 248a663 into main May 22, 2023
@mttrbrts mttrbrts deleted the jonathan/introspection_map_type branch May 22, 2023 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mttrbrts mttrbrts mttrbrts approved these changes

@dselman dselman Awaiting requested review from dselman

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jonathan-casey @dselman @mttrbrts