Skip to content

Commit

Permalink
resources/page: Deprecate .Sites.First in favor of .Sites.Default
Browse files Browse the repository at this point in the history
Closes #12513
  • Loading branch information
jmooring authored and bep committed Jun 1, 2024
1 parent 0068f03 commit c8dac67
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 3 deletions.
2 changes: 1 addition & 1 deletion hugolib/pages_language_merge_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func TestMergeLanguages(t *testing.T) {

firstNN := nnSite.RegularPages()[0]
c.Assert(len(firstNN.Sites()), qt.Equals, 4)
c.Assert(firstNN.Sites().First().Language().Lang, qt.Equals, "en")
c.Assert(firstNN.Sites().Default().Language().Lang, qt.Equals, "en")

nnBundle := nnSite.getPageOldVersion("page", "bundle")
enBundle := enSite.getPageOldVersion("page", "bundle")
Expand Down
11 changes: 9 additions & 2 deletions resources/page/site.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,15 @@ type Site interface {
// Sites represents an ordered list of sites (languages).
type Sites []Site

// First is a convenience method to get the first Site, i.e. the main language.
// Deprecated: Use .Sites.Default instead.
func (s Sites) First() Site {
hugo.Deprecate(".Sites.First", "Use .Sites.Default instead.", "v0.127.0")
return s.Default()
}

// Default is a convenience method to get the site corresponding to the default
// content language.
func (s Sites) Default() Site {
if len(s) == 0 {
return nil
}
Expand All @@ -165,7 +172,7 @@ func (s *siteWrapper) Key() string {
return s.s.Language().Lang
}

// // Deprecated: Use .Site.Params instead.
// Deprecated: Use .Site.Params instead.
func (s *siteWrapper) Social() map[string]string {
return s.s.Social()
}
Expand Down
44 changes: 44 additions & 0 deletions resources/page/site_integration_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// 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 page_test

import (
"testing"

"github.com/gohugoio/hugo/hugolib"
)

// Issue 12513
func TestPageSiteSitesDefault(t *testing.T) {
t.Parallel()

files := `
-- hugo.toml --
disableKinds = ['page','rss','section','sitemap','taxonomy','term']
defaultContentLanguage = 'de'
defaultContentLanguageInSubdir = true
[languages.en]
languageName = 'English'
weight = 1
[languages.de]
languageName = 'Deutsch'
weight = 2
-- layouts/index.html --
{{ .Site.Sites.Default.Language.LanguageName }}
`

b := hugolib.Test(t, files)

b.AssertFileContent("public/de/index.html", "Deutsch")
}

0 comments on commit c8dac67

Please sign in to comment.