add method to query fragment names in prepared template

java-src/io/github/erdos/stencil/TemplateVariables.java

@@ -20,11 +20,13 @@
  */
 public final class TemplateVariables {
 
+ private final Set<String> fragmentNames;
  private final Set<String> variables;
  private final Node root;
 
- private TemplateVariables(Set<String> variables) {
+ private TemplateVariables(Set<String> variables, Set<String> fragmentNames) {
  this.variables = unmodifiableSet(variables);
+ this.fragmentNames = unmodifiableSet(fragmentNames);
 
  Node r = LEAF;
  for (String x : variables) {
@@ -112,8 +114,8 @@ public Node visitLeaf() {
  }
  }
 
- public static TemplateVariables fromPaths(Collection<String> allVariablePaths) {
- return new TemplateVariables(new HashSet<>(allVariablePaths));
+ public static TemplateVariables fromPaths(Collection<String> allVariablePaths, Collection<String> allFragmentNames) {
+ return new TemplateVariables(new HashSet<>(allVariablePaths), new HashSet<>(allFragmentNames));
  }
 
  /**
@@ -124,8 +126,12 @@ public Set<String> getAllVariables() {
  return variables;
  }
 
+ public Set<String> getAllFragmentNames() {
+ return fragmentNames;
+ }
+
  /**
- * Throws IllegalArgumentException exception when template data.
+ * Throws IllegalArgumentException exception when template data is missing values for schema.
  * <p>
  * Throws when referred keys are missing from data.
  *

java-src/io/github/erdos/stencil/impl/NativeTemplateFactory.java

@@ -71,9 +71,15 @@ public PreparedFragment prepareFragmentFile(final File fragmentFile) throws IOEx
  */
  @SuppressWarnings("unchecked")
  private Set variableNames(Map prepared) {
- // TODO: ez mindig null lesz ugyhogy csinaljunk vele valamit!!!!!
- return prepared.containsKey(ClojureHelper.Keywords.VARIABLES)
- ? unmodifiableSet(new HashSet<Set>((Collection) prepared.get(ClojureHelper.Keywords.VARIABLES)))
+ return prepared.containsKey(ClojureHelper.Keywords.VARIABLES.kw)
+ ? unmodifiableSet(new HashSet<Set>((Collection) prepared.get(ClojureHelper.Keywords.VARIABLES.kw)))
+ : emptySet();
+ }
+
+ @SuppressWarnings("unchecked")
+ private Set fragmentNames(Map prepared) {
+ return prepared.containsKey(ClojureHelper.Keywords.FRAGMENTS.kw)
+ ? unmodifiableSet(new HashSet<Set>((Collection) prepared.get(ClojureHelper.Keywords.FRAGMENTS.kw)))
  : emptySet();
  }
 
@@ -92,7 +98,7 @@ private PreparedTemplate prepareTemplateImpl(TemplateDocumentFormats templateDoc
  throw ParsingException.wrapping("Could not parse template file!", e);
  }
 
- final TemplateVariables vars = TemplateVariables.fromPaths(variableNames(prepared));
+ final TemplateVariables vars = TemplateVariables.fromPaths(variableNames(prepared), fragmentNames(prepared));
 
  final File zipDirResource = (File) prepared.get(ClojureHelper.Keywords.SOURCE_FOLDER.kw);
  if (zipDirResource != null) {

java-test/io/github/erdos/stencil/TemplateVariablesTest.java

@@ -20,7 +20,7 @@ public void testSimple() {
  final Set<String> schema = set("a.x.p", "a.x.q");
  Map<String, Object> data = map("a", map("x", map("p", null, "q", 23)));
 
- fromPaths(schema).throwWhenInvalid(fromMap(data));
+ fromPaths(schema, emptySet()).throwWhenInvalid(fromMap(data));
  }
 
 
@@ -30,12 +30,12 @@ public void testArray() {
 
  // valid
  final Map<String, Object> data = singletonMap("x", asList(1, 2, 3));
- fromPaths(schema).throwWhenInvalid(fromMap(data));
+ fromPaths(schema, emptySet()).throwWhenInvalid(fromMap(data));
 
  try {
  // invalid
  final TemplateData data2 = fromMap(singletonMap("a", singletonMap("x", asList(1, 2, 3))));
- fromPaths(schema).throwWhenInvalid(data2);
+ fromPaths(schema, emptySet()).throwWhenInvalid(data2);
  fail("Should have thrown!");
  } catch (IllegalArgumentException ignored) {
  }
@@ -47,11 +47,11 @@ public void testNestedArray() {
 
  // valid
  final Map<String, Object> data = singletonMap("a", singletonMap("x", singletonList(singletonList(singletonMap("p", 1)))));
- fromPaths(schema).throwWhenInvalid(fromMap(data));
+ fromPaths(schema, emptySet()).throwWhenInvalid(fromMap(data));
 
  try {
  // invalid
- fromPaths(schema).throwWhenInvalid(fromMap(singletonMap("a", singletonMap("x", asList(1, 2, 3)))));
+ fromPaths(schema, emptySet()).throwWhenInvalid(fromMap(singletonMap("a", singletonMap("x", asList(1, 2, 3)))));
  fail("Should have thrown!");
  } catch (IllegalArgumentException ignored) {
  }
@@ -64,7 +64,7 @@ public void testNestedArraySimple() {
  try {
  // invalid
  final Map<String, Object> data = singletonMap("a", 3);
- fromPaths(schema).throwWhenInvalid(fromMap(data));
+ fromPaths(schema, emptySet()).throwWhenInvalid(fromMap(data));
  fail("Should have thrown!");
  } catch (IllegalArgumentException ignored) {
  }

src/stencil/cleanup.clj

@@ -208,12 +208,18 @@
  []))]
  (distinct (collect {} control-ast))))
 
-; (find-variables [])
+(defn- find-fragments [control-ast]
+ ;; returns a set of fragment names use in this document
+ (set (for [item (tree-seq map? (comp flatten :blocks) {:blocks [control-ast]})
+ :when (map? item)
+ :when (= :cmd/include (:cmd item))]
+ (:name item))))
 
 (defn process [raw-token-seq]
  (let [ast (tokens->ast raw-token-seq)
  executable (control-ast-normalize (annotate-environments ast))]
  {:variables (find-variables ast)
+ :fragments (find-fragments ast)
  :dynamic? (boolean (some :cmd executable))
  :executable executable}))
 

src/stencil/model.clj

@@ -100,7 +100,7 @@
  (with-open [stream (io/input-stream xml-streamable)]
  (-> (tokenizer/parse-to-tokens-seq stream)
  (cleanup/process)
- (select-keys [:variables :dynamic? :executable]))))
+ (select-keys [:variables :dynamic? :executable :fragments]))))
 
 
 (defn load-template-model [^File dir]

src/stencil/process.clj

@@ -9,12 +9,32 @@
 
 (set! *warn-on-reflection* true)
 
+;; merge a set of fragment names under the :fragments key
+(defn- merge-fragment-names [model]
+ (assoc model
+ :fragments
+ (-> #{}
+ (into (-> model :main :executable :fragments))
+ (into (for [x (:headers+footers (:main model))
+ f (:fragments (:executable x))] f)))))
+
+(defn- merge-variable-names [model]
+ (assoc model
+ :variables
+ (-> #{}
+ (into (-> model :main :executable :variables))
+ (into (for [x (:headers+footers (:main model))
+ v (:variables (:executable x))] v)))))
+
 (defn prepare-template [^InputStream stream]
  (assert (instance? InputStream stream))
  (let [zip-dir (FileHelper/createNonexistentTempFile "stencil-" ".zip.contents")]
  (with-open [zip-stream stream] ;; FIXME: maybe not deleted immediately
  (ZipHelper/unzipStreamIntoDirectory zip-stream zip-dir))
- (model/load-template-model zip-dir)))
+ (-> zip-dir
+ model/load-template-model
+ merge-fragment-names
+ merge-variable-names)))
 
 (defn prepare-fragment [input]
  (assert (some? input))

test/stencil/api_test.clj

@@ -117,8 +117,15 @@
  (render-template-2 "/tmp/output-7.pptx"
  {"customerName" "John Doe" "x" "XXX" "y" "yyyy"}))
 
-(comment
+(deftest test-prepare-fragment-names
+ (with-open [template (prepare "test-resources/multipart/main.docx")]
+ (is (= #{"header" "footer" "body"} (-> template .getVariables .getAllFragmentNames)))))
+
+(deftest test-prepare-variable-names
+ (with-open [template (prepare "test-resources/multipart/header.docx")]
+ (is (= #{"name"} (-> template .getVariables .getAllVariables)))))
 
+(comment
 
  (let [template (prepare "test-resources/multipart/main.docx")
  body (fragment "test-resources/multipart/body.docx")

test/stencil/process_test.clj

@@ -31,5 +31,6 @@
  {:blocks [], :cmd :cmd/include, :name "elefant"}
  {:close :b}
  {:close :a}],
+ :fragments #{"elefant"}
  :variables ()}
  (test-prepare "<a><b>{%include \"elefant\"%}</b></a>")))))