Update vendored package heredoc

This commit is contained in:
tcharding
2017-08-21 16:15:54 +10:00
parent 4aaf39a5c0
commit a542bfddb6
4 changed files with 56 additions and 47 deletions

View File

@@ -1,15 +1,15 @@
// Copyright (c) 2014 TSUYUSATO Kitsune
// Copyright (c) 2014-2017 TSUYUSATO Kitsune
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
// Package heredoc provides the here-document with keeping indent.
// Package heredoc provides creation of here-documents from raw strings.
//
// Golang supports raw-string syntax.
// doc := `
// Foo
// Bar
// `
// But raw-string cannot recognize indent. Thus such content is indented string, equivalent to
// But raw-string cannot recognize indentation. Thus such content is an indented string, equivalent to
// "\n\tFoo\n\tBar\n"
// I dont't want this!
//
@@ -18,7 +18,7 @@
// Foo
// Bar
// `)
// It is equivalent to
// Is equivalent to
// "Foo\nBar\n"
package heredoc
@@ -28,11 +28,9 @@ import (
"unicode"
)
// heredoc.Doc retutns unindented string as here-document.
//
// Process of making here-document:
// 1. Find most little indent size. (Skip empty lines)
// 2. Remove this indents of lines.
const maxInt = int(^uint(0) >> 1)
// Doc returns un-indented string as here-document.
func Doc(raw string) string {
skipFirstLine := false
if raw[0] == '\n' {
@@ -41,10 +39,18 @@ func Doc(raw string) string {
skipFirstLine = true
}
minIndentSize := int(^uint(0) >> 1) // Max value of type int
lines := strings.Split(raw, "\n")
// 1.
minIndentSize := getMinIndent(lines, skipFirstLine)
lines = removeIndentation(lines, minIndentSize, skipFirstLine)
return strings.Join(lines, "\n")
}
// getMinIndent calculates the minimum indentation in lines, excluding empty lines.
func getMinIndent(lines []string, skipFirstLine bool) int {
minIndentSize := maxInt
for i, line := range lines {
if i == 0 && skipFirstLine {
continue
@@ -67,23 +73,26 @@ func Doc(raw string) string {
minIndentSize = indentSize
}
}
return minIndentSize
}
// 2.
// removeIndentation removes n characters from the front of each line in lines.
// Skips first line if skipFirstLine is true, skips empty lines.
func removeIndentation(lines []string, n int, skipFirstLine bool) []string {
for i, line := range lines {
if i == 0 && skipFirstLine {
continue
}
if len(lines[i]) >= minIndentSize {
lines[i] = line[minIndentSize:]
if len(lines[i]) >= n {
lines[i] = line[n:]
}
}
return strings.Join(lines, "\n")
return lines
}
// heredoc.Docf returns unindented and formatted string as here-document.
// This format is same with package fmt's format.
// Docf returns unindented and formatted string as here-document.
// Formatting is done as for fmt.Printf().
func Docf(raw string, args ...interface{}) string {
return fmt.Sprintf(Doc(raw), args...)
}