修改module name

Author: fakeyanss

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Roy Lee <roylee0704@gmail.com>
+Copyright (c) 2023 Roy Lee <roylee0704@gmail.com>, fakeYanss
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -5,6 +5,10 @@
 
 Gron provides a clear syntax for writing and deploying cron jobs.
 
+**This is a fork repo of [github.com/roylee0704/gron](https://github.com/roylee0704/gron).**
+
+Just add feature of canceling job.
+
 ## Goals
 
 - Minimalist APIs for scheduling jobs.
@@ -15,7 +19,8 @@ Gron provides a clear syntax for writing and deploying cron jobs.
 ## Installation
 
 ```sh
-$ go get github.com/roylee0704/gron
+# $ go get github.com/roylee0704/gron
+$ go get github.com/fakeYanss/gron
 ```
 
 ## Usage
@@ -27,7 +32,8 @@ package main
 import (
 	"fmt"
 	"time"
-	"github.com/roylee0704/gron"
+	// "github.com/roylee0704/gron"
+	"github.com/fakeYanss/gron"
 )
 
 func main() {
@@ -53,7 +59,8 @@ gron.Every(1*time.Hour)
 
 Also support `Day`, `Week` by importing `gron/xtime`:
 ```go
-import "github.com/roylee0704/gron/xtime"
+// import "github.com/roylee0704/gron/xtime"
+import "github.com/fakeYanss/gron/xtime"
 
 gron.Every(1 * xtime.Day)
 gron.Every(1 * xtime.Week)
@@ -117,7 +124,7 @@ type canceledJob struct { // implements of JobWithCancel interface
 	id string
 }
 
-func (j *canceledJob) JobID() {
+func (j *canceledJob) JobID() string {
 	return id
 }
 
@@ -145,42 +152,68 @@ package main
 
 import (
 	"fmt"
-	"github.com/roylee0704/gron"
-	"github.com/roylee0704/gron/xtime"
+	"time"
+
+	"github.com/fakeYanss/gron"
+	"github.com/fakeYanss/gron/xtime"
 )
 
-type PrintJob struct{ Msg string }
+type printJob struct{ Msg string }
 
-func (p PrintJob) Run() {
+func (p printJob) Run() {
 	fmt.Println(p.Msg)
 }
 
-func main() {
+type canceledJob struct { // implements of JobWithCancel interface
+	id string
+}
+
+func (j *canceledJob) JobID() string {
+	return j.id
+}
+
+func (j *canceledJob) Run() {
+	fmt.Printf("job %s run\n", j.id)
+}
 
+func main() {
 	var (
-		// schedules
 		daily     = gron.Every(1 * xtime.Day)
 		weekly    = gron.Every(1 * xtime.Week)
 		monthly   = gron.Every(30 * xtime.Day)
 		yearly    = gron.Every(365 * xtime.Day)
-
-		// contrived jobs
-		purgeTask = func() { fmt.Println("purge aged records") }
+		purgeTask = func() { fmt.Println("purge unwanted records") }
 		printFoo  = printJob{"Foo"}
 		printBar  = printJob{"Bar"}
 	)
 
 	c := gron.New()
 
-	c.Add(daily.At("12:30"), printFoo)
+	c.AddFunc(gron.Every(1*time.Hour), func() {
+		fmt.Println("Every 1 hour")
+	})
+	c.Start()
+
 	c.AddFunc(weekly, func() { fmt.Println("Every week") })
+	c.Add(daily.At("12:30"), printFoo)
 	c.Start()
 
-	// Jobs may also be added to a running Gron
+	// Jobs may also be added to a running Cron
 	c.Add(monthly, printBar)
 	c.AddFunc(yearly, purgeTask)
 
-	// Stop Gron (running jobs are not halted).
-	c.Stop()
+	c.AddFuncWithJobID(gron.Every(1*time.Second), "job-id-1", func() {
+		fmt.Println("job-id-1 runs every second")
+	})
+	c.AddCancelingJob(gron.Every(1*time.Second), &canceledJob{id: "job-id-2"})
+	c.Start()
+
+	time.Sleep(5 * time.Second)
+	c.Cancel("job-id-1")
+	time.Sleep(5 * time.Second)
+
+	// Stop the scheduler (does not stop any jobs already running).
+	defer c.Stop()
 }
+
 ```

cron_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/roylee0704/gron/xtime"
+	"github.com/fakeYanss/gron/xtime"
 )
 
 // Most test jobs scheduled to run at 1 second mark.

example/main.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/roylee0704/gron"
-	"github.com/roylee0704/gron/xtime"
+	"github.com/fakeYanss/gron"
+	"github.com/fakeYanss/gron/xtime"
 )
 
 type printJob struct{ Msg string }
@@ -14,8 +14,19 @@ func (p printJob) Run() {
 	fmt.Println(p.Msg)
 }
 
-func main() {
+type canceledJob struct { // implements of JobWithCancel interface
+	id string
+}
+
+func (j *canceledJob) JobID() string {
+	return j.id
+}
+
+func (j *canceledJob) Run() {
+	fmt.Printf("job %s run\n", j.id)
+}
 
+func main() {
 	var (
 		daily     = gron.Every(1 * xtime.Day)
 		weekly    = gron.Every(1 * xtime.Week)
@@ -41,6 +52,16 @@ func main() {
 	c.Add(monthly, printBar)
 	c.AddFunc(yearly, purgeTask)
 
+	c.AddFuncWithJobID(gron.Every(1*time.Second), "job-id-1", func() {
+		fmt.Println("job-id-1 runs every second")
+	})
+	c.AddCancelingJob(gron.Every(1*time.Second), &canceledJob{id: "job-id-2"})
+	c.Start()
+
+	time.Sleep(5 * time.Second)
+	c.Cancel("job-id-1")
+	time.Sleep(5 * time.Second)
+
 	// Stop the scheduler (does not stop any jobs already running).
 	defer c.Stop()
 }

go.mod

@@ -1,3 +1,3 @@
-module github.com/roylee0704/gron
+module github.com/fakeYanss/gron
 
 go 1.19

schedule.go

@@ -4,7 +4,7 @@ import (
 	"errors"
 	"time"
 
-	"github.com/roylee0704/gron/xtime"
+	"github.com/fakeYanss/gron/xtime"
 )
 
 // Schedule is the interface that wraps the basic Next method.

schedule_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/roylee0704/gron/xtime"
+	"github.com/fakeYanss/gron/xtime"
 )
 
 func TestPeriodicAtNext(t *testing.T) {