From 00bd6f6870c53dbaee291fd8eb0addead9fa1e1d Mon Sep 17 00:00:00 2001
From: aryan <85390033+theredditbandit@users.noreply.github.com>
Date: Tue, 2 Jul 2024 15:44:09 +0530
Subject: [PATCH] refactor ReadReadme func (#62)

* add scaffolding for pman cd

* add director func

* refactor ReadREADME func to only do one thing

implement the logic to get the project path in a separate function

* remove cd.go
---
 pkg/utils/utils.go | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/pkg/utils/utils.go b/pkg/utils/utils.go
index ffdaaf9..02f06ad 100644
--- a/pkg/utils/utils.go
+++ b/pkg/utils/utils.go
@@ -75,27 +75,36 @@ func BeautifyMD(data []byte) (string, error) {
 	return out, nil
 }
 
-// ReadREADME: returns the byte array of README.md of a project
-func ReadREADME(dbname, projectName string) ([]byte, error) {
+// GetProjectPath: returns the path to the README inside the project
+func GetProjectPath(dbname, projectName string) (string, error) {
 	path, err := db.GetRecord(dbname, projectName, c.ProjectPaths)
 	if err != nil {
 		actualName, err := db.GetRecord(dbname, projectName, c.ProjectAliasBucket)
 		if err != nil {
 			log.Printf("project: %v not a valid project\n", projectName)
-			return nil, errors.Join(ErrGetAlias, err)
+			return "", errors.Join(ErrGetAlias, err)
 		}
 		projectName = actualName
 		path, err = db.GetRecord(dbname, projectName, c.ProjectPaths)
 		if err != nil {
 			log.Printf("project: %v not a valid project\n", projectName)
-			return nil, errors.Join(ErrGetProject, err)
+			return "", errors.Join(ErrGetProject, err)
 		}
 	}
 	pPath := filepath.Join(path, "README.md")
 	_, err = os.Stat(pPath)
-	if os.IsNotExist(err) {
-		msg := fmt.Sprintf("# README does not exist for %s", projectName)
-		return []byte(msg), nil
+	return pPath, err
+}
+
+// ReadREADME: returns the byte array of README.md of a project
+func ReadREADME(dbname, projectName string) ([]byte, error) {
+	pPath, err := GetProjectPath(dbname, projectName)
+	if err != nil {
+		if os.IsNotExist(err) {
+			msg := fmt.Sprintf("# README does not exist for %s", projectName)
+			return []byte(msg), nil
+		}
+		return nil, err
 	}
 	data, err := os.ReadFile(pPath)
 	if err != nil {
@@ -112,6 +121,7 @@ func UpdateLastEditedTime() error {
 		return err
 	}
 	return nil
+
 }
 
 func DayPassed(t string) bool {