string.go

// Package slicer contains utility classes for handling slices
package slicer

// Imports
import "sort"
import "strings"

// StringSlicer handles slices of string
type StringSlicer struct {
	slice []string
}

// String creates a new StringSlicer
func String(slice ...[]string) *StringSlicer {
	if len(slice) > 0 {
		return &StringSlicer{slice: slice[0]}
	}
	return &StringSlicer{}
}

// Add a string value to the slicer
func (s *StringSlicer) Add(value string, additional ...string) {
	s.slice = append(s.slice, value)
	s.slice = append(s.slice, additional...)
}

// AddUnique adds a string value to the slicer if it does not already exist
func (s *StringSlicer) AddUnique(value string, additional ...string) {

	if !s.Contains(value) {
		s.slice = append(s.slice, value)
	}

	// Add additional values
	for _, value := range additional {
		if !s.Contains(value) {
			s.slice = append(s.slice, value)
		}
	}
}

// AddSlice adds a string slice to the slicer
func (s *StringSlicer) AddSlice(value []string) {
	s.slice = append(s.slice, value...)
}

// AsSlice returns the slice
func (s *StringSlicer) AsSlice() []string {
	return s.slice
}

// AddSlicer appends a StringSlicer to the slicer
func (s *StringSlicer) AddSlicer(value *StringSlicer) {
	s.slice = append(s.slice, value.AsSlice()...)
}

// Filter the slice based on the given function
func (s *StringSlicer) Filter(fn func(string) bool) *StringSlicer {
	result := &StringSlicer{}
	for _, elem := range s.slice {
		if fn(elem) {
			result.Add(elem)
		}
	}
	return result
}

// Each runs a function on every element of the slice
func (s *StringSlicer) Each(fn func(string)) {
	for _, elem := range s.slice {
		fn(elem)
	}
}

// Contains indicates if the given value is in the slice
func (s *StringSlicer) Contains(matcher string) bool {
	result := false
	for _, elem := range s.slice {
		if elem == matcher {
			result = true
		}
	}
	return result
}

// Length returns the number of elements in the slice
func (s *StringSlicer) Length() int {
	return len(s.slice)
}

// Clear all elements in the slice
func (s *StringSlicer) Clear() {
	s.slice = []string{}
}

// Deduplicate removes duplicate values from the slice
func (s *StringSlicer) Deduplicate() {

	result := &StringSlicer{}

	for _, elem := range s.slice {
		if !result.Contains(elem) {
			result.Add(elem)
		}
	}

	s.slice = result.AsSlice()
}

// Join returns a string with the slicer elements separated by the given separator
func (s *StringSlicer) Join(separator string) string {
	return strings.Join(s.slice, separator)
}

// Sort the slice values
func (s *StringSlicer) Sort() {
	sort.Strings(s.slice)
}