ceres/view, branch v0.5.0Recipe server for your favorite disheshttps://cgit.xengineering.eu/ceres/atom?h=v0.5.02024-11-03T15:06:58Zview: Implement favorite recipes2024-11-03T15:06:58Zxengineeringme@xengineering.eu2024-11-03T14:50:08Zurn:sha1:c1b976edd0c27fdc488da7ff4c1b7551df0323cd
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.
view: Display URL content on recipe page2024-10-24T18:24:46Zxengineeringme@xengineering.eu2024-10-24T18:24:46Zurn:sha1:43ed47bf3d51e25d3195870241bbe6619c43e459
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 name2024-10-24T18:14:14Zxengineeringme@xengineering.eu2024-10-24T15:24:00Zurn:sha1:9422e8194245c9cdbfa09b38c20173964349e2a2
This makes it easier to write a shopping list for the required
ingredients.
Switch to http.Handler2024-10-23T18:34:57Zxengineeringme@xengineering.eu2024-10-23T18:34:57Zurn:sha1:e66691083a2455c29b50a2970c0aba1d6afca753
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.
Remove github.com/gorilla/mux dependency2024-10-22T19:53:30Zxengineeringme@xengineering.eu2024-10-22T19:17:47Zurn:sha1:dbc874e2b9f300bea7a18deda32e784afb0ab89a
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
model: Replace global db variable by custom type2024-10-13T17:55:38Zxengineeringme@xengineering.eu2024-10-13T17:52:28Zurn:sha1:473052ed8f2c83052ed5b47a7f4cec68ac2621a6
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.
model: Fix direct access to database2024-10-12T13:24:33Zxengineeringme@xengineering.eu2024-05-17T20:49:15Zurn:sha1:9d3a5fb85dc02e87fab879855c4c3bace5f753f2
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.
Apply go fmt to all source files2024-09-11T18:25:54Zxengineeringme@xengineering.eu2024-09-11T18:25:31Zurn:sha1:54029aac92f17ec87d3ef0bb73fcdac271b209c9
This applies default Go code style recommendations.
view: Fix time stamp bug2024-05-17T15:14:35Zxengineeringme@xengineering.eu2024-05-17T15:06:55Zurn:sha1:0416f520cff9716792ac0f3ade5f71187d07ac2e
The recipe edit page HTML template did not contain the two time stamps
"Created" and "LastChanged" as hidden form values.
Thus the information was not passed from the backend to the frontend. On
a save the recipe without time stamp information was injected into the
backend.
This effectively deleted any time stamp information. This commit fixes
that bug by including all fields of the model.Recipe struct inside the
form of the recipe-edit.html template.
view: Use number input for ingredient amount2024-05-17T15:14:29Zxengineeringme@xengineering.eu2024-05-17T13:51:45Zurn:sha1:c61e45a5a260d9804ebc4f54814edf1e1b471ac3
This accepts only real numbers with a minimum step of 0.001 as input for
the amount field of a recipe ingredient.
The browser has the chance to give the user direct feedback that a
non-numeric string will not work.
view: Remove empty ingredient summaries2024-05-15T18:42:09Zxengineeringme@xengineering.eu2024-05-15T18:42:09Zurn:sha1:d14aece3295405b4377ea20aabd9c621aace4922
If the recipe has no ingredients at all the "Ingredient summary:" text
used to be displayed. This is not useful and confusing. It is removed
with this commit.
view: Require text for steps2024-05-15T17:39:17Zxengineeringme@xengineering.eu2024-05-15T17:39:17Zurn:sha1:34880a0194f66e2b1808b45abfb01497d4816aaf
It does not make sense to add empty steps.
view: Require ingredient type2024-05-15T17:37:05Zxengineeringme@xengineering.eu2024-05-15T17:37:05Zurn:sha1:29c8c305c52b97248e505cdfc6b86e96f57d0a53
It does make sense to add an ingredient only with a type and no amount
or unit like 'salt'. But it does not make sense to add an ingredient
without a type like '5' or '2 l'.
view: Update to simple.css v2.3.02024-05-15T17:33:11Zxengineeringme@xengineering.eu2024-05-15T17:33:11Zurn:sha1:45a0a10c070e3dba33be01d4de4d094fd7f7394a
This is the latest available release. Updated to keep up to date and
adopt fixes.
view: Rename to 'Ingredient summary:'2024-05-15T17:27:05Zxengineeringme@xengineering.eu2024-05-15T17:27:05Zurn:sha1:b48f4514a44450da1ad5da68ce434c2b87e721d0
This used to be named 'Ingredients: which might be confusing since
ingredients are defined per step and the list at the top of the recipe
is just a summary.
When adding a recipe step or an ingredient the browser should focus on2024-05-15T17:20:01Zxengineeringme@xengineering.eu2024-05-15T17:20:01Zurn:sha1:d8b40f0a0a2ac2bcb8b9b690166ae7594c067298
the first text input of that new element.
This supports using Ceres without a mouse and only with tab-based
navigation with a keyboard.
view: Complete ingredient editing2024-05-14T18:43:41Zxengineeringme@xengineering.eu2024-05-14T18:14:42Zurn:sha1:a87128138bdb301ede64049ec5068e47abb5c839view: Add HTML for editing recipe ingredients2024-05-13T19:52:48Zxengineeringme@xengineering.eu2024-05-13T19:51:43Zurn:sha1:b5b72880a0b6e9f188b532c9b2ad360ff1dab2eaview: Add ingredient overview to recipe read page2024-05-12T18:52:25Zxengineeringme@xengineering.eu2024-04-07T10:04:11Zurn:sha1:bf328dd38a28cf44cfa81c7f1dcd95936d2d0301view: Show ingredients on read page2024-05-12T18:52:25Zxengineeringme@xengineering.eu2024-04-07T09:56:20Zurn:sha1:01d97189d245300d65ca31d650dd868d1d1fc0d8view: Use HTML template to add recipe steps2024-05-12T18:38:24Zxengineeringme@xengineering.eu2024-05-12T18:38:24Zurn:sha1:fec2fea87615e6ee3a6e73f7f98e021eee1b7098
This makes the JS function way simpler and removes a duplication of the
step HTML code.
view: Create new html/recipe-step.html2024-05-12T18:20:14Zxengineeringme@xengineering.eu2024-05-12T18:20:14Zurn:sha1:64ece1c4455ed6f8e8be5cb8f060f14b6131823f
This allows to use it in two places:
- template for loop for backend-generated steps
- a HTML template tag for frontend- / JS-generated steps
view: Move all JS code to static/ceres.js2024-05-12T18:06:17Zxengineeringme@xengineering.eu2024-05-12T18:06:17Zurn:sha1:f2800e8289e9637bb3227a5f9622edabf6529b0fview: Remove global JS code in recipe-edit.html2024-05-12T18:01:02Zxengineeringme@xengineering.eu2024-05-12T18:01:02Zurn:sha1:cfeff398f0ad7e4205dc26b66ca2b46ebca24606
This makes it impossible to move the whole JS functionality into the
central ceres.js script. Moving that JS code there makes caching
possible and bundles all JS-related code in one file.
The overall goal is to get rid of as many JS code as possible.
view: Add unit test for index handler2024-05-11T21:08:42Zxengineeringme@xengineering.eu2024-05-11T21:08:42Zurn:sha1:907bd7e63f4cf3cb01bc678e09fc5b8962afe750view: Fix cancel button on recipe create2024-05-09T10:19:35Zxengineeringme@xengineering.eu2024-04-23T16:47:30Zurn:sha1:a2aa866e630c45e1db4fadbb20cb1a9d24384a79view: Replace HTML form labels by placeholders2024-05-09T10:19:35Zxengineeringme@xengineering.eu2024-04-23T15:42:58Zurn:sha1:eb000e0cc514ebca753970ddb9135e09cb885d7a
This takes up way less space in the code and the actual user view.
Remove default recipe name2024-05-09T10:19:30Zxengineeringme@xengineering.eu2024-04-23T15:42:57Zurn:sha1:2704cb76554b02f546bf3f9d2d11be98f2854b7b
To avoid not clickable recipes on the /recipes page a default name used
to be inserted on recipe creation.
This was not a proper fix for the problem and also was annoying that the
user first had to remove the default recipe name.
This commit removes this default name.
view: Enforce recipe titles2024-05-09T10:07:48Zxengineeringme@xengineering.eu2024-04-22T19:51:21Zurn:sha1:c5e7551dc2da9798ff51d91aa238098f5ac4605f
In addition to the enforcement of titles in the model package the HTML
form field for the title is set to 'required' to give the user feedback
via the browser that a title is required.
Introduce model.Transaction()2024-05-08T20:26:00Zxengineeringme@xengineering.eu2024-05-08T19:53:13Zurn:sha1:0ba1a7661a81200db98e40149eef1e39fd22f407
It is a very common pattern that some function needs to access the
database and wants to wrap all the actions into one transaction.
The advantage of a transaction is that it is ACID:
- atomic
- consistent
- isolated
- durable
In Go it is required to request a new transaction, execute functionality
on it and handle rollback or commit of this transaction based on the
success of the operation.
All this and the error handling can be written down in the
model.Transaction() function exactly once. The full signature of it is:
func Transaction(f func(*sql.Tx) error) error
It requires a function or closure passed as argument which takes the
transaction (*sql.Tx) and returns an error which might be nil.
This is very generic. It is applied to:
- injecting test data
- database migrations
- data read requests
- data write requests