gopher-fleece / gleece / 20494816734

86%

Build Type

push

github

Committed by web-flow

Commit Message

V2 refactor - core (#68)


## Gleece v2.0.0-Release

### Summary

*Gleece* 2.1 brings in concrete support for type aliases, map input/outputs and an overhauled type resolution system.

### Features

* Support for type aliasing.</br>
Previously, alias support was limited and resulted in the aliased type effectively wiping the alias itself.

  Both declared and assigned aliases are valid:

  ```go
	// A unique ID
  	type Id string  `validate:"regex=^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"`

	// A unique ID
  	type Id = string `validate:"regex=^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"`
  ```
  </br>
  These aliases will be translated into an equivalent OpenAPI model:

  ```yaml
  Id:
      type: "string"
      format: "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
      description: "A unique ID"
  ```
</br>

* Full support for `map`.</br>
	Previously, non-primitive maps like `map[string]something.Something` would not resolve correctly, resulting errors.


* Infrastructure-level support for generics</br>
	Generics support represent *Gleece*'s next major milestone.

	This change includes the necessary infrastructure.
	These include expansion of the HIR to encode the one-to-many relationships between composites (e.g. `Something[string, bool, int]`) and their instantiated dependencies (e.g. `string`, `bool` and `int`)

	Below you can see a graphical dump of a controller with generics in use:

	![Generics in use](./images/2.1_generics_graph.svg)


* Added an configuration option to disable failure after encountering issues during package loads.

	To use this option, create a `failOnAnyPackageLoadError` (`boolean`) field under the `commonConfig` section of your `Gleece Config` file, e.g.:

	```json
	{
		"commonConfig": {
			"failOnAnyPackageLoadError": false,
			"controllerGlobs": [
				"./*.go",
				"./**/*.go"
			]
		},
		...
		...
		...
	}
	```

	For some complex environments, specifically those using generated code, ... (continued)

Run Details

2821 of 3719 new or added lines in 51 files covered. (75.85%)

150 existing lines in 11 files now uncovered.

8706 of 10162 relevant lines covered (85.67%)

1639.27 hits per line