Documentation
¶
Overview ¶
Package utils provides utility functions for commonmeta.
Index ¶
- func CamelCaseString(str string) string
- func CamelCaseToWords(str string) string
- func DecodeDOI(doi string) int64
- func DedupeSlice[T comparable](sliceList []T) []T
- func EncodeDOI(prefix string) string
- func FindFromFormat(p params) string
- func FindFromFormatByDict(dct map[string]interface{}) string
- func FindFromFormatByExt(ext string) string
- func FindFromFormatByFilename(filename string) string
- func FindFromFormatByID(id string) string
- func FindFromFormatByString(str string) string
- func ISSNAsURL(issn string) string
- func NormalizeCCUrl(url string) (string, bool)
- func NormalizeID(pid string) string
- func NormalizeORCID(orcid string) string
- func NormalizeROR(ror string) string
- func NormalizeURL(str string, secure bool, lower bool) (string, error)
- func Sanitize(html string) string
- func TitleCase(str string) string
- func URLToSPDX(url string) string
- func UnescapeUTF8(inStr string) (outStr string, err error)
- func ValidateID(id string) (string, string)
- func ValidateISSN(issn string) (string, bool)
- func ValidateORCID(orcid string) (string, bool)
- func ValidateROR(ror string) (string, bool)
- func ValidateURL(str string) string
- func ValidateUUID(uuid string) (string, bool)
- type ROR
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CamelCaseString ¶ added in v0.3.1
CamelCaseString converts a pascal case string to camel case
func CamelCaseToWords ¶ added in v0.2.14
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s := utils.CamelCaseToWords("earthAndRelatedEnvironmentalSciences")
fmt.Println(s)
}
Output: Earth and related environmental sciences
func DecodeDOI ¶ added in v0.2.14
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
i := utils.DecodeDOI("https://doi.org/10.73731/rxadv-a6v29")
fmt.Println(i)
}
Output: 10.73731
func DedupeSlice ¶
func DedupeSlice[T comparable](sliceList []T) []T
DedupeSlice removes duplicates from a slice https://stackoverflow.com/questions/66643946/how-to-remove-duplicates-strings-or-int-from-slice-in-go/76948712#76948712
func EncodeDOI ¶ added in v0.2.14
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s := utils.EncodeDOI("10.73731")
fmt.Println(s)
}
Output: https://doi.org/10.73731/rxadv-a6v29
func FindFromFormat ¶
func FindFromFormat(p params) string
FindFromFormat finds the commonmeta read format
func FindFromFormatByDict ¶
FindFromFormatByDict finds the commonmeta reader from format by dictionary
func FindFromFormatByExt ¶
FindFromFormatByExt finds the commonmeta reader from format by file extension
func FindFromFormatByFilename ¶
FindFromFormatByFilename finds the commonmeta reader from format by filename
func FindFromFormatByID ¶
FindFromFormatByID finds the commonmeta reader from format by id
func FindFromFormatByString ¶
FindFromFormatByString finds the commonmeta reader from format by string
func ISSNAsURL ¶ added in v0.2.1
ISSNAsURL returns the ISSN expressed as URL
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s := utils.ISSNAsURL("2146-8427")
fmt.Println(s)
}
Output: https://portal.issn.org/resource/ISSN/2146-8427
func NormalizeCCUrl ¶
NormalizeCCUrl returns the normalized Creative Commons License URL
func NormalizeID ¶
NormalizeID checks for valid DOI or HTTP(S) URL and normalizes them
func NormalizeORCID ¶
NormalizeORCID returns a normalized ORCID URL
func NormalizeURL ¶ added in v0.2.1
NormalizeURL normalizes URL
func Sanitize ¶
Sanitize removes all HTML tags except for a whitelist of allowed tags. Used for title and description fields.
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s := utils.Sanitize("<p>The Origins of SARS-CoV-2: A <i>Critical</i> <a href=\"index.html\">Review</a></p>")
fmt.Println(s)
}
Output: The Origins of SARS-CoV-2: A <i>Critical</i> Review
func TitleCase ¶ added in v0.2.8
TitleCase capitalizes the first letter of a string without changing the rest
func URLToSPDX ¶ added in v0.2.1
URLToSPDX provides the SPDX license ID given a Creative Commons URL
func UnescapeUTF8 ¶ added in v0.2.1
UnescapeUTF8 unescapes UTF-8 characters
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s, err := utils.UnescapeUTF8("capable of signi\"cance.")
if err != nil {
fmt.Println(err)
}
fmt.Println(s)
}
Output: capable of signi"cance.
func ValidateID ¶ added in v0.2.14
ValidateID validates an identifier and returns the type Can be DOI, UUID, ISSN, ORCID, ROR, URL
func ValidateISSN ¶ added in v0.2.14
ValidateISSN validates an ISSN
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s, _ := utils.ValidateISSN("https://portal.issn.org/resource/ISSN/2146-8427")
fmt.Println(s)
}
Output: 2146-8427
func ValidateORCID ¶
ValidateORCID validates an ORCID
func ValidateROR ¶
ValidateROR validates a ROR
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s, _ := utils.ValidateROR("https://ror.org/0342dzm54")
fmt.Println(s)
}
Output: 0342dzm54
func ValidateURL ¶ added in v0.2.1
ValidateURL validates a URL and checks if it is a DOI
func ValidateUUID ¶ added in v0.2.14
ValidateUUID validates a UUID
Example ¶
package main
import (
"fmt"
"github.com/front-matter/commonmeta/utils"
)
func main() {
s, _ := utils.ValidateUUID("2491b2d5-7daf-486b-b78b-e5aab48064c1")
fmt.Println(s)
}
Output: 2491b2d5-7daf-486b-b78b-e5aab48064c1
Types ¶
type ROR ¶ added in v0.2.14
type ROR struct {
ID string `json:"id"`
Name string `json:"name"`
Types []string `json:"types"`
ExternalIds struct {
FundRef struct {
Preferred string `json:"preferred"`
All []string `json:"all"`
} `json:"FundRef"`
} `json:"external_ids"`
}
ROR represents a Research Organization Registry (ROR) record
Source Files