tools/list/list.go - master - githubmirror/pocketbase

tools/list/list.go
163 строки4 KB
Gani Georgiev
changed store.Store to accept generic key type
23 дек 2024, 16:44
23 дек 2024, 16:4439df26e
package list

import (
	"encoding/json"
	"regexp"
	"strings"

	"github.com/pocketbase/pocketbase/tools/store"
	"github.com/spf13/cast"
)

var cachedPatterns = store.New[string, *regexp.Regexp](nil)

// SubtractSlice returns a new slice with only the "base" elements
// that don't exist in "subtract".
func SubtractSlice[T comparable](base []T, subtract []T) []T {
	var result = make([]T, 0, len(base))

	for _, b := range base {
		if !ExistInSlice(b, subtract) {
			result = append(result, b)
		}
	}

	return result
}

// ExistInSlice checks whether a comparable element exists in a slice of the same type.
func ExistInSlice[T comparable](item T, list []T) bool {
	for _, v := range list {
		if v == item {
			return true
		}
	}

	return false
}

// ExistInSliceWithRegex checks whether a string exists in a slice
// either by direct match, or by a regular expression (eg. `^\w+$`).
//
// Note: Only list items starting with '^' and ending with '$' are treated as regular expressions!
func ExistInSliceWithRegex(str string, list []string) bool {
	for _, field := range list {
		isRegex := strings.HasPrefix(field, "^") && strings.HasSuffix(field, "$")

		if !isRegex {
			// check for direct match
			if str == field {
				return true
			}
			continue
		}

		// check for regex match
		pattern := cachedPatterns.Get(field)
		if pattern == nil {
			var err error
			pattern, err = regexp.Compile(field)
			if err != nil {
				continue
			}
			// "cache" the pattern to avoid compiling it every time
			// (the limit size is arbitrary and it is there to prevent the cache growing too big)
			//
			// @todo consider replacing with TTL or LRU type cache
			cachedPatterns.SetIfLessThanLimit(field, pattern, 500)
		}

		if pattern != nil && pattern.MatchString(str) {
			return true
		}
	}

	return false
}

// ToInterfaceSlice converts a generic slice to slice of interfaces.
func ToInterfaceSlice[T any](list []T) []any {
	result := make([]any, len(list))

	for i := range list {
		result[i] = list[i]
	}

	return result
}

// NonzeroUniques returns only the nonzero unique values from a slice.
func NonzeroUniques[T comparable](list []T) []T {
	result := make([]T, 0, len(list))
	existMap := make(map[T]struct{}, len(list))

	var zeroVal T

	for _, val := range list {
		if val == zeroVal {
			continue
		}
		if _, ok := existMap[val]; ok {
			continue
		}
		existMap[val] = struct{}{}
		result = append(result, val)
	}

	return result
}

// ToUniqueStringSlice casts `value` to a slice of non-zero unique strings.
func ToUniqueStringSlice(value any) (result []string) {
	switch val := value.(type) {
	case nil:
		// nothing to cast
	case []string:
		result = val
	case string:
		if val == "" {
			break
		}

		// check if it is a json encoded array of strings
		if strings.Contains(val, "[") {
			if err := json.Unmarshal([]byte(val), &result); err != nil {
				// not a json array, just add the string as single array element
				result = append(result, val)
			}
		} else {
			// just add the string as single array element
			result = append(result, val)
		}
	case json.Marshaler: // eg. JSONArray
		raw, _ := val.MarshalJSON()
		_ = json.Unmarshal(raw, &result)
	default:
		result = cast.ToStringSlice(value)
	}

	return NonzeroUniques(result)
}

// ToChunks splits list into chunks.
//
// Zero or negative chunkSize argument is normalized to 1.
//
// See https://go.dev/wiki/SliceTricks#batching-with-minimal-allocation.
func ToChunks[T any](list []T, chunkSize int) [][]T {
	if chunkSize <= 0 {
		chunkSize = 1
	}

	chunks := make([][]T, 0, (len(list)+chunkSize-1)/chunkSize)

	if len(list) == 0 {
		return chunks
	}

	for chunkSize < len(list) {
		list, chunks = list[chunkSize:], append(chunks, list[0:chunkSize:chunkSize])
	}

	return append(chunks, list)
}