Merge pull request #77 from embulk/checkstyle-9.3

Checkstyle with checkstyle 9.3

Author: dmikurube

build.gradle

@@ -337,3 +337,13 @@ task jruby9_2_9Test(type: Test, description: "Runs tests with JRuby 9.2.9.", gro
         outputs.upToDateWhen { false }
     }
 }
+
+checkstyle {
+    toolVersion = libs.versions.checkstyle.get()
+    configFile = file("${rootProject.projectDir}/config/checkstyle/checkstyle.xml")
+    configProperties = [
+        "org.checkstyle.google.suppressionfilter.config": file("${rootProject.projectDir}/config/checkstyle/checkstyle-suppressions.xml"),
+    ]
+    ignoreFailures = false
+    maxWarnings = 0
+}

config/checkstyle/README.md

@@ -0,0 +1,11 @@
+Checkstyle for the Embulk project
+==================================
+
+* google_check.xml: Downloaded from: https://github.com/checkstyle/checkstyle/blob/checkstyle-9.3/src/main/resources/google_checks.xml
+     * Commit: 5c1903792f8432243cc8ae5cd79a03a004d3c09c
+* checkstyle.xml: Customized from google_check.xml.
+    * To enable suppressions through checkstyle-suppressions.xml.
+    * To enable suppressions with @SuppressWarnings.
+    * To indent with 4-column spaces.
+    * To limit columns to 180 characters.
+    * To reject unused imports.

config/checkstyle/checkstyle-suppressions.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+    "-//Puppy Crawl//DTD Suppressions 1.2//EN"
+    "http://checkstyle.sourceforge.net/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+  <suppress checks="JavadocMethod" files=".*"/>
+  <suppress checks="JavadocParagraph" files=".*"/>
+  <suppress checks="JavadocTagContinuationIndentation" files=".*"/>
+  <suppress checks="MissingJavadocType" files=".*"/>
+  <suppress checks="SingleLineJavadoc" files=".*"/>
+  <suppress checks="SummaryJavadoc" files=".*"/>
+</suppressions>

config/checkstyle/checkstyle.xml

@@ -2,6 +2,8 @@
 
 junit5 = "5.9.2"
 
+checkstyle = "9.3"
+
 [libraries]
 
 junit5-bom = { group = "org.junit", name = "junit-bom", version.ref = "junit5" }

config/checkstyle/google_checks.xml

