rename spec for clearity

easegress-io · May 6, 2024 · 417aed6 · 417aed6
1 parent 0c61721
commit 417aed6
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 22 deletions.
diff --git a/cmd/client/resources/object.go b/cmd/client/resources/object.go
@@ -44,7 +44,7 @@ type ObjectNamespaceFlags struct {
 
 var globalAPIResources []*api.APIResource
 
-func generateTableMap(objectSpecs []ObjectSpec, namespace string) map[string]Table {
+func generateTableMap(objectSpecs []SpecInfo, namespace string) map[string]Table {
 	tables := map[string]Table{}
 
 	wrapRow := func(row TableRow) TableRow {
@@ -252,7 +252,7 @@ func GetObject(cmd *cobra.Command, args *general.ArgInfo, kind string, flags *Ob
 	}
 
 	if flags.AllNamespace {
-		err := unmarshalPrintNamespaceObjectSpec(body, func(s ObjectSpec) bool {
+		err := unmarshalPrintNamespaceObjectSpec(body, func(s SpecInfo) bool {
 			return s.GetKind() == kind
 		})
 		if err != nil {
@@ -261,7 +261,7 @@ func GetObject(cmd *cobra.Command, args *general.ArgInfo, kind string, flags *Ob
 		return nil
 	}
 
-	err = unmarshalPrintMetaSpec(body, !args.ContainName(), func(o ObjectSpec) bool {
+	err = unmarshalPrintMetaSpec(body, !args.ContainName(), func(o SpecInfo) bool {
 		return o.GetKind() == kind
 	})
 	if err != nil {
@@ -270,7 +270,7 @@ func GetObject(cmd *cobra.Command, args *general.ArgInfo, kind string, flags *Ob
 	return nil
 }
 
-func unmarshalPrintMetaSpec(body []byte, list bool, filter func(ObjectSpec) bool) error {
+func unmarshalPrintMetaSpec(body []byte, list bool, filter func(SpecInfo) bool) error {
 	specs, err := unmarshalObjectSpec(body, list)
 	if err != nil {
 		return err
@@ -285,7 +285,7 @@ func unmarshalPrintMetaSpec(body []byte, list bool, filter func(ObjectSpec) bool
 	return nil
 }
 
-func unmarshalPrintNamespaceObjectSpec(body []byte, filter func(ObjectSpec) bool) error {
+func unmarshalPrintNamespaceObjectSpec(body []byte, filter func(SpecInfo) bool) error {
 	allObjectSpecs, err := unmarshalNamespaceMetaSpec(body)
 	if err != nil {
 		return err
@@ -307,18 +307,18 @@ func unmarshalPrintNamespaceObjectSpec(body []byte, filter func(ObjectSpec) bool
 	return nil
 }
 
-func unmarshalObjectSpec(body []byte, listBody bool) ([]ObjectSpec, error) {
+func unmarshalObjectSpec(body []byte, listBody bool) ([]SpecInfo, error) {
 	res, err := general.UnmarshalMapInterface(body, listBody)
 	if err != nil {
 		return nil, err
 	}
-	specs := []ObjectSpec{}
+	specs := []SpecInfo{}
 	for _, m := range res {
 		data, err := codectool.MarshalJSON(m)
 		if err != nil {
 			return nil, err
 		}
-		spec, err := GetObjectSpec(m["kind"].(string), data)
+		spec, err := GetSpecInfo(m["kind"].(string), data)
 		if err != nil {
 			return nil, err
 		}
@@ -327,20 +327,20 @@ func unmarshalObjectSpec(body []byte, listBody bool) ([]ObjectSpec, error) {
 	return specs, nil
 }
 
-func unmarshalNamespaceMetaSpec(body []byte) (map[string][]ObjectSpec, error) {
+func unmarshalNamespaceMetaSpec(body []byte) (map[string][]SpecInfo, error) {
 	raw := map[string][]map[string]interface{}{}
 	err := codectool.Unmarshal(body, &raw)
 	if err != nil {
 		return nil, err
 	}
-	res := map[string][]ObjectSpec{}
+	res := map[string][]SpecInfo{}
 	for ns, v := range raw {
 		for _, s := range v {
 			data, err := codectool.MarshalJSON(s)
 			if err != nil {
 				return nil, err
 			}
-			spec, err := GetObjectSpec(s["kind"].(string), data)
+			spec, err := GetSpecInfo(s["kind"].(string), data)
 			if err != nil {
 				return nil, err
 			}
@@ -350,7 +350,7 @@ func unmarshalNamespaceMetaSpec(body []byte) (map[string][]ObjectSpec, error) {
 	return res, nil
 }
 
-func printNamespaceObjectSpec(metas map[string][]ObjectSpec) {
+func printNamespaceObjectSpec(metas map[string][]SpecInfo) {
 	defaults := metas[DefaultNamespace]
 	res := generateTableMap(defaults, DefaultNamespace)
 
@@ -376,7 +376,7 @@ func printNamespaceObjectSpec(metas map[string][]ObjectSpec) {
 	}
 }
 
-func printObjectSpec(metas []ObjectSpec) {
+func printObjectSpec(metas []SpecInfo) {
 	tableMap := generateTableMap(metas, "")
 	tables := tableMapToArray(tableMap)
 	for _, table := range tables {

diff --git a/cmd/client/resources/spec.go b/cmd/client/resources/spec.go
@@ -31,13 +31,13 @@ import (
 const defaultTableType = "__default__"
 
 // kindToSpec maps the kind to the spec.
-var kindToSpec = map[string]func() ObjectSpec{
-	httpserver.Kind:  func() ObjectSpec { return &HTTPServerSpec{} },
-	defaultTableType: func() ObjectSpec { return &MetaSpec{} },
+var kindToSpec = map[string]func() SpecInfo{
+	httpserver.Kind:  func() SpecInfo { return &HTTPServerSpec{} },
+	defaultTableType: func() SpecInfo { return &MetaSpec{} },
 }
 
-// GetObjectSpec returns the spec of the object, used to generate table.
-func GetObjectSpec(kind string, data []byte) (ObjectSpec, error) {
+// GetSpecInfo returns the spec of the object, used to generate table.
+func GetSpecInfo(kind string, data []byte) (SpecInfo, error) {
 	specFn, ok := kindToSpec[kind]
 	if !ok {
 		specFn = kindToSpec[defaultTableType]
@@ -60,8 +60,8 @@ func (row TableRow) WithNamespace(namespace string) TableRow {
 	return append(row, namespace)
 }
 
-// ObjectSpec is the interface of the object spec.
-type ObjectSpec interface {
+// SpecInfo is the interface for the object specs to get information used by table.
+type SpecInfo interface {
 	GetName() string
 	GetKind() string
 	GetAge() string
@@ -74,7 +74,7 @@ type MetaSpec struct {
 	supervisor.MetaSpec `json:",inline"`
 }
 
-var _ ObjectSpec = &MetaSpec{}
+var _ SpecInfo = &MetaSpec{}
 
 // GetName returns the name of the object.
 func (m *MetaSpec) GetName() string {
@@ -111,7 +111,7 @@ type HTTPServerSpec struct {
 	httpserver.Spec `json:",inline"`
 }
 
-var _ ObjectSpec = &HTTPServerSpec{}
+var _ SpecInfo = &HTTPServerSpec{}
 
 // TableHeader returns the table header.
 func (h *HTTPServerSpec) TableHeader() (string, TableRow) {