Introducing a Messages.formatWithAttributes() method + unit tests #1649

andreiruse · 2018-01-26T14:04:33Z

This new method will not only return the formatted message with values instead of placeholders but also a map of attributes.

cjkent · 2018-01-26T14:09:47Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+          Messages.format("You have included {} placeholders, however only provided {} arguments.", matchesCount, args.length));
+    }
+    matcher.reset(); //Since we have already called .find(), and that state needs to be reset
+    while (matcher.find()) {


Can you use Matcher.appendReplacement() to simplify this?

https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#appendReplacement-java.lang.StringBuffer-java.lang.String-

cjkent · 2018-01-26T14:10:39Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

@@ -110,4 +118,74 @@ public static String format(String messageTemplate, Object... args) {
    return builder.toString();
  }

+  /**
+   * Formats a templated message inserting named arguments.


I don't think these Javadoc make it clear enough what the method does. An example would be worth a thousand words.

cjkent · 2018-01-26T14:12:03Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+    while (matcher.find()) {
+      matchesCount++;
+    }
+    if (matchesCount > args.length) {


Could you roll this check into the replacement loop?

cjkent · 2018-01-26T14:20:38Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+   */
+  public static Pair<String, Map<String, String>> formatWithAttributes(String messageTemplate, Object... args) {
+    if (messageTemplate == null) {
+      return formatWithAttributes("", args);


Would this achieve the same thing?

return "";

Logically, yes. However, the method has to return Pair<String, Map<String, String>> - returning a String would not work.

My point was that it's probably clearer to return immediately rather than calling back into the method and asking the reader to work out how that would behave. Like this:

return Pair.of("", ImmutableMap.of());

cjkent · 2018-01-26T14:21:02Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+      return formatWithAttributes("", args);
+    }
+    if (args == null) {
+      return formatWithAttributes(messageTemplate, new Object[0]);


Is this the same as:

return messageTemplate;

Logically, yes. However, the method has to return Pair<String, Map<String, String>> - returning a String would not work

cjkent · 2018-01-26T14:22:45Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+    ImmutableMap.Builder<String, String> attributesMap = ImmutableMap.builder();
+
+    String pattern = "\\{(\\w+)\\}";
+    Pattern regexPattern = Pattern.compile(pattern);


Compiling a pattern is relatively expensive. Do it once and put it in a static final field. Pattern is thread safe and can be shared.

cjkent · 2018-01-26T14:25:49Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+
+    String pattern = "\\{(\\w+)\\}";
+    Pattern regexPattern = Pattern.compile(pattern);
+    Matcher matcher = regexPattern.matcher(messageTemplate);


Using a regex might be a performance problem. But manually parsing is likely to be fiddly. I'd use a regex for simplicity until it's obviously a problem.

jodastephen · 2018-01-26T14:40:28Z

modules/collect/src/test/java/com/opengamma/strata/collect/MessagesTest.java

+    return new Object[][]{
+        // null template
+        {null, null, Pair.of("", ImmutableMap.of())},
+        {null, new Object[]{}, Pair.of("", ImmutableMap.of())},


There should be one space between the square and curly braces [] { on each of these lines

jodastephen · 2018-01-26T14:47:50Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+   * The message template contains zero to many "{name}" placeholders.
+   * Each placeholder is replaced by the next available argument.
+   * Empty "{}" placeholders do not get replaced, and will be present in the output in the same form.
+   * If there are too few arguments, then an {@link IllegalArgumentException} will be thrown.


No exceptions. This method is used when producing exceptions, so it must not throw one.

jodastephen · 2018-01-26T15:05:34Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+   * <p>
+   * The message template contains zero to many "{name}" placeholders.
+   * Each placeholder is replaced by the next available argument.
+   * Empty "{}" placeholders do not get replaced, and will be present in the output in the same form.


No. {} is still a placeholder, just an unamed one.

That argument is outdated. Both named and unnamed placeholders are not replaced, as expected

jodastephen · 2018-01-26T15:08:02Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+
+    // try to make builder big enough for the message and the args
+    StringBuilder outputStringBuilder = new StringBuilder(messageTemplate.length() + args.length * 20);
+    Map<String, String> attributesMap = new HashMap<>();


Add a comment to not use ImmutableMap as duplicate keys must be allowed even though there is data loss (to avoid exceptions)

jodastephen · 2018-01-26T15:15:42Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

+    int groupIndex = 0;
+    int lastAddedStringEndIndex = 0;
+    int matchesCount = 0;
+    while (matcher.find()) {


This loop won't be needed once you get rid of the exception

cjkent · 2018-01-26T16:18:38Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java


+      if (matchesCount > args.length) {
+        throw new IllegalArgumentException(


Don't throw an exception. Just ignore the extra placeholders so they appear in the output as {} or {foo}.

cjkent · 2018-01-26T20:10:56Z

modules/collect/src/main/java/com/opengamma/strata/collect/Messages.java

@@ -110,4 +120,57 @@ public static String format(String messageTemplate, Object... args) {
    return builder.toString();
  }

+  /**
+   * Formats a templated message inserting named arguments. Typical template would look like "Hello, {attributeName}".


I still think this needs an example. I don't think it's clear from the docs what it does. Something like:

Messages.formatWithAttributes("Foo={foo}, Bar={}", "abc", 123);

returns the message

"Foo=abc, Bar=123"

and the map

{"foo": "123"}

Feel free to copy and paste :)

Introducing a Messages.formatWithAttributes() method + unit tests

ad80805

andreiruse assigned jodastephen Jan 26, 2018

andreiruse requested a review from jodastephen January 26, 2018 14:04

cjkent reviewed Jan 26, 2018

View reviewed changes

Checkstyle issue

ce45257

cjkent reviewed Jan 26, 2018

View reviewed changes

Fixing some edge cases

7d5e7d9

jodastephen requested changes Jan 26, 2018

View reviewed changes

Andrei Ruse added 2 commits January 26, 2018 15:32

Addressing PR feedback

a75976d

Addressing PR feedback

a1c624d

cjkent suggested changes Jan 26, 2018

View reviewed changes

Andrei Ruse added 4 commits January 26, 2018 16:26

Addressing PR feedback

d2ac467

Addressing PR feedback

e3ea022

Addressing PR feedback - Extra unit test

9da5d60

Addressing PR feedback

8ef66d4

jodastephen approved these changes Jan 26, 2018

View reviewed changes

cjkent suggested changes Jan 26, 2018

View reviewed changes

Andrei Ruse added 3 commits January 30, 2018 10:25

Addressing PR feedback. Fixing $-related bug

0660b01

Addressing PR feedback

8289858

Addressing PR feedback

210ee5c

cjkent approved these changes Jan 30, 2018

View reviewed changes

andreiruse merged commit dedab3e into master Jan 30, 2018

andreiruse deleted the topic/messages-format-with-attributes branch January 30, 2018 11:17

jodastephen added the Type:Enhancement label Feb 14, 2018

jodastephen added this to the v1.7 milestone Feb 14, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introducing a Messages.formatWithAttributes() method + unit tests #1649

Introducing a Messages.formatWithAttributes() method + unit tests #1649

andreiruse commented Jan 26, 2018

cjkent Jan 26, 2018

cjkent Jan 26, 2018 •

edited

Loading

cjkent Jan 26, 2018

cjkent Jan 26, 2018

andreiruse Jan 26, 2018

cjkent Jan 26, 2018

cjkent Jan 26, 2018

andreiruse Jan 26, 2018

cjkent Jan 26, 2018

cjkent Jan 26, 2018

jodastephen Jan 26, 2018

jodastephen Jan 26, 2018

jodastephen Jan 26, 2018

andreiruse Jan 26, 2018

jodastephen Jan 26, 2018

jodastephen Jan 26, 2018

cjkent Jan 26, 2018

cjkent Jan 26, 2018


		if (matchesCount > args.length) {
		throw new IllegalArgumentException(

Introducing a Messages.formatWithAttributes() method + unit tests #1649

Introducing a Messages.formatWithAttributes() method + unit tests #1649

Conversation

andreiruse commented Jan 26, 2018

Choose a reason for hiding this comment

cjkent Jan 26, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjkent Jan 26, 2018 •

edited

Loading