String template curly braces bugfix #427

aktsay6 · 2020-10-19T10:14:57Z

What's done:

Fixed bug

This pull request closes #401

### What's done: * Fixed bug

codecov · 2020-10-19T10:28:00Z

Codecov Report

Merging #427 into master will decrease coverage by 0.05%.
The diff coverage is 62.50%.

@@             Coverage Diff              @@
##             master     #427      +/-   ##
============================================
- Coverage     81.94%   81.89%   -0.06%     
- Complexity     1445     1448       +3     
============================================
  Files            70       70              
  Lines          3617     3623       +6     
  Branches       1155     1158       +3     
============================================
+ Hits           2964     2967       +3     
  Misses          202      202              
- Partials        451      454       +3

Flag	Coverage Δ	Complexity Δ
#unittests	`81.89% <62.50%> (-0.06%)`	`1448.00 <6.00> (+3.00)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ	Complexity Δ
...n/diktat/ruleset/rules/StringTemplateFormatRule.kt	`85.29% <62.50%> (-7.57%)`	`12.00 <6.00> (+3.00)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f28dfb9...07c5f77. Read the comment docs.

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

### What's done: * Fixed bugs

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

diktat-rules/src/test/resources/test/paragraph3/string_template/StringTemplateExpected.kt

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

### What's done: * Fixed bugs

orchestr7 · 2020-10-20T11:31:33Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/StringTemplateRuleWarnTest.kt

@@ -22,6 +21,7 @@ class StringTemplateRuleWarnTest : LintTestBase(::StringTemplateFormatRule) {
                """
                    |class Some { 
                    |   val template = "${'$'}{::String} ${'$'}{asd.moo()}"
+                    |   val some = "${'$'}{foo as Foo}"


not much tests for a regression

### What's done: * Fixed bugs

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

petertrr · 2020-10-20T15:50:56Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/StringTemplateRuleWarnTest.kt

                    |}
                """.trimMargin(),
                LintError(2, 20, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{a}", true),
-                LintError(3, 16, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{1.0}", true)
+                LintError(3, 16, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{1.0}", true),
+                LintError(4, 19, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{1}", true)


Do you mean that braces can be omitted around dollar sign? Then you must ensure that your fixer escapes it for single-quoted strings and doesn't fix ${'$'} for triple-quoted strings (no way to escape $ there)

No, it was meant that braces can be omitted around integers or floats

But they can't - in your example it's not a part of template, these braces are just regular characters inside the string. ${'$'} is a template, and {1.0} that goes after is a regular part of string.

Oh, this warning complains about $, not 1? Then it makes sense.. Do you have tests that ${'$'} is considered valid in triple-quoted strings?

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/StringTemplateRuleWarnTest.kt

### What's done: * Fixed bugs

### What's done: * Added test

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

petertrr · 2020-10-26T15:35:33Z

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/StringTemplateRuleWarnTest.kt

                    |}
                """.trimMargin(),
                LintError(2, 20, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{a}", true),
-                LintError(3, 16, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{1.0}", true)
+                LintError(3, 16, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{1.0}", true),
+                LintError(4, 19, ruleId, "${Warnings.STRING_TEMPLATE_CURLY_BRACES.warnText()} ${'$'}{1}", true)


Oh, this warning complains about $, not 1? Then it makes sense.. Do you have tests that ${'$'} is considered valid in triple-quoted strings?

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/StringTemplateRuleWarnTest.kt

### What's done: * Fixed bugs

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

### What's done: * Fixed bugs

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

### What's done: * Fixed bugs

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt

### What's done: * Fixed bugs

petertrr

lgtm

bugfix/string-template-curly-braces

93ea84b

### What's done: * Fixed bug

aktsay6 added the bug Something isn't working label Oct 19, 2020

aktsay6 requested review from petertrr and kentr0w October 19, 2020 10:14

petertrr reviewed Oct 19, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt Outdated Show resolved Hide resolved

bugfix/string-template-curly-braces(#401)

569ff78

### What's done: * Fixed bugs

petertrr requested changes Oct 20, 2020

View reviewed changes

aktsay6 added 2 commits October 20, 2020 11:10

bugfix/string-template-curly-braces(#401)

d7cf01e

### What's done: * Fixed bugs

bugfix/string-template-curly-braces(#401)

73a6fde

### What's done: * Fixed bugs

orchestr7 reviewed Oct 20, 2020

View reviewed changes

bugfix/string-template-curly-braces(#401)

4c225d3

### What's done: * Fixed bugs

petertrr requested changes Oct 20, 2020

View reviewed changes

aktsay6 added 2 commits October 21, 2020 16:01

bugfix/string-template-curly-braces(#401)

31293fe

### What's done: * Fixed bugs

bugfix/string-template-curly-braces

b6b9803

### What's done: * Added test

petertrr reviewed Oct 26, 2020

View reviewed changes

bugfix/string-template-curly-braces(#401)

7ee6da6

### What's done: * Fixed bugs

petertrr reviewed Oct 27, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt Outdated Show resolved Hide resolved

bugfix/string-template-curly-braces(#401)

0773b9d

### What's done: * Fixed bugs

petertrr requested changes Oct 27, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt Outdated Show resolved Hide resolved

bugfix/string-template-curly-braces(#401)

c244ebe

### What's done: * Fixed bugs

petertrr reviewed Oct 27, 2020

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/StringTemplateFormatRule.kt Show resolved Hide resolved

bugfix/string-template-curly-braces(#401)

317af80

### What's done: * Fixed bugs

petertrr approved these changes Oct 27, 2020

View reviewed changes

Merge branch 'master' into bugfix/string-template-curly-braces(#401)

07c5f77

aktsay6 merged commit 2d9e88e into master Oct 27, 2020

aktsay6 deleted the bugfix/string-template-curly-braces(#401) branch October 27, 2020 15:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

String template curly braces bugfix #427

String template curly braces bugfix #427

aktsay6 commented Oct 19, 2020

codecov bot commented Oct 19, 2020 •

edited

Loading

orchestr7 Oct 20, 2020 •

edited

Loading

petertrr Oct 20, 2020

aktsay6 Oct 21, 2020

petertrr Oct 21, 2020 •

edited

Loading

petertrr Oct 26, 2020

petertrr Oct 26, 2020

petertrr left a comment

String template curly braces bugfix #427

String template curly braces bugfix #427

Conversation

aktsay6 commented Oct 19, 2020

What's done:

codecov bot commented Oct 19, 2020 • edited Loading

Codecov Report

orchestr7 Oct 20, 2020 • edited Loading

Choose a reason for hiding this comment

petertrr Oct 20, 2020

Choose a reason for hiding this comment

aktsay6 Oct 21, 2020

Choose a reason for hiding this comment

petertrr Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

petertrr Oct 26, 2020

Choose a reason for hiding this comment

petertrr Oct 26, 2020

Choose a reason for hiding this comment

petertrr left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 19, 2020 •

edited

Loading

orchestr7 Oct 20, 2020 •

edited

Loading

petertrr Oct 21, 2020 •

edited

Loading