Merge pull request #2 from slashdevops/feat-SMapKeyValue

Feat: Add SMapKeyValue container implementing golang sync.Map

Author: christiangda

.vscode/settings.json

@@ -1,7 +1,9 @@
 {
   "cSpell.words": [
+    "codecov",
     "Doakes",
     "Donato",
+    "Gosec",
     "keyval",
     "Println",
     "Ramstorag",

README.md

@@ -16,13 +16,16 @@ This is focused on `usability and simplicity` rather than performance, but it do
 
 ## Overview
 
-Taking advantage of the [Golang Generics](https://go.dev/blog/intro-generics) and internal golang data structures like [Map](https://go.dev/blog/maps), `RamStorage (r9e)` provides a simple way to store and retrieve data.
+Taking advantage of the [Golang Generics](https://go.dev/blog/intro-generics) and internal golang data structures, `RamStorage (r9e)` provides a simple way to store and retrieve data.
 
-The goal is to provide a simple and easy way to use a library to store and retrieve data from memory using a simple API and data structures.
+The goal is to provide an easy way to use a library to store and retrieve data from memory using an API and data structures simples and.
+
+This package doesn't have any dependencies, so it's easy to use and maintain, only golang standard library is required.
 
 ### Available Containers
 
-* [MapKeyValue[K comparable, T any]](https://pkg.go.dev/github.com/slashdevops/r9e#MapKeyValue) using `sync.RWMutex`
+* [MapKeyValue[K comparable, T any]](https://pkg.go.dev/github.com/slashdevops/r9e#MapKeyValue) using [sync.RWMutex](https://pkg.go.dev/sync#RWMutex)
+* [SMapKeyValue[K comparable, T any]](https://pkg.go.dev/github.com/slashdevops/r9e#SMapKeyValue) using [sync.Map](https://pkg.go.dev/sync#Map)
 
 ### Documentation
 

example_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/slashdevops/r9e"
 )
 
-func Example_basic() {
+func ExampleMapKeyValue_basic() {
 	type MathematicalConstants struct {
 		Name  string
 		Value float64
@@ -61,3 +61,57 @@ func Example_basic() {
 		fmt.Printf("Key: %v, Name: %v, Value: %v\n", key, value.Name, value.Value)
 	})
 }
+
+func ExampleSMapKeyValue_basic() {
+	type MathematicalConstants struct {
+		Name  string
+		Value float64
+	}
+
+	kv := r9e.NewSMapKeyValue[string, MathematicalConstants]()
+
+	kv.Set("pi", MathematicalConstants{"Archimedes' constant", 3.141592})
+	kv.Set("e", MathematicalConstants{"Euler number, Napier's constant", 2.718281})
+	kv.Set("γ", MathematicalConstants{"Euler number, Napier's constant", 0.577215})
+	kv.Set("Φ", MathematicalConstants{"Golden ratio constant", 1.618033})
+	kv.Set("ρ", MathematicalConstants{"Plastic number ρ (or silver constant)", 2.414213})
+
+	kvFilteredValues := kv.FilterValue(func(value MathematicalConstants) bool {
+		return value.Value > 2.0
+	})
+
+	fmt.Println("Mathematical Constants:")
+	kvFilteredValues.ForEach(func(key string, value MathematicalConstants) {
+		fmt.Printf("Key: %v, Name: %v, Value: %v\n", key, value.Name, value.Value)
+	})
+
+	fmt.Printf("\n")
+	fmt.Printf("The most famous mathematical constant:\n")
+	fmt.Printf("Name: %v, Value: %v\n", kv.Get("pi").Name, kv.Get("pi").Value)
+
+	lst := kv.SortValues(func(value1, value2 MathematicalConstants) bool {
+		return value1.Value > value2.Value
+	})
+
+	fmt.Printf("\n")
+	fmt.Printf("The most famous mathematical constant sorted by value:\n")
+	for i, value := range lst {
+		fmt.Printf("i: %v, Name: %v, Value: %v\n", i, value.Name, value.Value)
+	}
+
+	kvHigh, kvLow := kv.Partition(func(key string, value MathematicalConstants) bool {
+		return value.Value > 2.5
+	})
+
+	fmt.Printf("\n")
+	fmt.Printf("Mathematical constants which value is greater than 2.5:\n")
+	kvHigh.ForEach(func(key string, value MathematicalConstants) {
+		fmt.Printf("Key: %v, Name: %v, Value: %v\n", key, value.Name, value.Value)
+	})
+
+	fmt.Printf("\n")
+	fmt.Printf("Mathematical constants which value is less than 2.5:\n")
+	kvLow.ForEach(func(key string, value MathematicalConstants) {
+		fmt.Printf("Key: %v, Name: %v, Value: %v\n", key, value.Name, value.Value)
+	})
+}

godoc.go

@@ -4,6 +4,7 @@ Package r9e provides a collection of memory store containers.
 # Available Containers
 
 * [MapKeyValue[K comparable, T any]](https://pkg.go.dev/github.com/slashdevops/r9e#MapKeyValue) using sync.RWMutex
+* [SMapKeyValue[K comparable, T any]](https://pkg.go.dev/github.com/slashdevops/r9e#SMapKeyValue) using sync.Map
 
 */
 package r9e

mapkeyvalue.go

@@ -54,9 +54,9 @@ func (r *MapKeyValue[K, T]) Set(key K, value T) {
 	r.data[key] = value
 }
 
-// GetCheck returns the value associated with the key if this exist also a
+// GetAndCheck returns the value associated with the key if this exist also a
 // boolean value if this exist of not.
-func (r *MapKeyValue[K, T]) GetCheck(key K) (T, bool) {
+func (r *MapKeyValue[K, T]) GetAndCheck(key K) (T, bool) {
 	r.mu.RLock()
 	defer r.mu.RUnlock()
 
@@ -65,6 +65,7 @@ func (r *MapKeyValue[K, T]) GetCheck(key K) (T, bool) {
 }
 
 // Get returns the value associated with the key.
+// If the key does not exist, return zero value of the type.
 func (r *MapKeyValue[K, T]) Get(key K) T {
 	r.mu.RLock()
 	defer r.mu.RUnlock()