Merge pull request #9 from Daffadon/dev

Daffadon · web-flow · commit 9ed7dcbbbc8e · 2025-10-30T08:27:49.000+07:00
Feat: add Clickhouse to DB option, issue template, and v0.4.0 release
diff --git a/.github/workflows/releaser.yml b/.github/workflows/releaser.yml
@@ -4,8 +4,6 @@ on:
   push:
     tags:
       - 'v*'   # only run when a tag starting with "v" is pushed (e.g., v1.0.0)
-    branches:
-      - main   # only on main branch
 
 permissions:
   contents: write   # required for creating GitHub Releases
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -55,7 +55,6 @@ changelog:
     exclude:
       - "^docs:"
       - "^test:"
-      - Merge pull request
 
 release:
   footer: >-
diff --git a/README.MD b/README.MD
@@ -18,20 +18,20 @@ Bootstrap your Go projects with clean architecture, best practices, and a solid
 ---
 
 > [!NOTE]
-> v0.3.2 now is stable, latest version, and generating one set of application with its driver to 3rd party. in this version, you can generate different framework, database, and message queue.
+> v0.4.0 now is stable, latest version, and generating one set of application with its driver to 3rd party. in this version, you can generate different framework, database, and message queue.
 
 ## 🔥 Get started
 
 ```bash
-go run github.com/daffadon/fndn@v0.3.2 init .
+go run github.com/daffadon/fndn@v0.4.0 init .
 ```
 
 \* . generate in current directory
 
 OR
 
 ```bash
-go run github.com/daffadon/fndn@v0.3.2 --help
+go run github.com/daffadon/fndn@v0.4.0 --help
 ```
 
 to see how can you use the tools
@@ -44,12 +44,12 @@ to see how can you use the tools
 If you want to install the tools to your system, you can either using go install or download the binary in available release:
 
 ```bash
-go install github.com/daffadon/fndn@v0.3.2
+go install github.com/daffadon/fndn@v0.4.0
 ```
 
 ## 🛠️ The techstack
 
-Currently, the generation are in default mode and custom mode with limitation at `framework` and `database`. the `Default` mode is using the first techstack from each section. the generated techstack that you can use are:
+Currently, the generation are in default mode and custom mode with limitation at `framework`, `database`, and `message queue`. the `Default` mode is using the first techstack from each section. the generated techstack that you can use are:
 
 - Framework
 
