Merge pull request #1 from MartinSimango/fix/embedded-fields

fix: remove support for embedded field alias names

Author: MartinSimango

field.go

@@ -2,7 +2,7 @@ package dstruct
 
 import "reflect"
 
-type field struct {
+type structField struct {
 	name              string
 	tag               reflect.StructTag
 	value             reflect.Value
@@ -14,25 +14,24 @@ type field struct {
 	fqn               string
 	structIndex       *int
 	numberOfSubFields *int
-	isFQNAlias        bool
 }
 
-func (f field) GetFieldName() string {
+func (f structField) GetFieldName() string {
 	return f.name
 }
 
-func (f field) GetValue() any {
+func (f structField) GetValue() any {
 	return f.value.Interface()
 }
 
-func (f field) GetType() reflect.Type {
+func (f structField) GetType() reflect.Type {
 	return f.typ
 }
 
-func (f field) GetFieldFQName() string {
+func (f structField) GetFieldFQName() string {
 	return f.fqn
 }
 
-func (f field) GetTag(t string) string {
+func (f structField) GetTag(t string) string {
 	return f.tag.Get(t)
 }

generated.struct.go

@@ -56,8 +56,8 @@ func NewGeneratedStructWithConfig(val any,
 
 func (gs *GeneratedStructImpl) populateGeneratedFields() {
 
-	for name, field := range gs.fieldMap {
-		if field.HasChildren() || field.data.isFQNAlias {
+	for name, field := range gs.fieldNodeMap {
+		if field.HasChildren() {
 			continue
 		}
 
@@ -77,13 +77,10 @@ func (gs *GeneratedStructImpl) Generate() {
 func (gs *GeneratedStructImpl) GenerateAndUpdate() {
 	gs.Generate()
 	gs.Update()
-	// for k, v := range gs.GetFields() {
-	// 	fmt.Println(k, v.anonymous, v.isFQNAlias)
-	// }
 }
 
 func (gs *GeneratedStructImpl) SetFieldGenerationConfig(field string, generationConfig *generator.GenerationConfig) error {
-	if gs.fieldMap[field] == nil {
+	if gs.fieldNodeMap[field] == nil {
 		return fmt.Errorf("field %s does not exist within the struct", field)
 	}
 	if gs.generatedFields[field] == nil {
@@ -102,7 +99,7 @@ func (gs *GeneratedStructImpl) GetFieldGenerator(field string) *generator.Genera
 }
 func (gs *GeneratedStructImpl) SetFieldDefaultGenerationFunction(field string,
 	generationFunction generator.GenerationFunction) {
-	kind := gs.fieldMap[field].data.GetType().Kind()
+	kind := gs.fieldNodeMap[field].data.GetType().Kind()
 	generator := gs.generatedFields[field].Field.Generator
 	generator.DefaultGenerationFunctions[kind] = generationFunction
 	generationFunction.SetGenerationConfig(generator.GenerationConfig)
@@ -123,12 +120,3 @@ func (gs *GeneratedStructImpl) generateFields() {
 		}
 	}
 }
-
-func getGeneratorField(field *field, defaultGenerationFunction *generator.Generator) *generator.GeneratedField {
-	return &generator.GeneratedField{
-		Name:      field.fqn,
-		Value:     field.value,
-		Tag:       field.tag,
-		Generator: defaultGenerationFunction,
-	}
-}

limitations/README.md

@@ -56,4 +56,6 @@ func main() {
 
 }
 
+* Generated structs cannot generate slice fields whose types have recursive definition.
+
 ```

modifier.go

@@ -9,7 +9,9 @@ import (
 	"github.com/MartinSimango/dstruct/dreflect"
 )
 
-type FieldMap map[string]*Node[field]
+type FieldNode map[string]*Node[structField]
+
+type FieldData map[string]structField
 
 type DynamicStructModifier interface {
 	// Instance returns a copy of the struct
@@ -26,8 +28,8 @@ type DynamicStructModifier interface {
 	// The program will panic if the type of value does not match the type of the struct field `field`.
 	Set(field string, value any) error
 
-	// GetFields returns are map containing all fields within a struct (including fields subfields)
-	GetFields() map[string]field
+	// GetFields returns a map containing all fields within a struct
+	GetFields() FieldData
 
 	// Update updates the struct's underlying tree to represent that of the strct's value
 	Update()
@@ -36,35 +38,36 @@ type DynamicStructModifier interface {
 	Apply(field string, value any) error
 }
 
-type FieldModifier func(*field)
+type FieldModifier func(*structField)
 
 type DynamicStructModifierImpl struct {
-	strct     any
-	fieldMap  FieldMap
-	fieldData map[string]field
-	root      *Node[field]
+	strct        any
+	fieldNodeMap FieldNode
+	fieldData    map[string]structField
+	root         *Node[structField]
 }
 
 var _ DynamicStructModifier = &DynamicStructModifierImpl{}
 
-func newStruct(strct any, rootNode *Node[field]) *DynamicStructModifierImpl {
+func newStruct(strct any, rootNode *Node[structField]) *DynamicStructModifierImpl {
 	dsm := &DynamicStructModifierImpl{
-		strct:     strct,
-		fieldMap:  make(FieldMap),
-		fieldData: make(map[string]field),
-		root:      rootNode,
+		strct:        strct,
+		fieldNodeMap: make(FieldNode),
+		fieldData:    make(map[string]structField),
+		root:         rootNode,
 	}
-	dsm.createFieldMap(rootNode)
+	dsm.createFieldToNodeMappings(rootNode)
 	return dsm
 }
 
-func (dm *DynamicStructModifierImpl) createFieldMap(rootNode *Node[field]) {
+func (dm *DynamicStructModifierImpl) createFieldToNodeMappings(rootNode *Node[structField]) {
 
 	for _, field := range rootNode.children {
-		dm.fieldMap[field.data.fqn] = field
+		dm.fieldNodeMap[field.data.fqn] = field
 		dm.fieldData[field.data.fqn] = *field.data
-		dm.createFieldMap(field)
+		dm.createFieldToNodeMappings(field)
 	}
+
 }
 
 func (dm *DynamicStructModifierImpl) New() any {
@@ -74,11 +77,17 @@ func (dm *DynamicStructModifierImpl) Instance() any {
 	return dreflect.GetUnderlyingPointerValue(dm.strct)
 }
 
+func (dm *DynamicStructModifierImpl) get(field string) (n *Node[structField]) {
+	return dm.fieldNodeMap[field]
+
+}
+
 func (dm *DynamicStructModifierImpl) Get(field string) (any, error) {
-	if dm.fieldMap[field] == nil {
+	if f := dm.get(field); f == nil {
 		return nil, fmt.Errorf("field %s does not exists in struct", field)
+	} else {
+		return f.data.value.Interface(), nil
 	}
-	return dm.fieldMap[field].data.value.Interface(), nil
 }
 
 func isFieldExported(field string) bool {
@@ -94,15 +103,16 @@ func isFieldExported(field string) bool {
 	return true
 }
 func (dm *DynamicStructModifierImpl) Set(field string, value any) error {
-	if dm.fieldMap[field] == nil {
+	var f *Node[structField]
+	if f = dm.get(field); f == nil {
 		return fmt.Errorf("field %s does not exists in struct", field)
 	}
 
 	if !isFieldExported(field) {
 		return fmt.Errorf("field %s is not exported", field)
 	}
 
-	fieldValue := dm.fieldMap[field].data.value
+	fieldValue := f.data.value
 	if !canExtend(value) {
 		if value == nil {
 			if !fieldValue.IsZero() {
@@ -119,7 +129,7 @@ func (dm *DynamicStructModifierImpl) Set(field string, value any) error {
 	return nil
 }
 
-func (dm *DynamicStructModifierImpl) GetFields() map[string]field {
+func (dm *DynamicStructModifierImpl) GetFields() FieldData {
 	return dm.fieldData
 }