-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make cascade front matter order deterministic
Fixes #12594
- Loading branch information
Showing
9 changed files
with
227 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| // Copyright 2024 The Hugo Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package maps | ||
|
|
||
| type Ordered[K comparable, T any] struct { | ||
| // The keys in the order they were added. | ||
| keys []K | ||
| // The values. | ||
| values map[K]T | ||
| } | ||
|
|
||
| // NewOrdered creates a new Ordered map. | ||
| func NewOrdered[K comparable, T any]() *Ordered[K, T] { | ||
| return &Ordered[K, T]{values: make(map[K]T)} | ||
| } | ||
|
|
||
| // Set sets the value for the given key. | ||
| func (m *Ordered[K, T]) Set(key K, value T) { | ||
| // Check if the key already exists. If it does, move it to the end. | ||
| var found bool | ||
| for i, k := range m.keys { | ||
| if k == key { | ||
| m.keys = append(m.keys[:i], m.keys[i+1:]...) | ||
| found = true | ||
| break | ||
| } | ||
| } | ||
| if !found { | ||
| m.keys = append(m.keys, key) | ||
| } | ||
| m.values[key] = value | ||
| } | ||
|
|
||
| // Get gets the value for the given key. | ||
| func (m *Ordered[K, T]) Get(key K) (value T, found bool) { | ||
| value, found = m.values[key] | ||
| return | ||
| } | ||
|
|
||
| // Delete deletes the value for the given key. | ||
| func (m *Ordered[K, T]) Delete(key K) { | ||
| delete(m.values, key) | ||
| n := 0 | ||
| for _, k := range m.keys { | ||
| if k == key { | ||
| continue | ||
| } | ||
| m.keys[n] = k | ||
| n++ | ||
| } | ||
| m.keys = m.keys[:n] | ||
| } | ||
|
|
||
| // Clone creates a shallow copy of the map. | ||
| // If m is nil, it returns nil. | ||
| func (m *Ordered[K, T]) Clone() *Ordered[K, T] { | ||
| if m == nil { | ||
| return nil | ||
| } | ||
| clone := NewOrdered[K, T]() | ||
| for _, k := range m.keys { | ||
| clone.Set(k, m.values[k]) | ||
| } | ||
| return clone | ||
| } | ||
|
|
||
| // Keys returns the keys in the order they were added. | ||
| func (m *Ordered[K, T]) Keys() []K { | ||
| if m == nil { | ||
| return nil | ||
| } | ||
| return m.keys | ||
| } | ||
|
|
||
| func (m *Ordered[K, T]) Values() []T { | ||
| if m == nil { | ||
| return nil | ||
| } | ||
| var values []T | ||
| for _, k := range m.keys { | ||
| values = append(values, m.values[k]) | ||
| } | ||
| return values | ||
| } | ||
|
|
||
| // Len returns the number of items in the map. | ||
| func (m *Ordered[K, T]) Len() int { | ||
| return len(m.keys) | ||
| } | ||
|
|
||
| // Range calls f sequentially for each key and value present in the map. | ||
| // If f returns false, range stops the iteration. | ||
| // TODO(bep) replace with iter.Seq2 when we bump go Go 1.24. | ||
| func (m *Ordered[K, T]) Range(f func(key K, value T) bool) { | ||
| if m == nil { | ||
| return | ||
| } | ||
| for _, k := range m.keys { | ||
| if !f(k, m.values[k]) { | ||
| return | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| // Copyright 2024 The Hugo Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package maps | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| qt "github.com/frankban/quicktest" | ||
| ) | ||
|
|
||
| func TestOrdered(t *testing.T) { | ||
| c := qt.New(t) | ||
|
|
||
| m := NewOrdered[string, int]() | ||
| m.Set("a", 1) | ||
| m.Set("b", 2) | ||
| m.Set("c", 3) | ||
|
|
||
| c.Assert(m.Keys(), qt.DeepEquals, []string{"a", "b", "c"}) | ||
| c.Assert(m.Values(), qt.DeepEquals, []int{1, 2, 3}) | ||
|
|
||
| v, found := m.Get("b") | ||
| c.Assert(found, qt.Equals, true) | ||
| c.Assert(v, qt.Equals, 2) | ||
|
|
||
| m.Delete("b") | ||
|
|
||
| c.Assert(m.Keys(), qt.DeepEquals, []string{"a", "c"}) | ||
| c.Assert(m.Values(), qt.DeepEquals, []int{1, 3}) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.