filter_head.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

// Head copies the first N lines from the pipeline's Stdin to its Stdout
//
// If `n` is less than 1 (ie 0, or negative), no lines are copied
func Head(n int, opts ...*StepOption) *SequenceStep {
	// special case - negative n
	if n < 1 {
		return NewSequenceStep(
			func(p *Pipe) (int, error) {
				// debugging support
				Tracef("Head(%d)", n)

				// do nothing
				return StatusOkay, nil
			},
			opts...,
		)
	}

	// general case
	return NewSequenceStep(
		func(p *Pipe) (int, error) {
			// debugging support
			Tracef("Head(%d)", n)

			count := 0
			for line := range p.Stdin.ReadLines() {
				TracePipeStdout("%s", line)

				p.Stdout.WriteString(line)
				p.Stdout.WriteRune('\n')
				count++

				// are we done?
				if count >= n {
					break
				}
			}

			return StatusOkay, nil
		},
		opts...,
	)
}