#196 print command

jcabi · Aug 22, 2024 · 1e3fa7c · 1e3fa7c
1 parent 75706b1
commit 1e3fa7c
Show file tree

Hide file tree

Showing 16 changed files with 21 additions and 36 deletions.
diff --git a/src/main/java/com/jcabi/log/ControlSequenceIndicatorFormatted.java b/src/main/java/com/jcabi/log/ControlSequenceIndicatorFormatted.java
@@ -41,7 +41,7 @@ public class ControlSequenceIndicatorFormatted implements Formatted {
     private final transient String pattern;
 
     /**
-     * Construtor.
+     * Ctor.
      * @param pat Pattern to be used to find replacement points
      */
     public ControlSequenceIndicatorFormatted(final String pat) {

diff --git a/src/main/java/com/jcabi/log/DecorsManager.java b/src/main/java/com/jcabi/log/DecorsManager.java
@@ -44,7 +44,6 @@ final class DecorsManager {
 
     /**
      * Storage of all found decors.
-     * @checkstyle LineLength (2 lines)
      */
     private static final ConcurrentMap<String, Class<? extends Formattable>> DECORS =
         new ConcurrentHashMap<>(0);

diff --git a/src/main/java/com/jcabi/log/Logger.java b/src/main/java/com/jcabi/log/Logger.java
@@ -398,7 +398,6 @@ public static void log(final Level level, final Object source,
      * @return Output stream directly pointed to the logging facility
      * @see <a href="http://stackoverflow.com/questions/17258325">some discussion</a>
      * @since 0.8
-     * @checkstyle MagicNumberCheck (20 lines)
      */
     public static OutputStream stream(final Level level, final Object source) {
         // @checkstyle AnonInnerLengthCheck (50 lines)

diff --git a/src/main/java/com/jcabi/log/MsDecor.java b/src/main/java/com/jcabi/log/MsDecor.java
@@ -101,7 +101,6 @@ public void formatTo(final Formatter formatter, final int flags,
      * Create text.
      * @param precision The precision
      * @return The text
-     * @checkstyle MagicNumber (50 lines)
      */
     private String toText(final int precision) {
         final double number;

diff --git a/src/main/java/com/jcabi/log/NanoDecor.java b/src/main/java/com/jcabi/log/NanoDecor.java
@@ -105,7 +105,6 @@ public void formatTo(final Formatter formatter, final int flags,
     private String toText(final int precision) {
         final double number;
         final String title;
-        // @checkstyle MagicNumber (15 lines)
         if (this.nano < 1000.0) {
             number = this.nano;
             title = "ns";

diff --git a/src/main/java/com/jcabi/log/PreFormatter.java b/src/main/java/com/jcabi/log/PreFormatter.java
@@ -47,8 +47,7 @@ final class PreFormatter {
      * Pattern used for matching format string arguments.
      */
     private static final Pattern PATTERN = Pattern.compile(
-        // @checkstyle LineLength (1 line)
-        "%(\\d+\\$)?(\\[([A-Za-z\\-\\.0-9]+)\\])?[\\+\\-]?(?:\\d*(?:\\.\\d+)?)?[a-zA-Z%]"
+        "%(\\d+\\$)?(\\[([A-Za-z\\-.0-9]+)])?[+\\-]?(?:\\d*(?:\\.\\d+)?)?[a-zA-Z%]"
     );
 
     /**
@@ -146,7 +145,6 @@ private void process(final CharSequence fmt, final Object... args) {
         if (pos < args.length) {
             throw new IllegalArgumentException(
                 String.format(
-                    // @checkstyle LineLength (1 line)
                     "There are %d parameter(s) but only %d format argument(s) were provided.",
                     args.length,
                     pos

diff --git a/src/main/java/com/jcabi/log/SizeDecor.java b/src/main/java/com/jcabi/log/SizeDecor.java
@@ -58,7 +58,6 @@ final class SizeDecor implements Formattable {
     private final transient Long size;
 
     static {
-        // @checkstyle MagicNumber (9 lines)
         SizeDecor.SUFFIXES.put(0, "b");
         SizeDecor.SUFFIXES.put(1, "Kb");
         SizeDecor.SUFFIXES.put(2, "Mb");
@@ -89,7 +88,7 @@ public void formatTo(final Formatter formatter, final int flags,
                 format.append('-');
             }
             if (width > 0) {
-                format.append(Integer.toString(width));
+                format.append(width);
             }
             if ((flags & FormattableFlags.UPPERCASE) == FormattableFlags
                 .UPPERCASE) {
@@ -111,9 +110,8 @@ public void formatTo(final Formatter formatter, final int flags,
     private String formatSizeWithSuffix(final int precision) {
         int power = 0;
         double number = this.size;
-        // @checkstyle MagicNumber (2 lines)
         while (number / 1024.0 >= 1.0 && power < SizeDecor.MAX_POWER) {
-            number = number / 1024.0;
+            number /= 1024.0;
             power += 1;
         }
         final String suffix = SizeDecor.SUFFIXES.get(power);

diff --git a/src/main/java/com/jcabi/log/TextDecor.java b/src/main/java/com/jcabi/log/TextDecor.java
@@ -88,8 +88,7 @@ private static String pretty(final String text) {
             final int skip = text.length() - TextDecor.MAX;
             final StringBuilder output = new StringBuilder(text.length());
             output.append(text.substring(0, (text.length() - skip) / 2));
-            // @checkstyle MultipleStringLiterals (1 line)
-            output.append("..").append(Integer.toString(skip)).append("..");
+            output.append("..").append(skip).append("..");
             output.append(
                 text.substring(text.length() - TextDecor.MAX + output.length())
             );

diff --git a/src/main/java/com/jcabi/log/VerboseCallable.java b/src/main/java/com/jcabi/log/VerboseCallable.java
@@ -175,25 +175,25 @@ public T call() throws Exception {
         } catch (final RuntimeException ex) {
             if (this.rethrow) {
                 Logger.warn(
-                    this, "escalated runtime exception: %s", this.tail(ex)
+                    this, "Escalated runtime exception: %s", this.tail(ex)
                 );
                 throw ex;
             }
-            Logger.warn(this, "swallowed runtime exception: %s", this.tail(ex));
+            Logger.warn(this, "Swallowed runtime exception: %s", this.tail(ex));
             // @checkstyle IllegalCatch (1 line)
         } catch (final Exception ex) {
             if (this.rethrow) {
-                Logger.warn(this, "escalated exception: %s", this.tail(ex));
+                Logger.warn(this, "Escalated exception: %s", this.tail(ex));
                 throw ex;
             }
-            Logger.warn(this, "swallowed exception: %s", this.tail(ex));
+            Logger.warn(this, "Swallowed exception: %s", this.tail(ex));
             // @checkstyle IllegalCatch (1 line)
         } catch (final Error error) {
             if (this.rethrow) {
-                Logger.error(this, "escalated error: %s", this.tail(error));
+                Logger.error(this, "Escalated error: %s", this.tail(error));
                 throw error;
             }
-            Logger.error(this, "swallowed error: %s", this.tail(error));
+            Logger.error(this, "Swallowed error: %s", this.tail(error));
         }
         try {
             TimeUnit.MICROSECONDS.sleep(1L);

diff --git a/src/main/java/com/jcabi/log/VerboseProcess.java b/src/main/java/com/jcabi/log/VerboseProcess.java
@@ -141,13 +141,11 @@ public VerboseProcess(final Process prc, final Level stdout,
         }
         if (Level.ALL.equals(stdout)) {
             throw new IllegalArgumentException(
-                // @checkstyle LineLength (1 line)
                 "stdout LEVEL can't be set to ALL because it is intended only for internal configuration"
             );
         }
         if (Level.ALL.equals(stderr)) {
             throw new IllegalArgumentException(
-                // @checkstyle LineLength (1 line)
                 "stderr LEVEL can't be set to ALL because it is intended only for internal configuration"
             );
         }
@@ -247,11 +245,11 @@ public void close() {
         for (final Thread monitor : this.monitors) {
             if (monitor != null) {
                 monitor.interrupt();
-                Logger.debug(this, "monitor interrupted");
+                Logger.debug(this, "Monitor interrupted");
             }
         }
         this.process.destroy();
-        Logger.debug(this, "underlying process destroyed");
+        Logger.debug(this, "Underlying process destroyed");
     }
 
     /**
@@ -261,8 +259,13 @@ public void close() {
      */
     private static Process start(final ProcessBuilder builder) {
         if (builder == null) {
-            throw new IllegalArgumentException("builder can't be NULL");
+            throw new IllegalArgumentException("Builder can't be NULL");
         }
+        Logger.debug(
+            VerboseProcess.class,
+            "#start(): %s",
+            String.join(" ", builder.command())
+        );
         try {
             final Process process = builder.start();
             process.getOutputStream().close();
@@ -391,7 +394,7 @@ private static void close(final Closeable res) {
         } catch (final IOException ex) {
             Logger.error(
                 VerboseProcess.class,
-                "failed to close resource: %[exception]s",
+                "Failed to close resource: %[exception]s",
                 ex
             );
         }
@@ -456,7 +459,7 @@ public Void call() throws Exception {
                         if (Thread.interrupted()) {
                             Logger.debug(
                                 VerboseProcess.class,
-                                "explicitly interrupting read from buffer"
+                                "Explicitly interrupting read from buffer"
                             );
                             break;
                         }

diff --git a/src/test/java/com/jcabi/log/LoggerTest.java b/src/test/java/com/jcabi/log/LoggerTest.java
@@ -83,7 +83,6 @@ void providesOutputStream() throws Exception {
         final PrintWriter writer = new PrintWriter(
             new OutputStreamWriter(stream, "UTF-8")
         );
-        // @checkstyle LineLength (1 line)
         writer.print("hello, \u20ac, how're\u040a?\nI'm fine, \u0000\u0007!\n");
         writer.flush();
         writer.close();

diff --git a/src/test/java/com/jcabi/log/MsDecorTest.java b/src/test/java/com/jcabi/log/MsDecorTest.java
@@ -85,8 +85,6 @@ void testPrintsNullRight() {
     private static Collection<Object[]> params() {
         return Arrays.asList(
             new Object[][] {
-                // @checkstyle LineLength (20 lines)
-                // @checkstyle MagicNumber (20 lines)
                 {13L, "13ms", 0, 0, -1},
                 {13L, "13.0ms", 0, 0, 1},
                 {1024L, "1s", 0, 0, 0},

diff --git a/src/test/java/com/jcabi/log/NanoDecorTest.java b/src/test/java/com/jcabi/log/NanoDecorTest.java
@@ -85,8 +85,6 @@ void testPrintsNullRight() {
     private static Collection<Object[]> params() {
         return Arrays.asList(
             new Object[][] {
-                // @checkstyle LineLength (20 lines)
-                // @checkstyle MagicNumber (20 lines)
                 {13L, "13ns", 0, 0, -1},
                 {13L, "13.0ns", 0, 0, 1},
                 {25L, "25.00ns", 0, 0, 2},

diff --git a/src/test/java/com/jcabi/log/SecretDecorTest.java b/src/test/java/com/jcabi/log/SecretDecorTest.java
@@ -76,7 +76,6 @@ void testLogsRight(final Object list, final String text,
     private static Collection<Object[]> params() {
         return Arrays.asList(
             new Object[][] {
-                // @checkstyle MagicNumber (4 lines)
                 {"testing", "t***g", 0, 0, 0},
                 {"ouch", "o***h  ", FormattableFlags.LEFT_JUSTIFY, 7, 5},
                 {"x", " X***X", FormattableFlags.UPPERCASE, 6, 0},

diff --git a/src/test/java/com/jcabi/log/SizeDecorTest.java b/src/test/java/com/jcabi/log/SizeDecorTest.java
@@ -85,7 +85,6 @@ void testPrintsNullRight() {
     private static Collection<Object[]> params() {
         return Arrays.asList(
             new Object[][] {
-                // @checkstyle MagicNumber (14 lines)
                 {1L, "1b", 0, 0, 0},
                 {123L, "  123b", 0, 6, 0},
                 {1024L, "1.000Kb", 0, 0, 3},

diff --git a/src/test/java/com/jcabi/log/VerboseProcessTest.java b/src/test/java/com/jcabi/log/VerboseProcessTest.java
@@ -287,7 +287,6 @@ void terminatesMonitorsAndProcessIfClosedInstantly()
     @Test
     void terminatesMonitorsAndProcessIfClosedShortly()
         throws Exception {
-        // @checkstyle MagicNumberCheck (1 line)
         this.terminatesMonitorsAndProcessIfClosed(50L);
     }
 
@@ -353,7 +352,6 @@ public void run() {
             );
         }
         process.stdoutQuietly();
-        // @checkstyle MagicNumberCheck (1 line)
         TimeUnit.MILLISECONDS.sleep(1000L);
         Mockito.verify(
             prc,