ceres, branch main

Add `-version` suffix to VERSION.txt

2024-11-03T16:45:07Z

This follows the process described in RELEASE.md to make sure the development versions are not mixed up with the released ones.

Set version to 0.5.0

2024-11-03T15:54:04Z

Update CHANGELOG.md for version 0.5.0

2024-11-03T15:54:04Z

Fix RELEASE.md

2024-11-03T15:54:04Z

The changelog should be changed before updating the version to make sure changing the version is the commit which is tagged. Furthermore there was a mistake that the suffix `-devel` should be removed after release. Instead it should be added.

Fix version string

2024-11-03T15:54:04Z

This contained an unwanted newline.

view: Implement favorite recipes

2024-11-03T15:06:58Z

This marks favorite recipes with a `⭐` emoticon. The favorite flag value can be set on the recipe edit page. Favorite recipes are listed first on the recipe list view. Furthermore as a second priority the created time stamp is used in the recipe list so that more recent recipes are listed first.

model: Implement favorite recipes

2024-11-03T15:05:55Z

This adds the ability to store a flag `is_favorite` inside the database. The corresponding SQL migration is part of this commit. Furthermore the Go code in the model package is adapted.

Add file extension to LICENSE

2024-11-03T14:45:46Z

This makes it easier for humans and software to detect that this is a plain text file.

view: Display URL content on recipe page

2024-10-24T18:24:46Z

This makes the recipe page less pretty. Nevertheless the URL is more visible to the user which makes it more likely that errors in the URL are detected. This change is based on user feedback. Invalid URLs were added which led effectively to data loss.

view: Order ingredient summary by ingredient name

2024-10-24T18:14:14Z

This makes it easier to write a shopping list for the required ingredients.

Rework error handling of model.DB.Transaction()

2024-10-24T15:01:24Z

The functions in the sub-packages model, view and controller should not log too much. Instead they should return errors which can be extended by fmt.Errorf(": %w", err).

Switch to http.Handler

2024-10-23T18:34:57Z

The used `func(http.ResponseWriter, *http.Request)` return values made the HTTP handler factory functions quite unreadable. Thus it is switched to the http.Handler type.

tools: Add unit tests to check.sh

2024-10-23T16:43:02Z

Fix unit tests

2024-10-23T16:42:20Z

API changes were not adopted in the unit tests.

Explain package structure in README.md

2024-10-23T16:17:44Z

Apply go fmt

2024-10-23T16:02:06Z

Remove Makefile and update README.md accordingly

2024-10-23T15:56:35Z

This drops the build dependency GNU Make. The resulting build steps are typical for Go repositories and thus more familiar for Go developers.

Inject version with embed instead of build flags

2024-10-23T14:04:22Z

The build flags made the basic build and debug calls quite complex and bound this strictly to Git repositories which is a problem if the source code is passed around as tar archive. Embedding this via Go's embed package and a VERSION.txt file makes this way easier. A simple `go build` command is sufficient to build ceres. To make sure the version string is extended by a `-devel` marker and that this marker is removed before a release a RELEASE.md file was added as a checklist for releases.

Remove github.com/gorilla/mux dependency

2024-10-22T19:53:30Z

The reason for the introduction of this dependency was that it was easy to setup routes with HTTP method restrictions. Since Go 1.22 this feature is part of the standard library. Method restrictions are part of the patterns used to register routes [1]. [1]: https://pkg.go.dev/net/http#hdr-Patterns-ServeMux

Use `-race` for debug runs

2024-10-22T18:26:04Z

This option for the go tool activates a race condition detector. It makes building the executable slower. Nevertheless it is worth it since it detects a lot of race conditions and race conditions should be avoided as much as possible.

Run go mod tidy

2024-10-21T19:43:11Z

model: Rename to db.go

2024-10-21T19:37:54Z

The old name database.go did not match the type name DB.

model: Refactor public API of DB

2024-10-21T19:34:31Z

This commit makes not externally needed methods private and adds error return values since something like log.Fatal() should be called outside this package since it is control-flow-related.

model: Save int-based schema version in DB

2024-10-21T19:34:26Z

Ceres v0.4.0 used the `git describe` output as database schema and enforced exactly matching versions between the database and the executable. This turned out to be not flexible enough. It is way easier to version the database separately with a simple integer and require the same database schema version integer between the application and the database. This commit implements this new approach.

model: Handle schema versions internally by integers

2024-10-15T18:25:38Z

This references the database schemas known from the past with integer values internally. 0 is used for an empty database and 1 for what was used in ceres version 0.4.0. The old approach to write the `git describe` output into the database worked well for released versions but was problematic during development. A numerical and separate database schema versioning is easier to handle.

model: Simplify DB method signatures

2024-10-13T18:21:00Z

Simplify Server type

2024-10-13T18:01:27Z

It is not required to create a struct definition with only one member. The new solution is more elegant.

model: Replace global db variable by custom type

2024-10-13T17:55:38Z

Reducing global variables makes it easier to understand functions independently of the rest of the code. Adding the new model.DB type as a custom variant of the sql.DB type makes it possible to write methods for the database which makes the code way more readable.

Introduce xengineering.eu/ceres/model/migrations

2024-10-13T16:54:18Z

This new package is only for database migrations. All data for Ceres should be stored inside the SQLite3 database. Thus migrations can always be executed with functions with the following signature. func(tx *sql.Tx) error Those migration functions should be stored inside the new package. Bigger SQL code can be stored in *.sql files for better syntax highlighting. This code is embedded into the final Go executable by using the embed package.

model: Fix direct access to database

2024-10-12T13:24:33Z

Instead a database transaction has to be used. Each database interaction should be wrapped into a transaction to make sure any possible change (even side-effects) can be rolled back in case of errors.