Skip to content

Commit

Permalink
#180 Display Requirements content on multiple lines
Browse files Browse the repository at this point in the history 
Requirements fields are displayed as bulleted lists and line breaks are
preserved. HTML content is now handled in Requirements using the
org.jsoup library.

Change-Id: I9d0745bcf2871b94a99a15d8b5c72db156dad64e
Signed-off-by: Glenn Plouhinec <[email protected]>
  • Loading branch information
@GlennPlou
GlennPlou committed Sep 24, 2024
1 parent 390e9b3 commit d73b413
Show file tree
Hide file tree
Showing 3 changed files with 123 additions and 9 deletions.
3 changes: 2 additions & 1 deletion plugins/org.polarsys.capella.vp.requirements.design/META-INF/MANIFEST.MF
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Require-Bundle: org.eclipse.ui,
org.polarsys.capella.core.data.business.queries,
org.eclipse.sirius.common,
org.polarsys.capella.vp.requirements.ui.commands,
org.polarsys.kitalpha.vp.requirements.model.helpers
org.polarsys.kitalpha.vp.requirements.model.helpers,
org.jsoup;bundle-version="1.15.3"
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: JavaSE-17
Bundle-Localization: plugin
Expand Down
125 changes: 117 additions & 8 deletions ...g/polarsys/capella/vp/requirements/design/service/CapellaRequirementsOpenJavaService.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2016, 2019, 2019 THALES GLOBAL SERVICES.
* Copyright (c) 2016, 2024 THALES GLOBAL SERVICES.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
Expand All @@ -13,10 +13,12 @@
package org.polarsys.capella.vp.requirements.design.service;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import org.eclipse.emf.ecore.EAnnotation;
Expand All @@ -30,11 +32,17 @@
import org.eclipse.sirius.diagram.DEdge;
import org.eclipse.sirius.diagram.DSemanticDiagram;
import org.eclipse.sirius.diagram.EdgeTarget;
import org.eclipse.sirius.diagram.model.business.internal.helper.ContentLayerHelper;
import org.eclipse.sirius.diagram.description.EdgeMapping;
import org.eclipse.sirius.diagram.description.Layer;
import org.eclipse.sirius.diagram.description.Layer;
import org.eclipse.sirius.diagram.model.business.internal.helper.ContentLayerHelper;
import org.eclipse.sirius.viewpoint.DSemanticDecorator;
import org.eclipse.sirius.viewpoint.ViewpointPackage;
import org.jsoup.Jsoup;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Node;
import org.jsoup.nodes.TextNode;
import org.jsoup.select.NodeTraversor;
import org.jsoup.select.NodeVisitor;
import org.polarsys.capella.common.mdsofa.common.constant.ICommonConstants;
import org.polarsys.capella.core.business.queries.IBusinessQuery;
import org.polarsys.capella.core.business.queries.capellacore.BusinessQueriesProvider;
Expand Down Expand Up @@ -338,7 +346,7 @@ public String getRequirementTitle(Requirement requirement) {
.get(ReqVPCustomDataHelper.CUSTOM_DATA_KEY_FOR_REQ_VP_QUERIES_LABEL_LENGTH);
}

return evaluateExpression(session, requirement, expression, maxLength);
return evaluateExpression(session, requirement, expression, maxLength, false);
}

/**
Expand All @@ -360,7 +368,7 @@ public String getRequirementContent(Requirement requirement) {
.get(ReqVPCustomDataHelper.CUSTOM_DATA_KEY_FOR_REQ_VP_QUERIES_CONTENT_LENGTH);
}

return evaluateExpression(session, requirement, expression, maxLength);
return evaluateExpression(session, requirement, expression, maxLength, true);
}

/**
Expand All @@ -370,9 +378,10 @@ public String getRequirementContent(Requirement requirement) {
* @param requirement
* @param expression
* @param maxLength
* @param keepEnfOfLine
* @return
*/
protected String evaluateExpression(Session session, Requirement requirement, String expression, String maxLength) {
protected String evaluateExpression(Session session, Requirement requirement, String expression, String maxLength, boolean keepEnfOfLine) {
try {
if (session != null && expression != null) {
IInterpreter interpreter = session.getInterpreter();
Expand All @@ -387,7 +396,7 @@ protected String evaluateExpression(Session session, Requirement requirement, St
resultBuilder.append(value);
}
String evaluationResult = resultBuilder.toString();
String sanytizedResult = LabelHelper.unescape(LabelHelper.transformHTMLToText(evaluationResult));
String sanytizedResult = getTextFromHtml(evaluationResult, keepEnfOfLine);
return reduceString(sanytizedResult, maxLength);
}
}
Expand Down Expand Up @@ -418,6 +427,20 @@ protected String reduceString(String value, String maxLengthText) {
return value;
}

public static String getTextFromHtml(String html, boolean keepMultiline) {
if (html == null) {
return null;
}

Html2TextVisitor visitor = new Html2TextVisitor(keepMultiline);
Document htmlDoc = Jsoup.parse(html);
NodeTraversor.traverse(visitor, htmlDoc);

String text = visitor.toString();
text = text.trim();
return text;
}

/**
* Find the source of the outgoing relation with a requirement. With this relation, the target is a requirement, the
* source is capella element or diagram.
Expand Down Expand Up @@ -552,4 +575,90 @@ public boolean isLinkedToDiagram(EObject requirement, EObject diagram) {
}
return false;
}
}

private static class Html2TextVisitor implements NodeVisitor {

private static final Pattern MULTI_BLANKS_PATTERN = Pattern.compile("\\p{javaWhitespace}+");

private final StringBuilder str = new StringBuilder();

private final boolean keepMultiline;

public Html2TextVisitor(boolean keepMultiline) {
this.keepMultiline = keepMultiline;
}

private void addNewLineIfNoneBefore() {
if (str.length() == 0 || str.charAt(str.length() - 1) == '\n') {
return;
}

str.append('\n');
}

private void addBlankIfNoneBefore() {
if (str.length() == 0 || Character.isWhitespace(str.charAt(str.length() - 1))) {
return;
}

str.append(' ');
}

private void addBlankOrNewLineIfNoneBefore() {
if (keepMultiline) {
addNewLineIfNoneBefore();
} else {
addBlankIfNoneBefore();
}
}

@Override
public void head(Node node, int depth) {
String name = node.nodeName();
if (node instanceof TextNode) {
String internalText = ((TextNode) node).text();
// Internal text does not contains any formatting (as defined by HTML except inside "pre" tag) so multiple
// blanks are equals to 1 and newline and stuff is the same, so replace them all by a single space
// pre tags does not seem to be used by Capella editors so do not handle it
String pureText = MULTI_BLANKS_PATTERN.matcher(internalText).replaceAll(" ");

// Add a new line before each occurrence of "- "
pureText = pureText.replaceAll("- ", "\n- ");

pureText = pureText.trim();
str.append(pureText);
} else if (name.equals("li")) {
// Basic handling of list items (no difference between numbered and dotted nor depth)
if (keepMultiline) {
addNewLineIfNoneBefore();
str.append(" * ");
} else {
addBlankIfNoneBefore();
str.append("* ");
}
} else if (Arrays.asList("p", "h1", "h2", "h3", "h4", "h5", "tr").contains(name)) {
if (str.length() > 0 && str.charAt(str.length() - 1) == '-') {
// Prevents adding a new line right after a dash
str.append(' ');
} else {
addBlankOrNewLineIfNoneBefore();
}
}
}

@Override
public void tail(Node node, int depth) {
String name = node.nodeName();
if (name.equals("br")) {
str.append(keepMultiline ? '\n' : ' ');
} else if (Arrays.asList("li", "p", "h1", "h2", "h3", "h4", "h5").contains(name)) {
addBlankOrNewLineIfNoneBefore();
}
}

@Override
public String toString() {
return str.toString();
}
}
}
4 changes: 4 additions & 0 deletions ...g/org.polarsys.capella.vp.requirements.target/tp/capella.target-definition.targetplatform
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,8 @@ location xhtml "https://download.eclipse.org/capella/addons/xhtmldocgen/updates/

location orbit "https://download.eclipse.org/tools/orbit/downloads/2023-03" {
org.apache.commons.io lazy
}

location eclipse "https://download.eclipse.org/releases/2023-03" {
org.jsoup lazy
}

0 comments on commit d73b413

Please sign in to comment.