Merge pull request #103 from enthus1ast/fixImports

Fix imports

.gitignore

@@ -15,4 +15,6 @@ tests/basic/test_if
 tests/basic/test_if_complex
 tests/basic/test_insert
 tests/basic/test_simple
-tests/basic/test_while
+tests/basic/test_while
+src/nimja/parser
+src/nimja/sharedhelper

examples/fromReadme/server.nim

@@ -19,7 +19,7 @@ proc renderIndex(title: string, users: seq[User]): string =
   ## so it can access all variables like `title` and `users`
   ## the return variable could be `string` or `Rope` or
   ## anything which has a `&=`(obj: YourObj, str: string) proc.
-  compileTemplateFile(getScriptDir() / "index.nimja")
+  compileTemplateFile("index.nimja", baseDir = getScriptDir())
 
 proc main {.async.} =
   var server = newAsyncHttpServer()

examples/prologue/serverJester.nim

@@ -17,15 +17,15 @@ const users = @[
 ]
 
 proc renderIndex(title: string, users: seq[User]): string =
-  compileTemplateFile(getScriptDir() / "index.nimja")
+  compileTemplateFile("index.nimja", baseDir = getScriptDir())
 
 proc renderUser(title: string, idx: int, users: seq[User]): string =
   let user = users[idx]
-  compileTemplateFile(getScriptDir() / "user.nimja")
+  compileTemplateFile("user.nimja", baseDir = getScriptDir())
 
 proc renderError(title: auto, code: HttpCode, users: seq[User]): string =
   ## title is `auto` here; nim generics work as well!
-  compileTemplateFile(getScriptDir() / "error.nimja")
+  compileTemplateFile("error.nimja", baseDir = getScriptDir())
 
 routes:
   get "/":

examples/prologue/serverPrologue.nim

@@ -23,15 +23,15 @@ method extend(ctx: Context) =
   ]
 
 proc renderIndex(title: string, users: seq[User]): string =
-  compileTemplateFile(getScriptDir() / "index.nimja")
+  compileTemplateFile("index.nimja", baseDir = getScriptDir())
 
 proc renderUser(title: string, idx: int, users: seq[User]): string =
   let user = users[idx]
-  compileTemplateFile(getScriptDir() / "user.nimja")
+  compileTemplateFile("user.nimja", baseDir = getScriptDir())
 
 proc renderError(title: auto, code: HttpCode, users: seq[User]): string =
   ## title is `auto` here; nim generics work as well!
-  compileTemplateFile(getScriptDir() / "error.nimja")
+  compileTemplateFile("error.nimja", baseDir = getScriptDir())
 
 proc hello*(ctx: Context) {.async.} =
   resp renderIndex("someTitle", UserContext(ctx).users)

nimja.nimble

@@ -1,6 +1,6 @@
 # Package
 
-version       = "0.8.7"
+version       = "0.9.0"
 
 author        = "David Krause"
 description   = "typed and compiled template engine inspired by jinja2, twig and onionhammer/nim-templates for Nim."

readme.md

@@ -68,7 +68,7 @@ proc renderIndex(title: string, users: seq[User]): string =
   ## so it can access all variables like `title` and `users`
   ## the return variable could be `string` or `Rope` or
   ## anything which has a `&=`(obj: YourObj, str: string) proc.
-  compileTemplateFile(getScriptDir() / "index.nimja")
+  compileTemplateFile("index.nimja", baseDir = getScriptDir())
 
 proc main {.async.} =
   var server = newAsyncHttpServer()
@@ -258,7 +258,7 @@ you should use it like so:
 ```nim
 import os # for `/`
 proc myRenderProc(someParam: string): string =
-  compileTemplateFile(getScriptDir() / "myFile.html")
+  compileTemplateFile("myFile.html", baseDir = getScriptDir())
 
 echo myRenderProc("test123")
 ```
@@ -379,7 +379,7 @@ situations where you want to inline a render call.
 ```nim
 let leet = 1337
 echo tmpls("foo {{leet}}")
-echo tmplf(getScriptDir() / "templates" / "myfile.nimja")
+echo tmplf("templates" / "myfile.nimja", baseDir = getScriptDir())
 ```
 
 A context can be supplied to the template, to override variable names:
@@ -525,7 +525,7 @@ if the child.nimja is compiled then rendered like so:
 
 ```nim
 proc renderChild(): string =
-  compileTemplateFile(getScriptDir() / "child.nimja")
+  compileTemplateFile("child.nimja", baseDir = getScriptDir())
 
 echo renderChild()
 ```
