Normalize paths within hugo

filepath was used inconsistently throughout the hugolib.  With the
introduction of source and target modules, all path are normalized to
"/".  This simplifies the processing of paths.  It does mean that
contributors need to be aware of using path/filepath in any module other
than source or target is not recommended.  The current exception is
hugolib/config.go

diff --git a/hugolib/config.go b/hugolib/config.go
index 12dc544c794389c8e49fb91b68829c5d5bd277e4..030a5c945e2876616118216a57ace155dc55cf8d 100644 (file)
--- a/hugolib/config.go
+++ b/hugolib/config.go
@@ -103,7 +103,7 @@ func (c *Config) readInConfig() {
 
 func (c *Config) setPath(p string) {
        if p == "" {
-               path, err := FindPath()
+               path, err := findPath()
                if err != nil {
                        fmt.Printf("Error finding path: %s", err)
                }
@@ -124,7 +124,7 @@ func (c *Config) GetPath() string {
        return c.Path
 }
 
-func FindPath() (string, error) {
+func findPath() (string, error) {
        serverFile, err := filepath.Abs(os.Args[0])
 
        if err != nil {
@@ -147,13 +147,14 @@ func FindPath() (string, error) {
        return path, nil
 }
 
+// GetAbsPath return the absolute path for a given path with the internal slashes
+// properly converted.
 func (c *Config) GetAbsPath(name string) string {
        if filepath.IsAbs(name) {
                return name
        }
 
-       p := filepath.Join(c.GetPath(), name)
-       return p
+       return filepath.ToSlash(filepath.Join(c.GetPath(), name))
 }
 
 func (c *Config) findConfigFile(configFileName string) (string, error) {

diff --git a/hugolib/page.go b/hugolib/page.go
index 6289fc61cce4c0a2fafec47019068b0015c69de2..5721412f5047c02eba7dc3c05d9206ae8710f05e 100644 (file)
--- a/hugolib/page.go
+++ b/hugolib/page.go
@@ -26,16 +26,13 @@ import (
        "html/template"
        "io"
        "launchpad.net/goyaml"
-       "os"
-       "path/filepath"
+       "path"
        "sort"
        "strings"
        "time"
        "unicode"
 )
 
-var _ = filepath.Base("")
-
 type Page struct {
        Status          string
        Images          []string
@@ -135,7 +132,7 @@ func StripHTML(s string) string {
 
 func (p *Page) guessSection() {
        if p.Section == "" {
-               x := strings.Split(p.FileName, string(os.PathSeparator))
+               x := strings.Split(p.FileName, "/")
                if len(x) > 1 {
                        if section := x[len(x)-2]; section != "content" {
                                p.Section = section
@@ -223,26 +220,26 @@ func (p *Page) Permalink() template.HTML {
        section := strings.TrimSpace(p.Section)
        pSlug := strings.TrimSpace(p.Slug)
        pUrl := strings.TrimSpace(p.Url)
-       var path string
+       var permalink string
        if len(pSlug) > 0 {
                if p.Site.Config.UglyUrls {
-                       path = section + "/" + p.Slug + "." + p.Extension
+                       permalink = section + "/" + p.Slug + "." + p.Extension
                } else {
-                       path = section + "/" + p.Slug + "/"
+                       permalink = section + "/" + p.Slug + "/"
                }
        } else if len(pUrl) > 2 {
-               path = pUrl
+               permalink = pUrl
        } else {
-               _, t := filepath.Split(p.FileName)
+               _, t := path.Split(p.FileName)
                if p.Site.Config.UglyUrls {
                        x := replaceExtension(strings.TrimSpace(t), p.Extension)
-                       path = section + "/" + x
+                       permalink = section + "/" + x
                } else {
                        file, _ := fileExt(strings.TrimSpace(t))
-                       path = section + "/" + file
+                       permalink = section + "/" + file
                }
        }
-       return template.HTML(MakePermalink(baseUrl, path))
+       return template.HTML(MakePermalink(baseUrl, permalink))
 }
 
 func (page *Page) handleTomlMetaData(datum []byte) (interface{}, error) {

diff --git a/hugolib/page_test.go b/hugolib/page_test.go
index 7acbcedab65ca4a8a72b14ebfe54912802c140f3..72833bb7dd3379760fa5a2d31e90d10905ad61a2 100644 (file)
--- a/hugolib/page_test.go
+++ b/hugolib/page_test.go
@@ -2,7 +2,7 @@ package hugolib
 
 import (
        "html/template"
-       "path/filepath"
+       "path"
        "strings"
        "testing"
        "time"
@@ -260,7 +260,7 @@ func TestDegenerateInvalidFrontMatterLeadingWhitespace(t *testing.T) {
 }
 
 func TestSectionEvaluation(t *testing.T) {
-       page, _ := ReadFrom(strings.NewReader(SIMPLE_PAGE), filepath.FromSlash("blue/file1.md"))
+       page, _ := ReadFrom(strings.NewReader(SIMPLE_PAGE), "blue/file1.md")
        if page.Section != "blue" {
                t.Errorf("Section should be %s, got: %s", "blue", page.Section)
        }
@@ -268,11 +268,11 @@ func TestSectionEvaluation(t *testing.T) {
 
 func TestLayoutOverride(t *testing.T) {
        var (
-               path_content_one_dir = filepath.Join("content", "gub", "file1.md")
-               path_content_two_dir = filepath.Join("content", "dub", "sub", "file1.md")
-               path_content_no_dir  = filepath.Join("content", "file1")
-               path_one_directory   = filepath.Join("fub", "file1.md")
-               path_no_directory    = filepath.Join("file1.md")
+               path_content_one_dir = path.Join("content", "gub", "file1.md")
+               path_content_two_dir = path.Join("content", "dub", "sub", "file1.md")
+               path_content_no_dir  = path.Join("content", "file1")
+               path_one_directory   = path.Join("fub", "file1.md")
+               path_no_directory    = path.Join("file1.md")
        )
        tests := []struct {
                content        string

diff --git a/hugolib/path_seperators_test.go b/hugolib/path_seperators_test.go
index 4f9e7cdfdc9c0e460e405e58154c4d3385657859..1c7f7eb10e85993124855d4eb36ee85bd9a1c907 100644 (file)
--- a/hugolib/path_seperators_test.go
+++ b/hugolib/path_seperators_test.go
@@ -1,7 +1,7 @@
 package hugolib
 
 import (
-       "path/filepath"
+       "path"
        "strings"
        "testing"
 )
@@ -13,7 +13,7 @@ Sample Text
 `
 
 func TestDegenerateMissingFolderInPageFilename(t *testing.T) {
-       p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_YAML), filepath.Join("foobar"))
+       p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_YAML), path.Join("foobar"))
        if err != nil {
                t.Fatalf("Error in ReadFrom")
        }
@@ -28,9 +28,9 @@ func TestNewPageWithFilePath(t *testing.T) {
                section string
                layout  string
        }{
-               {filepath.Join("sub", "foobar.html"), "sub", "sub/single.html"},
-               {filepath.Join("content", "sub", "foobar.html"), "sub", "sub/single.html"},
-               {filepath.Join("content", "dub", "sub", "foobar.html"), "sub", "sub/single.html"},
+               {path.Join("sub", "foobar.html"), "sub", "sub/single.html"},
+               {path.Join("content", "sub", "foobar.html"), "sub", "sub/single.html"},
+               {path.Join("content", "dub", "sub", "foobar.html"), "sub", "sub/single.html"},
        }
 
        for _, el := range toCheck {

diff --git a/hugolib/site.go b/hugolib/site.go
index 9b466590162d9c64d917a98977549cc1ee4ca281..3db3a5ee5eedcba63b0841fa0ae8db33616db17f 100644 (file)
--- a/hugolib/site.go
+++ b/hugolib/site.go
@@ -24,7 +24,7 @@ import (
        "github.com/spf13/nitro"
        "html/template"
        "os"
-       "path/filepath"
+       "path"
        "strings"
        "time"
 )
@@ -264,7 +264,9 @@ func (s *Site) CreatePages() (err error) {
                }
                page.Site = s.Info
                page.Tmpl = s.Tmpl
-               _ = s.setUrlPath(page)
+               if err = s.setUrlPath(page); err != nil {
+                       return err
+               }
                s.setOutFile(page)
                if s.Config.BuildDrafts || !page.Draft {
                        s.Pages = append(s.Pages, page)
@@ -288,15 +290,15 @@ func (s *Site) setupPrevNext() {
 }
 
 func (s *Site) setUrlPath(p *Page) error {
-       y := strings.TrimPrefix(p.FileName, s.Config.GetAbsPath(s.Config.ContentDir))
-       x := strings.Split(y, string(os.PathSeparator))
+       y := strings.TrimPrefix(p.FileName, s.absContentDir())
+       x := strings.Split(y, "/")
 
        if len(x) <= 1 {
                return fmt.Errorf("Zero length page name")
        }
 
-       p.Section = strings.Trim(x[1], "/\\")
-       p.Path = strings.Trim(strings.Join(x[:len(x)-1], string(os.PathSeparator)), "/\\")
+       p.Section = strings.Trim(x[1], "/")
+       p.Path = path.Join(x[:len(x)-1]...)
        return nil
 }
 
@@ -320,11 +322,11 @@ func (s *Site) setOutFile(p *Page) {
                outfile = strings.TrimSpace(p.Slug) + "." + p.Extension
        } else {
                // Fall back to filename
-               _, t := filepath.Split(p.FileName)
+               _, t := path.Split(p.FileName)
                outfile = replaceExtension(strings.TrimSpace(t), p.Extension)
        }
 
-       p.OutFile = p.Path + string(os.PathSeparator) + strings.TrimSpace(outfile)
+       p.OutFile = p.Path + "/" + strings.TrimSpace(outfile)
 }
 
 func (s *Site) BuildSiteMeta() (err error) {
@@ -524,7 +526,7 @@ func (s *Site) RenderLists() error {
                if err != nil {
                        return err
                }
-               err = s.WritePublic(section+"/index.html", content.Bytes())
+               err = s.WritePublic(section, content.Bytes())
                if err != nil {
                        return err
                }

diff --git a/hugolib/site_url_test.go b/hugolib/site_url_test.go
index e506ee66b86e0d048756ccaa8fa167592608a48b..f6098634b86eec6b2dd3173ac498d7cdea10bce0 100644 (file)
--- a/hugolib/site_url_test.go
+++ b/hugolib/site_url_test.go
@@ -3,7 +3,6 @@ package hugolib
 import (
        "bytes"
        "io"
-       "path/filepath"
        "strings"
        "testing"
 )
@@ -49,8 +48,8 @@ func TestPageCount(t *testing.T) {
        s := &Site{Target: target}
        s.prepTemplates()
        must(s.addTemplate("indexes/blue.html", INDEX_TEMPLATE))
-       s.Pages = append(s.Pages, mustReturn(ReadFrom(strings.NewReader(SLUG_DOC_1), filepath.FromSlash("content/blue/doc1.md"))))
-       s.Pages = append(s.Pages, mustReturn(ReadFrom(strings.NewReader(SLUG_DOC_2), filepath.FromSlash("content/blue/doc2.md"))))
+       s.Pages = append(s.Pages, mustReturn(ReadFrom(strings.NewReader(SLUG_DOC_1), "content/blue/doc1.md")))
+       s.Pages = append(s.Pages, mustReturn(ReadFrom(strings.NewReader(SLUG_DOC_2), "content/blue/doc2.md")))
 
        if err := s.BuildSiteMeta(); err != nil {
                t.Errorf("Unable to build site metadata: %s", err)
@@ -60,7 +59,7 @@ func TestPageCount(t *testing.T) {
                t.Errorf("Unable to render site lists: %s", err)
        }
 
-       blueIndex := target.files["blue/index.html"]
+       blueIndex := target.files["blue"]
        if blueIndex == nil {
                t.Errorf("No indexed rendered. %v", target.files)
        }

diff --git a/source/filesystem.go b/source/filesystem.go
index 5434431aa42bd78c6c0fc12d3ba4ca33536b6935..da3983aec3e28cf9becfc1927bbc38348f459c1f 100644 (file)
--- a/source/filesystem.go
+++ b/source/filesystem.go
@@ -27,6 +27,7 @@ func (f *Filesystem) Files() []*File {
 }
 
 func (f *Filesystem) add(name string, reader io.Reader) {
+       name = filepath.ToSlash(name)
        f.files = append(f.files, &File{Name: name, Contents: reader})
 }
 

diff --git a/target/file_test.go b/target/file_test.go
index ee474c1c40ca8e3a97ce1bf88b64c6e51b943452..1ac1f3c7986690d95f18177b6dd9564cb6bc43c6 100644 (file)
--- a/target/file_test.go
+++ b/target/file_test.go
@@ -14,6 +14,8 @@ func TestFileTranslator(t *testing.T) {
                {"foo", "foo/index.html"},
                {"foo.html", "foo/index.html"},
                {"foo.xhtml", "foo/index.xhtml"},
+               {"section", "section/index.html"},
+               {"section/", "section/index.html"},
                {"section/foo", "section/foo/index.html"},
                {"section/foo.html", "section/foo/index.html"},
                {"section/foo.rss", "section/foo/index.rss"},
@@ -34,7 +36,7 @@ func TestFileTranslator(t *testing.T) {
 
 func TestFileTranslatorBase(t *testing.T) {
        tests := []struct {
-               content string
+               content  string
                expected string
        }{
                {"/", "a/base/index.html"},
@@ -64,6 +66,7 @@ func TestTranslateUglyUrls(t *testing.T) {
        }{
                {"foo.html", "foo.html"},
                {"/", "index.html"},
+               {"section", "section.html"},
                {"index.html", "index.html"},
        }