fix: golangci-lint linter error

Signed-off-by: Saket Maurya <[email protected]>

book-store-inventory/main.go

@@ -1,3 +1,4 @@
+// Package main is the entry point of the application
 package main
 
 import (

book-store-inventory/migrations/migration.go

@@ -1,5 +1,9 @@
+// Package main contains function for database migration
+// It initialise the db with some default value
 package main
 
+// for database migration
+
 import (
 	"database/sql"
 	"fmt"
@@ -21,7 +25,17 @@ func main() {
 	if err != nil {
 		log.Fatalf("Failed to open database: %v", err)
 	}
-	defer db.Close()
+
+	// defer db.Close()
+	// fixing linter issue for defer
+
+	// This is anonymous function :)
+	defer func() {
+		err := db.Close()
+		if err != nil {
+			log.Fatalf("Failed to close database: %v", err)
+		}
+	}()
 
 	// Here Goose is being initialized and setting up the db type to sqlite
 	err = goose.SetDialect("sqlite3")

book-store-inventory/pkg/database/db_sqlite.go

@@ -1,3 +1,4 @@
+// Package database contains helper functions for initializing and managing database connections.
 package database
 
 import (

book-store-inventory/pkg/handlers/book_handler.go

@@ -1,3 +1,4 @@
+// Package handlers contains the main bussiness logic of the application
 package handlers
 
 import (
@@ -24,11 +25,11 @@ func (bookHandler *BookHandler) GetBooksHandler(ctx *gin.Context) {
 	ctx.JSON(http.StatusOK, books)
 }
 
-func (bookHandler *BookHandler) GetBookByIdHandler(ctx *gin.Context) {
+func (bookHandler *BookHandler) GetBookByIDHandler(ctx *gin.Context) {
 	// getting param from the URL
 	/* http://localhost:9090/api/v1/book/id/3 --> 3 is param here */
-	book_id_param := ctx.Param("book_id")
-	book, err := bookHandler.BookModel.GetBookByID(book_id_param)
+	bookIDParam := ctx.Param("book_id")
+	book, err := bookHandler.BookModel.GetBookByID(bookIDParam)
 	if err != nil {
 		ctx.JSON(http.StatusInternalServerError, gin.H{
 			"error":   "Failed to get book by ID",

book-store-inventory/pkg/handlers/test_handler.go

@@ -6,7 +6,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-func TestApi(ctx *gin.Context) {
+func TestAPI(ctx *gin.Context) {
 	ctx.JSON(http.StatusOK, gin.H{
 		"message": "API Working 💞 [Private route]",
 	})

book-store-inventory/pkg/middleware/basic_auth.go

@@ -1,3 +1,4 @@
+// Package middleware contains basic user and pass middleware for testing private routes
 package middleware
 
 import "github.com/gin-gonic/gin"

book-store-inventory/pkg/models/book_model.go

@@ -1,3 +1,4 @@
+// Package models contains struct for Data
 package models
 
 import "time"

book-store-inventory/pkg/repositories/book_repository.go

@@ -1,3 +1,4 @@
+// Package repositories contains logic to interact with database uisng raw SQL queries
 package repositories
 
 import (
@@ -48,12 +49,12 @@ func (bookModel *BookModel) GetBooks() ([]models.Book, error) {
 	return books, nil
 }
 
-func (bookModel *BookModel) GetBookByID(book_id string) (models.Book, error) {
+func (bookModel *BookModel) GetBookByID(bookID string) (models.Book, error) {
 	statement := `SELECT book_id, title, author, price, published_date, stock_quantity FROM books WHERE book_id = ? ;`
 	// empty book model
 	book := models.Book{}
 
-	err := bookModel.DB.QueryRow(statement, book_id).Scan(
+	err := bookModel.DB.QueryRow(statement, bookID).Scan(
 		&book.BookID,
 		&book.Title,
 		&book.Author,
@@ -76,14 +77,14 @@ func (bookModel *BookModel) AddBook(book models.Book) (models.Book, error) {
 		return models.Book{}, err
 	}
 
-	lastInsertedId, err := result.LastInsertId()
+	lastInsertedID, err := result.LastInsertId()
 	if err != nil {
 		return models.Book{}, err
 	}
 
 	// adding Id to book model inserted autmatically by sqlite before returning to end user
 	// removing int gives int64 cannot covert to int :)
-	book.BookID = int(lastInsertedId)
+	book.BookID = int(lastInsertedID)
 
 	return book, nil
 }

book-store-inventory/pkg/router/private_router.go

@@ -1,10 +1,12 @@
+// Package router have routes defined in it for REST API
+package router
+
 // https://stackoverflow.com/a/62608670
 // https://stackoverflow.com/questions/62608429/how-to-combine-group-of-routes-in-gin
 
-package router
-
 import (
 	"github.com/gin-gonic/gin"
+	"github.com/saketV8/book-store-inventory/pkg/handlers"
 	"github.com/saketV8/book-store-inventory/pkg/middleware"
 	"github.com/saketV8/book-store-inventory/pkg/utils"
 )
@@ -14,12 +16,17 @@ func SetupPrivateRouter(app *App, superRouterGroup *gin.Engine) {
 	// <ROUTER_PREFIX> = /api
 	// <ROUTER_PREFIX_VERSION> = /v1
 
+	// fixing linter issue
+	// app will be used when we pass data from app to handler :)
+	// see example in <public_router.go> SetupPublicRouter()
+	_ = app
+
 	routerGroup := superRouterGroup.Group(utils.ROUTER_PREFIX)
 	{
 		v1 := routerGroup.Group(utils.ROUTER_PREFIX_VERSION)
 		v1.Use(middleware.BasicAuthMiddleware())
 		{
-			// v1.GET("/test-private-api/", handlers.TestApi)
+			v1.GET("/test-private/", handlers.TestAPI)
 		}
 	}
 }

book-store-inventory/pkg/router/public_router.go

@@ -18,7 +18,7 @@ func SetupPublicRouter(app *App, superRouterGroup *gin.Engine) {
 		{
 			// GET
 			v1.GET("/books/", app.Books.GetBooksHandler)
-			v1.GET("/book/id/:book_id", app.Books.GetBookByIdHandler)
+			v1.GET("/book/id/:book_id", app.Books.GetBookByIDHandler)
 
 			// POST
 			v1.POST("/book/add/", app.Books.AddBookHandler)

book-store-inventory/pkg/router/router.go

@@ -9,16 +9,13 @@ import (
 	"github.com/gin-gonic/gin"
 	"github.com/saketV8/book-store-inventory/pkg/handlers"
 	"github.com/saketV8/book-store-inventory/pkg/utils"
-
-	log "github.com/sirupsen/logrus"
 )
 
 type App struct {
 	// Add more handlers as needed
 	Books *handlers.BookHandler
 }
 
-// func SetupRouter(DbModel *querydb.DbModel) {
 func SetupRouter(app *App) {
 	// Initializing the GIN Router
 	gin.SetMode(gin.ReleaseMode)
@@ -41,7 +38,7 @@ func SetupRouter(app *App) {
 	err := rtr.Run(utils.PORT)
 	if err != nil {
 		fmt.Println("============================================")
-		log.Fatal("ERROR: while Initializing the server")
+		fmt.Println("ERROR: while Initializing the server")
 		fmt.Println("============================================")
 	}
 }

book-store-inventory/pkg/utils/constants.go

@@ -1,7 +1,9 @@
+// Package utils contains constant to be used across the application
 package utils
 
 // TODO:
 // replace all with env variable
-var PORT string = ":9090"
-var ROUTER_PREFIX string = "/api"
+
+var PORT = ":9090"
+var ROUTER_PREFIX = "/api"
 var ROUTER_PREFIX_VERSION = "/v1"

book-store-inventory/pkg/utils/list_all_routes.go

@@ -1,3 +1,4 @@
+// Package utils contains function to print all available routes in application
 package utils
 
 import (
@@ -8,6 +9,7 @@ import (
 
 // https://stackoverflow.com/questions/287871/how-do-i-print-colored-text-to-the-terminal
 // https://stackoverflow.com/a/26445590
+
 var Reset = "\033[0m"
 
 var Blue = "\033[34m"