Fix code generation to support pointer embedding of gorm.Model and include base fields #16

uptutu · 2025-09-15T10:05:19Z

Enhanced Code Generation for Pointer-Embedded gorm.Model and Base Field Inclusion

This pull request implements comprehensive enhancements to the code generation system, enabling proper support for both pointer-embedded (*gorm.Model) and value-embedded (gorm.Model) struct bases within user models. The PR refactors core embedding logic in internal/gen/generator.go for generalized, modular field processing, adds caching of the Go module directory to optimize filesystem access, updates field type handling for improved nullable field support, expands the .gitignore file to follow best practices, and introduces new example/test coverage for pointer embedding scenarios (e.g., the new CreditCard example). These changes collectively resolve issue #15 and strengthen the code generator's flexibility, correctness, and maintainability for complex model patterns.

Key Changes

• Refactored handleAnonymousEmbedding in internal/gen/generator.go for generalized support of pointer and value struct embedding, with explicit pointer unwrapping and modular helper functions (addEmbeddedFields, loadAndProcessExternalStruct).
• Introduced a cached goModDir attribute on the File struct to minimize repeated calls to findGoModDir(), reducing filesystem access overhead.
• Updated field type mapping logic to properly use field.Field[sql.NullTime], field.Field[sql.NullInt64], and improved nullable field detection.
• Significantly expanded .gitignore to cover build, editor, OS, sensitive, and generated file patterns; removed duplications.
• Added new CreditCard model example embedding *gorm.Model, corresponding generated output, and expanded tests in examples/output/models_field_helpers_test.go to verify pointer embedding and base field handling.

Affected Areas

• internal/gen/generator.go (embedding/reflection/refactoring, caching)
• examples/models/user.go (added CreditCard model with *gorm.Model pointer embedding)
• examples/output/models/user.go (generated code updated for new model/fields)
• examples/output/models_field_helpers_test.go (expanded test assertions for new model/fields)
• .gitignore (expanded and deduplicated coverage)

This summary was automatically generated by @propel-code-bot

Copilot

Pull Request Overview

This PR fixes an issue where models using *gorm.Model as an embedded field were missing the corresponding gorm.Model fields in the generated files. The fix improves the handling of anonymous embedded fields, particularly for pointer types to external structs.

Refactored the handleAnonymousEmbedding function to properly handle pointer-wrapped embedded types
Added helper functions to streamline the processing of embedded struct fields
Fixed field type handling to unwrap pointer types before processing embedded structs

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.

File	Description
internal/gen/generator.go	Enhanced anonymous embedding handling to support pointer types and refactored code structure
examples/output/models/user.go	Updated generated model to include gorm.Model fields and correct field types
examples/models/user.go	Changed from `gorm.Model` to `*gorm.Model` to test pointer embedding

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-15T10:06:08Z

internal/gen/generator.go

+	loadAndProcessExternalStruct := func(pkgName, typeName string) bool {
+		st, err := loadNamedStructType(findGoModDir(p.inputPath), p.getFullImportPath(pkgName), typeName)
+		if err != nil || st == nil {
+			return false
+		}
+		return addEmbeddedFields(st, typeName, pkgName)
+	}


The loadAndProcessExternalStruct function calls findGoModDir(p.inputPath) on every invocation. Consider caching this value at the struct level or passing it as a parameter to avoid repeated filesystem operations.

internal/gen/generator.go

Co-authored-by: Copilot <[email protected]>

propel-code-bot · 2025-09-16T01:37:47Z

.gitignore

+$GOCACHE/
+
+# Air live reload
+tmp/


[NitPick]

Duplicate tmp/ entry on lines 68 and 78. The Air live reload entry is redundant since temporary folders are already ignored above.

Context for Agents

[**NitPick**] Duplicate `tmp/` entry on lines 68 and 78. The Air live reload entry is redundant since temporary folders are already ignored above. File: .gitignore Line: 78

uptutu · 2025-09-16T01:54:19Z

Error: output/models_field_helpers_test.go:354:35: cannot use generated.User.Profile (variable of struct type "gorm.io/cli/gorm/field".String) as examples.JSON value in variable declaration

Hi @jinzhu

这个问题我需要一点时间看看，因为 example.JSON 不在 field 包内，应该算是一个实验字段或自定义字段，当前我的想法是在 user 模型 tag 注释中添加更多内容让 gen 生成找到该符合规范的自定义字段然后使用。但是需要一点时间看看。可能才分成两个 PR 会更好一点。当前 PR 解决 *gorm.Model 问题

uptutu · 2025-09-16T02:07:02Z

我看见了文档 json maping field 的用法，稍后我修复试一试

