new error features (#9)

### Background

→ starting to actually use the model, changes are required.

### Changes

- expose DetailTag for special creation cases
- expose CustomSrc(...) in factory

### Testing

- existing?

gerror/error.go

@@ -3,7 +3,7 @@ package gerror
 // Error exposes methods that can be used as an error type.
 type Error interface {
 	// Error implements the error interface; it returns a formatted message of the style
-	// "Name: <name>, DTag: <detailTag>, Src: <source>, Message: <message> \n <stack>
+	// "Name: <name>, DTag: <DetailTag>, Src: <source>, Message: <message> \n <stack>
 	Error() string
 
 	// Is implements the errors.Is interface.
@@ -25,7 +25,7 @@ type Error interface {
 	// ErrName returns the name of the error.
 	ErrName() string
 
-	// ErrDetailTag returns the detailTag (if set).
+	// ErrDetailTag returns the DetailTag (if set).
 	ErrDetailTag() string
 
 	// ErrStack returns an error stack (if available).

gerror/factory.go

@@ -11,6 +11,9 @@ type Factory interface {
 	// Source is a limited stack.
 	Src() Error
 
+	// CustomSrc returns a copy of the embedded error with a custom source and without a stack.
+	CustomSrc(src string) Error
+
 	// Stack returns a copy of the embedded error with a Stack trace and diagnostic info.
 	Stack() Error
 
@@ -62,18 +65,18 @@ func CloneBase[T factoryOf](
 		Name:       base.Name,
 		Message:    base.Message,
 		Source:     base.Source,
-		detailTag:  base.detailTag,
+		DetailTag:  base.DetailTag,
 		factoryRef: base.factoryRef,
 		stack:      base.stack,
 		srcError:   base.srcError,
 	}
 
 	// handle detail tags:
 	if len(dTag) > 0 {
-		if len(clone.detailTag) == 0 {
-			clone.detailTag = dTag
+		if len(clone.DetailTag) == 0 {
+			clone.DetailTag = dTag
 		} else {
-			clone.detailTag += "-" + dTag
+			clone.DetailTag += "-" + dTag
 		}
 	}
 

gerror/gen/gerror.gotmpl

@@ -99,6 +99,14 @@ func (e *{{$desc.TypeName}}) Src() gerror.Error {
 	return e.toPrimaryType(clone)
 }
 
+{{index $.FactoryComments "CustomSrc"}}
+func (e *{{$desc.TypeName}}) CustomSrc(src string) gerror.Error {
+	clone := gerror.CloneBase(e, gerror.NoStack, "", "", nil)
+	clone.Source = src
+	return e.toPrimaryType(clone)
+}
+
+
 {{index $.FactoryComments "Stack"}}
 func (e *{{$desc.TypeName}}) Stack() gerror.Error {
 	clone := gerror.CloneBase(e, gerror.DefaultStack, "", "", nil)

gerror/gerror.go

@@ -21,8 +21,8 @@ type GError struct {
 	// A derived source includes packageName, typeName (if applicable), and methodName.
 	Source string
 
-	// detailTag is a metric-safe 'tag' that can distinguish between different uses of the same error.
-	detailTag string
+	// DetailTag is a metric-safe 'tag' that can distinguish between different uses of the same error.
+	DetailTag string
 
 	// stack is the stack trace info.
 	stack Stack
@@ -55,7 +55,7 @@ func (e *GError) ErrName() string {
 
 // ErrDetailTag returns the metric-safe detail-tag of the error.
 func (e *GError) ErrDetailTag() string {
-	return e.detailTag
+	return e.DetailTag
 }
 
 // ErrStack returns an error stack (if available).
@@ -97,6 +97,13 @@ func (e *GError) Src() Error {
 	return CloneBase(e, SourceStack, "", "", nil)
 }
 
+// CustomSrc returns a copy of the embedded error with a custom source.
+func (e *GError) CustomSrc(src string) Error {
+	base := CloneBase(e, NoStack, "", "", nil)
+	base.Source = src
+	return base
+}
+
 // Stack is a factory method for cloning the base error with a full sack trace.
 func (e *GError) Stack() Error {
 	return CloneBase(e, DefaultStack, "", "", nil)
@@ -109,8 +116,8 @@ func (e *GError) Error() string {
 	if len(e.Name) > 0 {
 		result += "Name: " + e.Name + separator
 	}
-	if len(e.detailTag) > 0 {
-		result += "DTag: " + e.detailTag + separator
+	if len(e.DetailTag) > 0 {
+		result += "DTag: " + e.DetailTag + separator
 	}
 	if len(e.Source) > 0 {
 		result += "Source: " + e.Source + separator

gsort/README.md

@@ -53,5 +53,4 @@ func (s GSortSortable) Less(i, j int) bool {
 ### TODO:
 
 -	arrive at a syntax that works to generate varients of sortable data.
--	improve documentation.
--
+-	improve documentation. -