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

initial formatter schema #12

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

initial formatter schema #12

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
795b99c
initial formatter schema
maytheu Sep 11, 2023
a4d238e
conceptual entity formatter
maytheu Sep 12, 2023
4517414
formatter for conceptual element
maytheu Sep 14, 2023
16d7123
.
maytheu Sep 14, 2023
39b3605
test passes with no formmater
maytheu Sep 18, 2023
cfe58ae
improve test cases
maytheu Sep 19, 2023
731cd27
remove extra lines from test
maytheu Sep 28, 2023
5c61e26
logical model formatter
maytheu Sep 28, 2023
7693f72
platform data model formatter
maytheu Sep 29, 2023
f2333d4
format association before entities
maytheu Oct 2, 2023
5a56353
ldm test
maytheu Oct 4, 2023
f196456
formatting platform element
maytheu Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions src/language-server/universal-data-definition-language-formatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,12 @@ export class UniversalDataDefinitionLanguageFormatter extends AbstractFormatter
if (ast.isDataModel(node)) {
this.formatDataModel(node);
}
// test passes with this commetned check
// if(ast.isConceptualAssociation(node)){
// this.formatConceptualAssociation(node)
// }

if(ast.isConceptualEntity(node)){
this.formatConceptualEntity(node)
else if(ast.isConceptualAssociation(node)){
this.formatConceptualAssociation(node)
}

// test passes with this commetned check
// if(ast.isConceptualBasisEntity(node)){
// this.formatConceptualBasisEntity(node)
// }
else if(ast.isConceptualEntity(node)){
this.formatConceptualEntity(node)
}
}


Expand Down Expand Up @@ -108,10 +101,6 @@ export class UniversalDataDefinitionLanguageFormatter extends AbstractFormatter
})
}

protected formatConceptualBasisEntity(basis: ast.ConceptualBasisEntity): void {
this.formatNode(basis)
}

protected formatConceptualAssociation(cassoc: ast.ConceptualAssociation): void {
this.formatContainer(cassoc)

Expand All @@ -120,8 +109,6 @@ export class UniversalDataDefinitionLanguageFormatter extends AbstractFormatter
})
}

protected formatConceptualCharacteristic(xter: ast.ConceptualCharacteristic): void {}

protected formatConceptualComposition(comp: ast.ConceptualComposition ): void {
this.formatContainer(comp)
}
Expand All @@ -134,6 +121,7 @@ export class UniversalDataDefinitionLanguageFormatter extends AbstractFormatter
}
}

