componentizer

type Component interface {
	ComponentRef
	GetRepository() Repository
	GetTemplates() (bool, []string)
	ParseModel(path string, tplC TemplateContext) (Model, error)
	ParseComponents(path string, tplC TemplateContext) (Component, []Component, error)
}

type ComponentManager interface {
	//Init initialize the component manager with the specified main component
	Init(main Component, tplC TemplateContext) (Model, error)

	//ContainsFile returns paths pointing on templated components containing the given file
	//	Parameters
	//		name: the name of the file to search
	//		ctx: the context used to eventually template the matching components
	//		in: the component referencer where to look for the file, if not provided
	//          the Finder will look into all the components available into the platform.
	ContainsFile(name string, tplC TemplateContext, in ...ComponentRef) MatchingPaths

	//ContainsDirectory returns paths pointing on templated components containing the given directory
	//	Parameters
	//		name: the name of the directory to search
	//		ctx: the context used to eventually template the matching components
	//		in: the component referencer where to look for the directory, if not provided
	//          the Finder will look into all the components available into the platform.
	ContainsDirectory(name string, tplC TemplateContext, in ...ComponentRef) MatchingPaths

	//IsAvailable checks if a component is locally available
	IsAvailable(cr ComponentRef) bool

	// ComponentOrder returns a slice of component identifiers in the parsing order
	ComponentOrder() []string

	//Use returns a component matching the given reference.
	//If the component corresponding to the reference contains a template
	//definition then the component will be duplicated and templated before
	// being returned as a UsableComponent.
	// Don't forget to Release the UsableComponent once is processing is over...
	Use(cr ComponentRef, tplC TemplateContext) (UsableComponent, error)
}

type ComponentRef interface {
	// ComponentId returns the referenced component id
	ComponentId() string
	// Component returns the referenced component
	Component(model interface{}) (Component, error)
}

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

type FileScmHandler struct {
	Logger *log.Logger
}

type GitScmHandler struct {
	Logger *log.Logger
}

type Handler func() (fetchedComponent, error)

type MatchingPath interface {
	//Owner gives the usable component wherein the searched content has been located
	Owner() UsableComponent
	//RelativePath specifies the relatives path of the searched content into the usable component
	RelativePath() string
	//AbsolutePath specifies the absolute path of the searched content into the usable component
	AbsolutePath() string
}

type MatchingPaths struct {
	//Paths holds the searched  results
	Paths []MatchingPath
}

type Model interface {
	IsReferenced(c Component) bool
	Merge(with Model) (Model, error)
}

type Repository struct {
	// Loc holds the absolute location of the repository
	Loc *url.URL
	// The reference to the branch or tag to fetch. If not specified the default branch will be fetched
	Ref string
	// The authentication parameters to use if repository is not publicly accessible
	Authentication map[string]string
}

type SCMType string

type TemplateContext interface {
	Clone(ref ComponentRef) TemplateContext
	Execute(content string) (string, error)
}

type TestContext struct {
	T              *testing.T
	Logger         *log.Logger
	Directory      string
	DescriptorName string
}

type UsableComponent interface {
	//Name returns the name of the component
	Id() string
	//Templated returns true is the component content has been templated
	Templated() bool
	//Release deletes the templated content.
	Release()
	//RootPath returns the absolute path of the, eventually templated, component
	RootPath() string
	//ContainsFile returns the matching path of the searched file
	ContainsFile(name string) (bool, MatchingPath)
	//ContainsDirectory returns the matching path of the searched directory
	ContainsDirectory(name string) (bool, MatchingPath)
	//Source returns the component that was used to produce this UsableComponent
	Source() ComponentRef
}