@@ -780,7 +780,7 @@ Good for documentation etc..
 
 ```nim
 proc test(): string =
-  let path = (getScriptDir() / "tests/basic" / "includeRawT.txt")
+  let path = ("tests/basic" / "includeRawT.txt", baseDir = getScriptDir())
   compileTemplateStr("""pre{{ includeRaw(path) }}suf""")
 ```
 
@@ -1012,10 +1012,10 @@ import os # for `/`
 
 proc index*(): string {.exportc, dynlib.} =
   var foos =  1351 # change me i'm dynamic :)
-  compileTemplateFile(getScriptDir() / "templates/index.nimja")
+  compileTemplateFile("templates/index.nimja", baseDir = getScriptDir())
 
 proc detail*(id: string): string {.exportc, dynlib.} =
-  compileTemplateFile(getScriptDir() / "templates/detail.nimja")
+  compileTemplateFile("templates/detail.nimja", baseDir = getScriptDir())
 
 ```
 
@@ -1107,9 +1107,20 @@ Changelog
 =========
 
 ## TODO
-- 0.8.?
+- 0.?.?
   - Added context to `importnimja`
 ## DONE
+- 0.9.0
+  - BREAKING CHANGE!
+  - in order to fix #15 & #89 and to enable nimja components imported from other modules,
+    all proc (`tmpls`, `tmplf`, `compileTemplateString` and `compileTemplateFile`) got an `baseDir` param:
+    ```
+        compileTemplateStr("""{{importnimja "some/template.nimja"}}""", baseDir = getScriptDir())
+        tmpls("""{{importnimja "some/template.nimja"}}""", baseDir = getScriptDir())
+        compileTemplateFile("some/template.nimja", baseDir = getScriptDir())
+        tmpls("some/template.nimja", baseDir = getScriptDir())
+    ```
+    The use of `tmplf(getScriptDir() / "foo.nimja")` is discourage. It could still work in some cirumstances though.
 - 0.8.7
   - Removed unused `NImport`.
   - Error on uneven `when` blocks.

src/nimja/parser.nim

@@ -75,6 +75,7 @@ var cacheNwtNode {.compileTime.}: Table[string, seq[NwtNode]] ## a cache for ren
 var cacheNwtNodeFile {.compileTime.}: Table[Path, string] ## a cache for content of a path
 var nwtIter {.compileTime.} = false
 var nwtVarname {.compileTime.}: string
+var nwtBaseDir {.compileTime.}: string 
 var blocks {.compileTime.} : Table[string, seq[NwtNode]]
 var guessedStringLen {.compileTime.} = 0
 
@@ -292,8 +293,7 @@ converter singleNwtNodeToSeq(nwtNode: NwtNode): seq[NwtNode] =
   return @[nwtNode]
 
 proc importNimja(nodes: var seq[NwtNode], path: string) =
-  const basePath = getScriptDir()
-  var str = read(basePath / path)
+  var str = read(nwtBaseDir / path)
   nodes = compile(str)
 
 proc parseSecondStepOne(fsTokens: seq[FSNode], pos: var int): seq[NwtNode] =
@@ -665,20 +665,20 @@ proc loadCacheFile(path: Path): string =
   ## The second time the same file should be read
   ## it is returned from the cache
   when defined(nwtCacheOff):
-    return read(path)
+    return read(nwtBaseDir / path)
   else:
-    if cacheNwtNodeFile.contains(path):
-      return cacheNwtNodeFile[path]
+    if cacheNwtNodeFile.contains(nwtBaseDir / path):
+      return cacheNwtNodeFile[nwtBaseDir / path]
     else:
-      cacheNwtNodeFile[path] = read(path)
-      return cacheNwtNodeFile[path]
+      cacheNwtNodeFile[nwtBaseDir / path] = read(nwtBaseDir / path)
+      return cacheNwtNodeFile[nwtBaseDir / path]
 
 proc extend(str: string, templateCache: var Deque[seq[NwtNode]]) =
   var secondsStepTokens = loadCache(str)
   let foundExtendAt = validExtend(secondsStepTokens)
   if foundExtendAt > -1:
     templateCache.addFirst secondsStepTokens
-    let ext = loadCacheFile(getScriptDir() / secondsStepTokens[foundExtendAt].extendsPath)
+    let ext = loadCacheFile(secondsStepTokens[foundExtendAt].extendsPath)
     extend(ext, templateCache)
   else:
     templateCache.addFirst secondsStepTokens
@@ -784,7 +784,7 @@ template tmplsMacroImpl() =
     alias.add body
     result.add alias
 
-macro compileTemplateStr*(str: typed, iter: static bool = false,
+macro compileTemplateStr*(str: typed, baseDir: static string = "", iter: static bool = false,
     varname: static string = "result", context: untyped = nil): untyped =
   ## Compiles a Nimja template from a string.
   ##
@@ -825,11 +825,13 @@ macro compileTemplateStr*(str: typed, iter: static bool = false,
   # Please note, currently the context **cannot be** procs/funcs etc.
   nwtVarname = varname
   nwtIter = iter
+  nwtBaseDir = baseDir
+  echo "inCompileTemplateStr: ", nwtBaseDir
   tmplsMacroImpl()
   doCompile(str.strVal, result)
 
-macro compileTemplateFile*(path: static string, iter: static bool = false,
-    varname: static string = "result", context: untyped = nil): untyped =
+macro compileTemplateFile*(path: static string, baseDir: static string = "", iter: static bool = false,
+    varname: static string = "result",  context: untyped = nil): untyped =
   ## Compiles a Nimja template from a file.
   ##
   ## .. code-block:: nim
@@ -866,16 +868,17 @@ macro compileTemplateFile*(path: static string, iter: static bool = false,
   ##
   nwtVarname = varname
   nwtIter = iter
+  nwtBaseDir = baseDir
   let str = loadCacheFile(path)
   tmplsMacroImpl()
   doCompile(str, result)
 
-template tmplsImpl(str: static string): string =
+template tmplsImpl(str: static string, baseDir: static string): string =
   var nimjaTmplsVar: string
-  compileTemplateStr(str, varname = astToStr nimjaTmplsVar)
+  compileTemplateStr(str, baseDir, varname = astToStr nimjaTmplsVar)
   nimjaTmplsVar
 
-macro tmpls*(str: static string, context: untyped = nil): string =
+macro tmpls*(str: static string, baseDir: static string = "", context: untyped = nil): string =
   ## Compiles a Nimja template string and returns directly.
   ## Can be used inline, without a wrapper proc.
   ##
@@ -895,14 +898,14 @@ macro tmpls*(str: static string, context: untyped = nil): string =
   ##
   tmplsMacroImpl()
   result.add quote do:
-    tmplsImpl(`str`)
+    tmplsImpl(`str`, `baseDir`)
 
-template tmplfImpl(path: static string): string =
+template tmplfImpl(path: static string, baseDir: static string = "",): string =
   var nimjaTmplfVar: string
-  compileTemplateFile(path, varname = astToStr nimjaTmplfVar)
+  compileTemplateFile(path, baseDir, varname = astToStr nimjaTmplfVar)
   nimjaTmplfVar
 
-macro tmplf*(str: static string, context: untyped = nil): string =
+macro tmplf*(str: static string, baseDir: static string = "", context: untyped = nil): string =
   ## Compiles a Nimja template file and returns directly.
   ## Can be used inline, without a wrapper proc.
   ##
@@ -921,4 +924,4 @@ macro tmplf*(str: static string, context: untyped = nil): string =
   ##
   tmplsMacroImpl()
   result.add quote do:
-    tmplfImpl(`str`)
+    tmplfImpl(`str`, `baseDir`)

src/nimja/sharedhelper.nim

@@ -9,9 +9,10 @@ template read*(path: untyped): untyped =
     staticRead(path)
   else:
     readFile(path)
+
 
 template getScriptDir*(): string =
   ## Helper for staticRead.
   ##
   ## returns the absolute path to your project, on compile time.
-  getProjectPath()
+  instantiationInfo(-1, true).filename.parentDir() 

tests/basic/test_block.nim

@@ -7,10 +7,10 @@ import unittest
 block:
   ## Test compileTemplateFile
   proc index(title: auto, body: auto): string =
-    compileTemplateFile("../templates/blockIndex.nimja")
+    compileTemplateFile("../templates/blockIndex.nimja", baseDir = getScriptDir())
 
   proc master(): string =
-    compileTemplateFile("../templates/blockMaster.nimja")
+    compileTemplateFile("../templates/blockMaster.nimja", baseDir = getScriptDir())
 
   check index("title", "FOO") == "<html><title>title</title><body>FOO</body></html>"
   check index("", "") == "<html><title></title><body></body></html>"
@@ -23,4 +23,4 @@ block:
     compileTemplateStr("""{%extends "../templates/blockMaster.nimja"%}{%block mytitle%}{{title}}{%endblock%}{%block mybody%}{{body}}{%endblock%}""")
   check index("title", "FOO") == "<html><title>title</title><body>FOO</body></html>"
   check index("", "") == "<html><title></title><body></body></html>"
-  check index(1, 2) == "<html><title>1</title><body>2</body></html>"
+  check index(1, 2) == "<html><title>1</title><body>2</body></html>"

tests/basic/test_blockInBlock.nim

@@ -7,11 +7,11 @@ import unittest
 test "one block":
   block:
     proc child1(): string =
-      compileTemplateStr("{% extends test_block_in_block/master.nimja %}{%block inner%}newinner{%endblock%}")
+      compileTemplateStr("{% extends test_block_in_block/master.nimja %}{%block inner%}newinner{%endblock%}", baseDir = getScriptDir())
     check child1() == "outer1newinnerouter2"
 
 test "two blocks":
   block:
     proc child2(): string =
-      compileTemplateStr("{% extends test_block_in_block/master.nimja %}{%block outer%}newouter{%endblock%}")
-    check child2() == "newouter"
+      compileTemplateStr("{% extends test_block_in_block/master.nimja %}{%block outer%}newouter{%endblock%}", baseDir = getScriptDir())
+    check child2() == "newouter"

tests/basic/test_blockRenderMasterDirectly.nim

@@ -5,6 +5,6 @@ import ../../src/nimja
 block:
   ## Render Master directly
   proc master(): string =
-    compileTemplateFile("../templates/blockMasterWithContent.nimja")
+    compileTemplateFile("../templates/blockMasterWithContent.nimja", baseDir = getScriptDir())
   echo master()
   assert master() == """<html><title>TITLE</title><body>BODY</body></html>"""

tests/basic/test_case.nim

@@ -8,10 +8,10 @@ import os
 suite "case":
   test "basic test":
     var str = "foo"
-    check "foo" == tmplf(getScriptDir() / "case" / "case.nimja")
+    check "foo" == tmplf("case" / "case.nimja", baseDir = getScriptDir())
 
     str = "baa"
-    check "baa" == tmplf(getScriptDir() / "case" / "case.nimja")
+    check "baa" == tmplf(getScriptDir() / "case" / "case.nimja") # getScriptDir works in THAT case!
 
     str = "baz"
     check "baz" == tmplf(getScriptDir() / "case" / "case.nimja")
@@ -27,14 +27,14 @@ suite "case":
       aaa, bbb, ccc, ddd
     var foo: Foo = aaa
     var isNothing: bool
-    check "AAA" == tmplf(getScriptDir() / "case" / "case2.nimja", {ee: foo})
-    check "BBB" == tmplf(getScriptDir() / "case" / "case2.nimja", {ee: Foo.bbb})
-    check "CCC" == tmplf(getScriptDir() / "case" / "case2.nimja", {ee: ccc})
+    check "AAA" == tmplf("case" / "case2.nimja", getScriptDir(), {ee: foo})
+    check "BBB" == tmplf("case" / "case2.nimja", getScriptDir(), {ee: Foo.bbb})
+    check "CCC" == tmplf("case" / "case2.nimja", getScriptDir(), {ee: ccc})
 
     isNothing = true
-    check "nothing" == tmplf(getScriptDir() / "case" / "case2.nimja", {ee: ddd})
+    check "nothing" == tmplf("case" / "case2.nimja", getScriptDir(), {ee: ddd})
 
     isNothing = false
-    check "something" == tmplf(getScriptDir() / "case" / "case2.nimja", {ee: ddd})
+    check "something" == tmplf("case" / "case2.nimja", getScriptDir(), {ee: ddd})
 
 

tests/basic/test_case_missing.nim

@@ -8,4 +8,4 @@ include ../../src/nimja/parser
 type Foo = enum
   aaa, bbb, ccc, ddd
 var foo: Foo = aaa
-discard tmplf(getScriptDir() / "case" / "case3.nimja", {ee: ddd})
+discard tmplf("case" / "case3.nimja", baseDir = getScriptDir(), {ee: ddd})