Zlg.x(String) method automatically terminates the chain

Author: ekoutanov

README.md

@@ -55,6 +55,7 @@ public final class SysOutLoggingSample {
   private static final Zlg zlg = Zlg.forClass(SysOutLoggingSample.class).get();
 
   public static void open(String address, int port, double timeoutSeconds) {
+    zlg.i("Hello world");
     zlg.i("Pi is %.2f", z -> z.arg(Math.PI));
     zlg.i("Connecting to %s:%d [timeout: %.1f sec]", z -> z.arg(address).arg(port).arg(timeoutSeconds));
 
@@ -303,9 +304,9 @@ private static final Zlg zlg = Zlg.forClass(MethodHandles.lookup().lookupClass()
 
 private static final boolean TRACE_ENABLED = false;
 
-public static void withStaticConstant(String address, int port, double timeoutSeconds) {
+public static void withStaticConstant(String address, int port, double timeout) {
   if (TRACE_ENABLED) {
-    zlg.t("Connecting to %s:%d [timeout: %.1f sec]", z -> z.arg(address).arg(port).arg(timeoutSeconds));
+    zlg.t("Connecting to %s:%d [timeout: %.1f sec]", z -> z.arg(address).arg(port).arg(timeout));
   }
 }
 ```
@@ -315,12 +316,12 @@ public static void withStaticConstant(String address, int port, double timeoutSe
 ```java
 private static final Zlg zlg = Zlg.forClass(MethodHandles.lookup().lookupClass()).get();
 
-public static void withAssert(String address, int port, double timeoutSeconds) {
-  assert zlg.t("Connecting to %s:%d [timeout: %.1f sec]").arg(address).arg(port).arg(timeoutSeconds).log();
+public static void withAssert(String address, int port, double timeout) {
+  assert zlg.level(LogLevel.TRACE).format("Connecting to %s:%d [timeout: %.1f sec]").arg(address).arg(port).arg(timeout).log();
 }
 ```
 
-**Note:** Rather than chaining arguments within a lambda, the assertion example uses a continuous chaining style, culminating with a call to `log()`, which returns a constant `true`. If assertions are enabled with the `-ea` JVM argument, the log instruction will be evaluated and will never fail the assertion. Otherwise, the entire fluent chain will be dropped by DCE.
+**Note:** Rather than chaining arguments within a lambda, the assertion example uses a slightly longer, continuous chaining style, culminating with a call to `log()`, which returns a constant `true`. If assertions are enabled with the `-ea` JVM argument, the log instruction will be evaluated and will never fail the assertion. Otherwise, the entire fluent chain will be dropped by DCE.
 
 The choice of using option one or two depends on whether you are targeting zero overhead for both production and testing scenarios or only for production. In case of the latter, the `-ea` flag naturally solves the problem, without forcing you to change your class before building. In either case, you will sacrifice code coverage, as both techniques introduce a parasitic branching instruction behind the scenes; only one path is traversed during the test.
 

build.gradle

@@ -5,7 +5,7 @@ apply plugin: "maven-publish"
 apply plugin: "com.jfrog.bintray"
 
 group = "com.obsidiandynamics.zerolog"
-version = "0.7.0-SNAPSHOT"
+version = "0.7.0"
 
 def envUser = "BINTRAY_USER"
 def envKey = "BINTRAY_KEY"

slf4j17/src/test/java/com/obsidiandynamics/zerolog/sample/Slf4jLoggingSample.java

@@ -9,7 +9,7 @@ public final class Slf4jLoggingSample {
   private static final Zlg zlg = Zlg.forClass(MethodHandles.lookup().lookupClass()).get();
 
   public static void main(String[] args) {
-    zlg.i("Starting with %d args: %s").arg(args.length).arg(Arrays.asList(args)).done();
-    zlg.w("An error occurred at %s").arg(new Date()).threw(new RuntimeException()).tag("I/O").done();
+    zlg.i("Starting with %d args: %s", z -> z.arg(args.length).arg(Arrays.asList(args)));
+    zlg.w("An error occurred at %s", z -> z.arg(new Date()).threw(new RuntimeException()).tag("I/O"));
   }
 }

src/main/java/com/obsidiandynamics/zerolog/Zlg.java

@@ -59,37 +59,49 @@ default boolean log() {
 
   boolean isEnabled(int level);
 
-  default LogChain e(String format) { return level(LogLevel.ERROR).format(format); }
+  default void e(String format) { 
+    level(LogLevel.ERROR).format(format).done(); 
+  }
 
   default void e(String format, Consumer<LogChain> logChainConsumer) {
     level(LogLevel.ERROR).format(format).with(logChainConsumer);
   }
 
-  default LogChain w(String format) { return level(LogLevel.WARN).format(format); }
+  default void w(String format) { 
+    level(LogLevel.WARN).format(format).done(); 
+  }
 
   default void w(String format, Consumer<LogChain> logChainConsumer) {
     level(LogLevel.WARN).format(format).with(logChainConsumer);
   }
 
-  default LogChain i(String format) { return level(LogLevel.INFO).format(format); }
+  default void i(String format) { 
+    level(LogLevel.INFO).format(format).done(); 
+  }
 
   default void i(String format, Consumer<LogChain> logChainConsumer) {
     level(LogLevel.INFO).format(format).with(logChainConsumer);
   }
 
-  default LogChain c(String format) { return level(LogLevel.CONF).format(format); }
+  default void c(String format) { 
+    level(LogLevel.CONF).format(format).done();
+  }
 
   default void c(String format, Consumer<LogChain> logChainConsumer) {
     level(LogLevel.CONF).format(format).with(logChainConsumer);
   }
 
-  default LogChain d(String format) { return level(LogLevel.DEBUG).format(format); }
+  default void d(String format) { 
+    level(LogLevel.DEBUG).format(format).done(); 
+  }
 
   default void d(String format, Consumer<LogChain> logChainConsumer) {
     level(LogLevel.DEBUG).format(format).with(logChainConsumer);
   }
 
-  default LogChain t(String format) { return level(LogLevel.TRACE).format(format); }
+  default void t(String format) {
+    level(LogLevel.TRACE).format(format).done(); 
+  }
 
   default void t(String format, Consumer<LogChain> logChainConsumer) {
     level(LogLevel.TRACE).format(format).with(logChainConsumer);

src/test/java/com/obsidiandynamics/zerolog/MockLogTargetTest.java

@@ -16,7 +16,7 @@ public void testEntryToString() {
     final MockLogTarget target = new MockLogTarget(LogLevel.TRACE);
     final Zlg zlg = target.logger();
 
-    zlg.t("message").done();
+    zlg.t("message");
     final List<Entry> entries = target.entries().list();
     assertNotNull(entries);
     assertEquals(1, entries.size());
@@ -67,7 +67,7 @@ public void testEntryRetention() {
   public void testEntriesIterator() {
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("message").done();
+    zlg.t("message");
 
     final Iterator<Entry> it = target.entries().iterator();
     assertTrue(it.hasNext());
@@ -79,9 +79,9 @@ public void testEntriesIterator() {
   public void testForLevel() {
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("trace").done();
-    zlg.d("debug").done();
-    zlg.c("conf").done();
+    zlg.t("trace");
+    zlg.d("debug");
+    zlg.c("conf");
 
     final List<Entry> entries = target.entries().forLevel(LogLevel.DEBUG).list();
     assertEquals(1, entries.size());
@@ -92,9 +92,9 @@ public void testForLevel() {
   public void testForLevelAndAbove() {
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("trace").done();
-    zlg.d("debug").done();
-    zlg.c("conf").done();
+    zlg.t("trace");
+    zlg.d("debug");
+    zlg.c("conf");
 
     final List<Entry> entries = target.entries().forLevelAndAbove(LogLevel.DEBUG).list();
     assertEquals(2, entries.size());
@@ -107,9 +107,9 @@ public void testBeforeAfter() {
     final long startTime = System.currentTimeMillis();
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("trace").done();
-    zlg.d("debug").done();
-    zlg.c("conf").done();
+    zlg.t("trace");
+    zlg.d("debug");
+    zlg.c("conf");
     final long endTime = System.currentTimeMillis();
 
     assertEquals(3, target.entries().after(startTime - 1).list().size());
@@ -123,9 +123,9 @@ public void testBeforeAfter() {
   public void testTag() {
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("trace").done();
-    zlg.d("debug").tag("tag").done();
-    zlg.c("conf").done();
+    zlg.t("trace");
+    zlg.d("debug", z -> z.tag("tag"));
+    zlg.c("conf");
 
     assertEquals(1, target.entries().tagged("tag").list().size());
   }
@@ -134,9 +134,9 @@ public void testTag() {
   public void testWithException() {
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("trace").done();
-    zlg.d("debug").threw(new IOException("simulated")).done();
-    zlg.c("conf").done();
+    zlg.t("trace");
+    zlg.d("debug", z -> z.threw(new IOException("simulated")));
+    zlg.c("conf");
 
     assertEquals(0, target.entries().withException(RuntimeException.class).list().size());
     assertEquals(1, target.entries().withException(IOException.class).list().size());
@@ -146,9 +146,9 @@ public void testWithException() {
   public void testContaining() {
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("trace").done();
-    zlg.d("debug").done();
-    zlg.c("conf").done();
+    zlg.t("trace");
+    zlg.d("debug");
+    zlg.c("conf");
 
     assertEquals(1, target.entries().containing("bug").list().size());
   }
@@ -157,9 +157,9 @@ public void testContaining() {
   public void testReset() {
     final MockLogTarget target = new MockLogTarget();
     final Zlg zlg = target.logger();
-    zlg.t("trace").done();
-    zlg.d("debug").done();
-    zlg.c("conf").done();
+    zlg.t("trace");
+    zlg.d("debug");
+    zlg.c("conf");
 
     assertEquals(3, target.entries().list().size());