Minor code cleanup; updated docs and travis-ci test matrix

Author: alex-alrux

.travis.yml

@@ -1,18 +1,19 @@
 language: go
 
 go:
+  - 1.8
   - 1.7.5
   - 1.7.4
   - 1.7.3
   - 1.7.2
   - 1.7.1
   - 1.7
+  - tip
   - 1.6.4
   - 1.6.3
   - 1.6.2
   - 1.6.1
   - 1.6
-  - tip
   - 1.5.4
   - 1.5.3
   - 1.5.2
@@ -32,15 +33,16 @@ go:
   - 1.1.2
   - 1.1.1
   - 1.1
-  - 1.0.3
-  - 1.0.2
-  - 1.0.1
-  - 1
 
 matrix:
   fast_finish: true
   allow_failures:
     - go: tip
+    - go: 1.6.4
+    - go: 1.6.3
+    - go: 1.6.2
+    - go: 1.6.1
+    - go: 1.6
     - go: 1.5.4
     - go: 1.5.3
     - go: 1.5.2
@@ -60,7 +62,3 @@ matrix:
     - go: 1.1.2
     - go: 1.1.1
     - go: 1.1
-    - go: 1.0.3
-    - go: 1.0.2
-    - go: 1.0.1
-    - go: 1

README.md

@@ -1,19 +1,22 @@
 # A Go package for handling of runtime panics
 
