Skip to content

Commit

Permalink
Merge pull request #165 from shwoodard/fix-lint
Browse files Browse the repository at this point in the history
Fix golint
  • Loading branch information
shwoodard authored Oct 16, 2018
2 parents 9246c91 + 4a0c98e commit d0428f6
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 17 deletions.
5 changes: 1 addition & 4 deletions errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,7 @@ import (
// http://jsonapi.org/format/#document-top-level
// and here: http://jsonapi.org/format/#error-objects.
func MarshalErrors(w io.Writer, errorObjects []*ErrorObject) error {
if err := json.NewEncoder(w).Encode(&ErrorsPayload{Errors: errorObjects}); err != nil {
return err
}
return nil
return json.NewEncoder(w).Encode(&ErrorsPayload{Errors: errorObjects})
}

// ErrorsPayload is a serializer struct for representing a valid JSON API errors payload.
Expand Down
19 changes: 6 additions & 13 deletions response.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,7 @@ func MarshalPayload(w io.Writer, models interface{}) error {
return err
}

if err := json.NewEncoder(w).Encode(payload); err != nil {
return err
}
return nil
return json.NewEncoder(w).Encode(payload)
}

// Marshal does the same as MarshalPayload except it just returns the payload
Expand Down Expand Up @@ -128,10 +125,7 @@ func MarshalPayloadWithoutIncluded(w io.Writer, model interface{}) error {
}
payload.clearIncluded()

if err := json.NewEncoder(w).Encode(payload); err != nil {
return err
}
return nil
return json.NewEncoder(w).Encode(payload)
}

// marshalOne does the same as MarshalOnePayload except it just returns the
Expand Down Expand Up @@ -195,11 +189,7 @@ func MarshalOnePayloadEmbedded(w io.Writer, model interface{}) error {

payload := &OnePayload{Data: rootNode}

if err := json.NewEncoder(w).Encode(payload); err != nil {
return err
}

return nil
return json.NewEncoder(w).Encode(payload)
}

func visitModelNode(model interface{}, included *map[string]*Node,
Expand Down Expand Up @@ -280,6 +270,9 @@ func visitModelNode(model interface{}, included *map[string]*Node,
// We had a JSON float (numeric), but our field was not one of the
// allowed numeric types
er = ErrBadJSONAPIID
}

if er != nil {
break
}

Expand Down
26 changes: 26 additions & 0 deletions runtime.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,58 @@ import (
"time"
)

// Event represents a lifecycle event in the marshaling or unmarshalling
// process.
type Event int

const (
// UnmarshalStart is the Event that is sent when deserialization of a payload
// begins.
UnmarshalStart Event = iota

// UnmarshalStop is the Event that is sent when deserialization of a payload
// ends.
UnmarshalStop

// MarshalStart is the Event that is sent sent when serialization of a payload
// begins.
MarshalStart

// MarshalStop is the Event that is sent sent when serialization of a payload
// ends.
MarshalStop
)

// Runtime has the same methods as jsonapi package for serialization and
// deserialization but also has a ctx, a map[string]interface{} for storing
// state, designed for instrumenting serialization timings.
type Runtime struct {
ctx map[string]interface{}
}

// Events is the func type that provides the callback for handling event timings.
type Events func(*Runtime, Event, string, time.Duration)

// Instrumentation is a a global Events variable. This is the handler for all
// timing events.
var Instrumentation Events

// NewRuntime creates a Runtime for use in an application.
func NewRuntime() *Runtime { return &Runtime{make(map[string]interface{})} }

// WithValue adds custom state variables to the runtime context.
func (r *Runtime) WithValue(key string, value interface{}) *Runtime {
r.ctx[key] = value

return r
}

// Value returns a state variable in the runtime context.
func (r *Runtime) Value(key string) interface{} {
return r.ctx[key]
}

// Instrument is deprecated.
func (r *Runtime) Instrument(key string) *Runtime {
return r.WithValue("instrument", key)
}
Expand All @@ -45,12 +68,14 @@ func (r *Runtime) shouldInstrument() bool {
return Instrumentation != nil
}

// UnmarshalPayload has docs in request.go for UnmarshalPayload.
func (r *Runtime) UnmarshalPayload(reader io.Reader, model interface{}) error {
return r.instrumentCall(UnmarshalStart, UnmarshalStop, func() error {
return UnmarshalPayload(reader, model)
})
}

// UnmarshalManyPayload has docs in request.go for UnmarshalManyPayload.
func (r *Runtime) UnmarshalManyPayload(reader io.Reader, kind reflect.Type) (elems []interface{}, err error) {
r.instrumentCall(UnmarshalStart, UnmarshalStop, func() error {
elems, err = UnmarshalManyPayload(reader, kind)
Expand All @@ -60,6 +85,7 @@ func (r *Runtime) UnmarshalManyPayload(reader io.Reader, kind reflect.Type) (ele
return
}

// MarshalPayload has docs in response.go for MarshalPayload.
func (r *Runtime) MarshalPayload(w io.Writer, model interface{}) error {
return r.instrumentCall(MarshalStart, MarshalStop, func() error {
return MarshalPayload(w, model)
Expand Down

0 comments on commit d0428f6

Please sign in to comment.