Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor Formatting changes #197

Merged
merged 13 commits into from
Jan 5, 2018
Merged

Minor Formatting changes #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
79951db
change tabs into spaces (formatting)
sdutry Jan 3, 2018
0713da4
add missing @Override annotations
sdutry Jan 3, 2018
1d0b375
add curly brackets (formatting)
sdutry Jan 3, 2018
fe65910
change tabs into spaces (formatting)
sdutry Jan 3, 2018
38e3734
change tabs into spaces (formatting)
sdutry Jan 3, 2018
7a251dd
add curly brackets (formatting)
sdutry Jan 3, 2018
a29051c
add missing @Override annotation
sdutry Jan 3, 2018
0bfdc5e
add test for mergeTemplate method
sdutry Jan 4, 2018
476697f
add test for buildTemplateName method
sdutry Jan 4, 2018
dd76d39
add tests for getTemplateDir method
sdutry Jan 4, 2018
7df1e67
add test for setting acceskey
sdutry Jan 4, 2018
2fd2cb5
add test for parameter with name "value"
sdutry Jan 4, 2018
0deea3f
remove old subversion comments
sdutry Jan 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions core/src/main/java/org/apache/struts2/components/Anchor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,17 @@ public Anchor(ValueStack stack, HttpServletRequest request, HttpServletResponse
urlProvider.setHttpServletResponse(response);
}

@Override
public String getDefaultOpenTemplate() {
return OPEN_TEMPLATE;
}

@Override
protected String getDefaultTemplate() {
return TEMPLATE;
}