Copilot

Pull Request Overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-17T11:58:58Z

internal/gen/generator.go

 		applicableConfigs []*genconfig.Config
 		inputPath         string
 		relPath           string
+		goModDir          string // 缓存的 go mod 目录路径


The comment contains Chinese characters. Please use English for consistency: // Cached go mod directory path

Suggested change

goModDir string // 缓存的 go mod 目录路径

goModDir string // Cached go mod directory path

Copilot · 2025-09-17T11:58:58Z

internal/gen/generator.go

 		Package:   f.Name.Name,
 		inputPath: inputFile,
 		relPath:   relPath,
+		goModDir:  findGoModDir(inputFile), // 初始化时缓存 go mod 目录


The comment contains Chinese characters. Please use English for consistency: // Initialize and cache go mod directory

Suggested change

goModDir: findGoModDir(inputFile), // 初始化时缓存 go mod 目录

goModDir: findGoModDir(inputFile), // Initialize and cache go mod directory

Copilot

Pull Request Overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-17T12:01:11Z

internal/gen/generator.go

+	// Helper function to add fields from embedded struct
+	addEmbeddedFields := func(structType *ast.StructType, typeName, embeddedPkgName string) bool {
+		sub := p.processStructType(&ast.TypeSpec{Name: &ast.Ident{Name: typeName}}, structType, embeddedPkgName)
+		s.Fields = append(s.Fields, sub.Fields...)
+		return true
+	}


The addEmbeddedFields helper function always returns true, making the return value meaningless. Consider either removing the return value or implementing proper error handling that could return false in failure cases.

Copilot · 2025-09-17T12:01:12Z

internal/gen/generator.go

+	// Helper function to load and process external struct type
+	loadAndProcessExternalStruct := func(pkgName, typeName string) bool {
+		st, err := loadNamedStructType(p.goModDir, p.getFullImportPath(pkgName), typeName)
+		if err != nil || st == nil {
+			return false
+		}
+		return addEmbeddedFields(st, typeName, pkgName)
+	}


The error from loadNamedStructType is silently ignored. Consider logging the error or propagating it to help with debugging when struct loading fails.

uptutu added 2 commits September 15, 2025 17:41

fix go-gorm#15 *gorm.Model

d19bb8b

fix go-gorm#15 *gorm.Model

920459e

Copilot AI review requested due to automatic review settings September 15, 2025 10:05

propel-code-bot bot changed the title ~~fix 模型使用了 *gorm.Model 作为字段内嵌再解析生成的文件中会缺失对应的 gorm.Model 中的字段~~ Fix generation of embedded *gorm.Model fields to include base fields Sep 15, 2025

Copilot AI reviewed Sep 15, 2025

View reviewed changes

Apply suggestion from @Copilot

a05330a

Co-authored-by: Copilot <[email protected]>

propel-code-bot bot changed the title ~~Fix generation of embedded *gorm.Model fields to include base fields~~ Fix code generation to support pointer embedding of gorm.Model and include base fields Sep 15, 2025

uptutu added 3 commits September 15, 2025 18:17

caching findGoModDir(p.inputPath)

488a768

Merge branch 'master' of github.com:uptutu/gormcli

8c24a60

fix models examples

590632f

propel-code-bot bot reviewed Sep 16, 2025

View reviewed changes

fix models examples

ae1324f

uptutu added 2 commits September 16, 2025 10:22

fix models examples

30c6e4f

test: add created CreditCard fields for test *gorm.Model

09eff32

jinzhu requested a review from Copilot September 17, 2025 11:58

Copilot AI reviewed Sep 17, 2025

View reviewed changes

Refactor goModDir comments for clarity

698ac24

jinzhu requested a review from Copilot September 17, 2025 12:00

Copilot AI reviewed Sep 17, 2025

View reviewed changes

jinzhu merged commit 1a7be25 into go-gorm:master Sep 17, 2025
1 check passed

	goModDir string // 缓存的 go mod 目录路径
	goModDir string // Cached go mod directory path

	goModDir: findGoModDir(inputFile), // 初始化时缓存 go mod 目录
	goModDir: findGoModDir(inputFile), // Initialize and cache go mod directory

Uh oh!

Fix code generation to support pointer embedding of gorm.Model and include base fields #16

Fix code generation to support pointer embedding of gorm.Model and include base fields #16

Uh oh!

Conversation

uptutu commented Sep 15, 2025 • edited by propel-code-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

propel-code-bot bot Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

uptutu commented Sep 16, 2025

Uh oh!

uptutu commented Sep 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

uptutu commented Sep 15, 2025 •

edited by propel-code-bot bot

Loading