rename remove method

Author: Kevin Wiesmüller

typed/remove.go

@@ -24,15 +24,15 @@ type removingWalker struct {
 	out      interface{}
 	schema   *schema.Schema
 	toRemove *fieldpath.Set
-	shallow  bool
+	deep     bool
 }
 
-func removeItemsWithSchema(val value.Value, toRemove *fieldpath.Set, schema *schema.Schema, typeRef schema.TypeRef, shallow bool) value.Value {
+func removeItemsWithSchema(val value.Value, toRemove *fieldpath.Set, schema *schema.Schema, typeRef schema.TypeRef, deep bool) value.Value {
 	w := &removingWalker{
 		value:    val,
 		schema:   schema,
 		toRemove: toRemove,
-		shallow:  shallow,
+		deep:     deep,
 	}
 	resolveSchema(schema, typeRef, val, w)
 	return value.NewValueInterface(w.out)
@@ -61,7 +61,7 @@ func (w *removingWalker) doList(t *schema.List) (errs ValidationErrors) {
 			continue
 		}
 		if subset := w.toRemove.WithPrefix(pe); !subset.Empty() {
-			item = removeItemsWithSchema(item, subset, w.schema, t.ElementType, w.shallow)
+			item = removeItemsWithSchema(item, subset, w.schema, t.ElementType, w.deep)
 		}
 		newItems = append(newItems, item.Unstructured())
 	}
@@ -89,7 +89,7 @@ func (w *removingWalker) doMap(t *schema.Map) ValidationErrors {
 		pe := fieldpath.PathElement{FieldName: &k}
 		path, _ := fieldpath.MakePath(pe)
 
-		if w.shallow {
+		if w.deep {
 			if w.toRemove.Has(path) {
 				return true
 			}
@@ -104,7 +104,7 @@ func (w *removingWalker) doMap(t *schema.Map) ValidationErrors {
 			}
 		}
 		if subset := w.toRemove.WithPrefix(pe); !subset.Empty() {
-			val = removeItemsWithSchema(val, subset, w.schema, fieldType, w.shallow)
+			val = removeItemsWithSchema(val, subset, w.schema, fieldType, w.deep)
 		}
 		newMap[k] = val.Unstructured()
 		return true

typed/remove_test.go

@@ -133,7 +133,7 @@ func TestRemoveShallowRemovesParents(t *testing.T) {
 		t.Fatalf("unexpected result after remove:\ngot: %v\nexp: %v", test.String(), expect.String())
 	}
 
-	result = tv.Remove(remove)
+	result = tv.RemoveDeep(remove)
 
 	expect, err = value.FromJSON([]byte(`{"keep": "value", "keepMap": {"child": "value"}, "keepList": [{"child": "value"}]}`))
 	if err != nil {

typed/typed.go

@@ -144,8 +144,9 @@ func (tv TypedValue) RemoveItems(items *fieldpath.Set) *TypedValue {
 	return &tv
 }
 
-// Remove removes each provided path from the value.
-func (tv TypedValue) Remove(paths *fieldpath.Set) *TypedValue {
+// RemoveDeep removes each provided path from the value, including matching child paths.
+// For example `.a` would also remove `.a.b` as it's a child path.
+func (tv TypedValue) RemoveDeep(paths *fieldpath.Set) *TypedValue {
 	tv.value = removeItemsWithSchema(tv.value, paths, tv.schema, tv.typeRef, true)
 	return &tv
 }