chore: add additionalProperties preset hooks #71

jonaslagoni · 2021-02-18T15:40:34Z

Description
This PR adds additionalProperties preset hooks.

Related issue(s)
solves #68

jonaslagoni · 2021-02-18T15:41:06Z

@magicmatatjahu how should we handle additionalProperties in Javascript renderer? 🤔

…es_rendering # Conflicts: # test/generators/typescript/TypeScriptGenerator.spec.ts

jonaslagoni · 2021-02-24T10:45:03Z

@magicmatatjahu I have fully added the typescript rendering can you check it out in regards to presets and the setup there? Also the class encapsulation for the additionProperties should they have presets?

magicmatatjahu

Good, but I have an another idea how to use additionalProperties :) It's a more generic.

magicmatatjahu · 2021-02-22T09:44:58Z

src/generators/typescript/TypeScriptRenderer.ts

@@ -77,6 +77,11 @@ ${lines.map(line => ` * ${line}`).join('\n')}
      const rendererProperty = await this.runPropertyPreset(propertyName, property, this.model);
      content.push(rendererProperty);
    }
+
+    if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {


Suggested change

if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {

if (this.model.additionalProperties instanceof CommonModel) {

magicmatatjahu · 2021-02-22T09:45:14Z

src/generators/java/renderers/ClassRenderer.ts

@@ -52,6 +52,12 @@ ${this.indent(this.renderBlock(content, 2))}
      content.push(this.renderBlock([getter, setter]));
    }

+    if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {


Suggested change

if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {

if (this.model.additionalProperties instanceof CommonModel) {

Like in TS -> to additionalContent preset

What do you mean by this? I don't use additionalContent in TypeScript

I mean that this part should be moved to additionalContent preset like I suggest in another comment for TS :)

I guess you mean this for JS - #71 (comment)

Yeah, sorry 😄

magicmatatjahu · 2021-02-24T11:25:44Z

src/models/Preset.ts

+export interface AdditionalPropertiesArgs {
+  parentModel: CommonModel;
+  additionalProperties: CommonModel;
+}
 export interface ClassPreset<R extends AbstractRenderer, O extends object = any> extends CommonPreset<R, O> {
  ctor?: (args: PresetArgs<R, O>) => Promise<string> | string;
  property?: (args: PresetArgs<R, O> & PropertyArgs) => Promise<string> | string;
+  additionalProperties?: (args: PresetArgs<R, O> & AdditionalPropertiesArgs) => Promise<string> | string;


additionalProperties should have only PresetArgs arguments, why? parentModel is not needed - it's my fault and in next PR I will remove it - we have model property for that (it is the same 😅). Also additionalProperties field is hardcoded for additionalProperties inferred from model so you have also possibility to use it by model. additionalProperties preset should have also possibility to render patternProperties etc, so hardcoded for only one field is very bad idea.

additionalProperties?: (args: PresetArgs<R, O>) => Promise<string> | string;

src/models/Preset.ts

src/generators/typescript/TypeScriptRenderer.ts

magicmatatjahu · 2021-02-24T11:30:38Z

src/generators/typescript/TypeScriptRenderer.ts

@@ -77,6 +77,11 @@ ${lines.map(line => ` * ${line}`).join('\n')}
      const rendererProperty = await this.runPropertyPreset(propertyName, property, this.model);
      content.push(rendererProperty);
    }
+
+    if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {
+      const additionalProperty = await this.runAdditionalPropertiesPreset(this.model.additionalProperties, this.model);


additionalProperties preset should also render another properties like patternProperties - also passed by options to preset - so this part should look like:

// from this if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) { const additionalProperty = await this.runAdditionalPropertiesPreset(this.model.additionalProperties, this.model); content.push(additionalProperty); } // to const additionalProperties = await this.runAdditionalPropertiesPreset(); if (additionalProperties) { content.push(additionalProperties); }

we shouldn't hardcoded only for additionalProperties from model.

magicmatatjahu · 2021-02-24T11:32:50Z

src/generators/javascript/renderers/ClassRenderer.ts

+    if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {
+      const getter = 'getAdditionalProperty(key){ return _additionalProperties[key]; }';
+      const setter = 'setAdditionalProperty(key, value) { _additionalProperties[key] = value; }';
+      content.push(this.renderBlock([getter, setter]));
+    }
+


it should be rendered inside additionalContent preset:

{ class: { additionalContent({ renderer, model, content }) { if (!(this.model.additionalProperties instanceof CommonModel)) return content; const getter = 'getAdditionalProperty(key){ return _additionalProperties[key]; }'; const setter = 'setAdditionalProperty(key, value) { _additionalProperties[key] = value; }'; this.renderBlock([content, getter, setter]); } } }

I think you mean the extra functions that are not really encapsulations right? 🤔

Yes, for that additionalContent exists - for extra function. Encapsulation is a problem, but you can create separate presets to make your encapsulation

new TypeScriptGenerator({ presets: [ADDITIONALPROPETIES, PATTERN_PROPERTES] })

We can make separate presets for everything, argument, type signature etc. but then it would be hard to use.

magicmatatjahu · 2021-02-24T11:33:17Z

src/generators/javascript/JavaScriptRenderer.ts

@@ -36,6 +36,11 @@ ${content}
      content.push(rendererProperty);
    }

+    if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {


Please add it like in JS -> to additionalContent preset

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

…onalProperties_rendering # Conflicts: # src/generators/typescript/TypeScriptRenderer.ts # src/generators/typescript/renderers/ClassRenderer.ts # test/generators/typescript/TypeScriptGenerator.spec.ts

…es_rendering # Conflicts: # src/generators/typescript/TypeScriptGenerator.ts

sonarcloud · 2021-06-03T09:48:18Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.9% Duplication

jonaslagoni · 2021-06-07T15:17:19Z

Gonna provide a clean implementation here, gonna use most of the comments already given to solve it. Thanks for the review @magicmatatjahu 🙇

Added basic rendering of additional properties

723098b

jonaslagoni changed the title ~~chore: add basic rendering of additional properties~~ chore: add basic rendering of additionalProperties Feb 19, 2021

jonaslagoni added 4 commits February 19, 2021 16:08

Updated tests

c32399f

Merge branch 'master-upstream-master' into feature/additionalProperti…

c1fe800

…es_rendering # Conflicts: # test/generators/typescript/TypeScriptGenerator.spec.ts

Added all renders for additionalProperties

5469547

fixed some setups

ca59438

jonaslagoni marked this pull request as ready for review February 24, 2021 09:35

jonaslagoni added 2 commits February 24, 2021 11:43

Refactored the typescript renderer with presets

958af1d

Merge branch 'master' into feature/additionalProperties_rendering

7b7bc93

Fixed wrong encapsulation signature for additionalProperties

44c1667

magicmatatjahu requested changes Feb 24, 2021

View reviewed changes

jonaslagoni and others added 2 commits February 24, 2021 12:38

Update src/models/Preset.ts

13c071c

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

Update src/generators/typescript/TypeScriptRenderer.ts

d4925c9

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

jonaslagoni mentioned this pull request Feb 25, 2021

The direction of the (default) presets #111

Closed

jonaslagoni changed the title ~~chore: add basic rendering of additionalProperties~~ chore: add additionalProperties preset hooks Feb 25, 2021

jonaslagoni added 5 commits April 26, 2021 10:47

Merge remote-tracking branch 'github-main/master' into feature/additi…

a6cdd64

…onalProperties_rendering # Conflicts: # src/generators/typescript/TypeScriptRenderer.ts # src/generators/typescript/renderers/ClassRenderer.ts # test/generators/typescript/TypeScriptGenerator.spec.ts

Added some comments for typescript generator

dd24045

Removed additional properties from default TS render

40e0415

Updated docs

bbed287

Added more jsdoc

128e4d9

jonaslagoni marked this pull request as draft April 26, 2021 09:22

jonaslagoni added 4 commits April 26, 2021 12:13

Added hooks for additional properties

50c7a4d

Merge branch 'master' into feature/additionalProperties_rendering

a37ac77

added check

8418267

Merge branch 'master-upstream-master' into feature/additionalProperti…

b334fc3

…es_rendering # Conflicts: # src/generators/typescript/TypeScriptGenerator.ts

jonaslagoni closed this Jun 7, 2021

jonaslagoni deleted the feature/additionalProperties_rendering branch June 7, 2021 15:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add additionalProperties preset hooks #71

chore: add additionalProperties preset hooks #71

jonaslagoni commented Feb 18, 2021 •

edited

Loading

jonaslagoni commented Feb 18, 2021 •

edited

Loading

jonaslagoni commented Feb 24, 2021

magicmatatjahu left a comment

magicmatatjahu Feb 22, 2021

magicmatatjahu Feb 22, 2021

magicmatatjahu Feb 24, 2021

jonaslagoni Feb 24, 2021

magicmatatjahu Feb 24, 2021

jonaslagoni Feb 24, 2021

magicmatatjahu Feb 24, 2021

magicmatatjahu Feb 24, 2021

magicmatatjahu Feb 24, 2021 •

edited

Loading

magicmatatjahu Feb 24, 2021

jonaslagoni Feb 24, 2021

magicmatatjahu Feb 24, 2021

magicmatatjahu Feb 24, 2021

magicmatatjahu Feb 24, 2021 •

edited

Loading

sonarcloud bot commented Jun 3, 2021

jonaslagoni commented Jun 7, 2021

	if (this.model.additionalProperties !== undefined && this.model.additionalProperties instanceof CommonModel) {
	if (this.model.additionalProperties instanceof CommonModel) {

chore: add additionalProperties preset hooks #71

chore: add additionalProperties preset hooks #71

Conversation

jonaslagoni commented Feb 18, 2021 • edited Loading

jonaslagoni commented Feb 18, 2021 • edited Loading

jonaslagoni commented Feb 24, 2021

magicmatatjahu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magicmatatjahu Feb 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magicmatatjahu Feb 24, 2021 • edited Loading

Choose a reason for hiding this comment

sonarcloud bot commented Jun 3, 2021

jonaslagoni commented Jun 7, 2021

jonaslagoni commented Feb 18, 2021 •

edited

Loading

jonaslagoni commented Feb 18, 2021 •

edited

Loading

magicmatatjahu Feb 24, 2021 •

edited

Loading

magicmatatjahu Feb 24, 2021 •

edited

Loading