Extend PageMatcher with Environment keyword

Fixes gohugoio#9612

hugolib/cascade_test.go

@@ -547,6 +547,33 @@ kind="section"
 		b.AssertFileContent("public/index.html", `
 P1|p1:p1|p2:|
 S1|p1:|p2:p2|
+`)
+
+	})
+
+	c.Run("slice with environment _target", func(c *qt.C) {
+		b := newBuilder(c)
+
+		b.WithContent("_index.md", `+++
+title = "Home"
+[[cascade]]
+p1 = "p1"
+[cascade._target]
+path="**p1**"
+environment="testing"
+[[cascade]]
+p2 = "p2"
+[cascade._target]
+kind="section"
+environment="production"
++++
+`)
+
+		b.Build(BuildCfg{})
+
+		b.AssertFileContent("public/index.html", `
+P1|p1:|p2:|
+S1|p1:|p2:p2|
 `)
 	})
 

hugolib/page__meta.go

@@ -167,6 +167,10 @@ func (p *pageMeta) Description() string {
 	return p.description
 }
 
+func (p *pageMeta) Environment() string {
+	return p.s.Environment()
+}
+
 func (p *pageMeta) Lang() string {
 	return p.s.Lang()
 }

hugolib/site.go

@@ -1897,6 +1897,10 @@ func (s *Site) shouldBuild(p page.Page) bool {
 		s.BuildDrafts, p.Draft(), p.PublishDate(), p.ExpiryDate())
 }
 
+func (s *Site) Environment() string {
+	return s.Info.Hugo().Environment
+}
+
 func shouldBuild(buildFuture bool, buildExpired bool, buildDrafts bool, Draft bool,
 	publishDate time.Time, expiryDate time.Time) bool {
 	if !(buildDrafts || !Draft) {

resources/page/page.go

@@ -151,6 +151,9 @@ type PageMetaProvider interface {
 	// Whether this is a draft. Will only be true if run with the --buildDrafts (-D) flag.
 	Draft() bool
 
+	// Environment returns the environment of the Page
+	Environment() string
+
 	// IsHome returns whether this is the home page.
 	IsHome() bool
 

resources/page/page_matcher.go

@@ -37,6 +37,9 @@ type PageMatcher struct {
 
 	// A Glob pattern matching the Page's language, e.g. "{en,sv}".
 	Lang string
+
+	// A Glob pattern matching the Page's Environment, e.g. "{production,development}".
+	Environment string
 }
 
 // Matches returns whether p matches this matcher.
@@ -67,6 +70,13 @@ func (m PageMatcher) Matches(p Page) bool {
 		}
 	}
 
+	if m.Environment != "" {
+		g, err := glob.GetGlob(m.Environment)
+		if err == nil && !g.Match(p.Environment()) {
+			return false
+		}
+	}
+
 	return true
 }
 

resources/page/page_matcher_test.go

@@ -23,7 +23,10 @@ import (
 func TestPageMatcher(t *testing.T) {
 	c := qt.New(t)
 
-	p1, p2, p3 := &testPage{path: "/p1", kind: "section", lang: "en"}, &testPage{path: "p2", kind: "page", lang: "no"}, &testPage{path: "p3", kind: "page", lang: "en"}
+	p1, p2, p3 :=
+		&testPage{path: "/p1", kind: "section", lang: "en", environment: "development"},
+		&testPage{path: "p2", kind: "page", lang: "no", environment: "production"},
+		&testPage{path: "p3", kind: "page", lang: "en"}
 
 	c.Run("Matches", func(c *qt.C) {
 		m := PageMatcher{Kind: "section"}
@@ -50,6 +53,16 @@ func TestPageMatcher(t *testing.T) {
 		c.Assert(m.Matches(p1), qt.Equals, true)
 		c.Assert(m.Matches(p2), qt.Equals, false)
 		c.Assert(m.Matches(p3), qt.Equals, true)
+
+		m = PageMatcher{Environment: "development"}
+		c.Assert(m.Matches(p1), qt.Equals, true)
+		c.Assert(m.Matches(p2), qt.Equals, false)
+		c.Assert(m.Matches(p3), qt.Equals, false)
+
+		m = PageMatcher{Environment: "production"}
+		c.Assert(m.Matches(p1), qt.Equals, false)
+		c.Assert(m.Matches(p2), qt.Equals, true)
+		c.Assert(m.Matches(p3), qt.Equals, false)
 	})
 
 	c.Run("Decode", func(c *qt.C) {

resources/page/page_nop.go

@@ -120,6 +120,10 @@ func (p *nopPage) Description() string {
 	return ""
 }
 
+func (p *nopPage) Environment() string {
+	return ""
+}
+
 func (p *nopPage) RefFrom(argsm map[string]any, source any) (string, error) {
 	return "", nil
 }

resources/page/testhelpers_test.go

@@ -94,6 +94,7 @@ type testPage struct {
 	linkTitle   string
 	lang        string
 	section     string
+	environment string
 
 	content string
 
@@ -168,6 +169,10 @@ func (p *testPage) Data() any {
 	return p.data
 }
 
+func (p *testPage) Environment() string {
+	return p.environment
+}
+
 func (p *testPage) Sitemap() config.Sitemap {
 	return config.Sitemap{}
 }