Move kbuilder outside from the internal/ dir but hide it with a build flag

Author: VinGarcia

Makefile

@@ -1,6 +1,7 @@
 args=
 path=./...
 
+BUILD_TAGS=-tags ksql_enable_kbuilder_experiment
 GOBIN=$(shell go env GOPATH)/bin
 
 TIME=5s
@@ -13,7 +14,7 @@ pre-download-all-images:
 	docker pull mariadb:10.8
 
 test: setup go-mod-tidy
-	$(GOBIN)/richgo test $(path) $(args)
+	$(GOBIN)/richgo test $(BUILD_TAGS) $(path) $(args)
 	@( cd benchmarks ; $(GOBIN)/richgo test $(path) $(args) )
 	@( cd examples ; $(GOBIN)/richgo test $(path) $(args) )
 	@( cd adapters/kpgx ; $(GOBIN)/richgo test $(path) $(args) -timeout=60s )
@@ -34,8 +35,8 @@ readme: benchmark.tmp readme.template.md
 	go run scripts/build-readme-from-template.go readme.template.md
 
 lint: setup go-mod-tidy
-	@$(GOBIN)/staticcheck $(path) $(args)
-	@go vet $(path) $(args)
+	@$(GOBIN)/staticcheck $(BUILD_TAGS) $(path) $(args)
+	@go vet $(BUILD_TAGS) $(path) $(args)
 	@make --no-print-directory -C benchmarks lint
 	@echo "StaticCheck & Go Vet found no problems on your code!"
 

codecov.yml

@@ -2,7 +2,7 @@ coverage:
   ignore:
     - "internal/**/*"
     - "examples/**/*"
-    - "internal/kbuilder/*"
+    - "kbuilder/*"
     - "kstructs/*"
     - "test_adapters.go"
     - "internal_mocks.go"

internal/kbuilder/README.md

@@ -0,0 +1,31 @@
+# Welcome to the Keep It Simple Query Builder
+
+This is the Keep It Simple query builder created to work
+either in conjunction or separated from the KSQL package.
+
+This package was started after KSQL and while the KSQL is already
+in a usable state I still don't recommend using this one since this
+being actively implemented and might change without further warning.
+
+## Enabling kbuilder
+
+kbuilder is only available using a specific build tag, so if you want
+to experiment with this tool you will need to import KSQL normally, and when
+you compile your project you will need to add the tag `ksql_enable_kbuilder_experiment`,
+e.g.:
+
+
+```
+go run -tags ksql_enable_kbuilder_experiment [path to your entrypoint]
+go test -tags ksql_enable_kbuilder_experiment [path to your entrypoint]
+go build -tags ksql_enable_kbuilder_experiment [path to your entrypoint]
+```
+
+Not enabling this flag explicitly will cause it to panic, as I
+don't want anyone using it without knowing it is still experimental.
+
+## TODO List
+
+- Add support to Update and Delete operations
+- Improve support to JOINs by adding the `tablename` tag to the structs
+- Add error check for when the Select, Insert and Update attrs are all empty

internal/kbuilder/LICENSE renamed to kbuilder/LICENSE

@@ -1,3 +1,5 @@
+//go:build ksql_enable_kbuilder_experiment
+
 package kbuilder
 
 import (

kbuilder/README.md

@@ -0,0 +1,31 @@
+//go:build !ksql_enable_kbuilder_experiment
+
+package kbuilder
+
+import (
+	"github.com/vingarcia/ksql/sqldialect"
+)
+
+// This is the fallback file for kbuilder package when the ksql_enable_kbuilder_experiment
+// build tag is not enabled, check the file named `insert.go` to see the actual implementation.
+
+// Insert is the struct template for building INSERT queries
+type Insert struct {
+	// Into expects a table name, e.g. "users"
+	Into string
+
+	// Data expected either a single record annotated with `ksql` tags
+	// or a list of records annotated likewise.
+	Data interface{}
+}
+
+// Build is a utility function for finding the dialect based on the driver and
+// then calling BuildQuery(dialect)
+func (i Insert) Build(driver string) (sqlQuery string, params []interface{}, _ error) {
+	panic("kbuilder is an experimental package and needs to be explicitly enabled see github.com/vingarcia/ksql/tree/master/kbuilder/README.md")
+}
+
+// BuildQuery implements the queryBuilder interface
+func (i Insert) BuildQuery(dialect sqldialect.Provider) (sqlQuery string, params []interface{}, _ error) {
+	panic("kbuilder is an experimental package and needs to be explicitly enabled see github.com/vingarcia/ksql/tree/master/kbuilder/README.md")
+}

internal/kbuilder/insert.go renamed to kbuilder/insert.go

@@ -3,8 +3,8 @@ package kbuilder_test
 import (
 	"testing"
 
-	"github.com/vingarcia/ksql/internal/kbuilder"
 	tt "github.com/vingarcia/ksql/internal/testtools"
+	"github.com/vingarcia/ksql/kbuilder"
 )
 
 func TestInsertQuery(t *testing.T) {

kbuilder/insert_fallback.go

@@ -1,3 +1,5 @@
+//go:build ksql_enable_kbuilder_experiment
+
 package kbuilder
 
 import (
@@ -131,14 +133,14 @@ func (w WhereQueries) Where(cond string, params ...interface{}) WhereQueries {
 }
 
 // WhereIf conditionally adds a new boolean expression to the WhereQueries helper.
-func (w WhereQueries) WhereIf(cond string, param interface{}) WhereQueries {
-	if param == nil || reflect.ValueOf(param).IsNil() {
+func (w WhereQueries) WhereIf(ifCond bool, cond string, params ...interface{}) WhereQueries {
+	if !ifCond {
 		return w
 	}
 
 	return append(w, WhereQuery{
 		cond:   cond,
-		params: []interface{}{param},
+		params: params,
 	})
 }
 
@@ -152,14 +154,14 @@ func Where(cond string, params ...interface{}) WhereQueries {
 }
 
 // WhereIf conditionally adds a new boolean expression to the WhereQueries helper
-func WhereIf(cond string, param interface{}) WhereQueries {
-	if param == nil || reflect.ValueOf(param).IsNil() {
+func WhereIf(ifCond bool, cond string, params ...interface{}) WhereQueries {
+	if !ifCond {
 		return WhereQueries{}
 	}
 
 	return WhereQueries{{
 		cond:   cond,
-		params: []interface{}{param},
+		params: params,
 	}}
 }