-Package calmly implements convenient runtime panic recovery and handling in [Go](http://golang.org).
+[![Release](https://img.shields.io/github/release/agext/calmly.svg?style=flat)](https://github.com/agext/calmly/releases/latest)
+[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/agext/calmly) 
+[![Build Status](https://travis-ci.org/agext/calmly.svg?branch=master&style=flat)](https://travis-ci.org/agext/calmly)
+[![Coverage Status](https://coveralls.io/repos/github/agext/calmly/badge.svg?style=flat)](https://coveralls.io/github/agext/calmly)
+[![Go Report Card](https://goreportcard.com/badge/github.com/agext/calmly?style=flat)](https://goreportcard.com/report/github.com/agext/calmly)
+
 
-## Maturity
+Package calmly implements convenient runtime panic recovery and handling in [Go](http://golang.org).
 
-[![Build Status](https://travis-ci.org/agext/calmly.svg?branch=master)](https://travis-ci.org/agext/calmly)
+## Project Status
 
-v1.0 Stable: Guaranteed no breaking changes to the API in future v1.x releases. No known bugs or performance issues. Probably safe to use in production, though provided on "AS IS" basis.
+v1.0.1 Stable: Guaranteed no breaking changes to the API in future v1.x releases. Probably safe to use in production, though provided on "AS IS" basis.
 
 This package is being actively maintained. If you encounter any problems or have any suggestions for improvement, please [open an issue](https://github.com/agext/calmly/issues). Pull requests are welcome.
 
 ## Overview
 
-[![GoDoc](https://godoc.org/github.com/agext/calmly?status.png)](https://godoc.org/github.com/agext/calmly)
-
 When a panic condition needs to be handled by the program (rather than crashing it), wrap the code that can trigger such condition in a `Try`, which allows you to `Catch` the panic for further processing.
 
 The `Outcome` of a `Try`ed code also offers convenience methods to:

calmly.go

@@ -72,90 +72,90 @@ func Try(f interface{}) (o *Outcome) {
 
 // Catch calls the provided function passing the receiver Outcome as argument,
 // only if the Outcome is at PANIC level.
-func (this *Outcome) Catch(f func(*Outcome)) *Outcome {
-	if this.level == PANIC {
-		f(this)
+func (o *Outcome) Catch(f func(*Outcome)) *Outcome {
+	if o.level == PANIC {
+		f(o)
 	}
-	return this
+	return o
 }
 
 // KeepCalm downgrades a PANIC to ERROR level, to avoid triggering a panic upon
 // logging the outcome.
-func (this *Outcome) KeepCalm() *Outcome {
-	if this.level == PANIC {
-		this.level = ERROR
+func (o *Outcome) KeepCalm() *Outcome {
+	if o.level == PANIC {
+		o.level = ERROR
 	}
-	return this
+	return o
 }
 
 // Escalate converts a PANIC into a FATAL condition, to trigger program
 // termination upon logging the outcome.
-func (this *Outcome) Escalate() *Outcome {
-	if this.level == PANIC {
-		this.level = FATAL
+func (o *Outcome) Escalate() *Outcome {
+	if o.level == PANIC {
+		o.level = FATAL
 	}
-	return this
+	return o
 }
 
 // Log sends the error-condition Outcome to the provided log, using the appropriate
 // logging function: FATAL conditions are logged using Fatal(), PANIC using
 // Panic(), and ERROR using Print(). Non-error conditions are not logged
 // because there is no information stored in the Outcome, beside
 // what the Try-ed function returned (and is better suited to log itself).
-func (this *Outcome) Log(log Logger) *Outcome {
-	switch this.level {
+func (o *Outcome) Log(log Logger) *Outcome {
+	switch o.level {
 	case FATAL:
-		log.Fatal(this)
+		log.Fatal(o)
 	case PANIC:
-		log.Panic(this)
+		log.Panic(o)
 	case ERROR:
-		log.Print(this)
+		log.Print(o)
 	}
-	return this
+	return o
 }
 
 // Level returns the error level stored by the receiver.
-func (this *Outcome) Level() int8 {
-	return this.level
+func (o *Outcome) Level() int8 {
+	return o.level
 }
 
 // SetLevel sets the error level stored by the receiver.
-func (this *Outcome) SetLevel(l int8) *Outcome {
+func (o *Outcome) SetLevel(l int8) *Outcome {
 	if levelName(l) != "?" {
-		this.level = l
+		o.level = l
 	}
-	return this
+	return o
 }
 
 // Code returns the error code stored by the receiver.
-func (this *Outcome) Code() int {
-	return this.code
+func (o *Outcome) Code() int {
+	return o.code
 }
 
 // SetCode sets the error code stored by the receiver.
-func (this *Outcome) SetCode(c int) *Outcome {
-	this.code = c
-	return this
+func (o *Outcome) SetCode(c int) *Outcome {
+	o.code = c
+	return o
 }
 
 // Text returns the error text stored by the receiver.
-func (this *Outcome) Text() string {
-	return this.text
+func (o *Outcome) Text() string {
+	return o.text
 }
 
 // SetText sets the error text stored by the receiver.
-func (this *Outcome) SetText(t string) *Outcome {
-	this.text = t
-	return this
+func (o *Outcome) SetText(t string) *Outcome {
+	o.text = t
+	return o
 }
 
 // Info returns the error info stored by the receiver.
-func (this *Outcome) Info() []string {
-	return this.info
+func (o *Outcome) Info() []string {
+	return o.info
 }
 
 // addInfo adds (more) error info to the receiver.
-func (this *Outcome) addInfo(calldepth int, s ...string) *Outcome {
+func (o *Outcome) addInfo(calldepth int, s ...string) *Outcome {
 	for i, line := range s {
 		if line == "debug.stack" {
 			calldepth *= 2
@@ -181,41 +181,41 @@ func (this *Outcome) addInfo(calldepth int, s ...string) *Outcome {
 			break
 		}
 	}
-	this.info = append(this.info, s...)
-	return this
+	o.info = append(o.info, s...)
+	return o
 }
 
 // AddInfo adds (more) error info to the receiver.
-func (this *Outcome) AddInfo(s ...string) *Outcome {
-	return this.addInfo(2, s...)
+func (o *Outcome) AddInfo(s ...string) *Outcome {
+	return o.addInfo(2, s...)
 }
 
 // Value provides the value returned by the Try-ed function, if any.
-func (this *Outcome) Value() interface{} {
-	return this.val
+func (o *Outcome) Value() interface{} {
+	return o.val
 }
 
 // Err provides the error returned by the Try-ed function, if any.
-func (this *Outcome) Err() error {
-	return this.err
+func (o *Outcome) Err() error {
+	return o.err
 }
 
 // Result provides the value and error returned by the Try-ed function, if any.
-func (this *Outcome) Result() (interface{}, error) {
-	return this.val, this.err
+func (o *Outcome) Result() (interface{}, error) {
+	return o.val, o.err
 }
 
 // Error returns a string representation of the Outcome if it is in an error condition,
 // or an empty string if no error or panic occurred. Note that the Try-ed function
 // returning a non-nil error does not constitute an error condition for the Outcome.
 // That error value can be retrieved via Err or Result.
 // This is also useful for satisfying the `error` interface.
-func (this *Outcome) Error() string {
-	if this.level == OK {
+func (o *Outcome) Error() string {
+	if o.level == OK {
 		return ""
 	}
-	if this.code != 0 {
-		return this.text + fmt.Sprintf(" (code: 0x%04x)", this.code)
+	if o.code != 0 {
+		return o.text + fmt.Sprintf(" (code: 0x%04x)", o.code)
 	}
-	return this.text
+	return o.text
 }

calmly_test.go

@@ -24,14 +24,14 @@ type mockLogger struct {
 	log string
 }
 
-func (this *mockLogger) Print(s ...interface{}) {
-	this.log += fmt.Sprintln(s...)
+func (ml *mockLogger) Print(s ...interface{}) {
+	ml.log += fmt.Sprintln(s...)
 }
-func (this *mockLogger) Fatal(s ...interface{}) {
-	this.log += "[FATAL] " + fmt.Sprintln(s...)
+func (ml *mockLogger) Fatal(s ...interface{}) {
+	ml.log += "[FATAL] " + fmt.Sprintln(s...)
 }
-func (this *mockLogger) Panic(s ...interface{}) {
-	this.log += "[PANIC] " + fmt.Sprintln(s...)
+func (ml *mockLogger) Panic(s ...interface{}) {
+	ml.log += "[PANIC] " + fmt.Sprintln(s...)
 }
 
 func TestLevelNames(t *testing.T) {
@@ -131,7 +131,7 @@ func TestStack(t *testing.T) {
 	}
 	divByZero := func() {
 		a, b := 1, 0
-		a /= b
+		_ = a / b
 	}
 
 	out := Try(divByZero)
@@ -213,7 +213,7 @@ func TestStack(t *testing.T) {
 		t.Errorf(`Try(goodFunc).Err() = %v, want %v`, oe, nil)
 	}
 	if orv, ore := out.Result(); orv != ov || ore != oe {
-		t.Errorf(`Try(goodFunc).Result() should equal (Try(goodFunc).Value(), Try(goodFunc).Err()); got (%v, %v != %v, $v)`, orv, ore, ov, oe)
+		t.Errorf(`Try(goodFunc).Result() should equal (Try(goodFunc).Value(), Try(goodFunc).Err()); got (%v, %v != %v, %v)`, orv, ore, ov, oe)
 	}
 	if oes, exp := out.Error(), ""; oes != exp {
 		t.Errorf(`Try(goodFunc).Error() = %q, want %q`, oes, exp)
@@ -246,7 +246,7 @@ func TestStack(t *testing.T) {
 		t.Errorf(`Try(badFunc).Err() = %v, want %v`, oe, nil)
 	}
 	if orv, ore := out.Result(); orv != ov || ore != oe {
-		t.Errorf(`Try(badFunc).Result() should equal (Try(badFunc).Value(), Try(badFunc).Err()); got (%v, %v != %v, $v)`, orv, ore, ov, oe)
+		t.Errorf(`Try(badFunc).Result() should equal (Try(badFunc).Value(), Try(badFunc).Err()); got (%v, %v != %v, %v)`, orv, ore, ov, oe)
 	}
 	if oes, exp := out.Error(), ot; oes != exp {
 		t.Errorf(`Try(badFunc).Error() = %q, want %q`, oes, exp)

helpers.go

@@ -43,6 +43,7 @@ func levelName(l int8) string {
 	return "?"
 }
 
+// Logger defines the interface expected by the Log method of Outcome
 type Logger interface {
 	Fatal(...interface{})
 	Panic(...interface{})