Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Delete operation to maplike structs #899

Merged
merged 2 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/docs/openapi3.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,9 @@ func NewCallback(opts ...NewCallbackOption) *Callback
func NewCallbackWithCapacity(cap int) *Callback
NewCallbackWithCapacity builds a callback object of the given capacity.

func (callback *Callback) Delete(key string)
Delete removes the entry associated with key 'key' from 'callback'.

func (callback Callback) JSONLookup(token string) (interface{}, error)
JSONLookup implements
https://github.com/go-openapi/jsonpointer#JSONPointable
Expand Down Expand Up @@ -915,6 +918,9 @@ func NewPaths(opts ...NewPathsOption) *Paths
func NewPathsWithCapacity(cap int) *Paths
NewPathsWithCapacity builds a paths object of the given capacity.

func (paths *Paths) Delete(key string)
Delete removes the entry associated with key 'key' from 'paths'.

func (paths *Paths) Find(key string) *PathItem
Find returns a path that matches the key.

Expand Down Expand Up @@ -1145,6 +1151,9 @@ func NewResponsesWithCapacity(cap int) *Responses
func (responses *Responses) Default() *ResponseRef
Default returns the default response

func (responses *Responses) Delete(key string)
Delete removes the entry associated with key 'key' from 'responses'.

func (responses Responses) JSONLookup(token string) (interface{}, error)
JSONLookup implements
https://github.com/go-openapi/jsonpointer#JSONPointable
Expand Down
17 changes: 15 additions & 2 deletions maps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ EOF
}


maplike_ValueSetLen() {
maplike_ValueSetLenDelete() {
cat <<EOF >>"$maplike"
// Value returns the ${name} for key or nil
func (${name} ${type}) Value(key string) ${value_type} {
Expand All @@ -109,6 +109,13 @@ func (${name} ${type}) Len() int {
return len(${name}.m)
}

// Delete removes the entry associated with key 'key' from '${name}'.
func (${name} ${type}) Delete(key string) {
if ${name} != nil && ${name}.m != nil {
delete(${name}.m, key)
}
}

// Map returns ${name} as a 'map'.
// Note: iteration on Go maps is not ordered.
func (${name} ${type}) Map() (m map[string]${value_type}) {
Expand Down Expand Up @@ -213,6 +220,7 @@ test_body() {
require.Equal(t, map[string]${value_type}{}, x.Map())
require.Equal(t, (${value_type})(nil), x.Value("key"))
require.Panics(t, func() { x.Set("key", &${value_type#'*'}{}) })
require.NotPanics(t, func() { x.Delete("key") })
})
t.Run("nonnil", func(t *testing.T) {
x := &${type#'*'}{}
Expand All @@ -223,6 +231,11 @@ test_body() {
require.Equal(t, 1, x.Len())
require.Equal(t, map[string]${value_type}{"key": {}}, x.Map())
require.Equal(t, &${value_type#'*'}{}, x.Value("key"))
x.Delete("key")
require.Equal(t, 0, x.Len())
require.Equal(t, map[string]${value_type}{}, x.Map())
require.Equal(t, (${value_type})(nil), x.Value("key"))
require.NotPanics(t, func() { x.Delete("key") })
})
})

Expand All @@ -241,7 +254,7 @@ for i in "${!types[@]}"; do
name=${names[$i]}

type="$type" name="$name" value_type="$value_type" maplike_NewWithCapa
type="$type" name="$name" value_type="$value_type" maplike_ValueSetLen
type="$type" name="$name" value_type="$value_type" maplike_ValueSetLenDelete
type="$type" name="$name" deref_v="$deref_v" maplike_Pointable
type="$type" name="$name" value_type="$value_type" maplike_UnMarsh
[[ $((i+1)) != "${#types[@]}" ]] && echo >>"$maplike"
Expand Down
21 changes: 21 additions & 0 deletions openapi3/maplike.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ func (responses *Responses) Len() int {
return len(responses.m)
}

// Delete removes the entry associated with key 'key' from 'responses'.
func (responses *Responses) Delete(key string) {
if responses != nil && responses.m != nil {
delete(responses.m, key)
}
}

// Map returns responses as a 'map'.
// Note: iteration on Go maps is not ordered.
func (responses *Responses) Map() (m map[string]*ResponseRef) {
Expand Down Expand Up @@ -153,6 +160,13 @@ func (callback *Callback) Len() int {
return len(callback.m)
}

// Delete removes the entry associated with key 'key' from 'callback'.
func (callback *Callback) Delete(key string) {
if callback != nil && callback.m != nil {
delete(callback.m, key)
}
}

// Map returns callback as a 'map'.
// Note: iteration on Go maps is not ordered.
func (callback *Callback) Map() (m map[string]*PathItem) {
Expand Down Expand Up @@ -265,6 +279,13 @@ func (paths *Paths) Len() int {
return len(paths.m)
}

// Delete removes the entry associated with key 'key' from 'paths'.
func (paths *Paths) Delete(key string) {
if paths != nil && paths.m != nil {
delete(paths.m, key)
}
}

// Map returns paths as a 'map'.
// Note: iteration on Go maps is not ordered.
func (paths *Paths) Map() (m map[string]*PathItem) {
Expand Down
18 changes: 18 additions & 0 deletions openapi3/maplike_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ func TestMaplikeMethods(t *testing.T) {
require.Equal(t, map[string]*ResponseRef{}, x.Map())
require.Equal(t, (*ResponseRef)(nil), x.Value("key"))
require.Panics(t, func() { x.Set("key", &ResponseRef{}) })
require.NotPanics(t, func() { x.Delete("key") })
})
t.Run("nonnil", func(t *testing.T) {
x := &Responses{}
Expand All @@ -27,6 +28,11 @@ func TestMaplikeMethods(t *testing.T) {
require.Equal(t, 1, x.Len())
require.Equal(t, map[string]*ResponseRef{"key": {}}, x.Map())
require.Equal(t, &ResponseRef{}, x.Value("key"))
x.Delete("key")
require.Equal(t, 0, x.Len())
require.Equal(t, map[string]*ResponseRef{}, x.Map())
require.Equal(t, (*ResponseRef)(nil), x.Value("key"))
require.NotPanics(t, func() { x.Delete("key") })
})
})

Expand All @@ -38,6 +44,7 @@ func TestMaplikeMethods(t *testing.T) {
require.Equal(t, map[string]*PathItem{}, x.Map())
require.Equal(t, (*PathItem)(nil), x.Value("key"))
require.Panics(t, func() { x.Set("key", &PathItem{}) })
require.NotPanics(t, func() { x.Delete("key") })
})
t.Run("nonnil", func(t *testing.T) {
x := &Callback{}
Expand All @@ -48,6 +55,11 @@ func TestMaplikeMethods(t *testing.T) {
require.Equal(t, 1, x.Len())
require.Equal(t, map[string]*PathItem{"key": {}}, x.Map())
require.Equal(t, &PathItem{}, x.Value("key"))
x.Delete("key")
require.Equal(t, 0, x.Len())
require.Equal(t, map[string]*PathItem{}, x.Map())
require.Equal(t, (*PathItem)(nil), x.Value("key"))
require.NotPanics(t, func() { x.Delete("key") })
})
})

Expand All @@ -59,6 +71,7 @@ func TestMaplikeMethods(t *testing.T) {
require.Equal(t, map[string]*PathItem{}, x.Map())
require.Equal(t, (*PathItem)(nil), x.Value("key"))
require.Panics(t, func() { x.Set("key", &PathItem{}) })
require.NotPanics(t, func() { x.Delete("key") })
})
t.Run("nonnil", func(t *testing.T) {
x := &Paths{}
Expand All @@ -69,6 +82,11 @@ func TestMaplikeMethods(t *testing.T) {
require.Equal(t, 1, x.Len())
require.Equal(t, map[string]*PathItem{"key": {}}, x.Map())
require.Equal(t, &PathItem{}, x.Value("key"))
x.Delete("key")
require.Equal(t, 0, x.Len())
require.Equal(t, map[string]*PathItem{}, x.Map())
require.Equal(t, (*PathItem)(nil), x.Value("key"))
require.NotPanics(t, func() { x.Delete("key") })
})
})

Expand Down
Loading