CONCONDEC-14: Add macro parameters (#7)

* Rename macro so that the metadata is not lost (seems to be a macro bug)

* Fill projects selection field dynamically

* Enable to freeze imported data

Author: kleebaum

src/main/java/de/uhd/ifi/se/decision/management/confluence/macro/DecisionKnowledgeImportMacro.java

@@ -3,8 +3,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.springframework.beans.factory.annotation.Autowired;
-
 import com.atlassian.confluence.content.render.xhtml.ConversionContext;
 import com.atlassian.confluence.content.render.xhtml.storage.macro.MacroId;
 import com.atlassian.confluence.macro.Macro;
@@ -13,33 +11,43 @@
 import com.atlassian.confluence.util.velocity.VelocityUtils;
 import com.atlassian.confluence.xhtml.api.MacroDefinition;
 import com.atlassian.fugue.Option;
-import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;
-import com.atlassian.webresource.api.assembler.PageBuilderService;
 
 import de.uhd.ifi.se.decision.management.confluence.model.DecisionKnowledgeElement;
+import de.uhd.ifi.se.decision.management.confluence.oauth.JiraClient;
 import de.uhd.ifi.se.decision.management.confluence.persistence.KnowledgePersistenceManager;
 
 public class DecisionKnowledgeImportMacro implements Macro {
 
-	private PageBuilderService pageBuilderService;
-
-	@Autowired
-	public DecisionKnowledgeImportMacro(@ComponentImport PageBuilderService pageBuilderService) {
-		this.pageBuilderService = pageBuilderService;
-	}
-
 	@Override
 	public String execute(Map<String, String> map, String s, ConversionContext conversionContext)
 			throws MacroExecutionException {
-		pageBuilderService.assembler().resources().requireWebResource(
-				"de.uhd.ifi.se.decision.management.confluence.macro:decision-knowledge-import-resources");
 		int pageId = Integer.parseInt(conversionContext.getEntity().getIdAsString());
 		String macroId = getMacroId(conversionContext);
 
-		// Save all issues in an ArrayList data structure.
 		List<DecisionKnowledgeElement> knowledgeElements = KnowledgePersistenceManager.getElements(pageId, macroId);
 
-		// Create a new context for rendering...
+		boolean freeze = false;
+		if ("true".equals(map.get("freeze"))) {
+			freeze = true;
+		}
+
+		if (knowledgeElements.isEmpty() || !freeze) {
+			String projectKey = map.get("project");
+			String query = map.get("query");
+			if (query == null) {
+				query = "";
+			}
+			if (projectKey != null && !projectKey.isEmpty()) {
+				knowledgeElements = JiraClient.instance.getDecisionKnowledgeFromJira(query, projectKey);
+				KnowledgePersistenceManager.removeDecisionKnowledgeElements(pageId, macroId);
+				for (DecisionKnowledgeElement element : knowledgeElements) {
+					element.setPageId(pageId);
+					element.setMacroId(macroId);
+					KnowledgePersistenceManager.addDecisionKnowledgeElement(element);
+				}
+			}
+		}
+
 		Map<String, Object> renderContext = MacroUtils.defaultVelocityContext();
 		renderContext.put("knowledgeElements", knowledgeElements);
 

src/main/java/de/uhd/ifi/se/decision/management/confluence/model/DecisionKnowledgeElement.java

@@ -8,6 +8,8 @@
 import org.codehaus.jackson.map.ObjectMapper;
 import org.codehaus.jackson.map.annotate.JsonDeserialize;
 
+import com.google.gson.Gson;
+
 import de.uhd.ifi.se.decision.management.confluence.model.impl.DecisionKnowledgeElementImpl;
 
 /**
@@ -27,9 +29,10 @@ public static List<DecisionKnowledgeElement> parseJsonString(String jsonString)
 					.constructCollectionType(List.class, DecisionKnowledgeElementImpl.class));
 		} catch (JsonMappingException e) {
 			try {
-				List<DecisionKnowledgeElement[]> myelements = objectMapper.readValue(jsonString, objectMapper
-						.getTypeFactory().constructCollectionType(List.class, DecisionKnowledgeElementImpl[].class));
-				elements = Arrays.asList(myelements.get(0));
+				Gson g = new Gson();
+				DecisionKnowledgeElementImpl[] myelements = g.fromJson(jsonString.substring(1, jsonString.length() - 1),
+						DecisionKnowledgeElementImpl[].class);
+				elements = Arrays.asList(myelements);
 			} catch (Exception e1) {
 				e1.printStackTrace();
 			}

src/main/java/de/uhd/ifi/se/decision/management/confluence/oauth/JiraClient.java

@@ -4,9 +4,11 @@
 import java.net.URLEncoder;
 import java.util.Iterator;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Locale;
 import java.util.Set;
 
+import de.uhd.ifi.se.decision.management.confluence.model.DecisionKnowledgeElement;
 import de.uhd.ifi.se.decision.management.confluence.oauth.impl.JiraClientImpl;
 
 /**
@@ -40,9 +42,9 @@ public interface JiraClient {
 	 * 
 	 * @param jiraIssueKeys
 	 *            as a set of strings.
-	 * @return JSON string.
+	 * @return list of decision knowledge elements.
 	 */
-	String getDecisionKnowledgeFromJira(Set<String> jiraIssueKeys);
+	List<DecisionKnowledgeElement> getDecisionKnowledgeFromJira(Set<String> jiraIssueKeys);
 
 	/**
 	 * Retrieves the decision knowledge elements from Jira that match a certain
@@ -52,9 +54,9 @@ public interface JiraClient {
 	 *            JQL query.
 	 * @param projectKey
 	 *            of the Jira project.
-	 * @return JSON String.
+	 * @return list of decision knowledge elements.
 	 */
-	String getDecisionKnowledgeFromJira(String query, String projectKey);
+	List<DecisionKnowledgeElement> getDecisionKnowledgeFromJira(String query, String projectKey);
 
 	/**
 	 * Returns all Jira issue keys mentioned in a message.

src/main/java/de/uhd/ifi/se/decision/management/confluence/oauth/impl/JiraClientImpl.java

@@ -1,6 +1,7 @@
 package de.uhd.ifi.se.decision.management.confluence.oauth.impl;
 
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
 import org.json.JSONArray;
@@ -18,6 +19,7 @@
 import com.atlassian.sal.api.net.Response;
 import com.atlassian.sal.api.net.ResponseException;
 
+import de.uhd.ifi.se.decision.management.confluence.model.DecisionKnowledgeElement;
 import de.uhd.ifi.se.decision.management.confluence.oauth.JiraClient;
 
 /**
@@ -93,16 +95,21 @@ public String handle(final Response response) throws ResponseException {
 	}
 
 	@Override
-	public String getDecisionKnowledgeFromJira(Set<String> jiraIssueKeys) {
+	public List<DecisionKnowledgeElement> getDecisionKnowledgeFromJira(Set<String> jiraIssueKeys) {
 		String queryWithJiraIssues = JiraClient.getJiraCallQuery(jiraIssueKeys);
 		String projectKey = JiraClient.retrieveProjectKey(jiraIssueKeys);
 		return getDecisionKnowledgeFromJira(queryWithJiraIssues, projectKey);
 	}
 
 	@Override
-	public String getDecisionKnowledgeFromJira(String query, String projectKey) {
+	public List<DecisionKnowledgeElement> getDecisionKnowledgeFromJira(String query, String projectKey) {
+		String jsonString = getDecisionKnowledgeFromJiraAsJsonString(query, projectKey);
+		return DecisionKnowledgeElement.parseJsonString(jsonString);
+	}
+
+	private String getDecisionKnowledgeFromJiraAsJsonString(String query, String projectKey) {
 		return getResponseFromJiraWithApplicationLink(
-				"rest/decisions/latest/decisions/getElements.json?allTrees=true&query=" + query + "&projectKey="
+				"rest/decisions/latest/decisions/getElements.json?allTrees=false&query=" + query + "&projectKey="
 						+ projectKey);
 	}
 }

src/main/java/de/uhd/ifi/se/decision/management/confluence/persistence/KnowledgePersistenceManager.java

@@ -41,6 +41,9 @@ public static void removeDecisionKnowledgeElement(String id) {
 
 	public static List<DecisionKnowledgeElement> getElements(int pageId, String macroId) {
 		List<DecisionKnowledgeElement> elements = new ArrayList<DecisionKnowledgeElement>();
+		if (pageId == 0 || macroId == null) {
+			return elements;
+		}
 
 		for (String id : bandanaManager.getKeys(bandanaContext)) {
 			DecisionKnowledgeElement decisionKnowledgeElement = (DecisionKnowledgeElement) bandanaManager

src/main/java/de/uhd/ifi/se/decision/management/confluence/rest/impl/KnowledgeRestImpl.java

@@ -89,8 +89,9 @@ public Response getStoredKnowledgeElements(@QueryParam("pageId") int pageId,
 	public Response getKnowledgeElementsFromJira(@QueryParam("projectKey") String projectKey,
 			@QueryParam("query") String query) {
 		try {
-			String jsonString = JiraClient.instance.getDecisionKnowledgeFromJira(query, projectKey);
-			return Response.status(Response.Status.OK).entity(jsonString).build();
+			List<DecisionKnowledgeElement> elements = JiraClient.instance.getDecisionKnowledgeFromJira(query,
+					projectKey);
+			return Response.status(Response.Status.OK).entity(elements).build();
 		} catch (Exception e) {
 			return Response.serverError().build();
 		}

src/main/resources/atlassian-plugin.xml

@@ -21,13 +21,30 @@
 			(e.g. for meetings).
 		</description>
 		<context>editor</context>
+		<context>atl.general</context>
 		<context>Decision Knowledge Import Macro</context>
 		<resource type="download" name="condec.css" location="/css/condec.css" />
-		<resource type="download" name="condec.knowledge.import.js" location="/js/condec.knowledge.import.js" />
+		<resource type="download" name="condec.knowledge.import.js"
+			location="/js/condec.knowledge.import.js" />
 		<resource type="download" name="condec.api.js" location="/js/condec.api.js" />
 		<resource type="download" name="images/" location="/images" />
 		<resource type="download" name="pluginIconBig.png" location="/images/pluginIconBig.png" />
 		<dependency>com.atlassian.auiplugin:ajs</dependency>
+		<dependency>com.atlassian.auiplugin:aui-flag</dependency>
+		<dependency>com.atlassian.auiplugin:aui-buttons</dependency>
+		<dependency>com.atlassian.auiplugin:aui-forms</dependency>
+		<dependency>com.atlassian.auiplugin:aui-navigation</dependency>
+		<dependency>com.atlassian.auiplugin:aui-toggle</dependency>
+		<dependency>com.atlassian.auiplugin:table</dependency>
+		<dependency>com.atlassian.auiplugin:aui-lozenge</dependency>
+		<dependency>com.atlassian.auiplugin:dialog2</dependency>
+		<dependency>com.atlassian.auiplugin:aui-dropdown2</dependency>
+		<dependency>com.atlassian.auiplugin:aui-select2</dependency>
+		<dependency>com.atlassian.auiplugin:aui-experimental-iconfont</dependency>
+		<dependency>com.atlassian.auiplugin:aui-tooltips</dependency>
+		<dependency>com.atlassian.auiplugin:tabs</dependency>
+		<dependency>com.atlassian.auiplugin:aui-expander</dependency>
+		<dependency>com.atlassian.auiplugin:aui-table-sortable</dependency>
 	</web-resource>
 
 	<!-- REST API -->
@@ -37,18 +54,22 @@
 	</rest>
 
 	<!-- Decision Knowledge Import in Wiki Pages -->
-	<xhtml-macro name="Decision Knowledge Import" key="decision-knowledge-import-macro"
+	<xhtml-macro name="decision-knowledge-import-macro"
+		key="decision-knowledge-import-macro"
 		class="de.uhd.ifi.se.decision.management.confluence.macro.DecisionKnowledgeImportMacro"
 		icon="/download/resources/de.uhd.ifi.se.decision.management.confluence:decision-knowledge-import-resources/pluginIconBig.png">
 		<description key="condec.import.macro.description" />
 		<category name="external-content" />
 		<parameters>
-			<!--<parameter name="yourJsonArray" type="string" /> -->
+			<parameter name="query" type="string" desc="filter=allopenissues" />
+			<parameter name="project" type="enum" />
+			<parameter name="freeze" type="boolean" default="false" required="true"
+				title="Freeze the content?" />
 		</parameters>
 		<property-panel>
-			<spacer />
-			<button id="updateButton" label="Update Stand-up Table" />
-			<spacer />
+			<button id="updateButton" label="Edit Manually">
+				<label key="condec.import.macro.update.button" />
+			</button>
 		</property-panel>
 	</xhtml-macro>
 

src/main/resources/i18n/condec.properties

@@ -13,22 +13,8 @@ condec.report.label = Decision Knowledge Report
 condec.report.description = Generates statistics about decision knowledge in the project.
 condec.report.project.description = Please select a project to display the report for.
 condec.report.issuetype.description = Please select the JIRA issue type you want to see decision knowledge linked to.
-
-condec.import.macro.description=After inserting the macro to the confluence site the first time, you have to save the site and then you can click on the macro to edit your queries
-de.uhd.ifi.se.decision.management.confluence.issue-import-macro.param.yourJsonArray.label=Your Issues:
-de.uhd.ifi.se.decision.management.confluence.issue-import-macro.param.yourJsonArray.desc=Copy your Json Array here
-
-#
-# Dashboard item with feature branch reports
-condec.dashboard.featurebranch.title = RatDocQuality of branches
-condec.dashboard.featurebranch.description = Rationale documentation quality status of feature task branches.
-condec.dashboard.featurebranch.project.data.error = Fetching the project data resulted in an error. Is the project configured to use git for ConDec plug-in?
-condec.dashboard.featurebranch.project.selection.description = Please select a project you would like to see reports for.
-condec.dashboard.featurebranch.project.selection.pickone = pick a project
-condec.dashboard.featurebranch.project.selection.not.done = Nothing to show yet.
-condec.dashboard.featurebranch.project.processing = Please wait, processing ...
-condec.dashboard.featurebranch.project.nogit = The ConDec plugin is not configured to extract rationale from git for this project.
-
+condec.import.macro.description = Imports decision knowledge from Jira, if an application link exists.
+condec.import.macro.update.button = Edit Manually
 #
 # Decision Knowledge Elements
 condec.issue = Issue

src/main/resources/i18n/condec_de_DE.properties

@@ -13,6 +13,8 @@ condec.report.label = Bericht zu Dokumentation von Entscheidungswissen
 condec.report.description = Erzeugt eine statistische \u00dcbersicht zu Entscheidungswissen in einem JIRA Projekt.
 condec.report.project.description = Bitte w\u00e4hlen Sie ein Projekt, f\u00fcr das die statistische \u00dcbersicht erzeugt werden soll.
 condec.report.issuetype.description = Bitte w\u00e4hlen Sie den JIRA Issue Typen, f\u00fcr den die statistische \u00dcbersicht erzeugt werden soll
+condec.import.macro.description = Importiert Entscheidungswissen aus Jira, wenn ein Anwendungslink existiert.
+condec.import.macro.update.button = Manuelle Bearbeitung
 #
 # Decision Knowledge Elements
 condec.issue = Entscheidungsproblem

src/main/resources/js/condec.api.js

@@ -133,6 +133,11 @@
 			body : message
 		});
 	}
+	
+	/*
+	 * external references: condec.knowledge.import
+	 */
+	ConDecAPI.prototype.showFlag = showFlag;
 
 	// export ConDecAPI
 	global.conDecAPI = new ConDecAPI();