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.

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

feat: [#477] Configure camel case columns instead of snake case GORM #773

Merged
merged 3 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
496 changes: 248 additions & 248 deletions console/cli_helper.go

Large diffs are not rendered by default.

23 changes: 15 additions & 8 deletions contracts/database/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,24 @@ type Config struct {
// FullConfig Fill the default value for Config
type FullConfig struct {
Config
Driver Driver
Connection string
Prefix string
Singular bool
Charset string // Mysql, Sqlserver
Loc string // Mysql
Sslmode string // Postgres
Timezone string // Postgres
Driver Driver
Connection string
Prefix string
Singular bool
Charset string // Mysql, Sqlserver
Loc string // Mysql
Sslmode string // Postgres
Timezone string // Postgres
NoLowerCase bool
NameReplacer Replacer
}

type ConfigBuilder interface {
Reads() []FullConfig
Writes() []FullConfig
}

// Replacer replacer interface like strings.Replacer
type Replacer interface {
Replace(name string) string
}
16 changes: 11 additions & 5 deletions database/db/config_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,17 @@ func (c *ConfigBuilder) fillDefault(configs []database.Config) []database.FullCo

for _, config := range configs {
fullConfig := database.FullConfig{
Config: config,
Connection: c.connection,
Driver: driver,
Prefix: c.config.GetString(fmt.Sprintf("database.connections.%s.prefix", c.connection)),
Singular: c.config.GetBool(fmt.Sprintf("database.connections.%s.singular", c.connection)),
Config: config,
Connection: c.connection,
Driver: driver,
Prefix: c.config.GetString(fmt.Sprintf("database.connections.%s.prefix", c.connection)),
Singular: c.config.GetBool(fmt.Sprintf("database.connections.%s.singular", c.connection)),
NoLowerCase: c.config.GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", c.connection)),
}
if nameReplacer := c.config.Get(fmt.Sprintf("database.connections.%s.name_replacer", c.connection)); nameReplacer != nil {
if replacer, ok := nameReplacer.(database.Replacer); ok {
fullConfig.NameReplacer = replacer
}
}
if driver != database.DriverSqlite {
if fullConfig.Dsn == "" {
Expand Down
52 changes: 36 additions & 16 deletions database/db/config_builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package db

import (
"fmt"
"strings"
"testing"

"github.com/stretchr/testify/suite"
Expand Down Expand Up @@ -45,6 +46,8 @@ func (s *ConfigTestSuite) TestReads() {
}).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.prefix", s.connection)).Return(prefix).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.singular", s.connection)).Return(singular).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", s.connection)).Return(false).Once()
s.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", s.connection)).Return(nil).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.driver", s.connection)).Return(contractsdatabase.DriverSqlite.String()).Once()

s.Equal([]contractsdatabase.FullConfig{
Expand All @@ -70,6 +73,8 @@ func (s *ConfigTestSuite) TestWrites() {
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.database", s.connection)).Return(database).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.prefix", s.connection)).Return(prefix).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.singular", s.connection)).Return(singular).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", s.connection)).Return(false).Once()
s.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", s.connection)).Return(nil).Once()

s.Equal([]contractsdatabase.FullConfig{
{
Expand All @@ -91,6 +96,8 @@ func (s *ConfigTestSuite) TestWrites() {
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.driver", s.connection)).Return(contractsdatabase.DriverSqlite.String()).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.prefix", s.connection)).Return(prefix).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.singular", s.connection)).Return(singular).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", s.connection)).Return(false).Once()
s.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", s.connection)).Return(nil).Once()