@@ -396,7 +396,7 @@ private OffsetDateTime getOffsetAppliedDateTime(final TemporalAccessor original,
                 ? original.get(ChronoField.MINUTE_OF_HOUR) : this.defaultMinuteOfHour;
         int secondOfMinute = original.isSupported(ChronoField.SECOND_OF_MINUTE)
                 ? original.get(ChronoField.SECOND_OF_MINUTE) : this.defaultSecondOfMinute;
-        int nanoOfSecond = original.isSupported(ChronoField.NANO_OF_SECOND)
+        final int nanoOfSecond = original.isSupported(ChronoField.NANO_OF_SECOND)
                 ? original.get(ChronoField.NANO_OF_SECOND) : this.defaultNanoOfSecond;
 
         int offset = zoneOffset.getTotalSeconds();

gradle/libs.versions.toml

@@ -145,6 +145,7 @@ private List<FormatToken> compileInitial() {
          * @param beginningIndex  index of the character next to {@code '%'} in {@code formatString}.
          * @return {@code true} if recognized as a directive, {@code false} otherwise.
          */
+        @SuppressWarnings("checkstyle:LeftCurly")
         private boolean compileDirective(final int beginningIndex) {
             final FormatDirectiveOptions.Builder optionsBuilder = FormatDirectiveOptions.builder();
 
@@ -284,6 +285,8 @@ private boolean compileDirective(final int beginningIndex) {
 
                     case '0':
                         optionsBuilder.setPadding('0');
+                        // fall-through
+
                     case '1':
                     case '2':
                     case '3':

src/main/java/org/embulk/util/rubytime/DefaultRubyTimeResolver.java

@@ -16,11 +16,8 @@
 
 package org.embulk.util.rubytime;
 
-import java.util.ArrayList;
 import java.util.Collections;
-import java.util.EnumMap;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 /**

src/main/java/org/embulk/util/rubytime/Format.java

@@ -44,6 +44,7 @@ String format(final Format format) {
         return this.format(format, RubyDateTimeFormatter.ZoneNameStyle.NONE);
     }
 
+    @SuppressWarnings("checkstyle:LeftCurly")
     String format(final Format format, final RubyDateTimeFormatter.ZoneNameStyle zoneNameStyle) {
         final StringBuilder builder = new StringBuilder();
 
@@ -371,6 +372,9 @@ String format(final Format format, final RubyDateTimeFormatter.ZoneNameStyle zon
                         // %+ is not supported in formatter. %+ is only for parser.
                         builder.append(token.getImmediate().orElse(""));
                         break;
+
+                    default:
+                        // Pass-through.
                 }
             }
         }
@@ -616,12 +620,16 @@ private void appendYearWithoutCentury(
      * <li>MRI's {@code Time.zone} (the name of the time zone) cannot be set arbitrary.
      * It is set almost only from {@code localtime(3)} from the computer's environment,
      * such as the TZ environment variable.
-     * @see <a href="https://twitter.com/shyouhei/status/1245616200874209283">Tweet from @shyouhei (in Japanese)</a>
-     * @see <a href="https://twitter.com/nalsh/status/1245689453315670022">Tweet from @nalsh (in Japanese)</a>
+     * <ul>
+     * <li><a href="https://twitter.com/shyouhei/status/1245616200874209283">Tweet from @shyouhei (in Japanese)</a>
+     * <li><a href="https://twitter.com/nalsh/status/1245689453315670022">Tweet from @nalsh (in Japanese)</a>
+     * </ul>
      * <li>MRI's {@code Time#strptime} never sets the name of the time zone from its input.
      * The name of the time zone is set only from {@code Time.utc} or {@code Time.local}.
-     * @see <a href="https://docs.ruby-lang.org/en/2.7.0/Time.html#method-c-local">Time.local</a>
-     * @see <a href="https://docs.ruby-lang.org/en/2.7.0/Time.html#method-c-utc">Time.utc</a>
+     * <ul>
+     * <li><a href="https://docs.ruby-lang.org/en/2.7.0/Time.html#method-c-local">Time.local</a>
+     * <li><a href="https://docs.ruby-lang.org/en/2.7.0/Time.html#method-c-utc">Time.utc</a>
+     * </ul>
      * <li>Embulk uses only {@link java.time.Instant} as its internal timestamp representation.
      * </ol>
      *
@@ -679,6 +687,7 @@ private void appendYearWithoutCentury(
      *
      * <p>On the other hand, Embulk's legacy {@code TimestampFormatter} has used {@code org.jruby.util.RubyDateFormat}
      * directly. Unlike just {@code Time.strptime}, {@code RubyDateFormat} formats {@code "%Z"} into short names.
+     *
      * @see <a href="https://github.com/jruby/jruby/blob/9.1.15.0/core/src/main/java/org/jruby/util/RubyDateFormat.java#L411-L419">RubyDateFormat#compilePattern</a>
      * @see <a href="https://github.com/jruby/jruby/blob/9.1.15.0/core/src/main/java/org/jruby/util/RubyDateFormat.java#L622-L624">RubyDateFormat#format</a>
      *
@@ -737,6 +746,8 @@ private void appendTimeZoneName(
                     builder.append("");
                 }
                 break;
+            default:
+                // Pass-through.
         }
     }
 
@@ -872,6 +883,7 @@ private void appendLongFormatted(
      *
      * @see <a href="https://github.com/ruby/ruby/blob/v2_6_3/strftime.c#L985-L1092">iso8601wknum</a>
      */
+    @SuppressWarnings("checkstyle:LeftCurly")
     private static int calculateIso8601WeekNumber(final TemporalAccessor temporal) {
         final int jan1DayOfWeek = calculateJan1DayOfWeek(temporal);