GOMODULES
/
ksql
mirror of https://github.com/VinGarcia/ksql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Replace all instances of lower-cased kisssql for ksql

pull/2/head
Vinícius Garcia 2021-03-10 10:11:18 -03:00
parent fd659b9c0c
commit 8b8fb092d8
15 changed files with 145 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -87,24 +87,24 @@ import (
"fmt"
_ "github.com/mattn/go-sqlite3"
"github.com/vingarcia/kisssql"
"github.com/vingarcia/kisssql/nullable"
"github.com/vingarcia/ksql"
"github.com/vingarcia/ksql/nullable"
)
type User struct {
ID int `kisssql:"id"`
Name string `kisssql:"name"`
Age int `kisssql:"age"`
ID int `ksql:"id"`
Name string `ksql:"name"`
Age int `ksql:"age"`
// This field will be saved as JSON in the database
Address Address `kisssql:"address,json"`
Address Address `ksql:"address,json"`
}
type PartialUpdateUser struct {
ID int `kisssql:"id"`
Name *string `kisssql:"name"`
Age *int `kisssql:"age"`
Address *Address `kisssql:"address,json"`
ID int `ksql:"id"`
Name *string `ksql:"name"`
Age *int `ksql:"age"`
Address *Address `ksql:"address,json"`
}
type Address struct {
@ -114,7 +114,7 @@ type Address struct {
func main() {
ctx := context.Background()
db, err := kisssql.New("sqlite3", "/tmp/hello.sqlite", 1, "users")
db, err := ksql.New("sqlite3", "/tmp/hello.sqlite", 1, "users")
if err != nil {
panic(err.Error())
}
@ -178,8 +178,8 @@ func main() {
// Partial update technique 1:
err = db.Update(ctx, struct {
ID int `kisssql:"id"`
Age int `kisssql:"age"`
ID int `ksql:"id"`
Age int `ksql:"age"`
}{ID: cris.ID, Age: 28})
if err != nil {
panic(err.Error())
@ -210,7 +210,7 @@ func main() {
}
// Making transactions:
err = db.Transaction(ctx, func(db kisssql.SQLProvider) error {
err = db.Transaction(ctx, func(db ksql.SQLProvider) error {
var cris2 User
err = db.QueryOne(ctx, &cris2, "SELECT * FROM users WHERE id = ?", cris.ID)
if err != nil {
@ -243,9 +243,9 @@ func main() {
This library has a few helper functions for helping your tests:
- `kisssql.FillStructWith(struct interface{}, dbRow map[string]interface{}) error`
- `kisssql.FillSliceWith(structSlice interface{}, dbRows []map[string]interface{}) error`
- `kisssql.StructToMap(struct interface{}) (map[string]interface{}, error)`
- `ksql.FillStructWith(struct interface{}, dbRow map[string]interface{}) error`
- `ksql.FillSliceWith(structSlice interface{}, dbRows []map[string]interface{}) error`
- `ksql.StructToMap(struct interface{}) (map[string]interface{}, error)`
If you want to see examples (we have examples for all the public functions) just
read the example tests available on our [example service](./examples/example_service)
@ -259,16 +259,16 @@ $ make bench TIME=3s
go test -bench=. -benchtime=3s
goos: linux
goarch: amd64
pkg: github.com/vingarcia/kisssql
pkg: github.com/vingarcia/ksql
cpu: Intel(R) Core(TM) i5-3210M CPU @ 2.50GHz
BenchmarkInsert/kisssql-setup/insert-one-4 4302 776648 ns/op
BenchmarkInsert/ksql-setup/insert-one-4 4302 776648 ns/op
BenchmarkInsert/sqlx-setup/insert-one-4 4716 762358 ns/op
BenchmarkQuery/kisssql-setup/single-row-4 12204 293858 ns/op
BenchmarkQuery/kisssql-setup/multiple-rows-4 11145 323571 ns/op
BenchmarkQuery/ksql-setup/single-row-4 12204 293858 ns/op
BenchmarkQuery/ksql-setup/multiple-rows-4 11145 323571 ns/op
BenchmarkQuery/sqlx-setup/single-row-4 12440 290937 ns/op
BenchmarkQuery/sqlx-setup/multiple-rows-4 10000 310314 ns/op
PASS
ok github.com/vingarcia/kisssql 34.251s
ok github.com/vingarcia/ksql 34.251s
```
### TODO List

34
benchmark_test.go
View File

@ -1,4 +1,4 @@
package kisssql_test
package ksql_test
import (
"context"
@ -9,16 +9,16 @@ import (
"github.com/jmoiron/sqlx"
_ "github.com/lib/pq"
"github.com/vingarcia/kisssql"
"github.com/vingarcia/ksql"
)
func BenchmarkInsert(b *testing.B) {
ctx := context.Background()
driver := "postgres"
connStr := "host=localhost port=5432 user=postgres password=postgres dbname=kisssql sslmode=disable"
connStr := "host=localhost port=5432 user=postgres password=postgres dbname=ksql sslmode=disable"
kisssqlDB, err := kisssql.New(driver, connStr, kisssql.Config{
ksqlDB, err := ksql.New(driver, connStr, ksql.Config{
MaxOpenConns: 1,
TableName: "users",
})
@ -27,12 +27,12 @@ func BenchmarkInsert(b *testing.B) {
}
type User struct {
ID int `kisssql:"id" db:"id"`
Name string `kisssql:"name" db:"name"`
Age int `kisssql:"age" db:"age"`
ID int `ksql:"id" db:"id"`
Name string `ksql:"name" db:"name"`
Age int `ksql:"age" db:"age"`
}
b.Run("kisssql-setup", func(b *testing.B) {
b.Run("ksql-setup", func(b *testing.B) {
err := recreateTable(connStr)
if err != nil {
b.Fatalf("error creating table: %s", err.Error())
@ -40,7 +40,7 @@ func BenchmarkInsert(b *testing.B) {
b.Run("insert-one", func(b *testing.B) {
for i := 0; i < b.N; i++ {
err := kisssqlDB.Insert(ctx, &User{
err := ksqlDB.Insert(ctx, &User{
Name: strconv.Itoa(i),
Age: i,
})
@ -88,9 +88,9 @@ func BenchmarkQuery(b *testing.B) {
ctx := context.Background()
driver := "postgres"
connStr := "host=localhost port=5432 user=postgres password=postgres dbname=kisssql sslmode=disable"
connStr := "host=localhost port=5432 user=postgres password=postgres dbname=ksql sslmode=disable"
kisssqlDB, err := kisssql.New(driver, connStr, kisssql.Config{
ksqlDB, err := ksql.New(driver, connStr, ksql.Config{
MaxOpenConns: 1,
TableName: "users",
})
@ -99,12 +99,12 @@ func BenchmarkQuery(b *testing.B) {
}
type User struct {
ID int `kisssql:"id" db:"id"`
Name string `kisssql:"name" db:"name"`
Age int `kisssql:"age" db:"age"`
ID int `ksql:"id" db:"id"`
Name string `ksql:"name" db:"name"`
Age int `ksql:"age" db:"age"`
}
b.Run("kisssql-setup", func(b *testing.B) {
b.Run("ksql-setup", func(b *testing.B) {
err := recreateTable(connStr)
if err != nil {
b.Fatalf("error creating table: %s", err.Error())
@ -118,7 +118,7 @@ func BenchmarkQuery(b *testing.B) {
b.Run("single-row", func(b *testing.B) {
for i := 0; i < b.N; i++ {
var user User
err := kisssqlDB.QueryOne(ctx, &user, `SELECT * FROM users OFFSET $1 LIMIT 1`, i%100)
err := ksqlDB.QueryOne(ctx, &user, `SELECT * FROM users OFFSET $1 LIMIT 1`, i%100)
if err != nil {
b.Fatalf("query error: %s", err.Error())
}
@ -128,7 +128,7 @@ func BenchmarkQuery(b *testing.B) {
b.Run("multiple-rows", func(b *testing.B) {
for i := 0; i < b.N; i++ {
var users []User
err := kisssqlDB.Query(ctx, &users, `SELECT * FROM users OFFSET $1 LIMIT 10`, i%90)
err := ksqlDB.Query(ctx, &users, `SELECT * FROM users OFFSET $1 LIMIT 10`, i%90)
if err != nil {
b.Fatalf("query error: %s", err.Error())
}

6
contracts.go
View File

@ -1,4 +1,4 @@
package kisssql
package ksql
import (
"context"
@ -9,10 +9,10 @@ import (
)
// ErrRecordNotFound ...
var ErrRecordNotFound error = errors.Wrap(sql.ErrNoRows, "kisssql: the query returned no results")
var ErrRecordNotFound error = errors.Wrap(sql.ErrNoRows, "ksql: the query returned no results")
// ErrAbortIteration ...
var ErrAbortIteration error = fmt.Errorf("kisssql: abort iteration, should only be used inside QueryChunks function")
var ErrAbortIteration error = fmt.Errorf("ksql: abort iteration, should only be used inside QueryChunks function")
// SQLProvider describes the public behavior of this ORM
type SQLProvider interface {

2
dialect.go
View File

@ -1,4 +1,4 @@
package kisssql
package ksql
import "strconv"

28
examples/crud/crud.go
View File

@ -5,26 +5,26 @@ import (
"fmt"
_ "github.com/mattn/go-sqlite3"
"github.com/vingarcia/kisssql"
"github.com/vingarcia/kisssql/nullable"
"github.com/vingarcia/ksql"
"github.com/vingarcia/ksql/nullable"
)
// User ...
type User struct {
ID int `kisssql:"id"`
Name string `kisssql:"name"`
Age int `kisssql:"age"`
ID int `ksql:"id"`
Name string `ksql:"name"`
Age int `ksql:"age"`
// This field will be saved as JSON in the database
Address Address `kisssql:"address,json"`
Address Address `ksql:"address,json"`
}
// PartialUpdateUser ...
type PartialUpdateUser struct {
ID int `kisssql:"id"`
Name *string `kisssql:"name"`
Age *int `kisssql:"age"`
Address *Address `kisssql:"address,json"`
ID int `ksql:"id"`
Name *string `ksql:"name"`
Age *int `ksql:"age"`
Address *Address `ksql:"address,json"`
}
// Address ...
@ -35,7 +35,7 @@ type Address struct {
func main() {
ctx := context.Background()
db, err := kisssql.New("sqlite3", "/tmp/hello.sqlite", kisssql.Config{
db, err := ksql.New("sqlite3", "/tmp/hello.sqlite", ksql.Config{
MaxOpenConns: 1,
TableName: "users",
})
@ -102,8 +102,8 @@ func main() {
// Partial update technique 1:
err = db.Update(ctx, struct {
ID int `kisssql:"id"`
Age int `kisssql:"age"`
ID int `ksql:"id"`
Age int `ksql:"age"`
}{ID: cris.ID, Age: 28})
if err != nil {
panic(err.Error())
@ -134,7 +134,7 @@ func main() {
}
// Making transactions:
err = db.Transaction(ctx, func(db kisssql.SQLProvider) error {
err = db.Transaction(ctx, func(db ksql.SQLProvider) error {
var cris2 User
err = db.QueryOne(ctx, &cris2, "SELECT * FROM users WHERE id = ?", cris.ID)
if err != nil {

26
examples/example_service/example_service.go
View File

@ -4,13 +4,13 @@ import (
"context"
"time"
"github.com/vingarcia/kisssql"
"github.com/vingarcia/kisssql/nullable"
"github.com/vingarcia/ksql"
"github.com/vingarcia/ksql/nullable"
)
// Service ...
type Service struct {
usersTable kisssql.SQLProvider
usersTable ksql.SQLProvider
streamChunkSize int
}
@ -25,12 +25,12 @@ type Service struct {
// If this is not the case, it might be a good idea
// to create a DTO struct to receive select queries.
type UserEntity struct {
ID int `kisssql:"id"`
Name *string `kisssql:"name"`
Age *int `kisssql:"age"`
Score *int `kisssql:"score"`
LastPayment time.Time `kisssql:"last_payment"`
Address *Address `kisssql:"address,json"`
ID int `ksql:"id"`
Name *string `ksql:"name"`
Age *int `ksql:"age"`
Score *int `ksql:"score"`
LastPayment time.Time `ksql:"last_payment"`
Address *Address `ksql:"address,json"`
}
// Address contains the user's address
@ -42,7 +42,7 @@ type Address struct {
}
// NewUserService ...
func NewUserService(usersTable kisssql.SQLProvider) Service {
func NewUserService(usersTable ksql.SQLProvider) Service {
return Service{
usersTable: usersTable,
streamChunkSize: 100,
@ -58,7 +58,7 @@ func (s Service) CreateUser(ctx context.Context, u UserEntity) error {
// user score. Defaults to 0 if not set.
func (s Service) UpdateUserScore(ctx context.Context, uID int, scoreChange int) error {
var scoreRow struct {
Score int `kisssql:"score"`
Score int `ksql:"score"`
}
err := s.usersTable.QueryOne(ctx, &scoreRow, "SELECT score FROM users WHERE id = ?", uID)
if err != nil {
@ -74,7 +74,7 @@ func (s Service) UpdateUserScore(ctx context.Context, uID int, scoreChange int)
// ListUsers returns a page of users
func (s Service) ListUsers(ctx context.Context, offset, limit int) (total int, users []UserEntity, err error) {
var countRow struct {
Count int `kisssql:"count"`
Count int `ksql:"count"`
}
err = s.usersTable.QueryOne(ctx, &countRow, "SELECT count(*) as count FROM users")
if err != nil {
@ -91,7 +91,7 @@ func (s Service) ListUsers(ctx context.Context, offset, limit int) (total int, u
// function only when the ammount of data loaded might exceed the available memory and/or
// when you can't put an upper limit on the number of values returned.
func (s Service) StreamAllUsers(ctx context.Context, sendUser func(u UserEntity) error) error {
return s.usersTable.QueryChunks(ctx, kisssql.ChunkParser{
return s.usersTable.QueryChunks(ctx, ksql.ChunkParser{
Query: "SELECT * FROM users",
Params: []interface{}{},
ChunkSize: s.streamChunkSize,

26
examples/example_service/example_service_test.go
View File

@ -7,13 +7,13 @@ import (
gomock "github.com/golang/mock/gomock"
"github.com/stretchr/testify/require"
"github.com/tj/assert"
"github.com/vingarcia/kisssql"
"github.com/vingarcia/kisssql/nullable"
"github.com/vingarcia/kisssql/structs"
"github.com/vingarcia/ksql"
"github.com/vingarcia/ksql/nullable"
"github.com/vingarcia/ksql/structs"
)
func TestCreateUser(t *testing.T) {
t.Run("should call kisssql.Insert correctly", func(t *testing.T) {
t.Run("should call ksql.Insert correctly", func(t *testing.T) {
controller := gomock.NewController(t)
defer controller.Finish()
@ -54,8 +54,8 @@ func TestCreateUser(t *testing.T) {
usersTableMock.EXPECT().Insert(gomock.Any(), gomock.Any()).
DoAndReturn(func(ctx context.Context, records ...interface{}) error {
for _, record := range records {
// The StructToMap function will convert a struct with `kisssql` tags
// into a map using the kisssql attr names as keys.
// The StructToMap function will convert a struct with `ksql` tags
// into a map using the ksql attr names as keys.
//
// If you are inserting an anonymous struct (not usual) this function
// can make your tests shorter:
@ -79,7 +79,7 @@ func TestCreateUser(t *testing.T) {
}
func TestUpdateUserScore(t *testing.T) {
t.Run("should call kisssql.QueryOne() & Update() correctly", func(t *testing.T) {
t.Run("should call ksql.QueryOne() & Update() correctly", func(t *testing.T) {
controller := gomock.NewController(t)
defer controller.Finish()
@ -97,7 +97,7 @@ func TestUpdateUserScore(t *testing.T) {
// This function will use reflection to fill the
// struct fields with the values from the map
return structs.FillStructWith(result, map[string]interface{}{
// Use int this map the keys you set on the kisssql tags, e.g. `kisssql:"score"`
// Use int this map the keys you set on the ksql tags, e.g. `ksql:"score"`
// Each of these fields represent the database rows returned
// by the query.
"score": 42,
@ -123,7 +123,7 @@ func TestUpdateUserScore(t *testing.T) {
}
func TestListUsers(t *testing.T) {
t.Run("should call kisssql.QueryOne() & Query() correctly", func(t *testing.T) {
t.Run("should call ksql.QueryOne() & Query() correctly", func(t *testing.T) {
controller := gomock.NewController(t)
defer controller.Finish()
@ -140,7 +140,7 @@ func TestListUsers(t *testing.T) {
// This function will use reflection to fill the
// struct fields with the values from the map
return structs.FillStructWith(result, map[string]interface{}{
// Use int this map the keys you set on the kisssql tags, e.g. `kisssql:"score"`
// Use int this map the keys you set on the ksql tags, e.g. `ksql:"score"`
// Each of these fields represent the database rows returned
// by the query.
"count": 420,
@ -185,7 +185,7 @@ func TestListUsers(t *testing.T) {
}
func TestStreamAllUsers(t *testing.T) {
t.Run("should call kisssql.QueryChunks correctly", func(t *testing.T) {
t.Run("should call ksql.QueryChunks correctly", func(t *testing.T) {
controller := gomock.NewController(t)
defer controller.Finish()
@ -197,7 +197,7 @@ func TestStreamAllUsers(t *testing.T) {
}
usersTableMock.EXPECT().QueryChunks(gomock.Any(), gomock.Any()).
DoAndReturn(func(ctx context.Context, parser kisssql.ChunkParser) error {
DoAndReturn(func(ctx context.Context, parser ksql.ChunkParser) error {
fn, ok := parser.ForEachChunk.(func(users []UserEntity) error)
require.True(t, ok)
// Chunk 1:
@ -259,7 +259,7 @@ func TestStreamAllUsers(t *testing.T) {
}
func TestDeleteUser(t *testing.T) {
t.Run("should call kisssql.Delete correctly", func(t *testing.T) {
t.Run("should call ksql.Delete correctly", func(t *testing.T) {
controller := gomock.NewController(t)
defer controller.Finish()

6
examples/example_service/mocks.go
View File

@ -9,7 +9,7 @@ import (
reflect "reflect"
gomock "github.com/golang/mock/gomock"
kisssql "github.com/vingarcia/kisssql"
ksql "github.com/vingarcia/ksql"
)
// MockSQLProvider is a mock of SQLProvider interface.
@ -112,7 +112,7 @@ func (mr *MockSQLProviderMockRecorder) Query(ctx, records, query interface{}, pa
}
// QueryChunks mocks base method.
func (m *MockSQLProvider) QueryChunks(ctx context.Context, parser kisssql.ChunkParser) error {
func (m *MockSQLProvider) QueryChunks(ctx context.Context, parser ksql.ChunkParser) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "QueryChunks", ctx, parser)
ret0, _ := ret[0].(error)
@ -145,7 +145,7 @@ func (mr *MockSQLProviderMockRecorder) QueryOne(ctx, record, query interface{},
}
// Transaction mocks base method.
func (m *MockSQLProvider) Transaction(ctx context.Context, fn func(kisssql.SQLProvider) error) error {
func (m *MockSQLProvider) Transaction(ctx context.Context, fn func(ksql.SQLProvider) error) error {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "Transaction", ctx, fn)
ret0, _ := ret[0].(error)

2
go.mod
View File

@ -1,4 +1,4 @@
module github.com/vingarcia/kisssql
module github.com/vingarcia/ksql
go 1.14

2
json.go
View File

@ -1,4 +1,4 @@
package kisssql
package ksql
import (
"database/sql/driver"

24
kisssql.go
View File

@ -1,4 +1,4 @@
package kisssql
package ksql
import (
"context"
@ -8,10 +8,10 @@ import (
"strings"
"github.com/pkg/errors"
"github.com/vingarcia/kisssql/structs"
"github.com/vingarcia/ksql/structs"
)
// DB represents the kisssql client responsible for
// DB represents the ksql client responsible for
// interfacing with the "database/sql" package implementing
// the KissSQL interface `SQLProvider`.
type DB struct {
@ -21,7 +21,7 @@ type DB struct {
db sqlProvider
// Most dbs have a single primary key,
// But in future kisssql should work with compound keys as well
// But in future ksql should work with compound keys as well
idCols []string
insertMethod insertMethod
@ -41,7 +41,7 @@ const (
)
// Config describes the optional arguments accepted
// by the kisssql.New() function.
// by the ksql.New() function.
type Config struct {
// MaxOpenCons defaults to 1 if not set
MaxOpenConns int
@ -124,7 +124,7 @@ func (c DB) Query(
slicePtr := reflect.ValueOf(records)
slicePtrType := slicePtr.Type()
if slicePtrType.Kind() != reflect.Ptr {
return fmt.Errorf("kisssql: expected to receive a pointer to slice of structs, but got: %T", records)
return fmt.Errorf("ksql: expected to receive a pointer to slice of structs, but got: %T", records)
}
sliceType := slicePtrType.Elem()
slice := slicePtr.Elem()
@ -198,11 +198,11 @@ func (c DB) QueryOne(
) error {
t := reflect.TypeOf(record)
if t.Kind() != reflect.Ptr {
return fmt.Errorf("kisssql: expected to receive a pointer to struct, but got: %T", record)
return fmt.Errorf("ksql: expected to receive a pointer to struct, but got: %T", record)
}
t = t.Elem()
if t.Kind() != reflect.Struct {
return fmt.Errorf("kisssql: expected to receive a pointer to struct, but got: %T", record)
return fmt.Errorf("ksql: expected to receive a pointer to struct, but got: %T", record)
}
rows, err := c.db.QueryContext(ctx, query, params...)
@ -509,7 +509,7 @@ func (c DB) Delete(
func normalizeIDsAsMaps(idNames []string, ids []interface{}) ([]map[string]interface{}, error) {
if len(idNames) == 0 {
return nil, fmt.Errorf("internal kisssql error: missing idNames")
return nil, fmt.Errorf("internal ksql error: missing idNames")
}
idMaps := []map[string]interface{}{}
@ -736,7 +736,7 @@ func (c DB) Transaction(ctx context.Context, fn func(SQLProvider) error) error {
return tx.Commit()
default:
return fmt.Errorf("unexpected error on kisssql: db attribute has an invalid type")
return fmt.Errorf("unexpected error on ksql: db attribute has an invalid type")
}
}
@ -789,14 +789,14 @@ func scanRows(rows *sql.Rows, record interface{}) error {
v := reflect.ValueOf(record)
t := v.Type()
if t.Kind() != reflect.Ptr {
return fmt.Errorf("kisssql: expected record to be a pointer to struct, but got: %T", record)
return fmt.Errorf("ksql: expected record to be a pointer to struct, but got: %T", record)
}
v = v.Elem()
t = t.Elem()
if t.Kind() != reflect.Struct {
return fmt.Errorf("kisssql: expected record to be a pointer to struct, but got: %T", record)
return fmt.Errorf("ksql: expected record to be a pointer to struct, but got: %T", record)
}
info := structs.GetTagInfo(t)

34
kisssql_test.go
View File

@ -1,4 +1,4 @@
package kisssql
package ksql
import (
"context"
@ -12,15 +12,15 @@ import (
"github.com/ditointernet/go-assert"
_ "github.com/lib/pq"
_ "github.com/mattn/go-sqlite3"
"github.com/vingarcia/kisssql/nullable"
"github.com/vingarcia/ksql/nullable"
)
type User struct {
ID uint `kisssql:"id"`
Name string `kisssql:"name"`
Age int `kisssql:"age"`
ID uint `ksql:"id"`
Name string `ksql:"name"`
Age int `ksql:"age"`
Address Address `kisssql:"address,json"`
Address Address `ksql:"address,json"`
}
type Address struct {
@ -702,9 +702,9 @@ func TestUpdate(t *testing.T) {
c := newTestDB(db, driver, "users")
type partialUser struct {
ID uint `kisssql:"id"`
Name string `kisssql:"name"`
Age *int `kisssql:"age"`
ID uint `ksql:"id"`
Name string `ksql:"name"`
Age *int `ksql:"age"`
}
u := partialUser{
Name: "Letícia",
@ -743,9 +743,9 @@ func TestUpdate(t *testing.T) {
c := newTestDB(db, driver, "users")
type partialUser struct {
ID uint `kisssql:"id"`
Name string `kisssql:"name"`
Age *int `kisssql:"age"`
ID uint `ksql:"id"`
Name string `ksql:"name"`
Age *int `ksql:"age"`
}
u := partialUser{
Name: "Letícia",
@ -1309,11 +1309,11 @@ func TestScanRows(t *testing.T) {
assert.Equal(t, true, rows.Next())
var user struct {
ID int `kisssql:"id"`
Age int `kisssql:"age"`
ID int `ksql:"id"`
Age int `ksql:"age"`
// Omitted for testing purposes:
// Name string `kisssql:"name"`
// Name string `ksql:"name"`
}
err = scanRows(rows, &user)
assert.Equal(t, nil, err)
@ -1379,8 +1379,8 @@ func TestScanRows(t *testing.T) {
}
var connectionString = map[string]string{
"postgres": "host=localhost port=5432 user=postgres password=postgres dbname=kisssql sslmode=disable",
"sqlite3": "/tmp/kisssql.db",
"postgres": "host=localhost port=5432 user=postgres password=postgres dbname=ksql sslmode=disable",
"sqlite3": "/tmp/ksql.db",
}
func createTable(driver string) error {

2
mocks.go
View File

@ -1,4 +1,4 @@
package kisssql
package ksql
import "context"

10
structs/structs.go
View File

@ -68,7 +68,7 @@ func getCachedTagInfo(tagInfoCache map[reflect.Type]structInfo, key reflect.Type
}
// StructToMap converts any struct type to a map based on
// the tag named `kisssql`, i.e. `kisssql:"map_key_name"`
// the tag named `ksql`, i.e. `ksql:"map_key_name"`
//
// Valid pointers are dereferenced and copied to the map,
// null pointers are ignored.
@ -111,7 +111,7 @@ func StructToMap(obj interface{}) (map[string]interface{}, error) {
// FillStructWith is meant to be used on unit tests to mock
// the response from the database.
//
// The first argument is any struct you are passing to a kisssql func,
// The first argument is any struct you are passing to a ksql func,
// and the second is a map representing a database row you want
// to use to update this struct.
func FillStructWith(record interface{}, dbRow map[string]interface{}) error {
@ -139,7 +139,7 @@ func FillStructWith(record interface{}, dbRow map[string]interface{}) error {
for colName, rawSrc := range dbRow {
fieldInfo := info.ByName(colName)
if !fieldInfo.Valid {
// Ignore columns not tagged with `kisssql:"..."`
// Ignore columns not tagged with `ksql:"..."`
continue
}
@ -242,7 +242,7 @@ func (p PtrConverter) Convert(destType reflect.Type) (reflect.Value, error) {
// FillSliceWith is meant to be used on unit tests to mock
// the response from the database.
//
// The first argument is any slice of structs you are passing to a kisssql func,
// The first argument is any slice of structs you are passing to a ksql func,
// and the second is a slice of maps representing the database rows you want
// to use to update this struct.
func FillSliceWith(entities interface{}, dbRows []map[string]interface{}) error {
@ -293,7 +293,7 @@ func getTagNames(t reflect.Type) structInfo {
byName: map[string]*fieldInfo{},
}
for i := 0; i < t.NumField(); i++ {
name := t.Field(i).Tag.Get("kisssql")
name := t.Field(i).Tag.Get("ksql")
if name == "" {
continue
}

44
structs/structs_test.go
View File

@ -4,13 +4,13 @@ import (
"testing"
"github.com/ditointernet/go-assert"
"github.com/vingarcia/kisssql/nullable"
"github.com/vingarcia/ksql/nullable"
)
func TestStructToMap(t *testing.T) {
type S1 struct {
Name string `kisssql:"name_attr"`
Age int `kisssql:"age_attr"`
Name string `ksql:"name_attr"`
Age int `ksql:"age_attr"`
}
t.Run("should convert plain structs to maps", func(t *testing.T) {
m, err := StructToMap(S1{
@ -39,8 +39,8 @@ func TestStructToMap(t *testing.T) {
})
type S2 struct {
Name *string `kisssql:"name"`
Age *int `kisssql:"age"`
Name *string `ksql:"name"`
Age *int `ksql:"age"`
}
t.Run("should not ignore not nil pointers", func(t *testing.T) {
@ -72,8 +72,8 @@ func TestStructToMap(t *testing.T) {
func TestFillStructWith(t *testing.T) {
t.Run("should fill a struct correctly", func(t *testing.T) {
var user struct {
Name string `kisssql:"name"`
Age int `kisssql:"age"`
Name string `ksql:"name"`
Age int `ksql:"age"`
}
err := FillStructWith(&user, map[string]interface{}{
"name": "Breno",
@ -87,8 +87,8 @@ func TestFillStructWith(t *testing.T) {
t.Run("should fill ptr fields with ptr values", func(t *testing.T) {
var user struct {
Name *string `kisssql:"name"`
Age *int `kisssql:"age"`
Name *string `ksql:"name"`
Age *int `ksql:"age"`
}
err := FillStructWith(&user, map[string]interface{}{
"name": nullable.String("Breno"),
@ -102,8 +102,8 @@ func TestFillStructWith(t *testing.T) {
t.Run("should fill ptr fields with non-ptr values", func(t *testing.T) {
var user struct {
Name *string `kisssql:"name"`
Age *int `kisssql:"age"`
Name *string `ksql:"name"`
Age *int `ksql:"age"`
}
err := FillStructWith(&user, map[string]interface{}{
"name": "Breno",
@ -117,8 +117,8 @@ func TestFillStructWith(t *testing.T) {
t.Run("should fill non ptr fields with ptr values", func(t *testing.T) {
var user struct {
Name string `kisssql:"name"`
Age int `kisssql:"age"`
Name string `ksql:"name"`
Age int `ksql:"age"`
}
err := FillStructWith(&user, map[string]interface{}{
"name": nullable.String("Breno"),
@ -132,8 +132,8 @@ func TestFillStructWith(t *testing.T) {
t.Run("should fill ptr fields with nil when necessary", func(t *testing.T) {
var user struct {
Name *string `kisssql:"name"`
Age *int `kisssql:"age"`
Name *string `ksql:"name"`
Age *int `ksql:"age"`
}
err := FillStructWith(&user, map[string]interface{}{
"name": nil,
@ -147,8 +147,8 @@ func TestFillStructWith(t *testing.T) {
t.Run("should interpret nil fields as zero values when necessary", func(t *testing.T) {
var user struct {
Name string `kisssql:"name"`
Age int `kisssql:"age"`
Name string `ksql:"name"`
Age int `ksql:"age"`
}
user.Name = "not empty"
user.Age = 42
@ -165,9 +165,9 @@ func TestFillStructWith(t *testing.T) {
t.Run("should ignore extra or missing fields", func(t *testing.T) {
var user struct {
Name string `kisssql:"name"`
Age int `kisssql:"age"`
Missing string `kisssql:"missing"`
Name string `ksql:"name"`
Age int `ksql:"age"`
Missing string `ksql:"missing"`
}
user.Missing = "should be untouched"
@ -187,8 +187,8 @@ func TestFillStructWith(t *testing.T) {
func TestFillSliceWith(t *testing.T) {
t.Run("should fill a list correctly", func(t *testing.T) {
var users []struct {
Name string `kisssql:"name"`
Age int `kisssql:"age"`
Name string `ksql:"name"`
Age int `ksql:"age"`
}
err := FillSliceWith(&users, []map[string]interface{}{
{