1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
// Copyright © 2019 The Homeport Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
/*
Package text contains convenience functions for creating strings
*/
package text
import (
"bytes"
"fmt"
"math/rand"
"strconv"
"strings"
"time"
"github.com/gonvenience/bunt"
)
const chars = "abcdefghijklmnopqrstuvwxyz"
func init() {
rand.Seed(time.Now().UTC().UnixNano())
}
// RandomString creates a string with random content and a given length
func RandomString(length int) string {
if length < 0 {
panic(fmt.Errorf("negative length value"))
}
tmp := make([]byte, length)
for i := range tmp {
tmp[i] = chars[rand.Intn(len(chars))]
}
return string(tmp)
}
// RandomStringWithPrefix creates a string with the provided prefix and
// additional random content so that the whole string has the given length.
func RandomStringWithPrefix(prefix string, length int) string {
if length < 0 {
panic(fmt.Errorf("negative length value"))
}
if len(prefix) > length {
panic(fmt.Errorf("given prefix length exceeds given length"))
}
return prefix + RandomString(length-len(prefix))
}
// FixedLength expands or trims the given text to the provided length
func FixedLength(text string, length int, ellipsisOverride ...string) string {
var ellipsis = " […]"
if len(ellipsisOverride) > 0 {
ellipsis = ellipsisOverride[0]
}
textLength := bunt.PlainTextLength(text)
ellipsisLen := bunt.PlainTextLength(ellipsis)
switch {
case textLength < length: // padding required
return text + strings.Repeat(" ", length-textLength)
case textLength > length:
return bunt.Substring(text, 0, length-ellipsisLen) + ellipsis
default:
return text
}
}
// Plural returns a string with the number and noun in either singular or plural form.
// If one text argument is given, the plural will be done with the plural s. If two
// arguments are provided, the second text is the irregular plural. If more than two
// are provided, then the additional ones are simply ignored.
func Plural(amount int, text ...string) string {
words := [...]string{"no", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve"}
var number string
if amount < len(words) {
number = words[amount]
} else {
number = strconv.Itoa(amount)
}
switch len(text) {
case 1:
if amount == 1 {
return fmt.Sprintf("%s %s", number, text[0])
}
return fmt.Sprintf("%s %ss", number, text[0])
default:
if amount == 1 {
return fmt.Sprintf("%s %s", number, text[0])
}
return fmt.Sprintf("%s %s", number, text[1])
}
}
// List creates a list of the string entries with commas and an ending "and"
func List(list []string) string {
switch len(list) {
case 1:
return list[0]
case 2:
return fmt.Sprintf("%s and %s", list[0], list[1])
default:
var buf bytes.Buffer
for idx, entry := range list {
fmt.Fprint(&buf, entry)
if idx < len(list)-2 {
fmt.Fprint(&buf, ", ")
} else if idx < len(list)-1 {
fmt.Fprint(&buf, ", and ")
}
}
return buf.String()
}
}
|
