Merge pull request #7 from goinsane/develop

v1.1.0

Author: orkunkaraduman

erf.go

@@ -37,35 +37,47 @@ func (e *Erf) Unwrap() error {
 }
 
 // Format is implementation of fmt.Formatter.
-// Format formats error message and lists all StackTrace's line by line with given format.
+// Format lists error messages and appends StackTrace's for underlying Erf and all of wrapped Erf's,
+// line by line with given format.
 //
-// For '%s' (also '%v'):
-// 	%s       just show first error message (default: padding char '\t', padding 0, indent 1)
-// 	%+s      show error message with indent, append stack trace using format '%+s'
-// 	%#s      use file name as file path for StackCaller
-// 	%-s      use ' ' as padding char (padding 0, indent 2)
-// 	%0s      show only first error even verb '+' was given
-// 	% s      exact with %0s
-// 	%4s      padding 4, default indent
-// 	%.3s     default padding, indent 3
-// 	%4.3s    padding 4, indent 3
-// 	%4.s     padding 4, indent 0
+// For '%v' (also '%s'):
+// 	%v       just show the first error message without padding and indent.
+//
+// For '%x' and '%X':
+// 	%x       list all error messages by using indent and show StackTrace of errors by using format '%+s'.
+// 	% x      list all error messages by using indent and show StackTrace of errors by using format '% s'.
+// 	%#x      list all error messages by using indent and show StackTrace of errors by using format '%#s'.
+// 	% #x     list all error messages by using indent and show StackTrace of errors by using format '% #s'.
+// 	%X       show the first error message by using indent and show the StackTrace of error by using format '%+s'.
+// 	% X      show the first error message by using indent and show the StackTrace of error by using format '% s'.
+// 	%#X      show the first error message by using indent and show the StackTrace of error by using format '%#s'.
+// 	% #X     show the first error message by using indent and show the StackTrace of error by using format '% #s'.
+// 	%-x      don't show any error messages, just show all of StackTrace of errors.
+// 	%-X      don't show the error message, just show the StackTrace of the first error.
+// 	%4x      same with '%x', padding 4, indent 1 by default.
+// 	%.3x     same with '%x', padding 0 by default, indent 3.
+// 	%4.3x    same with '%x', padding 4, indent 3.
+// 	%4.x     same with '%x', padding 4, indent 0.
+// 	% 4x     same with '% x', padding 4, indent 2 by default.
+// 	% .3x    same with '% x', padding 0 by default, indent 3.
+// 	% 4.3x   same with '% x', padding 4, indent 3.
+// 	% 4.x    same with '% x', padding 4, indent 0.
+// 	%#4.3x   same with '%#x', padding 4, indent 3.
+// 	% #4.3x  same with '% #x', padding 4, indent 3.
 func (e *Erf) Format(f fmt.State, verb rune) {
 	buf := bytes.NewBuffer(make([]byte, 0, 4096))
 	switch verb {
 	case 's', 'v':
-		if !f.Flag('+') {
-			buf.WriteString(e.err.Error())
-			break
-		}
+		buf.WriteString(e.err.Error())
+	case 'x', 'X':
 		format := "%+"
-		for _, r := range []rune{'-', '#'} {
+		for _, r := range []rune{' ', '#'} {
 			if f.Flag(int(r)) {
 				format += string(r)
 			}
 		}
 		pad, wid, prec := byte('\t'), 0, 1
-		if f.Flag('-') {
+		if f.Flag(' ') {
 			pad = ' '
 			prec = 2
 		}
@@ -79,35 +91,33 @@ func (e *Erf) Format(f fmt.State, verb rune) {
 		format += "s"
 		padding := bytes.Repeat([]byte{pad}, wid)
 		indent := bytes.Repeat([]byte{pad}, prec)
-		for _, line := range strings.Split(e.err.Error(), "\n") {
-			buf.Write(padding)
-			buf.Write(indent)
-			buf.WriteString(line)
-			buf.WriteRune('\n')
-		}
-		buf.WriteString(fmt.Sprintf(format, e.StackTrace()))
-		buf.WriteRune('\n')
-		if !f.Flag('0') && !f.Flag(' ') {
-			for err := e.Unwrap(); err != nil; {
-				if e2, ok := err.(*Erf); ok {
+		count := 0
+		for err := error(e); err != nil; {
+			if e2, ok := err.(*Erf); ok {
+				if count > 0 {
 					buf.WriteRune('\n')
+				}
+				count++
+				if !f.Flag('-') {
 					for _, line := range strings.Split(e2.err.Error(), "\n") {
 						buf.Write(padding)
 						buf.Write(indent)
 						buf.WriteString(line)
 						buf.WriteRune('\n')
 					}
-					buf.WriteString(fmt.Sprintf(format, e2.StackTrace()))
-					buf.WriteRune('\n')
 				}
-				if wErr, ok := err.(WrappedError); ok {
-					err = wErr.Unwrap()
-				} else {
-					err = nil
+				buf.WriteString(fmt.Sprintf(format, e2.StackTrace()))
+				buf.WriteRune('\n')
+				if verb == 'X' {
+					break
 				}
 			}
+			if wErr, ok := err.(WrappedError); ok {
+				err = wErr.Unwrap()
+			} else {
+				err = nil
+			}
 		}
-		buf.WriteRune('\n')
 	default:
 		return
 	}

erf_test.go

@@ -8,41 +8,56 @@ import (
 
 func ExampleErf() {
 	e := erf.New("an example erf error")
-	e2 := erf.Wrap(e)
+	err := erf.Errorf("we have an example error: %w", e)
 
-	fmt.Println("just show first error message (default: padding char '\\t', padding 0, indent 1)")
-	fmt.Printf("%s\n\n", e2)
+	fmt.Println("just show the first error message without padding and indent.")
+	fmt.Printf("%v\n\n", err)
 
-	fmt.Println("show error message with indent, append stack trace")
-	fmt.Printf("%+s\n\n", e2)
+	fmt.Println("list all error messages by using indent and show StackTrace of errors by using format '%+s'.")
+	fmt.Printf("%x\n\n", err)
 
-	fmt.Println("show first error message with indent, append stack trace")
-	fmt.Printf("%+ s\n\n", e2)
+	fmt.Println("list all error messages by using indent and show StackTrace of errors by using format '% s'.")
+	fmt.Printf("% x\n\n", err)
 
-	fmt.Println("use file name as file path for StackCaller")
-	fmt.Printf("%+#s\n\n", e2)
+	fmt.Println("list all error messages by using indent and show StackTrace of errors by using format '%#s'.")
+	fmt.Printf("%#x\n\n", err)
 
-	fmt.Println("padding 2, indent 1 by default")
-	fmt.Printf("%+#2s\n\n", e2)
+	fmt.Println("list all error messages by using indent and show StackTrace of errors by using format '% #s'.")
+	fmt.Printf("% #x\n\n", err)
 
-	fmt.Println("padding 2, indent 3")
-	fmt.Printf("%+#2.3s\n\n", e2)
+	fmt.Println("show the first error message by using indent and show the StackTrace of error by using format '%+s'.")
+	fmt.Printf("%X\n\n", err)
 
-	fmt.Println("use ' ' as padding char (padding 0, indent 2)")
-	fmt.Printf("%-s\n\n", e2)
+	fmt.Println("show the first error message by using indent and show the StackTrace of error by using format '% s'.")
+	fmt.Printf("% X\n\n", err)
 
-	fmt.Println("show error message with indent, append stack trace")
-	fmt.Printf("%-+s\n\n", e2)
+	fmt.Println("show the first error message by using indent and show the StackTrace of error by using format '%#s'.")
+	fmt.Printf("%#X\n\n", err)
 
-	fmt.Println("show first error message with indent, append stack trace")
-	fmt.Printf("%-+ s\n\n", e2)
+	fmt.Println("show the first error message by using indent and show the StackTrace of error by using format '% #s'.")
+	fmt.Printf("% #X\n\n", err)
 
-	fmt.Println("use file name as file path for StackCaller")
-	fmt.Printf("%-+#s\n\n", e2)
+	fmt.Println("don't show any error messages, just show all of StackTrace of errors.")
+	fmt.Printf("%-x\n\n", err)
 
-	fmt.Println("padding 2, indent 2 by default")
-	fmt.Printf("%-+#2s\n\n", e2)
+	fmt.Println("don't show the error message, just show the StackTrace of the first error.")
+	fmt.Printf("%-X\n\n", err)
 
-	fmt.Println("padding 2, indent 3")
-	fmt.Printf("%-+#2.3s\n\n", e2)
+	fmt.Println("padding 2, indent 1 by default. padding char '\\t'.")
+	fmt.Printf("%2x\n\n", err)
+
+	fmt.Println("padding 2, indent 3. padding char '\\t'.")
+	fmt.Printf("%2.3x\n\n", err)
+
+	fmt.Println("padding 0 by default, indent 3. padding char '\\t'.")
+	fmt.Printf("%.3x\n\n", err)
+
+	fmt.Println("padding 2, indent 2 by default. padding char ' '.")
+	fmt.Printf("% 2x\n\n", err)
+
+	fmt.Println("padding 2, indent 3. padding char ' '.")
+	fmt.Printf("% 2.3x\n\n", err)
+
+	fmt.Println("padding 0 by default, indent 3. padding char ' '.")
+	fmt.Printf("% .3x\n\n", err)
 }

examples/.gitignore

@@ -0,0 +1 @@
+/example_dev.go

examples/erf.go

@@ -40,43 +40,53 @@ func Baz(z int) error {
 }
 
 func main() {
-	fmt.Println("#### Foo: just show error text")
+	fmt.Println("#### Foo: just the show first error message without padding and indent")
 	if err := Foo(-1); err != nil {
 		fmt.Printf("%v\n", err)
 	}
 
 	fmt.Println("#### Foo: show with stack trace")
 	if err := Foo(-2); err != nil {
-		fmt.Printf("%+v\n", err)
+		fmt.Printf("%x\n", err)
 	}
 
 	fmt.Println("#### Foo: show with stack trace, and use space as whitespace instead of tab")
 	if err := Foo(-3); err != nil {
-		fmt.Printf("%+-v\n", err)
+		fmt.Printf("% x\n", err)
 	}
 
-	fmt.Println("#### Foo: show with last stack trace")
+	fmt.Println("#### Foo: show with first stack trace")
 	if err := Foo(-4); err != nil {
-		fmt.Printf("%+0v\n", err)
+		fmt.Printf("%X\n", err)
 	}
 
 	fmt.Println("#### Foo: show with stack trace with only file names except full path")
 	if err := Foo(-5); err != nil {
-		fmt.Printf("%+#v\n", err)
+		fmt.Printf("%#x\n", err)
 	}
 
 	fmt.Println("#### Foo: show with stack trace with 2 whitespace chars of padding and 1 whitespace char of indent")
 	if err := Foo(-6); err != nil {
-		fmt.Printf("%+2.1v\n", err)
+		fmt.Printf("%2.1x\n", err)
 	}
 
 	fmt.Println("#### Bar: show with stack trace")
 	if err := Bar(-7); err != nil {
-		fmt.Printf("%+v\n", err)
+		fmt.Printf("%x\n", err)
 	}
 
 	fmt.Println("#### Baz: show with stack trace")
 	if err := Baz(-8); err != nil {
-		fmt.Printf("%+v\n", err)
+		fmt.Printf("%x\n", err)
+	}
+
+	fmt.Println("#### Baz: just show all of stack traces of errors")
+	if err := Baz(-9); err != nil {
+		fmt.Printf("%-x\n", err)
+	}
+
+	fmt.Println("#### Baz: just show the stack trace of the first error")
+	if err := Baz(-10); err != nil {
+		fmt.Printf("%-X\n", err)
 	}
 }