add more tests

Author: codemodify

manager-raise.go manager-emit.gomanager-raise.go renamed to manager-emit.go

@@ -1,7 +1,7 @@
 package events
 
-// Raise - informs all subscribers about the event
-func (thisRef *Manager) Raise(eventName string) {
+// Emit - informs all subscribers about the event
+func (thisRef *Manager) Emit(eventName string) {
 	thisRef.eventsMutex.RLock()
 	defer thisRef.eventsMutex.RUnlock()
 
@@ -13,8 +13,8 @@ func (thisRef *Manager) Raise(eventName string) {
 	thisRef.removeAllCallOnce(eventName)
 }
 
-// RaiseWithData - informs all subscribers about the event with data
-func (thisRef *Manager) RaiseWithData(eventName string, data []byte) {
+// EmitWithData - informs all subscribers about the event with data
+func (thisRef *Manager) EmitWithData(eventName string, data []byte) {
 	thisRef.eventsMutex.RLock()
 	defer thisRef.eventsMutex.RUnlock()
 

readme.md

@@ -1,8 +1,127 @@
 # ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) Events
-[![GoDoc](https://godoc.org/github.com/codemodify/systemkit-logging?status.svg)](https://godoc.org/github.com/codemodify/systemkit-logging)
+[![GoDoc](https://godoc.org/github.com/codemodify/systemkit-logging?status.svg)](https://godoc.org/github.com/codemodify/systemkit-events)
 [![0-License](https://img.shields.io/badge/license-0--license-brightgreen)](https://github.com/codemodify/TheFreeLicense)
 [![Go Report Card](https://goreportcard.com/badge/github.com/codemodify/systemkit-logging)](https://goreportcard.com/report/github.com/codemodify/systemkit-logging)
 [![Test Status](https://github.com/danawoodman/systemservice/workflows/Test/badge.svg)](https://github.com/danawoodman/systemservice/actions)
 ![code size](https://img.shields.io/github/languages/code-size/codemodify/SystemKit?style=flat-square)
 
-A Swiss-Knife collection of helpers for all cases of coding life
+#### Robust events for Go. It takes `0.1` seconds to send/receive 1 Million events.
+
+
+# ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) Install
+```go
+go get github.com/codemodify/systemkit-events
+```
+
+# ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) API
+
+ 										|  
+---											| ---
+On(`event`, `handler`, `callOnce`)			| Subscribe
+OnWithData(`event`, `handler`, `callOnce`)	| Subscribe with payload
+Off(`event`, `handlerRef`)					| Unsubscribe
+OffWithData(`event`, `handlerRef`)			| Unsubscribe with payload
+Emit(`event`)								| Emit
+EmitWithData(`event`, `data`)				| Emit with payload
+
+
+
+# ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) Usage: Subscribe + Notify
+```go
+package main
+
+import (
+	events "github.com/codemodify/systemkit-events"
+)
+
+func main() {
+	events.Events().On("PING", func() {
+		// FIMXE: will be called
+	})
+
+	events.Events().Emit("PING")
+}
+```
+
+# ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) Usage: Subscribe (data) + Notify (data)
+```go
+package main
+
+import (
+	events "github.com/codemodify/systemkit-events"
+)
+
+func main() {
+	events.Events().OnWithData("PING", func(data []byte) {
+		// FIMXE: will be called
+	})
+
+	events.Events().EmitWithData("PING", []byte("PING-DATA"))
+}
+```
+
+# ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) Usage: Subscribe (yes-no-data) + Notify (data)
+```go
+package main
+
+import (
+	events "github.com/codemodify/systemkit-events"
+)
+
+func main() {
+	events.Events().OnWithData("PING", func(data []byte) {
+		// FIMXE: will be called
+	})
+
+	events.Events().On("PING", func() {
+		// FIMXE: will be called
+	})
+
+	events.Events().EmitWithData("PING", []byte("PING-DATA"))
+}
+```
+
+# ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) Usage: Subscribe (yes-no-data) + Notify
+```go
+package main
+
+import (
+	events "github.com/codemodify/systemkit-events"
+)
+
+func main() {
+	events.Events().OnWithData("PING", func(data []byte) {
+		// FIMXE: will be called, data will be nil
+	})
+
+	events.Events().On("PING", func() {
+		// FIMXE: will be called
+	})
+
+	events.Events().Emit("PING")
+}
+```
+
+# ![](https://fonts.gstatic.com/s/i/materialicons/bookmarks/v4/24px.svg) Usage: Subscribe Once + Notify
+```go
+package main
+
+import (
+	events "github.com/codemodify/systemkit-events"
+)
+
+func main() {
+
+	handler1CallOnce := true
+	events.Events().On("PING", func() {
+		// FIMXE: will be called ONCE
+	}, handler1CallOnce)
+
+	handler3CallOnce := false
+	events.Events().On("PING", func() {
+		// FIMXE: will be called UNTIL "events.Events().Off()" is called
+	}, handler3CallOnce)
+
+	events.Events().Emit("PING")
+}
+```

tests/benchmarks/benchmark-one-mil_test.go

@@ -0,0 +1,28 @@
+package tests
+
+import (
+	"testing"
+
+	events "github.com/codemodify/systemkit-events"
+)
+
+func Benchmark_benchmark_one_mil(b *testing.B) {
+
+	const pingEvent = "BENCH"
+	const pingData = "PING-DATA"
+
+	events.Events().OnWithData(pingEvent, func(data []byte) {
+		// DO SOMETHING WITH DATA
+	})
+
+	b.ResetTimer()
+	b.StartTimer()
+	count := 0
+	countMax := 1000000
+	for ; count < countMax; count++ {
+		events.Events().EmitWithData(pingEvent, []byte(pingData))
+	}
+	b.StopTimer()
+
+	b.Logf("SEND/RECV: %d", count)
+}

tests/01-raise-nodata-on-nodata_test.go …s/unit/01-raise-nodata-on-nodata_test.gotests/01-raise-nodata-on-nodata_test.go renamed to tests/unit/01-raise-nodata-on-nodata_test.go tests/01-raise-nodata-on-nodata_test.go renamed to tests/unit/01-raise-nodata-on-nodata_test.go

@@ -16,7 +16,7 @@ func Test_RaiseNoData_OnNoData(t *testing.T) {
 	go func() {
 		for {
 			time.Sleep(1 * time.Second)
-			events.Events().Raise(pingEvent)
+			events.Events().Emit(pingEvent)
 		}
 	}()
 

tests/02-raise-data-on-data_test.go tests/unit/02-raise-data-on-data_test.gotests/02-raise-data-on-data_test.go renamed to tests/unit/02-raise-data-on-data_test.go

@@ -17,7 +17,7 @@ func Test_RaiseData_OnData(t *testing.T) {
 	go func() {
 		for {
 			time.Sleep(1 * time.Second)
-			events.Events().RaiseWithData(pingEvent, []byte(pingData))
+			events.Events().EmitWithData(pingEvent, []byte(pingData))
 		}
 	}()
 

tests/03-raise-data-on-nodata_test.go …sts/unit/03-raise-data-on-nodata_test.gotests/03-raise-data-on-nodata_test.go renamed to tests/unit/03-raise-data-on-nodata_test.go tests/03-raise-data-on-nodata_test.go renamed to tests/unit/03-raise-data-on-nodata_test.go

@@ -17,7 +17,7 @@ func Test_RaiseData_OnNoData(t *testing.T) {
 	go func() {
 		for {
 			time.Sleep(1 * time.Second)
-			events.Events().RaiseWithData(pingEvent, []byte(pingData))
+			events.Events().EmitWithData(pingEvent, []byte(pingData))
 		}
 	}()
 

…/04-raise-data-on-data-on-nodata_test.go …/04-raise-data-on-data-on-nodata_test.gotests/04-raise-data-on-data-on-nodata_test.go renamed to tests/unit/04-raise-data-on-data-on-nodata_test.go tests/04-raise-data-on-data-on-nodata_test.go renamed to tests/unit/04-raise-data-on-data-on-nodata_test.go

@@ -17,7 +17,7 @@ func Test_RaiseData_OnData_OnNoData(t *testing.T) {
 	go func() {
 		for {
 			time.Sleep(1 * time.Second)
-			events.Events().RaiseWithData(pingEvent, []byte(pingData))
+			events.Events().EmitWithData(pingEvent, []byte(pingData))
 		}
 	}()
 

…5-raise-nodata-on-data-on-nodata_test.go …5-raise-nodata-on-data-on-nodata_test.gotests/05-raise-nodata-on-data-on-nodata_test.go renamed to tests/unit/05-raise-nodata-on-data-on-nodata_test.go tests/05-raise-nodata-on-data-on-nodata_test.go renamed to tests/unit/05-raise-nodata-on-data-on-nodata_test.go

@@ -16,7 +16,7 @@ func Test_RaiseNoData_OnData_OnNoData(t *testing.T) {
 	go func() {
 		for {
 			time.Sleep(1 * time.Second)
-			events.Events().Raise(pingEvent)
+			events.Events().Emit(pingEvent)
 		}
 	}()
 

tests/06-raise-on-once_test.go tests/unit/06-raise-on-once_test.gotests/06-raise-on-once_test.go renamed to tests/unit/06-raise-on-once_test.go

@@ -16,7 +16,7 @@ func Test_Raise_On_Once(t *testing.T) {
 	go func() {
 		for {
 			time.Sleep(1 * time.Second)
-			events.Events().Raise(pingEvent)
+			events.Events().Emit(pingEvent)
 		}
 	}()