Merge pull request #2 from antkorwin/feature/escaping

Feature/escaping

Author: antkorwin

.travis.yml

@@ -5,12 +5,10 @@ jdk:
 script:
  - mvn clean -P jdk-tools org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.issue.ignore.multicriteria="e1" -Dsonar.issue.ignore.multicriteria.e1.ruleKey="squid:S00119" -Dsonar.issue.ignore.multicriteria.e1.resourceKey="**/*.java"
 
-
 addons:
   sonarcloud:
     organization: "antkorwin-github"
-    token:
-      secure: $SONAR_CLOUD_KEY
+    token: $SONAR_CLOUD_KEY
 
 after_success:
  - bash <(curl -s https://codecov.io/bash)

README.adoc

@@ -98,7 +98,7 @@ You need to add the following dependency:
 <dependency>
     <groupId>com.antkorwin</groupId>
     <artifactId>better-strings</artifactId>
-    <version>0.1</version>
+    <version>0.2</version>
 </dependency>
 ----
 
@@ -120,8 +120,50 @@ class Foo {
 
 this code prints: `${a+b}`
 
+Also, you can use the following workaround
+to escape string interpolation locally in your code:
+
+[source, java]
+----
+System.out.println("${'$'}{a+b}");
+----
+
+the result is : `${a+b}`
+
 
 ## How it works
 
 Better Strings is a Java Annotation Processor,
-but it does not process specific annotations, it makes AST modification of your code while javac compiling it.
+but it does not process specific annotations, it makes AST modification of your code while javac compiling it.
+
+NOTE: Keep in mind that this feature should be used carefully.
+You shouldn't write too much code inside string literals
+because it is too difficult to maintain and maybe not obvious for debugging.
+
+If you want to set annotation processors order
+or just set manually processors path,
+you should set the path for `better-strings` too, like this:
+[source, xml]
+----
+<build>
+    <plugins>
+        <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-compiler-plugin</artifactId>
+            <version>3.5.1</version> <!-- or newer version -->
+            <configuration>
+                <source>1.8</source> <!-- depending on your project -->
+                <target>1.8</target> <!-- depending on your project -->
+                <annotationProcessorPaths>
+                    <!-- other annotation processors -->
+                    <path>
+                       <groupId>com.antkorwin</groupId>
+                       <artifactId>better-strings</artifactId>
+                       <version>0.2</version>
+                    </path>
+                </annotationProcessorPaths>
+            </configuration>
+        </plugin>
+    </plugins>
+</build>
+----

src/main/java/com/antkorwin/betterstrings/ast/InnerStringVarsAstTranslator.java

@@ -101,7 +101,7 @@ public void visitLiteral(JCTree.JCLiteral jcLiteral) {
 
 			List<Token> tokens = tokenizer.split(jcLiteral);
 
-			if (tokens.size() < 1) {
+			if (tokens.isEmpty()) {
 				return;
 			}
 

src/test/java/com/antkorwin/betterstrings/BetterStringsProcessorTest.java

@@ -182,4 +182,27 @@ void importDisabledAnnotationAndCheckType() {
 			assertThat(result).isEqualTo("sum = ${3+4}");
 		}
 	}
+
+	@Nested
+	class StringInterpolationEscaping {
+
+		@Test
+		void workaround() {
+			@Language("Java") String classCode = "import com.antkorwin.betterstrings.*;" +
+			                                     "" +
+			                                     "public class Test { " +
+			                                     "  public static String sum(){ " +
+			                                     "      return \"sum = ${'$'}{3 + 4}\";" +
+			                                     "  } " +
+			                                     "}";
+
+			Object result = new CompileTest().classCode("Test", classCode)
+			                                 .processor(new BetterStringsProcessor())
+			                                 .compile()
+			                                 .loadClass("Test")
+			                                 .invokeStatic("sum");
+
+			assertThat(result).isEqualTo("sum = ${3 + 4}");
+		}
+	}
 }