docs: add section headers to Go files for better organization and readability

Author: anqorithm

internal/config/config.go

@@ -1,5 +1,9 @@
 package config
 
+// ###############################################################################
+// Configurations
+// ###############################################################################
+
 import (
 	"os"
 

internal/config/mongodb.go

@@ -1,5 +1,9 @@
 package config
 
+// ###############################################################################
+// MongoDB Configuration
+// ###############################################################################
+
 import (
 	"context"
 	"log"

internal/handlers/errors.go

@@ -1,14 +1,15 @@
 package handlers
 
+// ###############################################################################
+// Error Handling Functions
+// ###############################################################################
+
 import (
 	"github.com/anqorithm/naqa-api/internal/models"
 	"github.com/gofiber/fiber/v2"
 )
 
-// ###############################################################################
-// Error Handling Functions
-// ###############################################################################
-
+// SendError sends an error response to the client
 func SendError(c *fiber.Ctx, status int, code string, message string, details interface{}) error {
 	return c.Status(status).JSON(&models.ErrorResponse{
 		Status:  "error",

internal/handlers/handlers.go

@@ -1,5 +1,9 @@
 package handlers
 
+// ###############################################################################
+// Handler Functions
+// ###############################################################################
+
 import (
 	"fmt"
 	"os"
@@ -21,10 +25,6 @@ func NewHandler(db *mongo.Database) *Handler {
 	}
 }
 
-// ###############################################################################
-// Handler Functions
-// ###############################################################################
-
 // RootHandler handles the "/" endpoint
 func (h *Handler) RootHandler(c *fiber.Ctx) error {
 	return c.JSON(fiber.Map{

internal/handlers/stocks.go

@@ -1,5 +1,9 @@
 package handlers
 
+// ###############################################################################
+// Stock Handler Functions
+// ###############################################################################
+
 import (
 	"strconv"
 	"time"
@@ -12,10 +16,7 @@ import (
 	"go.mongodb.org/mongo-driver/bson/primitive"
 )
 
-// ###############################################################################
-// Stock Handler Functions
-// ###############################################################################
-
+// GetStocksHandler fetches all stocks for a given year
 func (h *Handler) GetStocksByYearHandler(c *fiber.Ctx) error {
 	collection := h.db.Collection(c.Params("year"))
 
@@ -48,6 +49,7 @@ func (h *Handler) GetStocksByYearHandler(c *fiber.Ctx) error {
 	return c.JSON(models.StockResponse{Stocks: result})
 }
 
+// GetStockByCodeHandler fetches a stock by its code for a given year
 func (h *Handler) SearchStocksHandler(c *fiber.Ctx) error {
 	filter := bson.M{}
 
@@ -95,6 +97,7 @@ func (h *Handler) SearchStocksHandler(c *fiber.Ctx) error {
 	return c.JSON(models.StockResponse{Stocks: result})
 }
 
+// CalculatePurificationHandler calculates purification amount for a stock
 func (h *Handler) CalculatePurificationHandler(c *fiber.Ctx) error {
 	const daysInYear = 365.0
 
@@ -154,5 +157,4 @@ func (h *Handler) CalculatePurificationHandler(c *fiber.Ctx) error {
 	}
 
 	return c.JSON(response)
-}
-
+}

internal/middleware/middleware.go

@@ -1,5 +1,9 @@
 package middleware
 
+// ###############################################################################
+// Middleware Functions
+// ###############################################################################
+
 import (
 	"fmt"
 	"time"
@@ -14,10 +18,6 @@ import (
 	"github.com/gofiber/fiber/v2/middleware/monitor"
 )
 
-// ###############################################################################
-// Middleware Functions
-// ###############################################################################
-
 // Logger returns a logger middleware
 func Logger() fiber.Handler {
 	return logger.New(logger.Config{

internal/middleware/year_validator.go

@@ -1,5 +1,9 @@
 package middleware
 
+// ###############################################################################
+// Year Validation Middleware
+// ###############################################################################
+
 import (
 	"fmt"
 
@@ -9,11 +13,7 @@ import (
 	"github.com/gofiber/fiber/v2"
 )
 
-// ###############################################################################
-// Year Validation Middleware
-// ###############################################################################
-
-
+// ValidateYear validates the year parameter
 func ValidateYear() fiber.Handler {
 	return func(c *fiber.Ctx) error {
 		year := c.Params("year")

internal/models/error.go

@@ -1,5 +1,9 @@
 package models
 
+// ###############################################################################
+// Error Response Model
+// ###############################################################################
+
 type ErrorResponse struct {
 	Status  string      `json:"status"`
 	Code    string      `json:"code"`
@@ -16,4 +20,4 @@ const (
 	ErrCodeDatabaseError     = "DATABASE_ERROR"
 	ErrCodeInvalidDateFormat = "INVALID_DATE_FORMAT"
 	ErrCodeInvalidData       = "INVALID_DATA"
-)
+)

internal/models/stock.go

@@ -1,7 +1,12 @@
 package models
 
+// ###############################################################################
+// Stock Model
+// ###############################################################################
+
 import "go.mongodb.org/mongo-driver/bson/primitive"
 
+// Stock represents a stock entity
 type Stock struct {
 	ID            primitive.ObjectID `json:"_id" bson:"_id,omitempty"`
 	Name          string             `json:"name" bson:"name"`
@@ -11,22 +16,23 @@ type Stock struct {
 	Purification  string             `json:"purification" bson:"purification"`
 }
 
+// StockResponse represents a response containing a list of stocks
 type StockResponse struct {
 	Stocks []Stock `json:"stocks"`
 }
 
-
+// PurificationRequest represents a request to calculate purification amount
 type PurificationRequest struct {
 	StartDate      string `json:"start_date" validate:"required,datetime=2006-01-02"`
 	EndDate        string `json:"end_date" validate:"required,datetime=2006-01-02"`
 	NumberOfStocks int    `json:"number_of_stocks" validate:"required,gt=0"`
 	StockCode      string `json:"stock_code" validate:"required"`
 }
 
-
+// PurificationResponse represents a response containing the purification amount
 type PurificationResponse struct {
 	ID                 primitive.ObjectID `json:"_id" bson:"_id,omitempty"`
 	PurificationAmount float64            `json:"purification_amount"`
 	DaysHeld           int                `json:"days_held"`
 	PurificationRate   float64            `json:"purification_rate"`
-}
+}

internal/routes/routes.go

@@ -1,5 +1,9 @@
 package routes
 
+// ###############################################################################
+// Routes
+// ###############################################################################
+
 import (
 	"github.com/anqorithm/naqa-api/internal/handlers"
 	"github.com/anqorithm/naqa-api/internal/middleware"