s.Equal([]contractsdatabase.FullConfig{
{
Expand All @@ -115,6 +122,7 @@ func (s *ConfigTestSuite) TestFillDefault() {
singular := false
charset := "utf8mb4"
loc := "Local"
nameReplacer := strings.NewReplacer("a", "b")

tests := []struct {
name string
Expand All @@ -133,6 +141,8 @@ func (s *ConfigTestSuite) TestFillDefault() {
setup: func() {
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.prefix", s.connection)).Return(prefix).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.singular", s.connection)).Return(singular).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", s.connection)).Return(true).Once()
s.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", s.connection)).Return(nameReplacer).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.driver", s.connection)).Return("mysql").Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.dsn", s.connection)).Return(dsn).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.host", s.connection)).Return(host).Once()
Expand All @@ -145,12 +155,14 @@ func (s *ConfigTestSuite) TestFillDefault() {
},
expectConfigs: []contractsdatabase.FullConfig{
{
Connection: s.connection,
Driver: contractsdatabase.DriverMysql,
Prefix: prefix,
Singular: singular,
Charset: charset,
Loc: loc,
Connection: s.connection,
Driver: contractsdatabase.DriverMysql,
Prefix: prefix,
Singular: singular,
Charset: charset,
Loc: loc,
NoLowerCase: true,
NameReplacer: nameReplacer,
Config: contractsdatabase.Config{
Dsn: dsn,
Host: host,
Expand Down Expand Up @@ -178,17 +190,21 @@ func (s *ConfigTestSuite) TestFillDefault() {
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.driver", s.connection)).Return("mysql").Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.prefix", s.connection)).Return(prefix).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.singular", s.connection)).Return(singular).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", s.connection)).Return(true).Once()
s.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", s.connection)).Return(nameReplacer).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.charset", s.connection)).Return(charset).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.loc", s.connection)).Return(loc).Once()
},
expectConfigs: []contractsdatabase.FullConfig{
{
Connection: s.connection,
Driver: contractsdatabase.DriverMysql,
Prefix: prefix,
Singular: singular,
Charset: charset,
Loc: loc,
Connection: s.connection,
Driver: contractsdatabase.DriverMysql,
Prefix: prefix,
Singular: singular,
Charset: charset,
Loc: loc,
NoLowerCase: true,
NameReplacer: nameReplacer,
Config: contractsdatabase.Config{
Dsn: dsn,
Database: database,
Expand All @@ -210,14 +226,18 @@ func (s *ConfigTestSuite) TestFillDefault() {
setup: func() {
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.prefix", s.connection)).Return(prefix).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.singular", s.connection)).Return(singular).Once()
s.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", s.connection)).Return(true).Once()
s.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", s.connection)).Return(nameReplacer).Once()
s.mockConfig.EXPECT().GetString(fmt.Sprintf("database.connections.%s.driver", s.connection)).Return("sqlite").Once()
},
expectConfigs: []contractsdatabase.FullConfig{
{
Connection: s.connection,
Driver: contractsdatabase.DriverSqlite,
Prefix: prefix,
Singular: singular,
Connection: s.connection,
Driver: contractsdatabase.DriverSqlite,
Prefix: prefix,
Singular: singular,
NoLowerCase: true,
NameReplacer: nameReplacer,
Config: contractsdatabase.Config{
Database: database,
},
Expand Down
2 changes: 2 additions & 0 deletions database/gorm/gorm.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ func (r *Builder) init(fullConfig database.FullConfig) error {
NamingStrategy: schema.NamingStrategy{
TablePrefix: fullConfig.Prefix,
SingularTable: fullConfig.Singular,
NoLowerCase: fullConfig.NoLowerCase,
NameReplacer: fullConfig.NameReplacer,
},
})
if err != nil {
Expand Down
10 changes: 9 additions & 1 deletion database/gorm/test_utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,8 @@ func (r *MockMysql) basic() {
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.charset", r.connection)).Return("utf8mb4")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.loc", r.connection)).Return("UTC")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.database", r.connection)).Return(r.database)

r.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", r.connection)).Return(false)
r.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", r.connection)).Return(nil)
mockPool(r.mockConfig)
}

Expand Down Expand Up @@ -433,6 +434,9 @@ func (r *MockPostgres) basic() {
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.sslmode", r.connection)).Return("disable")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.timezone", r.connection)).Return("UTC")
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.database", r.connection)).Return(r.database)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.search_path", r.connection), "public").Return("public")
r.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", r.connection)).Return(false)
r.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", r.connection)).Return(nil)

mockPool(r.mockConfig)
}
Expand Down Expand Up @@ -497,6 +501,8 @@ func (r *MockSqlite) WithSchema(schema string) {
func (r *MockSqlite) basic() {
r.mockConfig.On("GetBool", "app.debug").Return(true)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.driver", r.connection)).Return(r.driver.String())
r.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", r.connection)).Return(false)
r.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", r.connection)).Return(nil)
mockPool(r.mockConfig)
}

Expand Down Expand Up @@ -565,6 +571,8 @@ func (r *MockSqlserver) basic() {
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.driver", r.connection)).Return(r.driver.String())
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.database", r.connection)).Return(r.database)
r.mockConfig.On("GetString", fmt.Sprintf("database.connections.%s.charset", r.connection)).Return("utf8mb4")
r.mockConfig.EXPECT().GetBool(fmt.Sprintf("database.connections.%s.no_lower_case", r.connection)).Return(false)
r.mockConfig.EXPECT().Get(fmt.Sprintf("database.connections.%s.name_replacer", r.connection)).Return(nil)
mockPool(r.mockConfig)
}

Expand Down
2 changes: 2 additions & 0 deletions foundation/application_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,8 @@ func (s *ApplicationTestSuite) TestMakeOrm() {
mockConfig.EXPECT().GetString("database.connections.postgres.timezone").Return("UTC").Twice()
mockConfig.EXPECT().GetString("database.connections.postgres.database").Return(config.Database).Twice()
mockConfig.EXPECT().GetString("database.connections.postgres.schema", "public").Return("public").Twice()
mockConfig.EXPECT().GetBool("database.connections.postgres.no_lower_case").Return(false).Twice()
mockConfig.EXPECT().Get("database.connections.postgres.name_replacer").Return(nil).Twice()
mockConfig.EXPECT().GetBool("app.debug").Return(true).Once()
mockConfig.EXPECT().GetInt("database.pool.max_idle_conns", 10).Return(10).Once()
mockConfig.EXPECT().GetInt("database.pool.max_open_conns", 100).Return(100).Once()
Expand Down
78 changes: 78 additions & 0 deletions mocks/database/Replacer.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading