]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
Rename DefaultPageSize => PagerSize
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sat, 8 Jun 2024 20:28:02 +0000 (22:28 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sun, 9 Jun 2024 10:28:24 +0000 (12:28 +0200)
This was recently introduced. so no breaking change.

The thing is:

* We do not commonly use the prefix Default* even if it can be overridden in the templates.
* PagerSize makes more sense and is also the term used in the code.

config/allconfig/allconfig.go
config/allconfig/allconfig_integration_test.go
config/allconfig/alldecoders.go
config/commonConfig.go
resources/page/pagination.go

index 64288e8878a964dcb4b19b3bc89b66bc773de26a..9f899939b546cd2382f3b13959e0ad325c051b70 100644 (file)
@@ -374,8 +374,8 @@ func (c *Config) CompileConfig(logger loggers.Logger) error {
 
        // Legacy paginate values.
        if c.Paginate != 0 {
-               hugo.Deprecate("site config key paginate", "Use paginator.defaultPageSize instead.", "v0.128.0")
-               c.Pagination.DefaultPageSize = c.Paginate
+               hugo.Deprecate("site config key paginate", "Use paginator.pagerSize instead.", "v0.128.0")
+               c.Pagination.PagerSize = c.Paginate
        }
 
        if c.PaginatePath != "" {
index a71a28ed75842cbd3d2a8d26b1f0d9b2a9b3261e..7dc0d230eb9d183e44986fa58085d68b45d99550 100644 (file)
@@ -122,9 +122,9 @@ func TestPaginationConfigOld(t *testing.T) {
        confDe := b.H.Sites[1].Conf.Pagination()
 
        b.Assert(confEn.Path, qt.Equals, "page-en")
-       b.Assert(confEn.DefaultPageSize, qt.Equals, 10)
+       b.Assert(confEn.PagerSize, qt.Equals, 10)
        b.Assert(confDe.Path, qt.Equals, "page-de")
-       b.Assert(confDe.DefaultPageSize, qt.Equals, 20)
+       b.Assert(confDe.PagerSize, qt.Equals, 20)
 }
 
 func TestPaginationConfigNew(t *testing.T) {
@@ -133,7 +133,7 @@ func TestPaginationConfigNew(t *testing.T) {
  [languages.en]
  weight = 1
  [languages.en.pagination]
defaultPageSize = 20
pagerSize = 20
  [languages.de]
  weight = 2
  [languages.de.pagination]
@@ -147,9 +147,9 @@ func TestPaginationConfigNew(t *testing.T) {
        confDe := b.H.Sites[1].Conf.Pagination()
 
        b.Assert(confEn.Path, qt.Equals, "page")
-       b.Assert(confEn.DefaultPageSize, qt.Equals, 20)
+       b.Assert(confEn.PagerSize, qt.Equals, 20)
        b.Assert(confDe.Path, qt.Equals, "page-de")
-       b.Assert(confDe.DefaultPageSize, qt.Equals, 10)
+       b.Assert(confDe.PagerSize, qt.Equals, 10)
 }
 
 func TestPaginationConfigDisableAliases(t *testing.T) {
@@ -158,7 +158,7 @@ func TestPaginationConfigDisableAliases(t *testing.T) {
 disableKinds = ["taxonomy", "term"]
 [pagination]
 disableAliases = true
-defaultPageSize = 2
+pagerSize = 2
 -- layouts/_default/list.html --
 {{ $paginator := .Paginate  site.RegularPages }}
 {{ template "_internal/pagination.html" . }}
index 46dd59bbc20016a1effd4110ac53ca84f43bfa03..c09aa0ff0a2f49d1b0e4d52910066b1549d952f1 100644 (file)
@@ -331,8 +331,8 @@ var allDecoderSetups = map[string]decodeWeight{
                key: "pagination",
                decode: func(d decodeWeight, p decodeConfig) error {
                        p.c.Pagination = config.Pagination{
-                               DefaultPageSize: 10,
-                               Path:            "page",
+                               PagerSize: 10,
+                               Path:      "page",
                        }
                        if p.p.IsSet(d.key) {
                                if err := mapstructure.WeakDecode(p.p.Get(d.key), &p.c.Pagination); err != nil {
index 40650c5755ec2a7aa218a63f03b672af6a280707..6e41ac7f062613250434b23b39dd19fa1778b381 100644 (file)
@@ -413,8 +413,8 @@ func DecodeServer(cfg Provider) (Server, error) {
 
 // Pagination configures the pagination behavior.
 type Pagination struct {
-       //  Default number of elements per page in pagination.
-       DefaultPageSize int
+       //  Default number of elements per pager in pagination.
+       PagerSize int
 
        // The path element used during pagination.
        Path string
index d24879e6289b49fa39d7a49e8bc2c66d78df10d0..7794817927807cd40c22b2178b35330e2fc79efe 100644 (file)
@@ -263,7 +263,7 @@ func splitPageGroups(pageGroups PagesGroup, size int) []paginatedElement {
 
 func ResolvePagerSize(conf config.AllProvider, options ...any) (int, error) {
        if len(options) == 0 {
-               return conf.Pagination().DefaultPageSize, nil
+               return conf.Pagination().PagerSize, nil
        }
 
        if len(options) > 1 {