/**Formatting logicals */
protected formatLogicalElement(elem: ast.LogicalElement): void {
const formatter = this.getNodeFormatter(elem);
formatter.property('name').prepend(Formatting.newLine()).surround(Formatting.oneSpace({allowMore: true}));
Expand Down
91 changes: 79 additions & 12 deletions uddl_test/uddl_test_formatting/universal-data-definition-language-formatter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,20 @@ import { createUniversalDataDefinitionLanguageServices } from "../../src/languag
import { EmptyFileSystem } from "langium";
import { expectFormatting } from "langium/test";

const universalDataDefinitionLanguageService =createUniversalDataDefinitionLanguageServices({...EmptyFileSystem,}).UniversalDataDefinitionLanguage;
const universalDataDefinitionLanguageFormatting = expectFormatting(universalDataDefinitionLanguageService
);
const universalDataDefinitionLanguageService = createUniversalDataDefinitionLanguageServices({...EmptyFileSystem,}).UniversalDataDefinitionLanguage;
const universalDataDefinitionLanguageFormatting = expectFormatting(universalDataDefinitionLanguageService);

describe("Universal Data Definition Language Formatter", () => {
it("should format cdm array with conceptual elemnt", async () => {
it("should format cdm array", async () => {
await universalDataDefinitionLanguageFormatting({
before:
'dm PPT "Base data structures to support People, Places and Things"{cdm Conceptual "Need to start at Conceptual Level"{basis uddlBasis "Formating conceptual basis entity"; domain cdmDomain "Entry for conceptual domain"; cdm anothercdm "A cdm with another data" {observable Information "Something a party can learn";}}}',
'dm PPT "Base data structures to support People, Places and Things"{cdm Conceptual "Need to start at Conceptual Level"{cdm anothercdm "A cdm with another data" {observable Information "Something a party can learn";}}}',
after: `dm PPT "Base data structures to support People, Places and Things"
{

cdm Conceptual "Need to start at Conceptual Level"
{

basis uddlBasis "Formating conceptual basis entity";
domain cdmDomain "Entry for conceptual domain";
cdm anothercdm "A cdm with another data"
{

Expand All @@ -27,14 +24,14 @@ describe("Universal Data Definition Language Formatter", () => {

}

}`
}`,
});
});

it("should format conceptual element", async () => {
it("should format cdm with conceptual association", async () => {
await universalDataDefinitionLanguageFormatting({
before:
'dm PPT "Base data structures to support People, Places and Things"{cdm Conceptual "Need to start at Conceptual Level"{cassoc Training "Information delivered over time from one party to another " {};centity AddressableEntity "Any entity that is addressable in some way" {};}}',
'dm PPT "Base data structures to support People, Places and Things"{cdm Conceptual "Need to start at Conceptual Level"{cassoc Training "Information delivered over time from one party to another " {};}}',
after: `dm PPT "Base data structures to support People, Places and Things"
{

Expand All @@ -46,14 +43,84 @@ describe("Universal Data Definition Language Formatter", () => {

};

}

}`,
});
});

it("should format cdm with conceptual entity", async () => {
await universalDataDefinitionLanguageFormatting({
before:
'dm PPT "Base data structures to support People, Places and Things"{cdm Conceptual "Need to start at Conceptual Level"{centity AddressableEntity "Any entity that is addressable in some way" {};}}',
Copy link
Contributor

Choose a reason for hiding this comment

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

In your current tests, all the 'before' text is on a single line. You should also have the same tests where the 'before' text has each token on a separate line (you can do this with a find/replace that replaces blanks the before text with CRs).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Noted

after: `dm PPT "Base data structures to support People, Places and Things"
{

cdm Conceptual "Need to start at Conceptual Level"
{

centity AddressableEntity "Any entity that is addressable in some way"
{

};

}

}`
}`,
});
});
});

it('should format cdm with conceptual basis',async () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

While you can have tests for each individual type, you may find that a test that combines multiple types is sufficient.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In a previous commit, I merged conceptual entities and conceptual associations into one test case. During this process, only formatter for conceptual entities was checked. I then attempted to verify whether I would encounter similar behavior for conceptual basis and conceptual domain as well.

await universalDataDefinitionLanguageFormatting({
before:
'dm PPT "Base data structures to support People, Places and Things"{cdm Conceptual "Need to start at Conceptual Level"{basis uddlBasis "Formating conceptual basis entity"; }}',
after: `dm PPT "Base data structures to support People, Places and Things"
{

cdm Conceptual "Need to start at Conceptual Level"
{

basis uddlBasis "Formating conceptual basis entity";
}

}`,
})
})

it('should format cdm with conceptual domain',async () => {
await universalDataDefinitionLanguageFormatting({
before:
'dm PPT "Base data structures to support People, Places and Things"{cdm Conceptual "Need to start at Conceptual Level"{domain NaturalPerson "Base definition of a natural person"; }}',
after: `dm PPT "Base data structures to support People, Places and Things"
{

cdm Conceptual "Need to start at Conceptual Level"
{

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you really want all these blank lines after formatting? You've got a blank line after every '{' and '}'. That's going to make some files a lot longer - which will force users to scroll. When people have to scroll, they forget what they can't see - which makes it harder to understand complex content.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The test would not pass without the blank lines in the after block

Copy link
Contributor

Choose a reason for hiding this comment

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

When a test does not pass, you have a choice: change the test (what you did) or change the code being tested. The point I'm making above is that the formatter currently inserts those blank lines - which is why your test needs the blank lines to pass. My question is: do you want the formatter to do that? The goal of formatting is to put the text into a format that is easy to read and understand. Every decision you make about how the formatter works should be made with that in mind.

domain NaturalPerson "Base definition of a natural person";
}

}`,
})
})

it("should format ldm array",async () => {
await universalDataDefinitionLanguageFormatting({
before: 'dm Book "Base definition for book requirement" {ldm library "contains available books" {ldm BookShelf "Books related by category"{}}}',
after: `dm Book "Base definition for book requirement"
{

ldm library "contains available books"
{

ldm BookShelf "Books related by category"
{

}

}

}`
})
})
});