Use a more informative identifier for exec directive outputs

stencila · Apr 30, 2015 · dfc056c · dfc056c
1 parent 2f7d0f7
commit dfc056c
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/cpp/stencila/map-context.hpp b/cpp/stencila/map-context.hpp
@@ -44,7 +44,7 @@ class MapContext : public Context {
 	}
 
 	std::string execute(const std::string& code, const std::string& id="", const std::string& format="", const std::string& width="", const std::string& height="", const std::string& units=""){
-		return "";
+		return id;
 	}
 
 	std::string interact(const std::string& code, const std::string& id=""){

diff --git a/cpp/stencila/stencil-directives.cpp b/cpp/stencila/stencil-directives.cpp
@@ -2,6 +2,7 @@
 #include <boost/algorithm/string.hpp>
 
 #include <stencila/stencil.hpp>
+#include <stencila/string.hpp>
 
 namespace Stencila {
 
@@ -132,6 +133,7 @@ void Stencil::Execute::parse(const std::string& attribute){
 		for(auto& context : contexts) trim(context);
 		for(const auto& context : contexts){
 			if(not(
+				context=="map" or
 				context=="exec" or
 				context=="cila" or
 				context=="py" or
@@ -245,8 +247,25 @@ void Stencil::Execute::render(Stencil& stencil, Node node, Context* context){
 		units.value = "cm";
 	}
 
+	// Generate a unique id for this execute directive which, if possible, 
+	// includes useful text as well as the unique-ifying hash
+	std::string id;
+	// Does the parent of this element have an id?
+	id += node.parent().attr("id");
+	// Does the parent of this element have a caption
+	Node caption = node.parent().select("caption,figcaption");
+	if(caption){
+		std::string slug = slugify(caption.text(),25);
+		if(id.length()) id += "-";
+		id += slug;
+	}
+	if(id.length()) id += "-";
+	id += stencil.hash_;
+
 	// Execute code
-	std::string result = context->execute(code,stencil.hash_,
+	std::string result = context->execute(
+		code,
+		id,
 		format.value,
 		width.value,
 		height.value,

diff --git a/cpp/tests/stencil-render.cpp b/cpp/tests/stencil-render.cpp
@@ -61,6 +61,20 @@ BOOST_AUTO_TEST_CASE(exec){
 	render(R"(<pre data-exec="map">a = 42</pre>Text after)");
 }
 
+BOOST_AUTO_TEST_CASE(exec_output){
+	render(R"(
+		<figure id="figure-a">
+			<pre data-exec="map format png">do</pre>
+		</figure>
+
+		<figure id="figure-b">
+			<pre data-exec="map format png">do</pre>
+			<figcaption>Hello world</figcaption>
+		</figure>
+	)");
+	dump();
+}
+
 BOOST_AUTO_TEST_CASE(when){
 	render(R"(
 		<div data-when="map">