(feat #70) Navbar configuration: (#74)

- Removed fixed links in Urchin. - Added configurable `links` property in Urchin configuration. - Updated application settings to include new links property. - Updated `templ` to add additional parameter for links array. - Updated `app_settings_test`. (fix) Makefile: - Fixed version numbers in `install-tools`. --------- Co-authored-by: Sourab Paul <[email protected]> Co-authored-by: matheusgomes28 <[email protected]>
matheusgomes28 · Apr 11, 2024 · 31a1c6c · 31a1c6c
1 parent 86f0ef8
commit 31a1c6c
Show file tree

Hide file tree

Showing 18 changed files with 70 additions and 46 deletions.
diff --git a/Makefile b/Makefile
@@ -27,8 +27,8 @@ clean:
 	rm -rf $(BUILD_DIR)
 
 install-tools:
-	go install github.com/pressly/goose/v3/cmd/[email protected] 0.2.543
-	go install github.com/a-h/templ/cmd/[email protected] 0.2.543 
+	go install github.com/pressly/goose/v3/cmd/[email protected]
+	go install github.com/a-h/templ/cmd/[email protected] 
 	go install github.com/cosmtrek/[email protected] 
 
 .PHONY: all build test clean
diff --git a/app/app.go b/app/app.go
@@ -105,7 +105,7 @@ func homeHandler(c *gin.Context, settings common.AppSettings, db database.Databa
 	}
 
 	// if not cached, create the cache
-	index_view := views.MakeIndex(posts)
+	index_view := views.MakeIndex(posts, settings.AppNavbar.Links)
 	html_buffer := bytes.NewBuffer(nil)
 
 	err = index_view.Render(c, html_buffer)

diff --git a/app/contact.go b/app/contact.go
@@ -59,7 +59,7 @@ func makeContactFormHandler() func(*gin.Context) {
 
 // TODO : This is a duplicate of the index handler... abstract
 func contactHandler(c *gin.Context, app_settings common.AppSettings, db database.Database) ([]byte, error) {
-	index_view := views.MakeContactPage()
+	index_view := views.MakeContactPage(app_settings.AppNavbar.Links)
 	html_buffer := bytes.NewBuffer(nil)
 	if err := index_view.Render(c, html_buffer); err != nil {
 		log.Error().Msgf("could not render: %v", err)

diff --git a/app/image.go b/app/image.go
@@ -36,7 +36,7 @@ func imagesHandler(c *gin.Context, app_settings common.AppSettings, database dat
 	}
 
 	// if not cached, create the cache
-	index_view := views.MakeImagesPage(images)
+	index_view := views.MakeImagesPage(images, app_settings.AppNavbar.Links)
 	html_buffer := bytes.NewBuffer(nil)
 
 	err = index_view.Render(c, html_buffer)
@@ -60,7 +60,7 @@ func imageHandler(c *gin.Context, app_settings common.AppSettings, database data
 	}
 
 	// if not cached, create the cache
-	index_view := views.MakeImagePage(image)
+	index_view := views.MakeImagePage(image, app_settings.AppNavbar.Links)
 	html_buffer := bytes.NewBuffer(nil)
 
 	err = index_view.Render(c, html_buffer)

diff --git a/app/post.go b/app/post.go
@@ -50,7 +50,7 @@ func postHandler(c *gin.Context, app_settings common.AppSettings, database datab
 
 	// Generate HTML page
 	post.Content = string(mdToHTML([]byte(post.Content)))
-	post_view := views.MakePostPage(post.Title, post.Content)
+	post_view := views.MakePostPage(post.Title, post.Content, app_settings.AppNavbar.Links)
 	html_buffer := bytes.NewBuffer(nil)
 	if err = post_view.Render(c, html_buffer); err != nil {
 		log.Error().Msgf("could not render: %v", err)

diff --git a/cmd/urchin-admin/main.go b/cmd/urchin-admin/main.go
@@ -21,7 +21,7 @@ func main() {
 	flag.Parse()
 
 	var app_settings common.AppSettings
-	if *config_toml != "" {
+	if *config_toml == "" {
 		log.Error().Msgf("config not specified (--config)")
 		os.Exit(-1)
 	}

diff --git a/common/app_settings.go b/common/app_settings.go
@@ -4,6 +4,10 @@ import (
 	"github.com/BurntSushi/toml"
 )
 
+type Navbar struct {
+	Links []Link `toml:"links"`
+}
+
 type AppSettings struct {
 	DatabaseAddress  string `toml:"database_address"`
 	DatabasePort     int    `toml:"database_port"`
@@ -12,6 +16,7 @@ type AppSettings struct {
 	DatabaseName     string `toml:"database_name"`
 	WebserverPort    int    `toml:"webserver_port"`
 	ImageDirectory   string `toml:"image_dir"`
+	AppNavbar        Navbar `toml:"navbar"`
 }
 
 func ReadConfigToml(filepath string) (AppSettings, error) {

diff --git a/common/navigation.go b/common/navigation.go
@@ -1,6 +1,7 @@
 package common
 
 type Link struct {
-	Name string
-	Href string
+	Name  string
+	Href  string
+	Title string
 }
diff --git a/docker/urchin_config.toml b/docker/urchin_config.toml
@@ -19,3 +19,12 @@ webserver_port = 8080
 
 # Directory to use for storing uploaded images.
 image_dir = "./images"
+
+[navbar]
+links = [
+    { name = "Home", href = "/", title = "Homepage" },
+    { name = "About", href = "/about", title = "About page" },
+    { name = "Services", href = "/services", title = "Services page" },
+    { name = "Images", href = "/images", title = "Images page" },
+    { name = "Contact", href = "/contact", title = "Contacts page" },
+]
diff --git a/tests/app_tests/app_settings/app_settings_test.go b/tests/app_tests/app_settings/app_settings_test.go
@@ -36,6 +36,15 @@ func TestCorrectToml(t *testing.T) {
 		DatabaseName:     "test_database_name",
 		WebserverPort:    99999,
 		DatabasePort:     666,
+		AppNavbar: common.Navbar{
+			Links: []common.Link{
+				{Name: "Home", Href: "/", Title: "Homepage"},
+				{Name: "About", Href: "/about", Title: "About page"},
+				{Name: "Services", Href: "/services", Title: "Services page"},
+				{Name: "Images", Href: "/images", Title: "Images page"},
+				{Name: "Contact", Href: "/contact", Title: "Contacts page"},
+			},
+		},
 	}
 	bytes, err := toml.Marshal(expected)
 	assert.Nil(t, err)

diff --git a/urchin_config.toml b/urchin_config.toml
@@ -19,3 +19,12 @@ webserver_port = 8080
 
 # Directory to use for storing uploaded images.
 image_dir = "./images"
+
+[navbar]
+links = [
+    { name = "Home", href = "/", title = "Homepage" },
+    { name = "About", href = "/about", title = "About page" },
+    { name = "Services", href = "/services", title = "Services page" },
+    { name = "Images", href = "/images", title = "Images page" },
+    { name = "Contact", href = "/contact", title = "Contacts page" },
+]
diff --git a/views/contact.templ b/views/contact.templ
@@ -1,6 +1,8 @@
 package views
 
-templ MakeContactPage() {
+import "github.com/matheusgomes28/urchin/common"
+
+templ MakeContactPage(links []common.Link) {
     <!DOCTYPE html>
     <html lang="en">
 
@@ -14,7 +16,7 @@ templ MakeContactPage() {
     </head>
 
     <body>
-        @MakeNavBar()
+        @MakeNavBar(links)
         <main>
             <div id="contact-form">
                 <h2>Contact Us</h2>

diff --git a/views/header.templ b/views/header.templ
@@ -1,14 +1,16 @@
 package views
 
-templ MakeNavBar() {
-    <header>
-        <nav>
-            <ul>
-                for _, link := range GetUrchinLinks() {
-                    <li><a href={templ.URL(link.Href)}>{ link.Name }</a></li> // Pass the links in here
-                }
-            </ul>
-        </nav>
-    </header>
-    <br />
+import "github.com/matheusgomes28/urchin/common"
+
+templ MakeNavBar(links []common.Link) {
+	<header>
+		<nav>
+			<ul>
+				for _, link := range links {
+					<li><a href={ templ.URL(link.Href) }>{ link.Name }</a></li> // Pass the links in here
+				}
+			</ul>
+		</nav>
+	</header>
+	<br/>
 }
diff --git a/views/image.templ b/views/image.templ
@@ -5,7 +5,7 @@ import (
     . "github.com/matheusgomes28/urchin/common"
 )
 
-templ MakeImagePage(image Image) {
+templ MakeImagePage(image Image, links []Link) {
     <!DOCTYPE html>
     <html lang="en">
 
@@ -19,7 +19,7 @@ templ MakeImagePage(image Image) {
     </head>
 
     <body>
-        @MakeNavBar()
+        @MakeNavBar(links)
         <main>
             <article>
             <h3>{ image.Name }</h3>

diff --git a/views/images.templ b/views/images.templ
@@ -5,7 +5,7 @@ import (
     . "github.com/matheusgomes28/urchin/common"
 )
 
-templ MakeImagesPage(images []Image) {
+templ MakeImagesPage(images []Image, links []Link) {
     <!DOCTYPE html>
     <html lang="en">
 
@@ -39,7 +39,7 @@ templ MakeImagesPage(images []Image) {
     </head>
 
     <body>
-        @MakeNavBar()
+        @MakeNavBar(links)
         <main>
             <article>
                 if len(images) == 0 {

diff --git a/views/index.templ b/views/index.templ
@@ -5,7 +5,7 @@ import (
     . "github.com/matheusgomes28/urchin/common"
 )
 
-templ MakeIndex(posts []Post) {
+templ MakeIndex(posts []Post, links []Link) {
     <!DOCTYPE html>
     <html lang="en">
 
@@ -19,7 +19,7 @@ templ MakeIndex(posts []Post) {
     </head>
 
     <body>
-        @MakeNavBar()
+        @MakeNavBar(links)
         <main>
             for _, post := range posts {
                 <article>

diff --git a/views/links.go b/views/links.go
diff --git a/views/post.templ b/views/post.templ
@@ -1,7 +1,9 @@
 package views
 
+import "github.com/matheusgomes28/urchin/common"
 
-templ MakePostPage(title string, content string) {
+
+templ MakePostPage(title string, content string, links []common.Link) {
     <!DOCTYPE html>
     <html lang="en">
 
@@ -15,7 +17,7 @@ templ MakePostPage(title string, content string) {
     </head>
 
     <body>
-        @MakeNavBar()
+        @MakeNavBar(links)
         <main>
             <article>
                 <h2>{ title }</h2>