options for composing artifact meta data

Author: mandelsoft

api/ocm/compdesc/componentdescriptor.go

@@ -138,6 +138,7 @@ type ArtifactMetaAccess interface {
 	GetType() string
 	SetType(string)
 	ReferenceHintProvider
+	ReferenceHintSink
 }
 
 type ReferenceHintProvider interface {

api/ocm/elements/artifacts.go

@@ -1,6 +1,49 @@
 package elements
 
+import (
+	"ocm.software/ocm/api/ocm/compdesc"
+	"ocm.software/ocm/api/ocm/refhints"
+)
+
 type ArtifactOption interface {
 	ResourceMetaOption
 	SourceMetaOption
 }
+
+type artifactAccessor interface {
+	compdesc.ReferenceHintSink
+}
+
+type artifactOption struct {
+	apply func(meta artifactAccessor) error
+}
+
+type artifactOptionI interface {
+	apply(sink artifactAccessor) error
+}
+
+func newArtifactOption[T artifactOptionI](e T) ArtifactOption {
+	return artifactOption{e.apply}
+}
+
+func (o artifactOption) ApplyToResourceMeta(m *compdesc.ResourceMeta) error {
+	return o.apply(m)
+}
+
+func (o artifactOption) ApplyToSourceMeta(m *compdesc.SourceMeta) error {
+	return o.apply(m)
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+type refhint string
+
+func (o refhint) apply(m artifactAccessor) error {
+	m.SetReferenceHints(refhints.ParseHints(string(o)))
+	return nil
+}
+
+// WithHint sets a serialized list of hints for the artifact metadata.
+func WithHint(v string) ArtifactOption {
+	return newArtifactOption(refhint(v))
+}

api/ocm/internal/repository.go

@@ -176,10 +176,14 @@ type ComponentVersionAccess interface {
 
 	// AdjustResourceAccess is used to modify the access spec. The old and new one MUST refer to the same content.
 	AdjustResourceAccess(meta *ResourceMeta, acc compdesc.AccessSpec, opts ...ModificationOption) error
+	// SetResourceBlob sets a resource given by a blob access, the optional hints (must be implicit) are observed
+	// when adding a local blob to store them as implicit hints.
 	SetResourceBlob(meta *ResourceMeta, blob BlobAccess, hints []refhints.ReferenceHint, global AccessSpec, opts ...BlobModificationOption) error
 	AdjustSourceAccess(meta *SourceMeta, acc compdesc.AccessSpec) error
 	// SetSourceBlob updates or sets anew source. The options only use the
 	// target options. All other options are ignored.
+	// The optional hints (must be implicit) are observed
+	// when adding a local blob to store them as implicit hints.
 	SetSourceBlob(meta *SourceMeta, blob BlobAccess, hints []refhints.ReferenceHint, global AccessSpec, opts ...TargetElementOption) error
 
 	// AccessMethod provides an access method implementation for

examples/lib/tour/02-composing-a-component-version/README.md

@@ -192,7 +192,7 @@ optional additional information:
   (we don't use it, here).
 
 ```go
-		err = cv.SetResourceBlob(meta, blob, "", nil)
+		err = cv.SetResourceBlob(meta, blob, nil, nil)
 		if err != nil {
 			return errors.Wrapf(err, "cannot add yaml document")
 		}