Merge branch 'master' into toml_config

README.md

@@ -18,7 +18,7 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
 - Minimal user login/registration + sessions
 - Config file handling
 - Scheduled tasks
-- Entire website compiles into a single binary (~10mb) (excluding env.json)
+- Entire website compiles into a single binary (~10mb) (excluding env.toml)
 - Minimal dependencies (just standard library, postgres driver, and experimental package for bcrypt)
 
 <hr>
@@ -41,7 +41,7 @@ fine with getting your hands dirty, but I plan on having it ready to go for more
 1. Clone
 2. Delete the git folder, so you can start tracking in your own repo
 3. Run `go get` to install dependencies
-4. Copy env_example.json to env.json and fill in the values
+4. Copy env_example.toml to env.toml and fill in the values
 5. Run `go run main.go` to start the server
 6. Rename the occurences of "GoWeb" to your app name
 7. Start building your app!

config/config.go

@@ -1,53 +1,44 @@
 package config
 
 import (
-	"encoding/json"
 	"flag"
-	"log/slog"
+	"github.com/BurntSushi/toml"
 	"os"
 )
 
 type Configuration struct {
 	Db struct {
-		Ip          string `json:"DbIp"`
-		Port        string `json:"DbPort"`
-		Name        string `json:"DbName"`
-		User        string `json:"DbUser"`
-		Password    string `json:"DbPassword"`
-		AutoMigrate bool   `json:"DbAutoMigrate"`
+		Ip          string `toml:"DbIp"`
+		Port        string `toml:"DbPort"`
+		Name        string `toml:"DbName"`
+		User        string `toml:"DbUser"`
+		Password    string `toml:"DbPassword"`
+		AutoMigrate bool   `toml:"DbAutoMigrate"`
 	}
 
 	Listen struct {
-		Ip   string `json:"HttpIp"`
-		Port string `json:"HttpPort"`
+		Ip   string `toml:"HttpIp"`
+		Port string `toml:"HttpPort"`
 	}
 
 	Template struct {
-		BaseName string `json:"BaseTemplateName"`
+		BaseName string `toml:"BaseTemplateName"`
 	}
 }
 
 // LoadConfig loads and returns a configuration struct
 func LoadConfig() Configuration {
-	c := flag.String("c", "env.json", "Path to the json configuration file")
+	c := flag.String("c", "env.toml", "Path to the toml configuration file")
 	flag.Parse()
-	file, err := os.Open(*c)
+	file, err := os.ReadFile(*c)
 	if err != nil {
-		panic("unable to open JSON config file: " + err.Error())
+		panic("Unable to read TOML config file: " + err.Error())
 	}
 
-	defer func(file *os.File) {
-		err := file.Close()
-		if err != nil {
-			slog.Error("unable to close JSON config file: ", err)
-		}
-	}(file)
-
-	decoder := json.NewDecoder(file)
-	Config := Configuration{}
-	err = decoder.Decode(&Config)
+	var Config Configuration
+	_, err = toml.Decode(string(file), &Config)
 	if err != nil {
-		panic("unable to decode JSON config file: " + err.Error())
+		panic("Unable to decode TOML config file: " + err.Error())
 	}
 
 	return Config

env_example.json

@@ -1,17 +0,0 @@
-{
-  "Db": {
-    "DbIp": "127.0.0.1",
-    "DbPort": "5432",
-    "DbName": "database",
-    "DbUser": "user",
-    "DbPassword": "password",
-    "DbAutoMigrate": true
-  },
-  "Listen": {
-    "HttpIp": "127.0.0.1",
-    "HttpPort": "8090"
-  },
-  "Template": {
-    "BaseTemplateName": "templates/base.html"
-  }
-}

env_example.toml

@@ -0,0 +1,14 @@
+[Db]
+DbIp = "127.0.0.1"
+DbPort = "5432"
+DbName = "test"
+DbUser = "postgres"
+DbPassword = "postgres"
+DbAutoMigrate = true
+
+[Listen]
+HttpIp = "127.0.0.1"
+HttpPort = "8090"
+
+[Template]
+BaseTemplateName = "templates/base.html"

go.mod

@@ -4,5 +4,7 @@ go 1.21
 
 require (
 	github.com/lib/pq v1.10.9
-	golang.org/x/crypto v0.17.0
+	golang.org/x/crypto v0.13.0
 )
+
+require github.com/BurntSushi/toml v1.3.2

go.sum

@@ -1,4 +1,6 @@
+github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
+github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
 github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
-golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
-golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
+golang.org/x/crypto v0.13.0 h1:mvySKfSWJ+UKUii46M40LOvyWfN0s2U+46/jDd0e6Ck=
+golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=

models/session.go

@@ -62,7 +62,7 @@ func CreateSession(app *app.App, w http.ResponseWriter, userId int64, remember b
 	return session, nil
 }
 
-func SessionByAuthToken(app *app.App, authToken string) (Session, error) {
+func GetSessionByAuthToken(app *app.App, authToken string) (Session, error) {
 	session := Session{}
 
 	err := app.Db.QueryRow(selectSessionByAuthToken, authToken).Scan(&session.Id, &session.UserId, &session.AuthToken, &session.RememberMe, &session.CreatedAt)

models/user.go

@@ -27,23 +27,23 @@ const (
 	insertUser           = "INSERT INTO " + userTable + " (" + userColumnsNoId + ") VALUES ($1, $2, $3, $4) RETURNING \"Id\""
 )
 
-// CurrentUser finds the currently logged-in user by session cookie
-func CurrentUser(app *app.App, r *http.Request) (User, error) {
+// GetCurrentUser finds the currently logged-in user by session cookie
+func GetCurrentUser(app *app.App, r *http.Request) (User, error) {
 	cookie, err := r.Cookie("session")
 	if err != nil {
 		return User{}, err
 	}
 
-	session, err := SessionByAuthToken(app, cookie.Value)
+	session, err := GetSessionByAuthToken(app, cookie.Value)
 	if err != nil {
 		return User{}, err
 	}
 
-	return UserById(app, session.UserId)
+	return GetUserById(app, session.UserId)
 }
 
-// UserById finds a User table row in the database by id and returns a struct representing this row
-func UserById(app *app.App, id int64) (User, error) {
+// GetUserById finds a User table row in the database by id and returns a struct representing this row
+func GetUserById(app *app.App, id int64) (User, error) {
 	user := User{}
 
 	err := app.Db.QueryRow(selectUserById, id).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
@@ -54,8 +54,8 @@ func UserById(app *app.App, id int64) (User, error) {
 	return user, nil
 }
 
-// UserByUsername finds a User table row in the database by username and returns a struct representing this row
-func UserByUsername(app *app.App, username string) (User, error) {
+// GetUserByUsername finds a User table row in the database by username and returns a struct representing this row
+func GetUserByUsername(app *app.App, username string) (User, error) {
 	user := User{}
 
 	err := app.Db.QueryRow(selectUserByUsername, username).Scan(&user.Id, &user.Username, &user.Password, &user.CreatedAt, &user.UpdatedAt)
@@ -82,7 +82,7 @@ func CreateUser(app *app.App, username string, password string, createdAt time.T
 		return User{}, err
 	}
 
-	return UserById(app, lastInsertId)
+	return GetUserById(app, lastInsertId)
 }
 
 // AuthenticateUser validates the password for the specified user