Merge pull request #2 from raythurman2386/refactor/project-structure

refactor: reorganize project structure to follow Go best practices

Author: raythurman2386

GEMINI.md

@@ -14,13 +14,15 @@
 
 ## Key Files & Architecture
 
-*   **`cron.go`**: The core of the library. Contains:
-    *   `Cron`: The main scheduler engine managing the job list and run loop.
-    *   `Job`: Represents a scheduled task with its expression and state.
-    *   `Expression`: The parsed cron schedule using bitmasks.
-    *   `Parse()`: Logic to convert cron strings into `Expression` objects.
-    *   `run()`: The main event loop that waits for the next job or signal.
-*   **`*_test.go`**: Unit tests ensuring correctness of parsing, scheduling, and concurrency.
+*   **`cron.go`**: The core scheduler engine (`Cron` struct).
+*   **`parser.go`**: Logic for parsing cron expressions and calculating next run times (`Expression`, `Parse`).
+*   **`job.go`**: Job-related data structures (`Job`, `JobOptions`, `JobStatus`).
+*   **`interfaces.go`**: Core interfaces (`JobStore`, `DistLock`) and policy definitions.
+*   **`pkg/`**: Auxiliary packages and extensions:
+    *   `pkg/dashboard`: Web UI for monitoring.
+    *   `pkg/store/sqlite`: Persistence implementation.
+    *   `pkg/lock/redis`: Distributed locking implementation.
+*   **`*_test.go`**: Comprehensive unit and integration tests.
 
 ## Building and Running
 
@@ -43,10 +45,5 @@ go test ./... -v
 *   **Language:** Go (1.24+)
 *   **Concurrency:** Heavy reliance on Goroutines, Channels (`stopCh`, `addCh`), `sync.RWMutex` for state protection, and `sync.WaitGroup` for graceful shutdowns.
 *   **Context:** Uses `context.Context` for job cancellation, especially relevant for the `OverlapReplace` policy.
-*   **No External Dependencies:** The project relies solely on the Go standard library.
+*   **No External Dependencies:** The core library relies solely on the Go standard library. External implementations (SQLite, Redis) are in `pkg/`.
 *   **Formatting:** Standard `gofmt` style.
-
-## Future Roadmap (from README)
-*   Distributed locks (Redis/Etcd integration).
-*   Persistence layer (SQLite/BadgerDB).
-*   Web Dashboard for monitoring.

README.md

@@ -121,7 +121,7 @@ c.AddJobWithOptions("@every 1s", myTask, cronlib.JobOptions{
 Track job history and recover schedules across restarts.
 
 ```go
-import "github.com/raythurman2386/cronlib/store/sqlite"
+import "github.com/raythurman2386/cronlib/pkg/store/sqlite"
 
 store, _ := sqlite.New("cron.db")
 c.SetJobStore(store)
@@ -131,7 +131,7 @@ c.SetJobStore(store)
 Ensure a job runs only once across a cluster.
 
 ```go
-import "github.com/raythurman2386/cronlib/lock/redis"
+import "github.com/raythurman2386/cronlib/pkg/lock/redis"
 
 lock := redis.New("localhost:6379")
 c.SetDistLock(lock)
@@ -141,7 +141,7 @@ c.SetDistLock(lock)
 Embedded UI accessible at `http://localhost:8080`.
 
 ```go
-import "github.com/raythurman2386/cronlib/dashboard"
+import "github.com/raythurman2386/cronlib/pkg/dashboard"
 
 http.Handle("/", dashboard.NewHandler(c))
 http.ListenAndServe(":8080", nil)