#1164

pending completion

Build # #1164

Build Type

Pull #189

github

Committed by

web-flow

Commit Message

Merge e930cb29c into 34bbfca66

Pull Request Pull Request #189: Update dependency org.mybatis:mybatis-parent to v38

Run Details

611 of 621 relevant lines covered (98.39%)

0.98 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/main/java/org/mybatis/scripting/thymeleaf/processor/MyBatisParamTagProcessor.java

/*
 *    Copyright 2018-2022 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       https://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.mybatis.scripting.thymeleaf.processor;

import java.lang.reflect.Array;
import java.util.Collection;
import java.util.function.UnaryOperator;

import org.mybatis.scripting.thymeleaf.MyBatisBindingContext;
import org.thymeleaf.context.ITemplateContext;
import org.thymeleaf.engine.AttributeName;
import org.thymeleaf.engine.EngineEventUtils;
import org.thymeleaf.engine.IterationStatusVar;
import org.thymeleaf.model.IProcessableElementTag;
import org.thymeleaf.processor.element.AbstractAttributeTagProcessor;
import org.thymeleaf.processor.element.IElementTagStructureHandler;
import org.thymeleaf.standard.expression.IStandardExpression;
import org.thymeleaf.standard.expression.StandardExpressionExecutionContext;
import org.thymeleaf.templatemode.TemplateMode;

/**
 * The processor class for handling the {@code mb:p} tag. <br>
 * This processor render bind variable(default: {@code #{…​}}) expression that can parsed data access library and
 * register an iteration object to the bind variables.
 *
 * @author Kazuki Shimizu
 *
 * @version 1.0.0
 */
public class MyBatisParamTagProcessor extends AbstractAttributeTagProcessor {

  private static final int PRECEDENCE = 1400;
  private static final String ATTR_NAME = "p";

  private final StandardExpressionExecutionContext expressionExecutionContext;

  private UnaryOperator<String> bindVariableRender = BindVariableRender.BuiltIn.MYBATIS;

  /**
   * Constructor that can be specified the template mode and dialect prefix.
   *
   * @param templateMode
   *          A target template mode
   * @param prefix
   *          A target dialect prefix
   */
  public MyBatisParamTagProcessor(final TemplateMode templateMode, final String prefix) {
    super(templateMode, prefix, null, false, ATTR_NAME, true, PRECEDENCE, true);
    expressionExecutionContext = templateMode == TemplateMode.TEXT ? StandardExpressionExecutionContext.RESTRICTED
        : StandardExpressionExecutionContext.NORMAL;
  }