@Override
public boolean usesBody() {
return true;
}
Expand All @@ -96,16 +99,17 @@ public boolean usesBody() {
protected void evaluateExtraParams() {
super.evaluateExtraParams();

if (href != null)
if (href != null) {
addParameter("href", ensureAttributeSafelyNotEscaped(findString(href)));
else {
} else {
//no href, build it from URL attributes
StringWriter sw = new StringWriter();
urlRenderer.beforeRenderUrl(urlProvider);
urlRenderer.renderUrl(sw, urlProvider);
String builtHref = sw.toString();
if (StringUtils.isNotEmpty(builtHref))
if (StringUtils.isNotEmpty(builtHref)) {
addParameter("href", ensureAttributeSafelyNotEscaped(builtHref));
}
}
}

Expand All @@ -115,10 +119,10 @@ public void setUrlIncludeParams(String urlIncludeParams) {
}

@Inject
public void setUrlRenderer(UrlRenderer urlRenderer) {
urlProvider.setUrlRenderer(urlRenderer);
public void setUrlRenderer(UrlRenderer urlRenderer) {
urlProvider.setUrlRenderer(urlRenderer);
this.urlRenderer = urlRenderer;
}
}

@Inject(required=false)
public void setExtraParameterProvider(ExtraParameterProvider provider) {
Expand All @@ -135,6 +139,7 @@ public boolean start(Writer writer) {
/**
* Overrides to be able to render body in a template rather than always before the template
*/
@Override
public boolean end(Writer writer, String body) {
this.processingTagBody = false;
evaluateParams();
Expand All @@ -143,15 +148,14 @@ public boolean end(Writer writer, String body) {
mergeTemplate(writer, buildTemplateName(template, getDefaultTemplate()));
} catch (Exception e) {
LOG.error("error when rendering", e);
}
finally {
} finally {
popComponentStack();
}

return false;
}


@Override
public void addParameter(String key, Object value) {
/*
the parameters added by this method are used in the template. this method is also
Expand All @@ -160,8 +164,9 @@ public void addParameter(String key, Object value) {
*/
if (processingTagBody) {
this.urlParameters.put(key, value);
} else
} else {
super.addParameter(key, value);
}
}

@Override
Expand All @@ -173,8 +178,9 @@ public void addAllParameters(Map params) {
*/
if (processingTagBody) {
this.urlParameters.putAll(params);
} else
} else {
super.addAllParameters(params);
}
}

public UrlProvider getUrlProvider() {
Expand All @@ -196,6 +202,7 @@ public void setScheme(String scheme) {
urlProvider.setScheme(scheme);
}

@Override
@StrutsTagAttribute(description = "The target value to use, if not using action")
public void setValue(String value) {
urlProvider.setValue(value);
Expand Down
20 changes: 11 additions & 9 deletions core/src/main/java/org/apache/struts2/components/UIBean.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,7 @@ public void setTemplateEngineManager(TemplateEngineManager mgr) {
this.templateEngineManager = mgr;
}

@Override
public boolean end(Writer writer, String body) {
evaluateParams();
try {
Expand Down Expand Up @@ -883,7 +884,7 @@ public void evaluateParams() {
evaluateExtraParams();
}

protected String escape(String name) {
protected String escape(String name) {
// escape any possible values that can make the ID painful to work with in JavaScript
if (name != null) {
return name.replaceAll("[\\/\\.\\[\\]]", "_");
Expand Down Expand Up @@ -930,7 +931,7 @@ protected void enableAncestorFormCustomOnsubmit() {
form.addParameter("customOnsubmitEnabled", Boolean.TRUE);
} else {
if (LOG.isWarnEnabled()) {
LOG.warn("Cannot find an Ancestor form, custom onsubmit is NOT enabled");
LOG.warn("Cannot find an Ancestor form, custom onsubmit is NOT enabled");
}
}
}
Expand Down Expand Up @@ -1240,7 +1241,7 @@ public void setTooltipIconPath(String tooltipIconPath) {
this.tooltipIconPath = tooltipIconPath;
}

public void setDynamicAttributes(Map<String, Object> tagDynamicAttributes) {
public void setDynamicAttributes(Map<String, Object> tagDynamicAttributes) {
for (Map.Entry<String, Object> entry : tagDynamicAttributes.entrySet()) {
String key = entry.getKey();

Expand All @@ -1250,19 +1251,20 @@ public void setDynamicAttributes(Map<String, Object> tagDynamicAttributes) {
}
}

@Override
/**
* supports dynamic attributes for freemarker ui tags
* @see https://issues.apache.org/jira/browse/WW-3174
@Override
/**
* supports dynamic attributes for freemarker ui tags
* @see https://issues.apache.org/jira/browse/WW-3174
* @see https://issues.apache.org/jira/browse/WW-4166
*/
*/
public void copyParams(Map params) {
super.copyParams(params);
for (Object o : params.entrySet()) {
Map.Entry entry = (Map.Entry) o;
String key = (String) entry.getKey();
if(!isValidTagAttribute(key) && !key.equals("dynamicAttributes"))
if (!isValidTagAttribute(key) && !key.equals("dynamicAttributes")) {
dynamicAttributes.put(key, entry.getValue());
}
}
}

Expand Down
42 changes: 21 additions & 21 deletions core/src/main/java/org/apache/struts2/components/UrlRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,26 @@
*
*/
public interface UrlRenderer {
/**
* Preprocessing step
* @param provider The {@link UrlProvider} component that "owns" this renderer.
*/
void beforeRenderUrl(UrlProvider provider);
/**
* Render a URL.
* @param writer A writer that the implementation can use to write the result to.
* @param provider The {@link UrlProvider} component that "owns" this renderer.
*/
void renderUrl(Writer writer, UrlProvider provider);
/**
* Render a Form URL.
* @param formComponent The {@link Form} component that "owns" this renderer.
*/
void renderFormUrl(Form formComponent);

void setActionMapper(ActionMapper actionMapper);

/**
* Preprocessing step
* @param provider The {@link UrlProvider} component that "owns" this renderer.
*/
void beforeRenderUrl(UrlProvider provider);

/**
* Render a URL.
* @param writer A writer that the implementation can use to write the result to.
* @param provider The {@link UrlProvider} component that "owns" this renderer.
*/
void renderUrl(Writer writer, UrlProvider provider);

/**
* Render a Form URL.
* @param formComponent The {@link Form} component that "owns" this renderer.
*/
void renderFormUrl(Form formComponent);

void setActionMapper(ActionMapper actionMapper);

}
126 changes: 122 additions & 4 deletions core/src/test/java/org/apache/struts2/components/UIBeanTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,19 @@
package org.apache.struts2.components;

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.config.ConfigurationException;
import com.opensymphony.xwork2.util.ValueStack;
import org.apache.struts2.StrutsInternalTestCase;
import org.apache.struts2.components.template.Template;
import org.apache.struts2.components.template.TemplateEngine;
import org.apache.struts2.components.template.TemplateEngineManager;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;


import java.util.Collections;
import java.util.Map;

/**
*
* @version $Date$ $Id$
*/
public class UIBeanTest extends StrutsInternalTestCase {

public void testPopulateComponentHtmlId1() throws Exception {
Expand Down Expand Up @@ -161,4 +162,121 @@ public void testGetThemeFromContextNonString() throws Exception {
assertEquals("12", txtFld.getTheme());
}

public void testMergeTemplateNullEngineException() throws Exception {
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();
//templateEngineManager that returns null as TemplateEngine
TemplateEngineManager templateEngineManager = new TemplateEngineManager() {
public TemplateEngine getTemplateEngine(Template template, String templateTypeOverride) {
return null;
}
};
TextField txtFld = new TextField(stack, req, res);

txtFld.setTemplateEngineManager(templateEngineManager);

try {
txtFld.mergeTemplate(null, new Template(null, null, null));
fail("Exception not thrown");
} catch(final Exception e){
assertTrue(e instanceof ConfigurationException);
}
}

public void testBuildTemplate() throws Exception {
String defaultTemplateName = "default";
String customTemplateName = "custom";
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();

TextField txtFld = new TextField(stack, req, res);

Template defaultTemplate = txtFld.buildTemplateName(null, defaultTemplateName);
Template customTemplate = txtFld.buildTemplateName(customTemplateName, defaultTemplateName);

assertEquals(defaultTemplateName, defaultTemplate.getName());
assertEquals(customTemplateName, customTemplate.getName());
}

public void testGetTemplateDirExplicit() throws Exception {
String explicitTemplateDir = "explicitTemplateDirectory";
String attrTemplateDir = "attrTemplateDirectory";
String defaultTemplateDir = "defaultTemplateDirectory";
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();
Map context = Collections.singletonMap("templateDir", attrTemplateDir);
ActionContext.getContext().put("attr", context);

TextField txtFld = new TextField(stack, req, res);
txtFld.setTemplateDir(explicitTemplateDir);
txtFld.setDefaultTemplateDir(defaultTemplateDir);

assertEquals(explicitTemplateDir, txtFld.getTemplateDir());
}

public void testGetTemplateDirAttr() throws Exception {
String attrTemplateDir = "attrTemplateDirectory";
String defaultTemplateDir = "defaultTemplateDirectory";
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();
Map context = Collections.singletonMap("templateDir", attrTemplateDir);
ActionContext.getContext().put("attr", context);

TextField txtFld = new TextField(stack, req, res);
txtFld.setDefaultTemplateDir(defaultTemplateDir);

assertEquals(attrTemplateDir, txtFld.getTemplateDir());
}

public void testGetTemplateDirDefault() throws Exception {
String defaultTemplateDir = "defaultTemplateDirectory";
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();

TextField txtFld = new TextField(stack, req, res);
txtFld.setDefaultTemplateDir(defaultTemplateDir);

assertEquals(defaultTemplateDir, txtFld.getTemplateDir());
}

public void testGetTemplateDirNoneSet() throws Exception {
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();

TextField txtFld = new TextField(stack, req, res);

assertEquals("template", txtFld.getTemplateDir());
}

public void testSetAccesskey() {
String accesskeyValue = "myAccesskey";
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();

TextField txtFld = new TextField(stack, req, res);
txtFld.setAccesskey(accesskeyValue);
txtFld.evaluateParams();

assertEquals(accesskeyValue, txtFld.getParameters().get("accesskey"));
}

public void testValueParameterEvaluation() {
String value = "myValue";
ValueStack stack = ActionContext.getContext().getValueStack();
MockHttpServletRequest req = new MockHttpServletRequest();
MockHttpServletResponse res = new MockHttpServletResponse();

TextField txtFld = new TextField(stack, req, res);
txtFld.addParameter("value", value);
txtFld.evaluateParams();

assertEquals(value, txtFld.getParameters().get("nameValue"));
}
}