Docs and Tests (#14)

* Docs and Tests

* Test Review

Author: jsas4coding

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [1.4.9] - 2025-07-29
+
+### 🧪 Testing
+
+- Added **new unit tests** for `utify.go`, improving coverage and reliability.
+- Expanded tests to cover **logging-only functions** and **"Get" functions**.
+
+### 📚 Documentation
+
+- **Improved doccomments** in `utify.go`:
+  - Added comprehensive package-level documentation.
+  - Documented customization features for colors, icons, and logging.
+  - Clarified usage examples for:
+    - Direct output functions (e.g., `utify.Success()`)
+    - Formatted functions (e.g., `utify.Infof()`)
+    - Getters (e.g., `utify.GetSuccess()`)
+    - Logging-only functions (e.g., `utify.LogInfo()`)
+
+### 🛠 Maintenance
+
+- Minor refactoring for **consistency across all message functions**.
+- Updated **aliases** for backward compatibility (`MessageType`, `Options`).
+
 ## [1.4.8] - 2025-07-29
 
 ### 🔒 Security

README.md

@@ -4,7 +4,7 @@
 ![Stable Version](https://img.shields.io/github/v/release/jsas4coding/utify)
 ![License](https://img.shields.io/github/license/jsas4coding/utify)
 ![CI/CD](https://img.shields.io/github/actions/workflow/status/jsas4coding/utify/utify.yml?label=CI%2FCD&logo=githubactions&logoColor=white)
-![CodeQL](https://img.shields.io/github/actions/workflow/status/jsas4coding/utify/codeql-analysis.yml?label=CodeQL%20Security&logo=github&color=orange)
+![CodeQL](https://img.shields.io/github/actions/workflow/status/jsas4coding/utify/codeql-analysis.yml?label=CodeQL&style=flat-square)
 ![Coverage](https://img.shields.io/codecov/c/github/jsas4coding/utify?logo=codecov&logoColor=white)
 ![Stars](https://img.shields.io/github/stars/jsas4coding/utify?style=social)
 

tests/unit/utify_test.go

@@ -0,0 +1,134 @@
+package unit
+
+import (
+	"testing"
+
+	"github.com/jsas4coding/utify"
+)
+
+func defaultOpts() *utify.Options {
+	return utify.OptionsDefault()
+}
+
+func TestBasicOutputFunctions(t *testing.T) {
+	tests := []struct {
+		name string
+		fn   func(string, *utify.Options)
+	}{
+		{"Success", utify.Success},
+		{"Error", utify.Error},
+		{"Warning", utify.Warning},
+		{"Info", utify.Info},
+		{"Debug", utify.Debug},
+		{"Critical", utify.Critical},
+		{"Delete", utify.Delete},
+		{"Update", utify.Update},
+		{"Install", utify.Install},
+		{"Upgrade", utify.Upgrade},
+		{"Edit", utify.Edit},
+		{"New", utify.New},
+		{"Download", utify.Download},
+		{"Upload", utify.Upload},
+		{"Sync", utify.Sync},
+		{"Search", utify.Search},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.fn("Test message", defaultOpts())
+		})
+	}
+}
+
+func TestFormattedOutputFunctions(t *testing.T) {
+	tests := []struct {
+		name string
+		fn   func(string, *utify.Options, ...any)
+	}{
+		{"Successf", utify.Successf},
+		{"Errorf", utify.Errorf},
+		{"Warningf", utify.Warningf},
+		{"Infof", utify.Infof},
+		{"Debugf", utify.Debugf},
+		{"Criticalf", utify.Criticalf},
+		{"Deletef", utify.Deletef},
+		{"Updatef", utify.Updatef},
+		{"Installf", utify.Installf},
+		{"Upgradef", utify.Upgradef},
+		{"Editf", utify.Editf},
+		{"Newf", utify.Newf},
+		{"Downloadf", utify.Downloadf},
+		{"Uploadf", utify.Uploadf},
+		{"Syncf", utify.Syncf},
+		{"Searchf", utify.Searchf},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.fn("Formatted %s", defaultOpts(), "message")
+		})
+	}
+}
+
+func TestGetFunctions(t *testing.T) {
+	tests := []struct {
+		name string
+		fn   func(string, *utify.Options) (string, error)
+	}{
+		{"GetSuccess", utify.GetSuccess},
+		{"GetError", utify.GetError},
+		{"GetWarning", utify.GetWarning},
+		{"GetInfo", utify.GetInfo},
+		{"GetDebug", utify.GetDebug},
+		{"GetCritical", utify.GetCritical},
+		{"GetDelete", utify.GetDelete},
+		{"GetUpdate", utify.GetUpdate},
+		{"GetInstall", utify.GetInstall},
+		{"GetUpgrade", utify.GetUpgrade},
+		{"GetEdit", utify.GetEdit},
+		{"GetNew", utify.GetNew},
+		{"GetDownload", utify.GetDownload},
+		{"GetUpload", utify.GetUpload},
+		{"GetSync", utify.GetSync},
+		{"GetSearch", utify.GetSearch},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err := tt.fn("Test message", defaultOpts())
+			if err != nil && err != utify.ErrSilent {
+				t.Errorf("%s returned unexpected error: %v", tt.name, err)
+			}
+		})
+	}
+}
+
+func TestLogOnlyFunctions(t *testing.T) {
+	tests := []struct {
+		name string
+		fn   func(string)
+	}{
+		{"LogSuccess", utify.LogSuccess},
+		{"LogError", utify.LogError},
+		{"LogWarning", utify.LogWarning},
+		{"LogInfo", utify.LogInfo},
+		{"LogDebug", utify.LogDebug},
+		{"LogCritical", utify.LogCritical},
+		{"LogDelete", utify.LogDelete},
+		{"LogUpdate", utify.LogUpdate},
+		{"LogInstall", utify.LogInstall},
+		{"LogUpgrade", utify.LogUpgrade},
+		{"LogEdit", utify.LogEdit},
+		{"LogNew", utify.LogNew},
+		{"LogDownload", utify.LogDownload},
+		{"LogUpload", utify.LogUpload},
+		{"LogSync", utify.LogSync},
+		{"LogSearch", utify.LogSearch},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.fn("Log-only message")
+		})
+	}
+}