From 90b2674ddce69a07007b1ba60eb4808bbb38e8a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Wed, 14 Jun 2023 12:04:32 +0200 Subject: [PATCH] Re-add site.RSSLink (and deprecate it) Fixes #11110 --- hugolib/site_new.go | 11 +++++------ hugolib/site_output_test.go | 3 ++- resources/page/site.go | 11 +++++++++++ 3 files changed, 18 insertions(+), 7 deletions(-) diff --git a/hugolib/site_new.go b/hugolib/site_new.go index 4b3a28bddf1..911414121e0 100644 --- a/hugolib/site_new.go +++ b/hugolib/site_new.go @@ -29,6 +29,7 @@ import ( "github.com/gohugoio/hugo/config" "github.com/gohugoio/hugo/config/allconfig" "github.com/gohugoio/hugo/deps" + "github.com/gohugoio/hugo/helpers" "github.com/gohugoio/hugo/identity" "github.com/gohugoio/hugo/langs" "github.com/gohugoio/hugo/langs/i18n" @@ -345,12 +346,10 @@ func (s *Site) Copyright() string { return s.conf.Copyright } -func (s *Site) RSSLink() string { - rssOutputFormat, found := s.conf.C.KindOutputFormats[page.KindHome].GetByName("rss") - if !found { - return "" - } - return s.permalink(rssOutputFormat.BaseFilename()) +func (s *Site) RSSLink() template.URL { + helpers.Deprecated("Site.RSSLink", "Use the Output Format's Permalink method instead, e.g. .OutputFormats.Get \"RSS\".Permalink", false) + rssOutputFormat := s.home.OutputFormats().Get("rss") + return template.URL(rssOutputFormat.Permalink()) } func (s *Site) Config() page.SiteConfig { diff --git a/hugolib/site_output_test.go b/hugolib/site_output_test.go index c5cee7641de..b598e23d61d 100644 --- a/hugolib/site_output_test.go +++ b/hugolib/site_output_test.go @@ -15,6 +15,7 @@ package hugolib import ( "fmt" + "html/template" "strings" "testing" @@ -248,7 +249,7 @@ baseName = "feed" s := h.Sites[0] // Issue #3450 - c.Assert(s.RSSLink(), qt.Equals, "http://example.com/blog/feed.xml") + c.Assert(s.RSSLink(), qt.Equals, template.URL("http://example.com/blog/feed.xml")) } // Issue #3614 diff --git a/resources/page/site.go b/resources/page/site.go index ccc36a4eebb..6a352ef866c 100644 --- a/resources/page/site.go +++ b/resources/page/site.go @@ -137,6 +137,9 @@ type Site interface { // LanguagePrefix returns the language prefix for this site. LanguagePrefix() string + + // Deprecated. Use site.Home.OutputFormats.Get "rss" instead. + RSSLink() template.URL } // Sites represents an ordered list of sites (languages). @@ -300,6 +303,10 @@ func (s *siteWrapper) LanguagePrefix() string { return s.s.LanguagePrefix() } +func (s *siteWrapper) RSSLink() template.URL { + return s.s.RSSLink() +} + type testSite struct { h hugo.HugoInfo l *langs.Language @@ -444,6 +451,10 @@ func (s testSite) Param(key any) (any, error) { return nil, nil } +func (s testSite) RSSLink() template.URL { + return "" +} + // NewDummyHugoSite creates a new minimal test site. func NewDummyHugoSite(conf config.AllProvider) Site { return testSite{