Fix typo and grammar issues

alexandear · alexandear · commit 4599262b7c02 · 2021-11-01T17:25:07.000+02:00
diff --git a/aggregate/aggregate.go b/aggregate/aggregate.go
@@ -13,10 +13,10 @@ import (
 var ErrInvalidID = errors.New("goengine: an aggregate.ID must be a valid UUID")
 
 type (
-	// ID an UUID for a aggregate.Root instance
+	// ID a UUID for a aggregate.Root instance
 	ID string
 
-	// Root is a interface that a AggregateRoot must implement
+	// Root is an interface that a AggregateRoot must implement
 	Root interface {
 		eventSourced
 		eventProducer
@@ -27,7 +27,7 @@ type (
 		AggregateID() ID
 	}
 
-	// EventApplier is a interface so that a Changed event can be applied
+	// EventApplier is an interface so that a Changed event can be applied
 	EventApplier interface {
 		// Apply updates the state of the aggregateRoot based on the recorded event
 		// This method should only be called by the library
@@ -49,7 +49,7 @@ func GenerateID() ID {
 	return ID(uuid.New().String())
 }
 
-// IDFromString creates a ID from a string
+// IDFromString creates an ID from a string
 func IDFromString(str string) (ID, error) {
 	id, err := uuid.Parse(str)
 	if err != nil {
diff --git a/aggregate/aggregate_type.go b/aggregate/aggregate_type.go
@@ -7,15 +7,15 @@ import (
 	"github.com/hellofresh/goengine/v2"
 )
 
-// ErrInitiatorMustReturnRoot occurs when a aggregate.Initiator did not return a pointer
+// ErrInitiatorMustReturnRoot occurs when an aggregate.Initiator did not return a pointer
 var ErrInitiatorMustReturnRoot = errors.New("goengine: the aggregate.Initiator must return a pointer to the aggregate.Root")
 
 type (
 	// Initiator creates a new empty instance of a aggregate.Root
 	// this instance may then be used to reconstitute the state of the aggregate root
 	Initiator func() Root
 
-	// Type an aggregate type represent the type of a aggregate
+	// Type an aggregate type represent the type of aggregate
 	Type struct {
 		name           string
 		initiator      Initiator
@@ -50,7 +50,7 @@ func (t *Type) String() string {
 	return t.name
 }
 
-// IsImplementedBy returns whether the given aggregate root is a instance of this aggregateType
+// IsImplementedBy returns whether the given aggregate root is an instance of this aggregateType
 func (t *Type) IsImplementedBy(root interface{}) bool {
 	if root == nil {
 		return false
@@ -69,7 +69,7 @@ func (t *Type) IsImplementedBy(root interface{}) bool {
 	return t.reflectionType == rootType
 }
 
-// CreateInstance returns an new empty/zero instance of the aggregate root that the type represents
+// CreateInstance returns a new empty/zero instance of the aggregate root that the type represents
 func (t *Type) CreateInstance() Root {
 	return t.initiator()
 }
diff --git a/aggregate/changed.go b/aggregate/changed.go
@@ -19,7 +19,7 @@ var (
 	ErrInvalidChangePayload = errors.New("goengine: a changed event must have a payload that is not nil")
 )
 
-// Changed is a message indicating that a aggregate was changed
+// Changed is a message indicating that an aggregate was changed
 type Changed struct {
 	uuid        goengine.UUID
 	aggregateID ID
diff --git a/aggregate/repository.go b/aggregate/repository.go
@@ -100,7 +100,7 @@ func (r *Repository) GetAggregateRoot(ctx context.Context, aggregateID ID) (Root
 	return root, nil
 }
 
-// enrichEventMetadata add's aggregate_id and aggregate_type as metadata to domainEvent
+// enrichEventMetadata adds aggregate_id and aggregate_type as metadata to domainEvent
 func (r *Repository) enrichMetadata(aggregateEvent *Changed, aggregateID ID) *Changed {
 	domainEvent := aggregateEvent.WithMetadata(IDKey, aggregateID)
 	domainEvent = domainEvent.WithMetadata(TypeKey, r.aggregateType.String())
diff --git a/driver/generic/query_executor.go b/driver/generic/query_executor.go
@@ -7,7 +7,7 @@ import (
 	"github.com/hellofresh/goengine/v2/metadata"
 )
 
-// QueryExecutor is used to run a query against a inmemory event store
+// QueryExecutor is used to run a query against an inmemory event store
 type QueryExecutor struct {
 	store          goengine.EventStore
 	streamName     goengine.StreamName
diff --git a/driver/inmemory/eventstore.go b/driver/inmemory/eventstore.go
@@ -21,7 +21,7 @@ var (
 	_ goengine.EventStore = &EventStore{}
 )
 
-// EventStore a in memory event store implementation
+// EventStore an in memory event store implementation
 type EventStore struct {
 	sync.RWMutex
 
@@ -37,7 +37,7 @@ func NewEventStore(logger goengine.Logger) *EventStore {
 	}
 }
 
-// Create creates a event stream
+// Create creates an event stream
 func (i *EventStore) Create(ctx context.Context, streamName goengine.StreamName) error {
 	if _, found := i.streams[streamName]; found {
 		return ErrStreamExistsAlready
diff --git a/driver/inmemory/matcher.go b/driver/inmemory/matcher.go
@@ -101,7 +101,7 @@ func (m *MetadataMatcher) Matches(metadata metadata.Metadata) bool {
 
 // Matches returns true if the value satisfies the constraint
 func (c *metadataConstraint) Matches(val interface{}) (bool, error) {
-	// Ensure the value's are of the same type
+	// Ensure the values are of the same type
 	if valType := reflect.TypeOf(val); valType != c.valueType {
 		// The types do not match let's see if they can be converted
 		if !valType.ConvertibleTo(c.valueType) {
diff --git a/driver/inmemory/payload_registry.go b/driver/inmemory/payload_registry.go
@@ -16,7 +16,7 @@ var (
 	_ goengine.MessagePayloadResolver = &PayloadRegistry{}
 )
 
-// PayloadRegistry is a registry containing the mapping of an payload type to a event name
+// PayloadRegistry is a registry containing the mapping of a payload type to an event name
 type PayloadRegistry struct {
 	typeMap map[string]string
 }
diff --git a/driver/sql/listener.go b/driver/sql/listener.go
@@ -2,8 +2,8 @@ package sql
 
 import "context"
 
-// Listener listens to an event stream and triggers a notification when a event was appended
+// Listener listens to an event stream and triggers a notification when an event was appended
 type Listener interface {
-	// Listen starts listening to the event stream and call the trigger when a event was appended
+	// Listen starts listening to the event stream and call the trigger when an event was appended
 	Listen(ctx context.Context, trigger ProjectionTrigger) error
 }
diff --git a/driver/sql/postgres/advisory_lock_aggregate_projection_storage.go b/driver/sql/postgres/advisory_lock_aggregate_projection_storage.go
@@ -78,7 +78,7 @@ func NewAdvisoryLockAggregateProjectionStorage(
 			`UPDATE %[1]s SET failed = TRUE WHERE aggregate_id = $1`,
 			projectionTableQuoted,
 		),
-		// queryAcquireLock uses a `WITH` in order to insert if the projection is unknown other wise the row won't be locked
+		// queryAcquireLock uses a `WITH` in order to insert if the projection is unknown otherwise the row won't be locked
 		// The reason for using `INSERT SELECT` instead of `INSERT VALUES ON CONFLICT DO NOTHING` is that `ON CONFLICT` will
 		// increase the `no SERIAL` value.
 		queryAcquireLock: fmt.Sprintf(
@@ -120,7 +120,7 @@ func (a *AdvisoryLockAggregateProjectionStorage) PersistFailure(conn driverSQL.E
 }
 
 // Acquire returns a driverSQL.ProjectorTransaction and the position of the projection within the event stream when a
-// lock is acquired for the specified aggregate_id. Otherwise an error is returned indicating why the lock could not be acquired.
+// lock is acquired for the specified aggregate_id. Otherwise, an error is returned indicating why the lock could not be acquired.
 func (a *AdvisoryLockAggregateProjectionStorage) Acquire(
 	ctx context.Context,
 	conn *sql.Conn,
@@ -153,7 +153,7 @@ func (a *AdvisoryLockAggregateProjectionStorage) Acquire(
 
 	if locked || failed {
 		// The projection was locked by another process that died and for this reason not unlocked
-		// In this case a application needs to decide what to do to avoid invalid projection states
+		// In this case an application needs to decide what to do to avoid invalid projection states
 		if err := a.releaseProjectionConnectionLock(conn, aggregateID); err != nil {
 			a.logger.Error("failed to release lock for a projection with a locked row", func(e goengine.LoggerEntry) {
 				logFields(e)
diff --git a/driver/sql/postgres/advisory_lock_stream_projection_storage.go b/driver/sql/postgres/advisory_lock_stream_projection_storage.go
@@ -97,7 +97,7 @@ func (s *AdvisoryLockStreamProjectionStorage) CreateProjection(ctx context.Conte
 }
 
 // Acquire returns a driverSQL.ProjectorTransaction and the position of the projection within the event stream when a
-// lock is acquire for the specified aggregate_id. Otherwise an error is returned indicating why the lock could not be acquired.
+// lock is acquired for the specified aggregate_id. Otherwise, an error is returned indicating why the lock could not be acquired.
 func (s *AdvisoryLockStreamProjectionStorage) Acquire(
 	ctx context.Context,
 	conn *sql.Conn,
@@ -139,7 +139,7 @@ func (s *AdvisoryLockStreamProjectionStorage) Acquire(
 
 	if locked {
 		// The projection was locked by another process that died and for this reason not unlocked
-		// In this case a application needs to decide what to do to avoid invalid projection states
+		// In this case an application needs to decide what to do to avoid invalid projection states
 		if err := s.releaseProjectionConnectionLock(conn); err != nil {
 			s.logger.Error("failed to release lock for a projection with a locked row", func(e goengine.LoggerEntry) {
 				logFields(e)
diff --git a/driver/sql/projector_notification.go b/driver/sql/projector_notification.go
@@ -194,7 +194,7 @@ func wrapProjectionHandlers(handlers map[string]goengine.MessageHandler) map[str
 }
 
 // wrapProjectionHandlerToTrapError wraps a projection handler with error catching code.
-// This ensures a projection handler can return a error or panic without destroying the executor
+// This ensures a projection handler can return an error or panic without destroying the executor
 func wrapProjectionHandlerToTrapError(handler goengine.MessageHandler) goengine.MessageHandler {
 	return func(ctx context.Context, state interface{}, message goengine.Message) (returnState interface{}, handlerErr error) {
 		defer func() {
@@ -227,7 +227,7 @@ func wrapProjectionHandlerToTrapError(handler goengine.MessageHandler) goengine.
 	}
 }
 
-// eventStreamHandlerIterator is a iterator used to project a support message
+// eventStreamHandlerIterator is an iterator used to project a support message
 type eventStreamHandlerIterator struct {
 	stream   goengine.EventStream
 	handlers map[string]goengine.MessageHandler
diff --git a/driver/sql/sql.go b/driver/sql/sql.go
@@ -40,7 +40,7 @@ func AcquireConn(ctx context.Context, db *sql.DB) (*sql.Conn, error) {
 			return nil, ErrConnFailedToAcquire
 		case driver.ErrBadConn:
 			// This is needed due to https://github.com/golang/go/issues/29684
-			// We have a bad connection so we ping the server and try again
+			// We have a bad connection, so we ping the server and try again
 			timeoutCtx, timeoutCancel = context.WithTimeout(ctx, time.Second)
 			err := db.PingContext(timeoutCtx)
 			timeoutCancel()
diff --git a/eventstore.go b/eventstore.go
@@ -51,7 +51,7 @@ type (
 	}
 )
 
-// ReadEventStream reads the entire event stream and returns it's content as a slice.
+// ReadEventStream reads the entire event stream and returns its content as a slice.
 // The main purpose of the function is for testing and debugging.
 func ReadEventStream(stream EventStream) ([]Message, []int64, error) {
 	var messages []Message
diff --git a/extension/amqp/amqp.go b/extension/amqp/amqp.go
@@ -49,7 +49,7 @@ func DirectQueueConsume(amqpDSN, queue string) (Consume, error) {
 			return nil, nil, err
 		}
 
-		// Indicate we only want 1 message to be acknowledge at a time.
+		// Indicate we only want 1 message to be acknowledged at a time.
 		if err := ch.Qos(1, 0, false); err != nil {
 			return nil, nil, err
 		}
diff --git a/extension/amqp/publisher.go b/extension/amqp/publisher.go
@@ -14,7 +14,7 @@ import (
 
 var _ sql.ProjectionTrigger = (&NotificationPublisher{}).Publish
 
-// NotificationPublisher is responsible of publishing a notification to queue
+// NotificationPublisher is responsible for publishing a notification to queue
 type NotificationPublisher struct {
 	amqpDSN              string
 	queue                string
diff --git a/message.go b/message.go
@@ -8,10 +8,10 @@ import (
 )
 
 type (
-	// UUID is a 128 bit (16 byte) Universal Unique IDentifier as defined in RFC4122
+	// UUID is a 128 bit (16 byte) Universal Unique Identifier as defined in RFC4122
 	UUID = uuid.UUID
 
-	// Message is a interface describing a message.
+	// Message is an interface describing a message.
 	// A message can be a command, domain event or some other type of message.
 	Message interface {
 		// UUID returns the identifier of this message
diff --git a/message_payload.go b/message_payload.go
@@ -9,7 +9,7 @@ type (
 
 	// MessagePayloadFactory is used to reconstruct message payloads
 	MessagePayloadFactory interface {
-		// CreatePayload returns a reconstructed payload or a error
+		// CreatePayload returns a reconstructed payload or an error
 		CreatePayload(payloadType string, data interface{}) (interface{}, error)
 	}
 
diff --git a/metadata/matcher.go b/metadata/matcher.go
@@ -29,7 +29,7 @@ var (
 )
 
 type (
-	// Operator represents a operation for a constraint
+	// Operator represents an operation for a constraint
 	Operator string
 
 	// Matcher is a struct used to register constraints that should be applied
diff --git a/strategy/json/sql/message_factory_aggregate_test.go b/strategy/json/sql/message_factory_aggregate_test.go
@@ -97,7 +97,7 @@ func TestAggregateChangedFactory_CreateFromRows(t *testing.T) {
 				messageFactory, err := sql.NewAggregateChangedFactory(payloadFactory)
 				require.NoError(t, err)
 
-				// Finally recreate the messages
+				// Finally, recreate the messages
 				stream, err := messageFactory.CreateEventStream(rows)
 
 				asserts := assert.New(t)
@@ -125,7 +125,7 @@ func TestAggregateChangedFactory_CreateFromRows(t *testing.T) {
 		messageFactory, err := sql.NewAggregateChangedFactory(mocks.NewMessagePayloadFactory(ctrl))
 		require.NoError(t, err)
 
-		// Finally recreate the messages
+		// Finally, recreate the messages
 		msgs, err := messageFactory.CreateEventStream(nil)
 
 		// Check result
@@ -300,7 +300,7 @@ func TestAggregateChangedFactory_CreateFromRows(t *testing.T) {
 				messageFactory, err := sql.NewAggregateChangedFactory(payloadFactory)
 				require.NoError(t, err)
 
-				// Finally recreate the messages
+				// Finally, recreate the messages
 				stream, err := messageFactory.CreateEventStream(rows)
 
 				asserts := assert.New(t)

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ var (`
`19`	`19`	`ErrInvalidChangePayload = errors.New("goengine: a changed event must have a payload that is not nil")`
`20`	`20`	`)`
`21`	`21`
`22`		`-// Changed is a message indicating that a aggregate was changed`
	`22`	`+// Changed is a message indicating that an aggregate was changed`
`23`	`23`	`type Changed struct {`
`24`	`24`	`uuid goengine.UUID`
`25`	`25`	`aggregateID ID`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ func (r *Repository) GetAggregateRoot(ctx context.Context, aggregateID ID) (Root`
`100`	`100`	`return root, nil`
`101`	`101`	`}`
`102`	`102`
`103`		`-// enrichEventMetadata add's aggregate_id and aggregate_type as metadata to domainEvent`
	`103`	`+// enrichEventMetadata adds aggregate_id and aggregate_type as metadata to domainEvent`
`104`	`104`	`func (r Repository) enrichMetadata(aggregateEvent Changed, aggregateID ID) *Changed {`
`105`	`105`	`domainEvent := aggregateEvent.WithMetadata(IDKey, aggregateID)`
`106`	`106`	`domainEvent = domainEvent.WithMetadata(TypeKey, r.aggregateType.String())`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import (`
`7`	`7`	`"github.com/hellofresh/goengine/v2/metadata"`
`8`	`8`	`)`
`9`	`9`
`10`		`-// QueryExecutor is used to run a query against a inmemory event store`
	`10`	`+// QueryExecutor is used to run a query against an inmemory event store`
`11`	`11`	`type QueryExecutor struct {`
`12`	`12`	`store goengine.EventStore`
`13`	`13`	`streamName goengine.StreamName`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ var (`
`21`	`21`	`_ goengine.EventStore = &EventStore{}`
`22`	`22`	`)`
`23`	`23`
`24`		`-// EventStore a in memory event store implementation`
	`24`	`+// EventStore an in memory event store implementation`
`25`	`25`	`type EventStore struct {`
`26`	`26`	`sync.RWMutex`
`27`	`27`
`@@ -37,7 +37,7 @@ func NewEventStore(logger goengine.Logger) *EventStore {`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`		`-// Create creates a event stream`
	`40`	`+// Create creates an event stream`
`41`	`41`	`func (i *EventStore) Create(ctx context.Context, streamName goengine.StreamName) error {`
`42`	`42`	`if _, found := i.streams[streamName]; found {`
`43`	`43`	`return ErrStreamExistsAlready`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ var (`
`16`	`16`	`_ goengine.MessagePayloadResolver = &PayloadRegistry{}`
`17`	`17`	`)`
`18`	`18`
`19`		`-// PayloadRegistry is a registry containing the mapping of an payload type to a event name`
	`19`	`+// PayloadRegistry is a registry containing the mapping of a payload type to an event name`
`20`	`20`	`type PayloadRegistry struct {`
`21`	`21`	`typeMap map[string]string`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@ package sql`
`2`	`2`
`3`	`3`	`import "context"`
`4`	`4`
`5`		`-// Listener listens to an event stream and triggers a notification when a event was appended`
	`5`	`+// Listener listens to an event stream and triggers a notification when an event was appended`
`6`	`6`	`type Listener interface {`
`7`		`- // Listen starts listening to the event stream and call the trigger when a event was appended`
	`7`	`+ // Listen starts listening to the event stream and call the trigger when an event was appended`
`8`	`8`	`Listen(ctx context.Context, trigger ProjectionTrigger) error`
`9`	`9`	`}`