Added collection utilities (#32)

* Added utilities

* Added licensing header

Author: acabarbaye

changes/202111091652.feature

@@ -0,0 +1 @@
+Added collection utilities for removing elements from slices

utils/collection/modify.go

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package collection
+
+// Remove looks for elements in a slice. If they're found, it will
+// remove them.
+func Remove(slice []string, val ...string) []string {
+	return GenericRemove(func(val1, val2 string) bool { return val1 == val2 }, slice, val...)
+}
+
+// GenericRemove looks for elements in a slice using the equal function. If they're found, it will
+// remove them from the slice.
+func GenericRemove(equal func(string, string) bool, slice []string, val ...string) []string {
+	if len(val) == 0 {
+		return slice
+	}
+	list := make([]string, 0, len(slice))
+	found := make([]bool, len(val))
+
+	for i := range slice {
+		e := slice[i]
+		for j := range val {
+			found[j] = equal(e, val[j])
+		}
+		if !Any(found) {
+			list = append(list, e)
+		}
+	}
+	return list
+}

utils/collection/modify_test.go

@@ -0,0 +1,66 @@
+/*
+ * Copyright (C) 2020-2021 Arm Limited or its affiliates and Contributors. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package collection
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRemove(t *testing.T) {
+	// Given a list of strings and a string
+	// Returns the list without the string
+	tests := []struct {
+		SrcList      []string
+		ToDelete     []string
+		ExpectedList []string
+	}{
+		{
+			SrcList:      []string{"a", "b", "c", "d"},
+			ToDelete:     []string{"c"},
+			ExpectedList: []string{"a", "b", "d"},
+		},
+		{
+			SrcList:      []string{"a", "b", "c", "d"},
+			ToDelete:     []string{"h"},
+			ExpectedList: []string{"a", "b", "c", "d"},
+		},
+		{
+			SrcList:      []string{"a", "b", "c", "d"},
+			ToDelete:     []string{"d"},
+			ExpectedList: []string{"a", "b", "c"},
+		},
+		{
+			SrcList:      []string{"d", "d", "d", "d"},
+			ToDelete:     []string{"d"},
+			ExpectedList: []string{},
+		},
+		{
+			SrcList:      []string{},
+			ToDelete:     []string{"d"},
+			ExpectedList: []string{},
+		},
+		{
+			SrcList:      []string{},
+			ToDelete:     []string{"d", "e"},
+			ExpectedList: []string{},
+		},
+		{
+			SrcList:      []string{"a", "b", "c", "d"},
+			ToDelete:     []string{"a", "b", "d"},
+			ExpectedList: []string{"c"},
+		},
+	}
+	for i := range tests {
+		test := tests[i]
+		t.Run(fmt.Sprintf("test_%v", i), func(t *testing.T) {
+			t.Parallel()
+			newList := Remove(test.SrcList, test.ToDelete...)
+			assert.Equal(t, test.ExpectedList, newList)
+		})
+	}
+}

utils/collection/search.go

@@ -4,7 +4,7 @@
  */
 package collection
 
-// Looks for an element in a slice. If found it will
+// Find looks for an element in a slice. If found it will
 // return its index and true; otherwise it will return -1 and false.
 func Find(slice *[]string, val string) (int, bool) {
 	for i, item := range *slice {