@@ -63,6 +63,7 @@ Currently, the generation are in default mode and custom mode with limitation at
 
 ![Postgresql](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)
 ![MariaDB](https://img.shields.io/badge/MariaDB-003545?style=for-the-badge&logo=mariadb&logoColor=white)
+![ClickHouse](https://img.shields.io/badge/ClickHouse-FFCC01?style=for-the-badge&logo=ClickHouse&logoColor=white)
 ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)
 ![FerretDB](https://img.shields.io/badge/FerretDB-black?style=for-the-badge&logo=ferretdb&logoColor=white)
 ![Neo4J](https://img.shields.io/badge/Neo4j-008CC1?style=for-the-badge&logo=neo4j&logoColor=white)
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-v0.3.2
+v0.4.0
diff --git a/internal/domain/config.go b/internal/domain/config.go
@@ -35,6 +35,8 @@ func InitYamlConfig(i infra.CommandRunner, p *Project) error {
 			s += config_template.PostresqlYamlConfigTemplate
 		case "mariadb":
 			s += config_template.MariaDBYamlConfigTemplate
+		case "clickhouse":
+			s += config_template.ClickHouseYamlConfigTemplate
 		case "mongodb":
 			s += config_template.MongoDBYamlConfigTemplate
 		case "ferretdb":
diff --git a/internal/domain/database.go b/internal/domain/database.go
@@ -20,6 +20,9 @@ func InitDBConfig(i infra.CommandRunner, path *string, db *string) error {
 		case "mariadb":
 			fileName = folderName + "/mariadb.go"
 			template = database_template.MariaDBConfigTemplate
+		case "clickhouse":
+			fileName = folderName + "/clickhouse.go"
+			template = database_template.ClickHouseConfigTemplate
 		case "mongodb":
 			fileName = folderName + "/mongodb.go"
 			template = database_template.MongoDBConfigTemplate
diff --git a/internal/domain/docker.go b/internal/domain/docker.go
@@ -56,6 +56,8 @@ func InitDockerComposeConfig(i infra.CommandRunner, p *Project) error {
 			dbDockerTemplate = database_template.DockerComposePostgresqlConfigTemplate
 		case "mariadb":
 			dbDockerTemplate = database_template.DockerComposeMariaDBConfigTemplate
+		case "clickhouse":
+			dbDockerTemplate = database_template.DockerComposeClickHouseConfigTemplate
 		case "mongodb":
 			dbDockerTemplate = database_template.DockerComposeMongoDBConfigTemplate
 		case "ferretdb":
diff --git a/internal/domain/infra.go b/internal/domain/infra.go
@@ -19,6 +19,8 @@ func InitQuerierInfra(i infra.CommandRunner, path *string, database *string) err
 			s = infra_template.QuerierPgxInfraTemplate
 		case "mariadb":
 			s = infra_template.QuerierMariaDBInfraTemplate
+		case "clickhouse":
+			s = infra_template.QuerierClickHouseInfraTemplate
 		case "mongodb", "ferretdb":
 			st := struct{ DatabaseName string }{DatabaseName: "database_name"}
 			tmp, err := pkg.ParseTemplate(infra_template.QuerierMongoDBInfraTemplate, st)
diff --git a/internal/domain/main-gen.go b/internal/domain/main-gen.go
@@ -19,7 +19,7 @@ func InitDependencyInjection(i infra.CommandRunner, p *Project) error {
 			MQInfra      string
 		}
 		switch p.Database {
-		case "postgresql", "mariadb":
+		case "postgresql", "mariadb", "clickhouse":
 			st.DBConnection = "NewSQLConn"
 		case "neo4j":
 			st.DBConnection = "NewGraphDBConn"
diff --git a/internal/pkg/parser.go b/internal/pkg/parser.go
@@ -56,6 +56,10 @@ func HTTPServerParser(fwk, db, mq string) (string, error) {
 		t.DBInstanceType = "*sql.DB"
 		t.DBCloseConnection = "db.Close()"
 		t.DBImport = `"database/sql"`
+	case "clickhouse":
+		t.DBInstanceType = "clickhouse.Conn"
+		t.DBCloseConnection = "db.Close()"
+		t.DBImport = `"github.com/ClickHouse/clickhouse-go/v2"`
 	case "mongodb", "ferretdb":
 		t.DBInstanceType = "*mongo.Client"
 		t.DBCloseConnection = "db.Disconnect(ctx)"
diff --git a/internal/template/config/db.yaml.go b/internal/template/config/db.yaml.go
@@ -21,6 +21,16 @@ database:
     port: "3306"
     name: "database_name"
 `
+const ClickHouseYamlConfigTemplate string = `
+database:
+  sql:
+    host: "localhost"
+    user: "myusername"
+    password: "password"
+    port: "9002"
+    name: "database_name"
+    debug: true
+`
 
 const MongoDBYamlConfigTemplate string = `
 database:
diff --git a/internal/template/database/clickhouse.go b/internal/template/database/clickhouse.go
@@ -0,0 +1,50 @@
+package database_template
+
+const ClickHouseConfigTemplate string = `
+package storage
+
+import (
+	"github.com/ClickHouse/clickhouse-go/v2"
+	"github.com/ClickHouse/clickhouse-go/v2/lib/driver"
+	"github.com/rs/zerolog"
+	"github.com/spf13/viper"
+)
+
+func NewSQLConn(logger zerolog.Logger) clickhouse.Conn {
+	addr := fmt.Sprintf("%s:%s", viper.GetString("database.sql.host"), viper.GetString("database.sql.port"))
+	conn, err := clickhouse.Open(&clickhouse.Options{
+		Addr: []string{addr},
+		Auth: clickhouse.Auth{
+			Database: viper.GetString("database.sql.name"),
+			Username: viper.GetString("database.sql.user"),
+			Password: viper.GetString("database.sql.password"),
+		},
+		TLS:         nil,
+		DialTimeout: 5_000_000_000,
+		Debug:       viper.GetBool("database.sql.debug"),
+	})
+	if err != nil {
+		logger.Fatal().Msgf("failed to open ClickHouse connection: %v", err)
+	}
+	if err := conn.Ping(context.Background()); err != nil {
+		log.Fatalf("failed to ping ClickHouse: %v", err)
+	}
+	return conn
+}
+`
+
+const DockerComposeClickHouseConfigTemplate string = `
+# db
+	{{.ProjectName}}_db:
+			image: clickhouse:25.9.4.58-jammy
+			container_name: {{.ProjectName}}_db
+			restart: unless-stopped
+			environment:
+				CLICKHOUSE_DB: ${DB_NAME}
+				CLICKHOUSE_USER: ${DB_USER}
+				CLICKHOUSE_PASSWORD: ${DB_PASSWORD}
+			ports:
+				- "9002:9000"
+			volumes:
+			- {{.ProjectName}}_db_data:/var/lib/clickhouse
+`
diff --git a/internal/template/infra/querier.go b/internal/template/infra/querier.go
@@ -189,3 +189,55 @@ func (n *neo4jQuerier) Close(ctx context.Context) error {
 	return n.driver.Close(ctx)
 }
 `
+
+const QuerierClickHouseInfraTemplate = `
+package storage_infra
+
+import (
+	"github.com/ClickHouse/clickhouse-go/v2"
+	"github.com/ClickHouse/clickhouse-go/v2/lib/driver"
+)
+
+type (
+	Querier interface {
+		QueryRow(ctx context.Context, query string, args ...any) driver.Row
+		Query(ctx context.Context, query string, args ...any) (driver.Rows, error)
+		Exec(ctx context.Context, query string, args ...any) error
+		Close(ctx context.Context) error
+	}
+
+	clickhouseQuerier struct {
+		conn clickhouse.Conn
+	}
+)
+
+// NewQuerier creates a new ClickHouse querier using a shared connection
+func NewQuerier(conn clickhouse.Conn) Querier {
+	return &clickhouseQuerier{conn: conn}
+}
+
+func (c *clickhouseQuerier) QueryRow(ctx context.Context, query string, args ...any) driver.Row {
+	rows, err := c.conn.Query(ctx, query, args...)
+	if err != nil {
+		return nil
+	}
+	if !rows.Next() {
+		_ = rows.Close()
+		return nil
+	}
+	return rows
+}
+
+func (c *clickhouseQuerier) Query(ctx context.Context, query string, args ...any) (driver.Rows, error) {
+	return c.conn.Query(ctx, query, args...)
+}
+
+func (c *clickhouseQuerier) Exec(ctx context.Context, query string, args ...any) error {
+	return c.conn.Exec(ctx, query, args...)
+}
+
+func (c *clickhouseQuerier) Close(ctx context.Context) error {
+	return c.conn.Close()
+}
+
+`
diff --git a/internal/ui/input_main.go b/internal/ui/input_main.go
@@ -61,12 +61,12 @@ func newModel(uc *app.InitProjectUseCase, targetDir string) model {
 		},
 		{
 			Label:    "Database",
-			Input:    module.NewRadioButton([]string{"Postgresql", "MariaDB", "MongoDB", "FerretDB", "Neo4j"}, 0),
+			Input:    module.NewRadioButton([]string{"Postgresql", "MariaDB", "ClickHouse", "MongoDB", "FerretDB", "Neo4j"}, 0),
 			Validate: nil,
 		},
 		{
 			Label:    "Message Queue",
-			Input:    module.NewRadioButton([]string{"Nats", "RabbitMQ", "Kafka","Amazon SQS"}, 0),
+			Input:    module.NewRadioButton([]string{"Nats", "RabbitMQ", "Kafka", "Amazon SQS"}, 0),
 			Validate: nil,
 		},
 	}

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ func InitDependencyInjection(i infra.CommandRunner, p *Project) error {`
`19`	`19`	`MQInfra string`
`20`	`20`	`}`
`21`	`21`	`switch p.Database {`
`22`		`- case "postgresql", "mariadb":`
	`22`	`+ case "postgresql", "mariadb", "clickhouse":`
`23`	`23`	`st.DBConnection = "NewSQLConn"`
`24`	`24`	`case "neo4j":`
`25`	`25`	`st.DBConnection = "NewGraphDBConn"`