|
| 1 | +/** |
| 2 | + * |
| 3 | + */ |
| 4 | +package com.e1c.v8codestyle.md.check; |
| 5 | + |
| 6 | +import java.text.MessageFormat; |
| 7 | +import java.util.regex.Pattern; |
| 8 | + |
| 9 | +import org.eclipse.core.runtime.IProgressMonitor; |
| 10 | +import org.eclipse.emf.common.util.EMap; |
| 11 | +import org.eclipse.emf.ecore.EObject; |
| 12 | +import org.eclipse.emf.ecore.EReference; |
| 13 | + |
| 14 | +import com._1c.g5.v8.dt.common.StringUtils; |
| 15 | +import com._1c.g5.v8.dt.core.platform.IV8ProjectManager; |
| 16 | +import com.e1c.g5.v8.dt.check.CheckComplexity; |
| 17 | +import com.e1c.g5.v8.dt.check.ICheckParameters; |
| 18 | +import com.e1c.g5.v8.dt.check.components.BasicCheck; |
| 19 | +import com.e1c.g5.v8.dt.check.settings.IssueSeverity; |
| 20 | +import com.e1c.g5.v8.dt.check.settings.IssueType; |
| 21 | + |
| 22 | +/** |
| 23 | + * The abstract class to check UI feature of EMF object that is not empty or match pattern. |
| 24 | + * |
| 25 | + * @author Dmitriy Marmyshev |
| 26 | + */ |
| 27 | +public abstract class AbstractUiStringCheck |
| 28 | + extends BasicCheck |
| 29 | +{ |
| 30 | + protected static final String PARAM_UI_STRING_PATTERN = "uiStringPattern"; //$NON-NLS-1$ |
| 31 | + |
| 32 | + protected final EReference uiStringRef; |
| 33 | + |
| 34 | + private final IV8ProjectManager v8ProjectManager; |
| 35 | + |
| 36 | + protected AbstractUiStringCheck(EReference uiStringRef, IV8ProjectManager v8ProjectManager) |
| 37 | + { |
| 38 | + this.uiStringRef = uiStringRef; |
| 39 | + this.v8ProjectManager = v8ProjectManager; |
| 40 | + } |
| 41 | + |
| 42 | + @Override |
| 43 | + protected void configureCheck(CheckConfigurer builder) |
| 44 | + { |
| 45 | + builder.complexity(CheckComplexity.NORMAL) |
| 46 | + .severity(IssueSeverity.MINOR) |
| 47 | + .issueType(IssueType.UI_STYLE) |
| 48 | + .extension(new MdUiStringExtension()) |
| 49 | + .parameter(PARAM_UI_STRING_PATTERN, String.class, getUiStringPatternDefaultValue(), |
| 50 | + getUiStringPatternTitle()); |
| 51 | + } |
| 52 | + |
| 53 | + protected String getUiStringPatternDefaultValue() |
| 54 | + { |
| 55 | + return StringUtils.EMPTY; |
| 56 | + } |
| 57 | + |
| 58 | + protected String getUiStringPatternTitle() |
| 59 | + { |
| 60 | + return "UI string pattern"; |
| 61 | + } |
| 62 | + |
| 63 | + @Override |
| 64 | + protected void check(Object object, ResultAcceptor resultAceptor, ICheckParameters parameters, |
| 65 | + IProgressMonitor monitor) |
| 66 | + { |
| 67 | + EObject eObject = (EObject)object; |
| 68 | + Object rawValue = eObject.eGet(uiStringRef); |
| 69 | + if (!(rawValue instanceof EMap)) |
| 70 | + { |
| 71 | + return; |
| 72 | + } |
| 73 | + |
| 74 | + @SuppressWarnings("unchecked") |
| 75 | + EMap<String, String> uiString = (EMap<String, String>)rawValue; |
| 76 | + |
| 77 | + if (uiString.isEmpty()) |
| 78 | + { |
| 79 | + resultAceptor.addIssue(getUiStringIsEmptyForAll(), uiStringRef); |
| 80 | + } |
| 81 | + else |
| 82 | + { |
| 83 | + String uiStringPatternText = parameters.getString(PARAM_UI_STRING_PATTERN); |
| 84 | + Pattern uiStringPattern = StringUtils.isBlank(uiStringPatternText) ? null |
| 85 | + : Pattern.compile(uiStringPatternText, Pattern.UNICODE_CHARACTER_CLASS); |
| 86 | + |
| 87 | + for (String languageCode : MdUiStringExtension.getLanguageCodes(parameters, eObject, v8ProjectManager)) |
| 88 | + { |
| 89 | + String value = uiString.get(languageCode); |
| 90 | + if (StringUtils.isBlank(value)) |
| 91 | + { |
| 92 | + resultAceptor.addIssue(getUiStringIsEmpty(languageCode), uiStringRef); |
| 93 | + } |
| 94 | + else |
| 95 | + { |
| 96 | + if (uiStringPattern != null && !uiStringPattern.matcher(value).matches()) |
| 97 | + { |
| 98 | + resultAceptor.addIssue(getUiStringShouldMatchPattern(languageCode, uiStringPatternText), |
| 99 | + uiStringRef); |
| 100 | + } |
| 101 | + } |
| 102 | + } |
| 103 | + } |
| 104 | + } |
| 105 | + |
| 106 | + protected String getUiStringIsEmptyForAll() |
| 107 | + { |
| 108 | + return "UI string is empty for all languages"; |
| 109 | + } |
| 110 | + |
| 111 | + protected String getUiStringIsEmpty(String languageCode) |
| 112 | + { |
| 113 | + return MessageFormat.format("UI string for language \"{0}\" is empty", languageCode); |
| 114 | + } |
| 115 | + |
| 116 | + protected String getUiStringShouldMatchPattern(String languageCode, String patternText) |
| 117 | + { |
| 118 | + return MessageFormat.format("UI string for language \"{0}\" should match pattern: \"{1}\"", languageCode, |
| 119 | + patternText); |
| 120 | + } |
| 121 | + |
| 122 | +} |
0 commit comments