bug #15 Do not break out quoted text in block formatting (tucksaun)

This PR was merged into the main branch.

Discussion
----------

Do not break out quoted text in block formatting

Quite often, we have to output a long path in warning blocks.
In order to ease the reading of those, `@kocal` suggested we try not to break lines within quoted text when formatting blocks.
That seemed like a good idea, so here it is

Commits
-------

4026741 Do not break out quoted text in block formatting

Author: fabpot

block.go

@@ -62,18 +62,28 @@ func splitsBlockLines(msg string, width int) ([]string, int) {
 	for _, line := range strings.Split(msg, "\n") {
 		line = strings.ReplaceAll(line, "\t", "        ")
 		lastLinePos := 0
+		lastOpeningQuotePos := 0
 		inAnOpeningTag := false
 		inAClosingTag := false
 		inATagBody := false
+		inQuotes := false
 		length := 0
 		var lastChar rune
 		for pos, char := range line {
-			if char == '<' && lastChar != '\\' {
-				if len(line) > pos+1 && line[pos+1] == '/' {
-					inAClosingTag = true
-					inATagBody = false
-				} else {
-					inAnOpeningTag = true
+			if lastChar != '\\' {
+				switch char {
+				case '<':
+					if len(line) > pos+1 && line[pos+1] == '/' {
+						inAClosingTag = true
+						inATagBody = false
+					} else {
+						inAnOpeningTag = true
+					}
+				case '"':
+					inQuotes = !inQuotes
+					if inQuotes {
+						lastOpeningQuotePos = pos
+					}
 				}
 			}
 
@@ -92,10 +102,18 @@ func splitsBlockLines(msg string, width int) ([]string, int) {
 			}
 
 			if length >= width && !inAClosingTag && !inAnOpeningTag && !inATagBody {
+				// if we cross the line boundary but are currently within a
+				// quoted text, we jump back just before the opening quote
+				// because we don't want to cut the text inside
+				if inQuotes && lastOpeningQuotePos > lastLinePos {
+					length = pos - lastOpeningQuotePos
+					pos = lastOpeningQuotePos - 1
+				} else {
+					maxLen = width
+					length = 0
+				}
 				lines = append(lines, line[lastLinePos:pos+1])
-				maxLen = width
 				lastLinePos = pos + 1
-				length = 0
 			}
 
 			lastChar = char

block_test.go

@@ -45,6 +45,20 @@ func (ts *OutputBlockSuite) TestSplitsBlockLines(c *C) {
 	c.Assert(maxLen, Equals, 3)
 }
 
+func (ts *OutputBlockSuite) TestEnclosedWithQuotes(c *C) {
+	lines, maxLen := splitsBlockLines(`The "foo bar" file has moved to "a very long path". Please consider it.`, 40)
+	c.Assert(lines, DeepEquals, []string{`The "foo bar" file has moved to `, `"a very long path". Please consider it.`})
+	c.Assert(maxLen, Equals, 38)
+
+	lines, maxLen = splitsBlockLines(`The "foo bar" file has moved to "a very very very very very very very very very unterminated long path.`, 40)
+	c.Assert(lines, DeepEquals, []string{`The "foo bar" file has moved to `, `"a very very very very very very very ver`, `y very unterminated long path.`})
+	c.Assert(maxLen, Equals, 40)
+
+	lines, maxLen = splitsBlockLines(`This is an example of a message about a "/very/very/very/very/very/very/very/very/very/very/very/very/very/very/very/very/very/long/path" that needs to be moved to "/another/very/very/very/very/very/very/very/long/path"`, 107)
+	c.Assert(lines, DeepEquals, []string{`This is an example of a message about a `, `"/very/very/very/very/very/very/very/very/very/very/very/very/very/very/very/very/very/long/path" that needs`, ` to be moved to "/another/very/very/very/very/very/very/very/long/path"`})
+	c.Assert(maxLen, Equals, 107)
+}
+
 func (ts *OutputBlockSuite) TestSplitsBlockLinesDonotPanic(c *C) {
 	lines, maxLen := splitsBlockLines("Foo Baz<", 4)
 	c.Assert(lines, DeepEquals, []string{"Foo ", "Baz<"})