  /**
   * Set a custom bind variable render function.<br>
   * By default, render {@literal #{...}} format.
   *
   * @param bindVariableRender
   *          a custom bind variable render function
   *
   * @since 1.0.2
   */
  public void setBindVariableRender(UnaryOperator<String> bindVariableRender) {
    this.bindVariableRender = bindVariableRender;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected void doProcess(ITemplateContext context, IProcessableElementTag tag, AttributeName attributeName,
      String attributeValue, IElementTagStructureHandler structureHandler) {
    if (attributeValue.contains("${")) {
      attributeValue = getExpressionEvaluatedText(context, tag, attributeName, attributeValue);
    }

    Pair parameterAndOptionPair = Pair.parse(attributeValue, ',');
    String parameterPath = parameterAndOptionPair.left;
    String options = parameterAndOptionPair.right;

    Pair objectNameAndPropertyPathPair = Pair.parse(parameterPath, '.');
    String objectName = objectNameAndPropertyPathPair.left;
    String nestedPropertyPath = objectNameAndPropertyPathPair.right;

    String body;
    String iterationObjectName = objectName + "Stat";
    if (context.containsVariable(iterationObjectName)) {
      MyBatisBindingContext bindingContext = MyBatisBindingContext.load(context);
      IterationStatusVar iterationStatus = (IterationStatusVar) context.getVariable(iterationObjectName);
      String iterationObjectVariableName = bindingContext.generateUniqueName(objectName, iterationStatus);
      if (!bindingContext.containsCustomBindVariable(iterationObjectVariableName)) {
        bindingContext.setCustomBindVariable(iterationObjectVariableName, iterationStatus.getCurrent());
      }
      if (nestedPropertyPath.isEmpty()) {
        body = bindVariableRender.apply(iterationObjectVariableName + options);
      } else {
        Object value = getExpressionEvaluatedValue(context, tag, attributeName, parameterPath);
        if (isCollectionOrArray(value)) {
          body = generateCollectionBindVariables(value, iterationObjectVariableName + nestedPropertyPath, options);
        } else {
          body = bindVariableRender.apply(iterationObjectVariableName + nestedPropertyPath + options);
        }
      }
    } else {
      Object value = nestedPropertyPath.isEmpty() ? context.getVariable(objectName)
          : getExpressionEvaluatedValue(context, tag, attributeName, parameterPath);
      if (isCollectionOrArray(value)) {
        body = generateCollectionBindVariables(value, parameterPath, options);
      } else {
        body = bindVariableRender.apply(attributeValue);
      }
    }
    structureHandler.setBody(body, false);
  }

  private Object getExpressionEvaluatedValue(ITemplateContext context, IProcessableElementTag tag,
      AttributeName attributeName, String parameterValue) {
    IStandardExpression expression = EngineEventUtils.computeAttributeExpression(context, tag, attributeName,
        "${" + parameterValue + "}");
    return expression.execute(context, this.expressionExecutionContext);
  }

  private String getExpressionEvaluatedText(ITemplateContext context, IProcessableElementTag tag,
      AttributeName attributeName, String parameterValue) {
    IStandardExpression expression = EngineEventUtils.computeAttributeExpression(context, tag, attributeName,
        "|" + parameterValue + "|");
    return expression.execute(context, this.expressionExecutionContext).toString();
  }

  private boolean isCollectionOrArray(Object value) {
    return value != null && (Collection.class.isAssignableFrom(value.getClass()) || value.getClass().isArray());
  }

  private String generateCollectionBindVariables(Object value, String parameterPath, String options) {
    int size = value.getClass().isArray() ? Array.getLength(value) : ((Collection) value).size();
    if (size == 0) {
      return "null";
    } else {
      StringBuilder sb = new StringBuilder();
      for (int i = 0; i < size; i++) {
        if (i != 0) {
          sb.append(", ");
        }
        sb.append(bindVariableRender.apply(parameterPath + "[" + i + "]" + options));
      }
      return sb.toString();
    }
  }

  private static class Pair {

    private final String left;
    private final String right;

    private Pair(String left, String right) {
      this.left = left;
      this.right = right;
    }

    private static Pair parse(String value, char separator) {
      int separatorIndex = value.indexOf(separator);
      String left;
      String right;
      if (separatorIndex == -1) {
        left = value;
        right = "";
      } else {
        left = value.substring(0, separatorIndex);
        right = value.substring(separatorIndex);
      }
      return new Pair(left, right);
    }

  }

}

1	/*
2	* Copyright 2018-2022 the original author or authors.
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* https://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16	package org.mybatis.scripting.thymeleaf.processor;
17
18	import java.lang.reflect.Array;
19	import java.util.Collection;
20	import java.util.function.UnaryOperator;
21
22	import org.mybatis.scripting.thymeleaf.MyBatisBindingContext;
23	import org.thymeleaf.context.ITemplateContext;
24	import org.thymeleaf.engine.AttributeName;
25	import org.thymeleaf.engine.EngineEventUtils;
26	import org.thymeleaf.engine.IterationStatusVar;
27	import org.thymeleaf.model.IProcessableElementTag;
28	import org.thymeleaf.processor.element.AbstractAttributeTagProcessor;
29	import org.thymeleaf.processor.element.IElementTagStructureHandler;
30	import org.thymeleaf.standard.expression.IStandardExpression;
31	import org.thymeleaf.standard.expression.StandardExpressionExecutionContext;
32	import org.thymeleaf.templatemode.TemplateMode;
33
34	/**
35	* The processor class for handling the {@code mb:p} tag. <br>
36	* This processor render bind variable(default: {@code #{…}}) expression that can parsed data access library and
37	* register an iteration object to the bind variables.
38	*
39	* @author Kazuki Shimizu
40	*
41	* @version 1.0.0
42	*/
43	public class MyBatisParamTagProcessor extends AbstractAttributeTagProcessor {
44
45	private static final int PRECEDENCE = 1400;
46	private static final String ATTR_NAME = "p";
47
48	private final StandardExpressionExecutionContext expressionExecutionContext;
49
50	private UnaryOperator<String> bindVariableRender = BindVariableRender.BuiltIn.MYBATIS;	1✔
51
52	/**
53	* Constructor that can be specified the template mode and dialect prefix.
54	*
55	* @param templateMode
56	* A target template mode
57	* @param prefix
58	* A target dialect prefix
59	*/
60	public MyBatisParamTagProcessor(final TemplateMode templateMode, final String prefix) {
61	super(templateMode, prefix, null, false, ATTR_NAME, true, PRECEDENCE, true);	1✔
62	expressionExecutionContext = templateMode == TemplateMode.TEXT ? StandardExpressionExecutionContext.RESTRICTED	1✔
63	: StandardExpressionExecutionContext.NORMAL;	1✔
64	}	1✔
65
66	/**
67	* Set a custom bind variable render function.<br>
68	* By default, render {@literal #{...}} format.
69	*
70	* @param bindVariableRender
71	* a custom bind variable render function
72	*
73	* @since 1.0.2
74	*/
75	public void setBindVariableRender(UnaryOperator<String> bindVariableRender) {
76	this.bindVariableRender = bindVariableRender;	1✔
77	}	1✔
78
79	/**
80	* {@inheritDoc}
81	*/
82	@Override
83	protected void doProcess(ITemplateContext context, IProcessableElementTag tag, AttributeName attributeName,
84	String attributeValue, IElementTagStructureHandler structureHandler) {
85	if (attributeValue.contains("${")) {	1✔
86	attributeValue = getExpressionEvaluatedText(context, tag, attributeName, attributeValue);	1✔
87	}
88
89	Pair parameterAndOptionPair = Pair.parse(attributeValue, ',');	1✔
90	String parameterPath = parameterAndOptionPair.left;	1✔
91	String options = parameterAndOptionPair.right;	1✔
92
93	Pair objectNameAndPropertyPathPair = Pair.parse(parameterPath, '.');	1✔
94	String objectName = objectNameAndPropertyPathPair.left;	1✔
95	String nestedPropertyPath = objectNameAndPropertyPathPair.right;	1✔
96
97	String body;
98	String iterationObjectName = objectName + "Stat";	1✔
99	if (context.containsVariable(iterationObjectName)) {	1✔
100	MyBatisBindingContext bindingContext = MyBatisBindingContext.load(context);	1✔
101	IterationStatusVar iterationStatus = (IterationStatusVar) context.getVariable(iterationObjectName);	1✔
102	String iterationObjectVariableName = bindingContext.generateUniqueName(objectName, iterationStatus);	1✔
103	if (!bindingContext.containsCustomBindVariable(iterationObjectVariableName)) {	1✔
104	bindingContext.setCustomBindVariable(iterationObjectVariableName, iterationStatus.getCurrent());	1✔
105	}
106	if (nestedPropertyPath.isEmpty()) {	1✔
107	body = bindVariableRender.apply(iterationObjectVariableName + options);	1✔
108	} else {
109	Object value = getExpressionEvaluatedValue(context, tag, attributeName, parameterPath);	1✔
110	if (isCollectionOrArray(value)) {	1✔
111	body = generateCollectionBindVariables(value, iterationObjectVariableName + nestedPropertyPath, options);	1✔
112	} else {
113	body = bindVariableRender.apply(iterationObjectVariableName + nestedPropertyPath + options);	1✔
114	}
115	}
116	} else {	1✔
117	Object value = nestedPropertyPath.isEmpty() ? context.getVariable(objectName)	1✔
118	: getExpressionEvaluatedValue(context, tag, attributeName, parameterPath);	1✔
119	if (isCollectionOrArray(value)) {	1✔
120	body = generateCollectionBindVariables(value, parameterPath, options);	1✔
121	} else {
122	body = bindVariableRender.apply(attributeValue);	1✔
123	}
124	}
125	structureHandler.setBody(body, false);	1✔
126	}	1✔
127
128	private Object getExpressionEvaluatedValue(ITemplateContext context, IProcessableElementTag tag,
129	AttributeName attributeName, String parameterValue) {
130	IStandardExpression expression = EngineEventUtils.computeAttributeExpression(context, tag, attributeName,	1✔
131	"${" + parameterValue + "}");
132	return expression.execute(context, this.expressionExecutionContext);	1✔
133	}
134
135	private String getExpressionEvaluatedText(ITemplateContext context, IProcessableElementTag tag,
136	AttributeName attributeName, String parameterValue) {
137	IStandardExpression expression = EngineEventUtils.computeAttributeExpression(context, tag, attributeName,	1✔
138	"\|" + parameterValue + "\|");
139	return expression.execute(context, this.expressionExecutionContext).toString();	1✔
140	}
141
142	private boolean isCollectionOrArray(Object value) {
143	return value != null && (Collection.class.isAssignableFrom(value.getClass()) \|\| value.getClass().isArray());	1✔
144	}
145
146	private String generateCollectionBindVariables(Object value, String parameterPath, String options) {
147	int size = value.getClass().isArray() ? Array.getLength(value) : ((Collection) value).size();	1✔
148	if (size == 0) {	1✔
149	return "null";	1✔
150	} else {
151	StringBuilder sb = new StringBuilder();	1✔
152	for (int i = 0; i < size; i++) {	1✔
153	if (i != 0) {	1✔
154	sb.append(", ");	1✔
155	}
156	sb.append(bindVariableRender.apply(parameterPath + "[" + i + "]" + options));	1✔
157	}
158	return sb.toString();	1✔
159	}
160	}
161
162	private static class Pair {
163
164	private final String left;
165	private final String right;
166
167	private Pair(String left, String right) {	1✔
168	this.left = left;	1✔
169	this.right = right;	1✔
170	}	1✔
171
172	private static Pair parse(String value, char separator) {
173	int separatorIndex = value.indexOf(separator);	1✔
174	String left;
175	String right;
176	if (separatorIndex == -1) {	1✔
177	left = value;	1✔
178	right = "";	1✔
179	} else {
180	left = value.substring(0, separatorIndex);	1✔
181	right = value.substring(separatorIndex);	1✔
182	}
183	return new Pair(left, right);	1✔
184	}
185
186	}
187
188	}

mybatis / thymeleaf-scripting / #1164

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous