Major improvements

- Improve Collections API testing and interfaces
- Refactor concurrency package
- Add converter module
- Redefine functional interfaces
- Add task scheduler and process API
- Add value utils module

Author: aruizeac

.github/workflows/test-build.yml

@@ -8,58 +8,66 @@ on:
     branches:
       - master
 
+env:
+  GO111MODULE: 'on'
+
+permissions:
+  contents: read
+  pull-requests: read
+  checks: write
+
 jobs:
   lint:
     name: Run Go Linter
     strategy:
       matrix:
         os: ['ubuntu-latest']
-        go-version: ['1.20','1.21', '1.22']
+        go-version: ['1.21', '1.22']
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go-version }}
-          cache: false
+          cache: true
 
       - name: Run linter
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.54
+          version: v1.58
 
   unit-testing:
     name: Run Unit Tests
     strategy:
       matrix:
         os: [ 'ubuntu-latest' ]
-        go-version: [ '1.20','1.21', '1.22' ]
+        go-version: ['1.21', '1.22' ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go-version }}
           cache: true
 
       - name: Run Unit Testing
-        run: go test ./... -cover -v
+        run: go test ./... -cover
 
   integration-testing:
     name: Run Integration Tests
     strategy:
       matrix:
         os: [ 'ubuntu-latest' ]
-        go-version: [ '1.20','1.21', '1.22' ]
+        go-version: ['1.21', '1.22' ]
     runs-on: ${{ matrix.os }}
     needs: ['unit-testing']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go-version }}
           cache: true

.golangci.yml

@@ -2,22 +2,40 @@
 # https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
 
 run:
-  tests: false
+  tests: true
   timeout: 5m
+  allow-parallel-runners: true
   modules-download-mode: readonly
 
 output:
-  format: github-actions
+  formats:
+    - format: github-actions
 
 linters:
   enable:
-    - errcheck
     - goimports
-    - golint
-    - govet
-    - staticcheck
+  presets:
+    - bugs
+    - comment
+    - complexity
+    - error
+    - metalinter
+    - module
+    - performance
+    - style
+    - test
+    - unused
+
+#linters:
+#  enable:
+#    - errcheck
+#    - goimports
+#    - golint
+#    - govet
+#    - staticcheck
 
 issues:
   exclude-use-default: false
   max-issues-per-linter: 0
-  max-same-issues: 0
+  max-same-issues: 0
+  fix: true

collection/bag/bag.go

@@ -1,25 +1,3 @@
 package bag
 
-import (
-	"github.com/neutrinocorp/nolan/collection"
-	"github.com/neutrinocorp/nolan/collection/set"
-)
-
-// Bag Defines a collection that counts the number of times an object appears in
-// the collection.
-type Bag[T any] interface {
-	collection.Collection[T]
-	AddCopies(v T, numberCopies int) bool
-	GetCount(v T) int
-}
-
-// NewUniqueSet Returns a set.Set of unique elements in the Bag.
-func NewUniqueSet[T comparable](src Bag[T]) set.Set[T] {
-	buf := set.HashSet[T]{}
-	iter := src.NewIterator()
-	for iter.HasNext() {
-		item := iter.Next()
-		buf.Add(item)
-	}
-	return buf
-}
+// TODO: IMPLEMENT ME

collection/bag/hash.go

@@ -0,0 +1,3 @@
+package bag
+
+// TODO: IMPLEMENT ME

collection/collection.go

@@ -1,24 +1,25 @@
 package collection
 
-// Collection A collection represents a group of objects, known as its elements. Some collections allow duplicate
-// elements and others do not. Some are ordered and others unordered.
+// Collection a collection represents a group of objects, known as its elements.
+// Some collections allow duplicate elements and others do not.
+// Some are ordered and others unordered.
 type Collection[T any] interface {
 	Iterable[T]
-	// Add Ensures that this collection contains the specified element.
+	// Add adds an element into this collection.
 	Add(v T) bool
-	// AddAll Adds all the elements in the specified collection to this collection.
+	// AddAll adds all the elements into this collection.
 	AddAll(src Collection[T]) bool
-	// AddSlice Adds all the elements in the specified slice (variadic) to this collection.
+	// AddSlice adds all the elements in the specified slice (variadic) to this collection.
 	AddSlice(items ...T) bool
-	// Clear Removes all the elements from this collection.
+	// Clear removes all the elements from this collection.
 	Clear()
-	// Len Returns the number of elements in this collection.
+	// Len returns the number of elements in this collection.
 	Len() int
-	// IsEmpty Returns true if this collection contains no elements.
+	// IsEmpty returns true if this collection contains no elements.
 	IsEmpty() bool
-	// ToSlice Returns all the elements from this collection as a slice of T.
+	// ToSlice returns all the elements from this collection as a slice of T.
 	ToSlice() []T
-	// ForEach Iterates through all the elements from this collection. Use predicate's return value to
-	// indicate a break of the iteration.
+	// ForEach traverses through all the elements from this collection.
+	// Use predicate's return value to indicate a break of the iteration, TRUE meaning a break.
 	ForEach(predicateFunc IterablePredicateFunc[T])
 }

collection/compare.go

@@ -4,22 +4,26 @@ import (
 	"github.com/neutrinocorp/nolan/function"
 )
 
-// ComparatorFunc A functional interface used to indicate if first argument is greater, less or equals than
-// the second. If equals this will return 0, if less -1 and if greater, then it returns 1.
-type ComparatorFunc[T any] function.BiPredicate[T, T, int]
+// ComparatorFunc a functional interface used to indicate if the first argument is greater, less or equals than
+// the second.
+// If equals, this will return 0, if less -1 and if greater, then it returns 1.
+type ComparatorFunc[T any] function.DelegateBiFunc[T, T, int]
 
+// ComparableCollection a kind of Collection for comparable types.
+// Note that nolan offers a functional way to operate with Collection and comparable types
+// without the need of this interface (e.g., Contains, ContainsAll, ContainsSlice).
 type ComparableCollection[T comparable] interface {
 	Collection[T]
-	// Contains Returns true if this collection contains the specified element.
+	// Contains returns true if this collection contains the specified element.
 	Contains(v T) bool
-	// ContainsAll Returns true if this collection contains all the elements in the specified collection.
+	// ContainsAll returns true if this collection contains all the elements in the specified collection.
 	ContainsAll(src Collection[T]) bool
-	// ContainsSlice Returns true if this collection contains all the elements in the specified slice.
+	// ContainsSlice returns true if this collection contains all the elements in the specified slice.
 	ContainsSlice(src ...T) bool
 }
 
-// used internally to share iterator instances. This helps to reduce malloc as
-// we can reuse iterator instances.
+// NOTE: This is used internally to share iterator instances.
+// This helps to reduce malloc as we can reuse iterator instances.
 func containsWithIterator[T comparable](iter Iterator[T], v T) bool {
 	for iter.HasNext() {
 		if val := iter.Next(); val == v {
@@ -29,13 +33,13 @@ func containsWithIterator[T comparable](iter Iterator[T], v T) bool {
 	return false
 }
 
-// Contains Returns true if this collection contains the specified element.
+// Contains returns true if this collection contains the specified element.
 func Contains[T comparable](src Collection[T], v T) bool {
 	iter := src.NewIterator()
 	return containsWithIterator[T](iter, v)
 }
 
-// ContainsAll Returns true if this collection contains all the elements in the specified collection.
+// ContainsAll returns true if this collection contains all the elements in the specified collection.
 func ContainsAll[T comparable](src Collection[T], cmpColl Collection[T]) bool {
 	// Time complexity of O(mn)
 	srcIter := src.NewIterator()
@@ -51,7 +55,7 @@ func ContainsAll[T comparable](src Collection[T], cmpColl Collection[T]) bool {
 	return true
 }
 
-// ContainsSlice Returns true if this collection contains all the elements in the specified slice.
+// ContainsSlice returns true if this collection contains all the elements in the specified slice.
 func ContainsSlice[T comparable](src Collection[T], cmpSlice []T) bool {
 	iter := src.NewIterator()
 	for _, item := range cmpSlice {

collection/deque.go

@@ -0,0 +1,7 @@
+// Package collection is a robust package meticulously crafted to provide a rich assortment of
+// general-purpose data structures and algorithms. Whether you're working with lists, sets, maps, or more complex
+// data types, this package equips you with versatile tools to manage and manipulate data efficiently.
+//
+// From sorting and search algorithms to key data structures like arrays, linked lists, stacks, and queues,
+// 'Collection' offers a comprehensive suite to streamline your development workflow.
+package collection

collection/doc.go

@@ -0,0 +1,4 @@
+package graph
+
+// TODO: IMPLEMENT ME
+//  - Add dijkstra algo

collection/graph/search.go

@@ -0,0 +1,3 @@
+package heap
+
+// TODO: IMPLEMENT ME