pipeline.go

// scriptish is a library to help you port bash scripts to Golang
//
// inspired by:
//
// - http://labix.org/pipe
// - https://github.com/bitfield/script
//
// Copyright 2019-present Ganbaro Digital Ltd
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
//   * Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//
//   * Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//
//   * Neither the names of the copyright holders nor the names of his
//     contributors may be used to endorse or promote products derived
//     from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package scriptish

// NewPipeline creates a pipeline that's ready to run
func NewPipeline(steps ...*SequenceStep) *Sequence {
	// build our pipeline
	retval := NewSequence(steps...)

	// tell the underlying sequence how we want these commands to run
	retval.Controller = PipelineController(retval)

	// tell the commands what context they are running in
	retval.Flags = contextIsPipeline

	// we already have a pipe, so it needs to get our flags too
	retval.Pipe.Flags = retval.Flags

	// all done
	return retval
}

// NewPipelineFunc creates a pipeline, and wraps it in a function to make
// it easier to call.
func NewPipelineFunc(steps ...*SequenceStep) func(...string) *Pipeline {
	newPipe := NewPipeline(steps...)
	return func(params ...string) *Pipeline {
		return newPipe.Exec(params...)
	}
}

// ExecPipeline creates and runs a pipeline. Use this for short, throwaway
// actions.
func ExecPipeline(steps ...*SequenceStep) *Pipeline {
	pipeline := NewPipeline(steps...).Exec()
	return pipeline
}