v0.2: Discontinue core/core116 seperation. Upgrade to Go 1.21+ for log/slog support in favor of harwoeck/liblog

Author: harwoeck

README.md

@@ -19,33 +19,33 @@
     - **Embed migration folders** containing your SQL scripts
     - Hardcoded SQL statements
 - 🟢 **Branching and merging compatible:** _adapt_ automatically catches up with missing migrations ("holes")
-- 🟢 **Zero** external dependencies*
-
-<sub>* <i>adapt</i> includes <a href="https://pkg.go.dev/github.com/harwoeck/liblog/contract">liblog/contract</a> (a public contract - Go <code>interface</code> - for logging backends, so you can provide your own structured, leveled logging)
+- 🟢 **Zero** external dependencies
+- 🟢 **Customizable Logging:** _adapt_ uses [`slog`](https://pkg.go.dev/log/slog) [included with Go 1.21+](https://go.dev/blog/slog) so that you can provide your own logging backend.
 
 #### Supported Storage `Driver`
 
-- [File](https://pkg.go.dev/github.com/harwoeck/adapt/core#NewFileDriver) - Basic driver that stores migration meta-data in a local JSON file (demonstrates how a `Driver` without any reliance or dependency on `database/sql` can be written.)
-- [MySQL / MariaDB](https://pkg.go.dev/github.com/harwoeck/adapt/core#NewMySQLDriver)
-- [SQLite](https://pkg.go.dev/github.com/harwoeck/adapt/core#NewSQLiteDriver)
-- [PostgreSQL](https://pkg.go.dev/github.com/harwoeck/adapt/core#NewPostgresDriver)
+- [File](https://pkg.go.dev/github.com/harwoeck/adapt#NewFileDriver) - Basic driver that stores migration meta-data in a local JSON file (demonstrates how a `Driver` without any reliance or dependency on `database/sql` can be written.)
+- [MySQL / MariaDB](https://pkg.go.dev/github.com/harwoeck/adapt#NewMySQLDriver)
+- [SQLite](https://pkg.go.dev/github.com/harwoeck/adapt#NewSQLiteDriver)
+- [PostgreSQL](https://pkg.go.dev/github.com/harwoeck/adapt#NewPostgresDriver)
 - [Add driver ?](https://github.com/harwoeck/adapt/issues/new)
 
-**Any other storage backend** by providing your own [`Driver`](https://pkg.go.dev/github.com/harwoeck/adapt/core#Driver), [`DatabaseDriver`](https://pkg.go.dev/github.com/harwoeck/adapt/core#DatabaseDriver) or [`SqlStatementsDriver`](https://pkg.go.dev/github.com/harwoeck/adapt/core#SqlStatementsDriver). Unlike most other migration tools, with _adapt_ there is no reliance on `database/sql` (such a case can be seen with the included `FileDriver`)
+**Any other storage backend** by providing your own [`Driver`](https://pkg.go.dev/github.com/harwoeck/adapt#Driver), [`DatabaseDriver`](https://pkg.go.dev/github.com/harwoeck/adapt#DatabaseDriver) or [`SqlStatementsDriver`](https://pkg.go.dev/github.com/harwoeck/adapt#SqlStatementsDriver). Unlike most other migration tools, with _adapt_ there is no reliance on `database/sql` (such a case can be seen with the included `FileDriver`)
 
 #### Supported Migrations
 
-- [Go Code](https://pkg.go.dev/github.com/harwoeck/adapt/core#NewCodePackageSource)
-- [Filesystem](https://pkg.go.dev/github.com/harwoeck/adapt/core#NewFilesystemSource)
-- [In-memory](https://pkg.go.dev/github.com/harwoeck/adapt/core#NewMemoryFSSource)
-- [Embedded Filesystem](https://pkg.go.dev/github.com/harwoeck/adapt/core116#NewEmbedFSSource) - Using Go 1.16+ [go:embed](https://pkg.go.dev/embed)
+- [Go Code](https://pkg.go.dev/github.com/harwoeck/adapt#NewCodePackageSource)
+- [Filesystem](https://pkg.go.dev/github.com/harwoeck/adapt#NewFilesystemSource)
+- [In-memory](https://pkg.go.dev/github.com/harwoeck/adapt#NewMemoryFSSource)
+- [Embedded Filesystem](https://pkg.go.dev/github.com/harwoeck/adapt#NewEmbedFSSource) - Using Go 1.16+ [go:embed](https://pkg.go.dev/embed)
 
+> [!NOTE]
 > Please support this project and provide additional sources that could be useful for other people
 
 ### Install
 
 ```bash
-$ go get github.com/harwoeck/adapt/core
+$ go get github.com/harwoeck/adapt
 ```
 
 ## Usage
@@ -61,13 +61,14 @@ err := adapt.Migrate(
     })
 ```
 
-**Next example:** Due to compliance rules you decide encrypt the email address of your users inside your database. Using _adapt_ you simply provide one of [`adapt.Hook`](https://pkg.go.dev/github.com/harwoeck/adapt/core#Hook)'s callback functions and during your next deployment _adapt_ will notice that this migration hasn't been applied and therefore call your migration hook. When no error is returned _adapt_ will commit the transaction and update the schema table with the relevant meta information.
+> [!NOTE]
+> **Next example:** Due to compliance rules you decide to encrypt your users email addresses inside your database. Since this requires actual Go code (and not just SQL statements), you could implement one of the [`adapt.Hook`](https://pkg.go.dev/github.com/harwoeck/adapt#Hook) functions and during your next deployment _adapt_ will notice this new unapplied migration and execute your hook. When no error is returned _adapt_ will commit the transaction and update the schema table with the relevant meta information.
 
 ```go
 err := adapt.Migrate(
     "[email protected]",                      // <name> of executor
     adapt.NewMySQLDriver(db),               // Database driver
-    adapt.SourceCollection{
+    adapt.SourceCollection{                 // adapt will automatically merge and sort all provided sources for you
         adapt.NewFilesystemSource("./sql"), // SQL-Migration-Scripts from filesystem
         adapt.NewCodeSource("2020-04-17_1104_encrypt-user-email", adapt.Hook{
             MigrateUpTx: func(tx *sql.Tx) error {

core/adapt.go renamed to adapt.go

@@ -1,15 +1,16 @@
-package core
+package adapt
 
 const (
 	// Version is the package's version string used to store in meta tables
-	Version = "adapt@v0.1.0"
+	Version = "adapt@v0.2.0"
 )
 
 /*
 Migrate migrates all available migrations in your SourceCollection against the
-Driver, when they weren't already run before.
+Driver, when they weren't already applied before.
 
 Example:
+
 	var db *sql.DB = getDB()
 
 	err := adapt.Migrate(
@@ -19,7 +20,7 @@ Example:
 			adapt.MySQLDriverOptionDisableTx,
 		),
 		adapt.SourceCollection{
-			adapt116.NewEmbedFSSource(nil, ""),
+			adapt.NewEmbedFSSource(embedFS, "foo/bar/directory"),
 			adapt.NewMemoryFSSource(map[string]string{}),
 			adapt.NewCodeSource("x", adapt.Hook{
 				MigrateUpTx: func(tx *sql.Tx) error {

core/adapt_test.go renamed to adapt_test.go

@@ -1,4 +1,4 @@
-package core
+package adapt
 
 import (
 	"os"

core/exec_init.go

@@ -1,13 +1,12 @@
-package core
+package adapt
 
 import (
 	"context"
 	"database/sql"
 	"fmt"
+	"log/slog"
 	"strings"
 	"time"
-
-	logger "github.com/harwoeck/liblog/contract"
 )
 
 // MySQLOption provides configuration values for a DatabaseDriver implementing the
@@ -22,7 +21,7 @@ func MySQLDBName(dbName string) MySQLOption {
 	return func(driver *mysqlDriver) error {
 		dbName = strings.TrimSpace(dbName)
 		if len(dbName) == 0 {
-			return fmt.Errorf("adapt/core.mysqlDriver: dbName cannot be empty")
+			return fmt.Errorf("adapt.mysqlDriver: dbName cannot be empty")
 		}
 
 		driver.dbName = dbName
@@ -36,12 +35,13 @@ func MySQLDBName(dbName string) MySQLOption {
 // by default.
 //
 // The default script used is:
-//     CREATE DATABASE IF NOT EXISTS %s CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci
+//
+//	CREATE DATABASE IF NOT EXISTS %s CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci
 func MySQLDBCreateStatement(stmt string) MySQLOption {
 	return func(driver *mysqlDriver) error {
 		stmt = strings.TrimSpace(stmt)
 		if len(stmt) == 0 {
-			return fmt.Errorf("adapt/core.mysqlDriver: stmt cannot be empty")
+			return fmt.Errorf("adapt.mysqlDriver: stmt cannot be empty")
 		}
 
 		driver.dbCreateStmt = stmt
@@ -55,7 +55,7 @@ func MySQLTableName(tableName string) MySQLOption {
 	return func(driver *mysqlDriver) error {
 		tn := strings.TrimSpace(tableName)
 		if len(tn) == 0 {
-			return fmt.Errorf("adapt/core.mysqlDriver: tableName cannot be empty")
+			return fmt.Errorf("adapt.mysqlDriver: tableName cannot be empty")
 		}
 
 		driver.tableName = tn
@@ -109,12 +109,12 @@ func NewMySQLDriver(db *sql.DB, opts ...MySQLOption) DatabaseDriver {
 }
 
 type mysqlDriver struct {
+	log                *slog.Logger
 	db                 *sql.DB
 	opts               []MySQLOption
 	dbName             string
 	dbCreateStmt       string
 	tableName          string
-	log                logger.Logger
 	txBeginOptsFactory func() (context.Context, *sql.TxOptions)
 	txDisabled         bool
 	optDisableDBClose  bool
@@ -124,13 +124,14 @@ func (d *mysqlDriver) Name() string {
 	return "driver_mysql"
 }
 
-func (d *mysqlDriver) Init(log logger.Logger) error {
-	d.log = log.Named(d.Name())
+func (d *mysqlDriver) Init(log *slog.Logger) error {
+	d.log = log
 
 	for _, opt := range d.opts {
 		err := opt(d)
 		if err != nil {
-			return d.log.ErrorReturn("init failed due to option error", field("error", err))
+			d.log.Error("init failed due to option error", "error", err)
+			return err
 		}
 	}
 
@@ -141,17 +142,18 @@ func (d *mysqlDriver) Init(log logger.Logger) error {
 
 func (d *mysqlDriver) Healthy() error {
 	if d.db == nil {
-		return d.log.ErrorReturn("not healthy: provided db is nil")
+		return fmt.Errorf("adapt.mysqlDriver: not healthy: provided db is nil")
 	}
 	if err := d.db.Ping(); err != nil {
-		return d.log.ErrorReturn("not healthy: pinging db errors", field("error", err))
+		d.log.Error("not healthy: pinging db errors", "error", err)
+		return err
 	}
 
 	createDB := fmt.Sprintf(d.dbCreateStmt, d.dbName)
 	_, err := d.DB().Exec(createDB)
 	if err != nil {
-		return d.log.ErrorReturn("failed to create or check if database exists",
-			field("error", err))
+		d.log.Error("failed to create or check if database exists", "error", err)
+		return err
 	}
 
 	createTable := fmt.Sprintf(`CREATE TABLE IF NOT EXISTS %s
@@ -170,8 +172,8 @@ func (d *mysqlDriver) Healthy() error {
 );`, d.tableName)
 	_, err = d.DB().Exec(createTable)
 	if err != nil {
-		return d.log.ErrorReturn("failed to create or check if table exists",
-			field("error", err))
+		d.log.Error("failed to create or check if table exists", "error", err)
+		return err
 	}
 
 	return nil
@@ -182,13 +184,13 @@ func (d *mysqlDriver) SupportsLocks() bool {
 }
 
 func (d *mysqlDriver) AcquireLock() (query string) {
-	d.log.DPanic("not supported")
-	return ""
+	d.log.Error("not supported")
+	panic("not supported")
 }
 
 func (d *mysqlDriver) ReleaseLock() (query string) {
-	d.log.DPanic("not supported")
-	return ""
+	d.log.Error("not supported")
+	panic("not supported")
 }
 
 func (d *mysqlDriver) ListMigrations() (query string) {