Permalink
Browse files

tpl: Add os.fileExists template function

Fixes #3839
  • Loading branch information...
digitalcraftsman authored and bep committed Sep 28, 2017
1 parent b6a3028 commit 2818878994e906c292cbe00cb2a83f1531a21f32
Showing with 91 additions and 0 deletions.
  1. +29 −0 docs/content/functions/fileExists.md
  2. +7 −0 tpl/os/init.go
  3. +19 −0 tpl/os/os.go
  4. +36 −0 tpl/os/os_test.go
@@ -0,0 +1,29 @@
---
title: "fileExists"
linktitle: "fileExists"
date: 2017-08-31T22:38:22+02:00
description: Checks whether a file exists under the given path.
godocref:
publishdate: 2017-08-31T22:38:22+02:00
lastmod: 2017-08-31T22:38:22+02:00
categories: [functions]
menu:
docs:
parent: "functions"
signature: ["fileExists PATH"]
workson: []
hugoversion:
relatedfuncs: []
deprecated: false
aliases: []
---
`fileExists` allows you to check if a file exists under a given path, e.g. before inserting code into a template:
```
{{ if (fileExists "static/img/banner.jpg") -}}
<img src="{{ "img/banner.jpg" | absURL }}" />
{{- end }}
```
In the example above, a banner from the `static` folder should be shown if the given path points to an existing file.
View
@@ -48,6 +48,13 @@ func init() {
},
)
ns.AddMethodMapping(ctx.FileExists,
[]string{"fileExists"},
[][2]string{
{`{{ fileExists "foo.txt" }}`, `false`},
},
)
return ns
}
View
@@ -96,3 +96,22 @@ func (ns *Namespace) ReadDir(i interface{}) ([]_os.FileInfo, error) {
return list, nil
}
// FileExists checks whether a file exists under the given path.
func (ns *Namespace) FileExists(i interface{}) (bool, error) {
path, err := cast.ToStringE(i)
if err != nil {
return false, err
}
if path == "" {
return false, errors.New("fileExists needs a path to a file")
}
status, err := afero.Exists(ns.deps.Fs.WorkingDir, path)
if err != nil {
return false, err
}
return status, nil
}
View
@@ -63,3 +63,39 @@ func TestReadFile(t *testing.T) {
assert.Equal(t, test.expect, result, errMsg)
}
}
func TestFileExists(t *testing.T) {
t.Parallel()
workingDir := "/home/hugo"
v := viper.New()
v.Set("workingDir", workingDir)
ns := New(&deps.Deps{Fs: hugofs.NewMem(v)})
afero.WriteFile(ns.deps.Fs.Source, filepath.Join(workingDir, "/f/f1.txt"), []byte("f1-content"), 0755)
afero.WriteFile(ns.deps.Fs.Source, filepath.Join("/home", "f2.txt"), []byte("f2-content"), 0755)
for i, test := range []struct {
filename string
expect interface{}
}{
{filepath.FromSlash("/f/f1.txt"), true},
{filepath.FromSlash("f/f1.txt"), true},
{filepath.FromSlash("../f2.txt"), false},
{"b", false},
{"", nil},
} {
errMsg := fmt.Sprintf("[%d] %v", i, test)
result, err := ns.FileExists(test.filename)
if test.expect == nil {
require.Error(t, err, errMsg)
continue
}
require.NoError(t, err, errMsg)
assert.Equal(t, test.expect, result, errMsg)
}
}

0 comments on commit 2818878

Please sign in to comment.