Merge pull request #28 from ccremer/options

Refactoring: Improve pipeline options with struct

Author: ccremer

options.go

@@ -1,5 +1,9 @@
 package pipeline
 
+type options struct {
+	disableErrorWrapping bool
+}
+
 // Option configures the given Pipeline with a behaviour-altering setting.
 type Option func(pipeline *Pipeline)
 
@@ -17,5 +21,5 @@ func (p *Pipeline) WithOptions(options ...Option) *Pipeline {
 // DisableErrorWrapping disables the wrapping of errors that are emitted from pipeline steps.
 // This effectively causes Result.Err to be exactly the error as returned from a step.
 var DisableErrorWrapping Option = func(pipeline *Pipeline) {
-	pipeline.disableErrorWrapping = true
+	pipeline.options.disableErrorWrapping = true
 }

options_test.go

@@ -15,7 +15,7 @@ func TestPipeline_WithOptions(t *testing.T) {
 				return errors.New("some error")
 			}),
 		)
-		assert.True(t, p.disableErrorWrapping)
+		assert.True(t, p.options.disableErrorWrapping)
 		result := p.Run()
 		assert.Equal(t, "some error", result.Err.Error())
 	})

pipeline.go

@@ -8,11 +8,11 @@ import (
 type (
 	// Pipeline holds and runs intermediate actions, called "steps".
 	Pipeline struct {
-		steps                []Step
-		context              Context
-		beforeHooks          []Listener
-		finalizer            ResultHandler
-		disableErrorWrapping bool
+		steps       []Step
+		context     Context
+		beforeHooks []Listener
+		finalizer   ResultHandler
+		options     options
 	}
 	// Result is the object that is returned after each step and after running a pipeline.
 	Result struct {
@@ -91,7 +91,7 @@ func (p *Pipeline) WithSteps(steps ...Step) *Pipeline {
 // WithNestedSteps is similar to AsNestedStep, but it accepts the steps given directly as parameters.
 func (p *Pipeline) WithNestedSteps(name string, steps ...Step) Step {
 	return NewStep(name, func(_ Context) Result {
-		nested := &Pipeline{beforeHooks: p.beforeHooks, steps: steps, context: p.context, disableErrorWrapping: p.disableErrorWrapping}
+		nested := &Pipeline{beforeHooks: p.beforeHooks, steps: steps, context: p.context, options: p.options}
 		return nested.Run()
 	})
 }
@@ -100,7 +100,7 @@ func (p *Pipeline) WithNestedSteps(name string, steps ...Step) Step {
 // The properties are passed to the nested pipeline.
 func (p *Pipeline) AsNestedStep(name string) Step {
 	return NewStep(name, func(_ Context) Result {
-		nested := &Pipeline{beforeHooks: p.beforeHooks, steps: p.steps, context: p.context}
+		nested := &Pipeline{beforeHooks: p.beforeHooks, steps: p.steps, context: p.context, options: p.options}
 		return nested.Run()
 	})
 }
@@ -149,7 +149,7 @@ func (p *Pipeline) doRun() Result {
 				// Abort pipeline without error
 				return Result{aborted: true}
 			}
-			if p.disableErrorWrapping {
+			if p.options.disableErrorWrapping {
 				return Result{Err: err}
 			}
 			return Result{Err: fmt.Errorf("step '%s' failed: %w", step.Name, err)}