filter

Documentation

Index

• Variables
• type Factory
• type File
  • func (fe *File) Do(ctx context.Context) (bool, error)
  • func (fe *File) String() string
• type FileContent
  • func (fcl *FileContent) Do(ctx context.Context) (bool, error)
  • func (fcl *FileContent) String() string
• type FileContentFactory
  • func (f FileContentFactory) Create(params params.Params) (Filter, error)
  • func (f FileContentFactory) Name() string
• type FileFactory
  • func (f FileFactory) Create(params params.Params) (Filter, error)
  • func (f FileFactory) Name() string
• type Filter
• type FilterRepository
• type Jq
  • func (f *Jq) Do(ctx context.Context) (bool, error)
  • func (f *Jq) String() string
• type JqFactory
  • func (f JqFactory) Create(params params.Params) (Filter, error)
  • func (f JqFactory) Name() string
• type Repository
  • func (r *Repository) Do(ctx context.Context) (bool, error)
  • func (r *Repository) String() string
• type RepositoryFactory
  • func (f RepositoryFactory) Create(params params.Params) (Filter, error)
  • func (f RepositoryFactory) Name() string
• type Reverse
  • func NewReverse(wrapped Filter) *Reverse
  • func (r *Reverse) Do(ctx context.Context) (bool, error)
  • func (r *Reverse) String() string
• type Xpath
  • func (x *Xpath) Do(ctx context.Context) (bool, error)
  • func (x *Xpath) String() string
• type XpathFactory
  • func (f XpathFactory) Create(params params.Params) (Filter, error)
  • func (f XpathFactory) Name() string

Variables

var (
	BuiltInFactories = []Factory{
		FileContentFactory{},
		FileFactory{},
		JqFactory{},
		RepositoryFactory{},
		XpathFactory{},
	}
)

Types

type Factory

type Factory interface {
	Create(params params.Params) (Filter, error)
	Name() string
}

type File

type File struct {
	Op    string
	Paths []string
}

func (*File) Do

func (fe *File) Do(ctx context.Context) (bool, error)

func (*File) String

func (fe *File) String() string

type FileContent

type FileContent struct {
	Path   string
	Regexp *regexp.Regexp
}

func (*FileContent) Do

func (fcl *FileContent) Do(ctx context.Context) (bool, error)

func (*FileContent) String

func (fcl *FileContent) String() string

type FileContentFactory

type FileContentFactory struct{}

func (FileContentFactory) Create

func (f FileContentFactory) Create(params params.Params) (Filter, error)

func (FileContentFactory) Name

func (f FileContentFactory) Name() string

type FileFactory

type FileFactory struct{}

func (FileFactory) Create

func (f FileFactory) Create(params params.Params) (Filter, error)

func (FileFactory) Name

func (f FileFactory) Name() string

type Filter

type Filter interface {
	Do(context.Context) (bool, error)
	String() string
}

type FilterRepository

type FilterRepository interface {
	GetFile(fileName string) (string, error)
	HasFile(path string) (bool, error)
	Host() host.HostDetail
	Name() string
	Owner() string
}

type Jq

type Jq struct {
	Exprs       []*gojq.Code
	ExprsString string
	Path        string
}

Jq is a filter that applies a jq expression to a file in the repository.

func (*Jq) Do

func (f *Jq) Do(ctx context.Context) (bool, error)

Do implements Filter. It downloads a file from a repository and queries it via a jq expression. It returns true if the query returns at least one node.

func (*Jq) String

func (f *Jq) String() string

String implements Filter.

type JqFactory

type JqFactory struct{}

JqFactory creates jq filters.

func (JqFactory) Create

func (f JqFactory) Create(params params.Params) (Filter, error)

Create implements Factory.

func (JqFactory) Name

func (f JqFactory) Name() string

Name implements Factory.

type Repository

type Repository struct {
	Host  *regexp.Regexp
	Owner *regexp.Regexp
	Repo  *regexp.Regexp
}

func (*Repository) Do

func (r *Repository) Do(ctx context.Context) (bool, error)

func (*Repository) String

func (r *Repository) String() string

type RepositoryFactory

type RepositoryFactory struct{}

func (RepositoryFactory) Create

func (f RepositoryFactory) Create(params params.Params) (Filter, error)

func (RepositoryFactory) Name

func (f RepositoryFactory) Name() string

type Reverse

type Reverse struct {
	// contains filtered or unexported fields
}

Reverse takes the result of a wrapped filter and returns the opposite.

func NewReverse

func NewReverse(wrapped Filter) *Reverse

NewReverse returns a new Reverse filter.

func (*Reverse) Do

func (r *Reverse) Do(ctx context.Context) (bool, error)

Do implements Filter

func (*Reverse) String

func (r *Reverse) String() string

String implements Filter

type Xpath

type Xpath struct {
	Exprs []*xpath.Expr
	Path  string
}

Xpath filters repositories by applying an XPath expression to a file in the repository.

func (*Xpath) Do

func (x *Xpath) Do(ctx context.Context) (bool, error)

Do implements Filter. It downloads a XML document from a repository and queries it via an XPath expression. It returns true if the XPath expression returns at least one node.

func (*Xpath) String

func (x *Xpath) String() string

String implements Filter.

type XpathFactory

type XpathFactory struct{}

XpathFactory creates Xpath filters.

func (XpathFactory) Create

func (f XpathFactory) Create(params params.Params) (Filter, error)

Create implements Factory.

func (XpathFactory) Name

func (f XpathFactory) Name() string

Name implements Factory.