#517 checkstyle fixes

decorators-squad · Oct 29, 2022 · c859248 · c859248
1 parent b612e8e
commit c859248
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 7 deletions.
diff --git a/.rultor.yml b/.rultor.yml
@@ -6,7 +6,7 @@ env:
   MAVEN_OPTS: "-XX:MaxPermSize=256m -Xmx1g"
 merge:
   script: |-
-    mvn clean install -Pcheckstyle
+    mvn clean install -Pcheckstyle,itcases
 #decrypt:
 #  settings.xml: "repo/rcfg/settings.xml.asc"
 #  pubring.gpg: "repo/rcfg/pubring.gpg.asc"

diff --git a/src/main/java/com/amihaiemil/eoyaml/ReadYamlMapping.java b/src/main/java/com/amihaiemil/eoyaml/ReadYamlMapping.java
@@ -48,7 +48,12 @@
  */
 final class ReadYamlMapping extends BaseYamlMapping {
 
-    private static final Pattern KEY_PATTERN = Pattern.compile("^-?\\s*(?<key>.+):(|\\s.*)$");
+    /**
+     * Regex for a key in a mapping.
+     */
+    private static final Pattern KEY_PATTERN = Pattern.compile(
+        "^-?\\s*(?<key>.+):(|\\s.*)$"
+    );
 
     /**
      * Yaml line just previous to the one where this mapping starts. E.g.

diff --git a/src/test/java/com/amihaiemil/eoyaml/ReadYamlMappingTest.java b/src/test/java/com/amihaiemil/eoyaml/ReadYamlMappingTest.java
@@ -1171,13 +1171,19 @@ public void shouldReadFromAnotherFromYamlMapping()
             .equalTo("Some other value."));
     }
 
+    /**
+     * Reads mapping key properly if value has colon.
+     */
     @Test
     public void shouldReadKeyProperlyIfValueContainsColon() {
         final List<YamlLine> lines = new ArrayList<>();
         lines.add(new RtYamlLine("key: value:with-colon", 0));
         ReadYamlMapping mapping = new ReadYamlMapping(new AllYamlLines(lines));
 
         MatcherAssert.assertThat(mapping.keys(), Matchers.hasSize(1));
-        MatcherAssert.assertThat(mapping.keys().iterator().next().asScalar().value(), Matchers.equalTo("key"));
+        MatcherAssert.assertThat(
+            mapping.keys().iterator().next().asScalar().value(),
+            Matchers.equalTo("key")
+        );
     }
 }
diff --git a/src/test/java/com/amihaiemil/eoyaml/ReadYamlSequenceTest.java b/src/test/java/com/amihaiemil/eoyaml/ReadYamlSequenceTest.java
@@ -485,6 +485,9 @@ public void printsEmptyYaml() throws Exception {
         MatcherAssert.assertThat(sequence.toString(), Matchers.isEmptyString());
     }
 
+    /**
+     * Reads scalar containing colon properly.
+     */
     @Test
     public void dontReturnMappingForScalarWithColon() {
         final List<YamlLine> lines = new ArrayList<>();
@@ -495,7 +498,13 @@ public void dontReturnMappingForScalarWithColon() {
 
         MatcherAssert.assertThat(sequence.values(), Matchers.hasSize(1));
         YamlNode sequenceItem = sequence.values().iterator().next();
-        MatcherAssert.assertThat(sequenceItem.type(), Matchers.equalTo(Node.SCALAR));
-        MatcherAssert.assertThat(sequenceItem.asScalar().value(), Matchers.equalTo("scalar:with-colon"));
+        MatcherAssert.assertThat(
+            sequenceItem.type(),
+            Matchers.equalTo(Node.SCALAR)
+        );
+        MatcherAssert.assertThat(
+            sequenceItem.asScalar().value(),
+            Matchers.equalTo("scalar:with-colon")
+        );
     }
 }
diff --git a/src/test/java/com/amihaiemil/eoyaml/RtYamlInputTest.java b/src/test/java/com/amihaiemil/eoyaml/RtYamlInputTest.java
@@ -981,6 +981,10 @@ public void supportsSpringPropertyRef() throws IOException {
         MatcherAssert.assertThat(pretty, Matchers.equalTo(fileContents));
     }
 
+    /**
+     * Unit test for issue 517.
+     * @throws IOException If something goes wrong.
+     */
     @Test
     public void shouldReadKeysProperly() throws IOException {
         final String filename = "issue_517_values_with_colons.yml";
@@ -1002,7 +1006,8 @@ public void shouldReadKeysProperly() throws IOException {
                 topLevelMapping.asMapping().value("a_scalar").type(),
                 Matchers.equalTo(Node.SCALAR));
         MatcherAssert.assertThat(
-                topLevelMapping.asMapping().value("a_scalar").asScalar().value(),
+                topLevelMapping.asMapping().value("a_scalar")
+                    .asScalar().value(),
                 Matchers.equalTo("value:with-colon"));
 
         YamlNode topLevelSequence = read.asMapping().value("a_sequence");
@@ -1011,7 +1016,8 @@ public void shouldReadKeysProperly() throws IOException {
                 Matchers.equalTo(Node.SEQUENCE));
         MatcherAssert.assertThat(topLevelSequence.asSequence().values(),
                                  Matchers.hasSize(1));
-        YamlNode sequenceItem = topLevelSequence.asSequence().values().iterator().next();
+        YamlNode sequenceItem = topLevelSequence.asSequence().values()
+            .iterator().next();
         MatcherAssert.assertThat(sequenceItem.type(),
                                  Matchers.equalTo(Node.SCALAR));
         MatcherAssert.assertThat(sequenceItem.asScalar().value(),