Get the list commands up to multi-site level

This commit also unexports some Site methods, making it clear what the external build API really is.

See #2312

diff --git a/commands/list.go b/commands/list.go
index f47b4820cdf3401e753f312b3e2b6169a76c1001..423f1868f704e71c132a8f533578ce05db573724 100644 (file)
--- a/commands/list.go
+++ b/commands/list.go
@@ -51,13 +51,17 @@ var listDraftsCmd = &cobra.Command{
 
                viper.Set("BuildDrafts", true)
 
-               site := &hugolib.Site{}
+               sites, err := hugolib.NewHugoSitesFromConfiguration()
 
-               if err := site.PreProcess(hugolib.BuildCfg{}); err != nil {
+               if err != nil {
+                       return newSystemError("Error creating sites", err)
+               }
+
+               if err := sites.Build(hugolib.BuildCfg{SkipRender: true}); err != nil {
                        return newSystemError("Error Processing Source Content", err)
                }
 
-               for _, p := range site.AllPages {
+               for _, p := range sites.Pages() {
                        if p.IsDraft() {
                                fmt.Println(filepath.Join(p.File.Dir(), p.File.LogicalName()))
                        }
@@ -82,13 +86,17 @@ posted in the future.`,
 
                viper.Set("BuildFuture", true)
 
-               site := &hugolib.Site{}
+               sites, err := hugolib.NewHugoSitesFromConfiguration()
+
+               if err != nil {
+                       return newSystemError("Error creating sites", err)
+               }
 
-               if err := site.PreProcess(hugolib.BuildCfg{}); err != nil {
+               if err := sites.Build(hugolib.BuildCfg{SkipRender: true}); err != nil {
                        return newSystemError("Error Processing Source Content", err)
                }
 
-               for _, p := range site.AllPages {
+               for _, p := range sites.Pages() {
                        if p.IsFuture() {
                                fmt.Println(filepath.Join(p.File.Dir(), p.File.LogicalName()))
                        }
@@ -113,13 +121,17 @@ expired.`,
 
                viper.Set("BuildExpired", true)
 
-               site := &hugolib.Site{}
+               sites, err := hugolib.NewHugoSitesFromConfiguration()
+
+               if err != nil {
+                       return newSystemError("Error creating sites", err)
+               }
 
-               if err := site.PreProcess(hugolib.BuildCfg{}); err != nil {
+               if err := sites.Build(hugolib.BuildCfg{SkipRender: true}); err != nil {
                        return newSystemError("Error Processing Source Content", err)
                }
 
-               for _, p := range site.AllPages {
+               for _, p := range sites.Pages() {
                        if p.IsExpired() {
                                fmt.Println(filepath.Join(p.File.Dir(), p.File.LogicalName()))
                        }

diff --git a/hugolib/hugo_sites.go b/hugolib/hugo_sites.go
index e7a03394428ab7381cd759f1c36c5742de9a2b67..93ffc53da4706d3cbf62c4d05eb30c3a0f5682c6 100644 (file)
--- a/hugolib/hugo_sites.go
+++ b/hugolib/hugo_sites.go
@@ -37,6 +37,8 @@ type HugoSites struct {
        Multilingual *Multilingual
 }
 
+// NewHugoSites creates a new collection of sites given the input sites, building
+// a language configuration based on those.
 func NewHugoSites(sites ...*Site) (*HugoSites, error) {
        languages := make(Languages, len(sites))
        for i, s := range sites {
@@ -56,11 +58,11 @@ func NewHugoSites(sites ...*Site) (*HugoSites, error) {
 
 // NewHugoSitesFromConfiguration creates HugoSites from the global Viper config.
 func NewHugoSitesFromConfiguration() (*HugoSites, error) {
-       sites := make([]*Site, 0)
+       var sites []*Site
        multilingual := viper.GetStringMap("Languages")
        if len(multilingual) == 0 {
                // TODO(bep) multilingo langConfigsList = append(langConfigsList, NewLanguage("en"))
-               sites = append(sites, NewSite(NewLanguage("en")))
+               sites = append(sites, newSite(NewLanguage("en")))
        }
 
        if len(multilingual) > 0 {
@@ -73,7 +75,7 @@ func NewHugoSitesFromConfiguration() (*HugoSites, error) {
                }
 
                for _, lang := range languages {
-                       sites = append(sites, NewSite(lang))
+                       sites = append(sites, newSite(lang))
                }
 
        }
@@ -98,13 +100,14 @@ func (h HugoSites) toSiteInfos() []*SiteInfo {
        return infos
 }
 
+// BuildCfg holds build options used to, as an example, skip the render step.
 type BuildCfg struct {
        // Whether we are in watch (server) mode
        Watching bool
        // Print build stats at the end of a build
        PrintStats bool
        // Skip rendering. Useful for testing.
-       skipRender bool
+       SkipRender bool
        // Use this to add templates to use for rendering.
        // Useful for testing.
        withTemplate func(templ tpl.Template) error
@@ -131,7 +134,7 @@ func (h HugoSites) Build(config BuildCfg) error {
                s.RunMode.Watching = config.Watching
        }
 
-       if err := firstSite.PreProcess(config); err != nil {
+       if err := firstSite.preProcess(config); err != nil {
                return err
        }
 
@@ -146,7 +149,7 @@ func (h HugoSites) Build(config BuildCfg) error {
        }
 
        for _, s := range h.Sites {
-               if err := s.PostProcess(); err != nil {
+               if err := s.postProcess(); err != nil {
                        return err
                }
        }
@@ -155,10 +158,10 @@ func (h HugoSites) Build(config BuildCfg) error {
                return err
        }
 
-       if !config.skipRender {
+       if !config.SkipRender {
                for _, s := range h.Sites {
 
-                       if err := s.Render(); err != nil {
+                       if err := s.render(); err != nil {
                                return err
                        }
 
@@ -201,7 +204,7 @@ func (h HugoSites) Rebuild(config BuildCfg, events ...fsnotify.Event) error {
 
        if sourceChanged {
                for _, s := range h.Sites {
-                       if err := s.PostProcess(); err != nil {
+                       if err := s.postProcess(); err != nil {
                                return err
                        }
                }
@@ -211,9 +214,9 @@ func (h HugoSites) Rebuild(config BuildCfg, events ...fsnotify.Event) error {
                return err
        }
 
-       if !config.skipRender {
+       if !config.SkipRender {
                for _, s := range h.Sites {
-                       if err := s.Render(); err != nil {
+                       if err := s.render(); err != nil {
                                return err
                        }
                        if config.PrintStats {
@@ -256,7 +259,7 @@ func (h *HugoSites) render() error {
        return nil
 }
 
-func (s *HugoSites) setupTranslations(master *Site) {
+func (h *HugoSites) setupTranslations(master *Site) {
 
        for _, p := range master.rawAllPages {
                if p.Lang() == "" {
@@ -265,7 +268,7 @@ func (s *HugoSites) setupTranslations(master *Site) {
 
                shouldBuild := p.shouldBuild()
 
-               for i, site := range s.Sites {
+               for i, site := range h.Sites {
                        if strings.HasPrefix(site.Language.Lang, p.Lang()) {
                                site.updateBuildStats(p)
                                if shouldBuild {
@@ -283,14 +286,14 @@ func (s *HugoSites) setupTranslations(master *Site) {
                        }
                }
 
-               for i := 1; i < len(s.Sites); i++ {
-                       s.Sites[i].AllPages = s.Sites[0].AllPages
+               for i := 1; i < len(h.Sites); i++ {
+                       h.Sites[i].AllPages = h.Sites[0].AllPages
                }
        }
 
-       if len(s.Sites) > 1 {
-               pages := s.Sites[0].AllPages
-               allTranslations := pagesToTranslationsMap(s.Multilingual, pages)
+       if len(h.Sites) > 1 {
+               pages := h.Sites[0].AllPages
+               allTranslations := pagesToTranslationsMap(h.Multilingual, pages)
                assignTranslationsToPages(allTranslations, pages)
        }
 }
@@ -357,6 +360,11 @@ func (h *HugoSites) preRender() error {
        return nil
 }
 
+// Pages returns all pages for all sites.
+func (h HugoSites) Pages() Pages {
+       return h.Sites[0].AllPages
+}
+
 func handleShortcodes(p *Page, t tpl.Template) error {
        if len(p.contentShortCodes) > 0 {
                jww.DEBUG.Printf("Replace %d shortcodes in %q", len(p.contentShortCodes), p.BaseFileName())
@@ -417,7 +425,7 @@ func doBuildSite(s *Site, render bool, additionalTemplates ...string) error {
                return nil
        }
 
-       config := BuildCfg{skipRender: !render, withTemplate: addTemplates}
+       config := BuildCfg{SkipRender: !render, withTemplate: addTemplates}
        return sites.Build(config)
 }
 

diff --git a/hugolib/hugo_sites_test.go b/hugolib/hugo_sites_test.go
index 266a4adb882c50a1519baf703c7edc163042892f..cc8a029937bcc4ab4652d4df2f36637fc6e49afe 100644 (file)
--- a/hugolib/hugo_sites_test.go
+++ b/hugolib/hugo_sites_test.go
@@ -131,8 +131,8 @@ func TestMultiSitesBuild(t *testing.T) {
        // Check taxonomies
        enTags := enSite.Taxonomies["tags"]
        frTags := frSite.Taxonomies["plaques"]
-       require.Len(t, enTags, 2, fmt.Sprintf("Tags in en: %=v", enTags))
-       require.Len(t, frTags, 2, fmt.Sprintf("Tags in fr: %=v", frTags))
+       require.Len(t, enTags, 2, fmt.Sprintf("Tags in en: %v", enTags))
+       require.Len(t, frTags, 2, fmt.Sprintf("Tags in fr: %v", frTags))
        require.NotNil(t, enTags["tag1"])
        require.NotNil(t, frTags["frtag1"])
        readDestination(t, "public/fr/plaques/frtag1/index.html")

diff --git a/hugolib/site.go b/hugolib/site.go
index ad438e2e51c73bf8e4fa56ed6d441abbd45a15c2..3abde5d9780f5557d2e02d7cbb069af07c9d962c 100644 (file)
--- a/hugolib/site.go
+++ b/hugolib/site.go
@@ -99,18 +99,20 @@ type Site struct {
        Language     *Language
 }
 
-// TODO(bep) multilingo
 // Reset returns a new Site prepared for rebuild.
+// TODO(bep) multilingo
 func (s *Site) Reset() *Site {
        return &Site{Language: s.Language, Multilingual: s.Multilingual}
 }
 
-func NewSite(lang *Language) *Site {
+// newSite creates a new site in the given language.
+func newSite(lang *Language) *Site {
        return &Site{Language: lang}
 }
 
+// newSite creates a new site in the default language.
 func newSiteDefaultLang() *Site {
-       return NewSite(newDefaultLanguage())
+       return newSite(newDefaultLanguage())
 }
 
 // Convenience func used in tests.
@@ -593,8 +595,9 @@ func (s *Site) ReBuild(events []fsnotify.Event) (bool, error) {
 
 }
 
+// TODO(bep) ml
 func (s *Site) Analyze() error {
-       if err := s.PreProcess(BuildCfg{}); err != nil {
+       if err := s.preProcess(BuildCfg{}); err != nil {
                return err
        }
        return s.ShowPlan(os.Stdout)
@@ -718,7 +721,7 @@ func (s *Site) readDataFromSourceFS() error {
        return err
 }
 
-func (s *Site) PreProcess(config BuildCfg) (err error) {
+func (s *Site) preProcess(config BuildCfg) (err error) {
        s.timerStep("Go initialization")
        if err = s.initialize(); err != nil {
                return
@@ -740,7 +743,7 @@ func (s *Site) PreProcess(config BuildCfg) (err error) {
 
 }
 
-func (s *Site) PostProcess() (err error) {
+func (s *Site) postProcess() (err error) {
 
        s.setupPrevNext()
 
@@ -763,7 +766,7 @@ func (s *Site) setupPrevNext() {
        }
 }
 
-func (s *Site) Render() (err error) {
+func (s *Site) render() (err error) {
        if err = tpl.SetTranslateLang(s.Language.Lang); err != nil {
                return
        }
@@ -831,7 +834,7 @@ func (s *Site) initialize() (err error) {
        return
 }
 
-// HomeURL is a convenience method giving the absolute URL to the home page.
+// HomeAbsURL is a convenience method giving the absolute URL to the home page.
 func (s *SiteInfo) HomeAbsURL() string {
        base := "/"
        if s.Multilingual {
@@ -1950,7 +1953,7 @@ func (s *Site) renderRobotsTXT() error {
        rLayouts := []string{"robots.txt", "_default/robots.txt", "_internal/_default/robots.txt"}
        outBuffer := bp.GetBuffer()
        defer bp.PutBuffer(outBuffer)
-       err := s.render("robots", n, outBuffer, s.appendThemeTemplates(rLayouts)...)
+       err := s.renderForLayouts("robots", n, outBuffer, s.appendThemeTemplates(rLayouts)...)
 
        if err == nil {
                err = s.writeDestFile("robots.txt", outBuffer)
@@ -2011,7 +2014,7 @@ func (s *Site) renderAndWriteXML(name string, dest string, d interface{}, layout
        defer bp.PutBuffer(renderBuffer)
        renderBuffer.WriteString("<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>\n")
 
-       err := s.render(name, d, renderBuffer, layouts...)
+       err := s.renderForLayouts(name, d, renderBuffer, layouts...)
 
        if err != nil {
                return err
@@ -2041,7 +2044,7 @@ func (s *Site) renderAndWritePage(name string, dest string, d interface{}, layou
        renderBuffer := bp.GetBuffer()
        defer bp.PutBuffer(renderBuffer)
 
-       err := s.render(name, d, renderBuffer, layouts...)
+       err := s.renderForLayouts(name, d, renderBuffer, layouts...)
 
        if err != nil {
                return err
@@ -2126,7 +2129,7 @@ Your rendered home page is blank: /index.html is zero-length
        return err
 }
 
-func (s *Site) render(name string, d interface{}, w io.Writer, layouts ...string) error {
+func (s *Site) renderForLayouts(name string, d interface{}, w io.Writer, layouts ...string) error {
        layout, found := s.findFirstLayout(layouts...)
        if found == false {
                jww.WARN.Printf("Unable to locate layout for %s: %s\n", name, layouts)