Move zap support to subpackage (#13)

Depending on bark shouldn't impose a dependency on zap.

This moves zap support into a zbark subpackage.

Makefile

@@ -1,7 +1,7 @@
 .PHONY: test
 test:
 	go build -o testhelp/fatal testhelp/fatal.go
-	go test -v
+	go test -v . ./zbark
 
 .PHONY: get-deps
 get-deps:

interface.go

@@ -30,7 +30,6 @@ import (
 
 	"github.com/cactus/go-statsd-client/statsd"
 	"github.com/sirupsen/logrus"
-	"go.uber.org/zap"
 )
 
 // Logger is an interface for loggers accepted by Uber's libraries.
@@ -107,11 +106,6 @@ func NewLoggerFromLogrus(logger *logrus.Logger) Logger {
 	return newBarkLogrusLogger(logger)
 }
 
-// NewLoggerFromZap create a bark-compliant wrapper for a zap-brand logger.
-func NewLoggerFromZap(logger *zap.Logger) Logger {
-	return newBarkZapLogger(logger)
-}
-
 // Tags is an alias of map[string]string, a type for tags associated with a statistic
 type Tags map[string]string
 

zbark/doc.go

@@ -0,0 +1,20 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+// Package zbark integrates Bark with Zap (go.uber.org/zap).
+package zbark

zap_logger.go → zbark/zap_logger.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2015 Uber Technologies, Inc.
+// Copyright (c) 2017 Uber Technologies, Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
@@ -16,26 +16,29 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-package bark
+package zbark
 
 import (
 	"sort"
 
+	"github.com/uber-common/bark"
+
 	"go.uber.org/zap"
 )
 
-func newBarkZapLogger(l *zap.Logger) Logger {
+// New builds a Bark logger from a Zap logger.
+func New(l *zap.Logger) bark.Logger {
 	return barkZapLogger{l.Sugar()}
 }
 
 type barkZapLogger struct{ *zap.SugaredLogger }
 
-func (l barkZapLogger) WithField(key string, value interface{}) Logger {
+func (l barkZapLogger) WithField(key string, value interface{}) bark.Logger {
 	l.SugaredLogger = l.SugaredLogger.With(key, value) // safe to change because we pass-by-value
 	return l
 }
 
-func (l barkZapLogger) WithFields(keyValues LogFields) Logger {
+func (l barkZapLogger) WithFields(keyValues bark.LogFields) bark.Logger {
 	barkFields := keyValues.Fields()
 
 	// Deterministic ordering of fields.
@@ -54,12 +57,12 @@ func (l barkZapLogger) WithFields(keyValues LogFields) Logger {
 	return l
 }
 
-func (l barkZapLogger) WithError(err error) Logger {
+func (l barkZapLogger) WithError(err error) bark.Logger {
 	l.SugaredLogger = l.SugaredLogger.With(zap.Error(err)) // safe to change because we pass-by-value
 	return l
 }
 
-func (l barkZapLogger) Fields() Fields {
+func (l barkZapLogger) Fields() bark.Fields {
 	l.SugaredLogger.Warn("Fields() call to bark logger is not supported by Zap")
 	return nil
 }

zap_logger_test.go → zbark/zap_logger_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2015 Uber Technologies, Inc.
+// Copyright (c) 2017 Uber Technologies, Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
@@ -16,13 +16,14 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-package bark_test
+package zbark_test
 
 import (
 	"errors"
 	"testing"
 
 	"github.com/uber-common/bark"
+	"github.com/uber-common/bark/zbark"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -35,7 +36,7 @@ func newTestLogger() (bark.Logger, *observer.ObservedLogs) {
 	core, logs := observer.New(zap.LevelEnablerFunc(func(zapcore.Level) bool {
 		return true
 	}))
-	return bark.NewLoggerFromZap(zap.New(core)), logs
+	return zbark.New(zap.New(core)), logs
 }
 
 func TestBarkLoggerWith(t *testing.T) {