Refactoring: original zt-exec configuring through a separate method

Author: alekseysotnikov

README.md

@@ -40,16 +40,17 @@ This library solves this small problem and intended to call each command inside
 ### Examples
 > Execute command
 ````java
-new Cmd().executing().execute("echo", "Hello");
+new Cmd().command("echo", "Hello").execute();
 ````
 > Execute script in a Shell
 ````java
-new Cmd().executing().executeInShell("s='Hello'; echo $s;");
+new Cmd().script("s='Hello'; echo $s;").execute();
 ````
 > Execute script and read output
 ````java
-String output = new Cmd(e -> e.readOutput(true))
-                     .executing().executeInShell("s='Hello'; echo $s;")
+String output = new Cmd()
+                     .configuring(e -> e.readOutput(true))
+                     .script("s='Hello'; echo $s;").execute()
                      .outputUTF8();
 System.out.println(output);
 
@@ -59,23 +60,23 @@ System.out.println(output);
 ```java
 new Cmd()
       .outputFileName("output.txt")
-      .executing().execute("echo", "Hello");
+      .command("echo", "Hello").execute();
 ````
 > Create work directory before start and delete after finish
 ````java
 new Cmd()
+        .configuring(e -> e.directory(new File("./", "foo"))) // specify work directory ./foo
+        .cleanUp(true)
         .listening()
-        .beforeStart(e -> e.directory(new File("./", "foo"))) // specify work directory ./foo
         .afterStop(process -> {
             //work directory ./foo will be exists here
         })
         .back()
-        .cleanUp(true)
-        .executing().execute("echo", "hello world"); // work directory ./foo will be created automatically
+        .command("echo", "hello world").execute(); // work directory ./foo will be created automatically
 //work directory ./foo was deleted after execution
 ````
 > Run in a background
 ````java
-StartedProcess startedProcess = new Cmd().executing().start("echo", "Hello");
+StartedProcess startedProcess = new Cmd().command("echo", "Hello").start();
 startedProcess.getFuture().get(); //wait result
 ````

src/main/java/com/enot/cmd/core/BaseCommand.java

@@ -0,0 +1,40 @@
+package com.enot.cmd.core;
+
+import org.zeroturnaround.exec.ProcessExecutor;
+import org.zeroturnaround.exec.ProcessResult;
+import org.zeroturnaround.exec.StartedProcess;
+
+import java.io.IOException;
+import java.util.concurrent.TimeoutException;
+
+final class BaseCommand implements Command {
+    private final ProcessExecutor processExecutor;
+
+    BaseCommand(ProcessExecutor processExecutor) {
+        this.processExecutor = processExecutor;
+    }
+
+    /**
+     * See {@link ProcessExecutor#execute()}
+     */
+    @Override
+    public ProcessResult execute() throws IOException, TimeoutException, InterruptedException {
+        return processExecutor.execute();
+    }
+
+    /**
+     * See {@link ProcessExecutor#executeNoTimeout()}
+     */
+    @Override
+    public ProcessResult executeNoTimeout() throws IOException, InterruptedException {
+        return processExecutor.executeNoTimeout();
+    }
+
+    /**
+     * See {@link ProcessExecutor#start()}
+     */
+    @Override
+    public StartedProcess start() throws IOException {
+        return processExecutor.start();
+    }
+}

src/main/java/com/enot/cmd/core/BaseExecuting.java

@@ -23,19 +23,20 @@ public final class Cmd implements ICmd {
     private final boolean cleanUp;
     private final String outputFileName;
     private final Listening listening;
+    private final LambdaListenerAdapter.BeforeStart configuring;
 
     public Cmd() {
-        this(false, "", new Listening(null, new ArrayAsIterable<>()));
+        this(false,
+                "",
+                new Listening(null, new ArrayAsIterable<>()),
+                e -> {});
     }
 
-    public Cmd(LambdaListenerAdapter.BeforeStart configuring) {
-        this(false, "", new Listening(null, new ArrayAsIterable<>(new LambdaListenerAdapter(configuring))));
-    }
-
-    public Cmd(boolean cleanUp, String outputFileName, Listening listening) {
+    public Cmd(boolean cleanUp, String outputFileName, Listening listening, LambdaListenerAdapter.BeforeStart configuring) {
         this.cleanUp = cleanUp;
         this.outputFileName = outputFileName;
         this.listening = listening;
+        this.configuring = configuring;
     }
 
     /**
@@ -46,12 +47,17 @@ public Cmd(boolean cleanUp, String outputFileName, Listening listening) {
      */
     @Override
     public Cmd cleanUp(boolean cleanUp) {
-        return new Cmd(cleanUp, outputFileName, listening);
+        return new Cmd(cleanUp, outputFileName, listening, configuring);
     }
 
     @Override
     public Cmd outputFileName(String outputFileName) {
-        return new Cmd(cleanUp, outputFileName, listening);
+        return new Cmd(cleanUp, outputFileName, listening, configuring);
+    }
+
+    @Override
+    public Cmd configuring(LambdaListenerAdapter.BeforeStart configuring) {
+        return new Cmd(cleanUp, outputFileName, listening, configuring);
     }
 
     @Override
@@ -60,16 +66,21 @@ public CmdListening listening() {
     }
 
     @Override
-    public Executing executing() {
-        return new BaseExecuting(processExecutor());
+    public Command script(String script) {
+        return command("sh", "-c", script);
+    }
+
+    public Command command(String... command) {
+        return new BaseCommand(processExecutor(command));
     }
 
-    private ProcessExecutor processExecutor() {
+    private ProcessExecutor processExecutor(String... command) {
         final ProcessExecutor executor = new ProcessExecutor();
+        configuring.run(executor);
         for (LambdaListenerAdapter listener : listening.listeners) {
             executor.addListener(listener);
         }
-        return executor.addListener(baseListener(cleanUp, outputFileName));
+        return executor.command(command).addListener(baseListener(cleanUp, outputFileName));
     }
 
     private ProcessListener baseListener(boolean cleanUp, String outputFileName) {
@@ -180,7 +191,7 @@ public CmdListening afterStop(LambdaListenerAdapter.AfterStop... lambdas) {
 
         @Override
         public Cmd back() {
-            return new Cmd(owner.cleanUp, owner.outputFileName, this);
+            return new Cmd(owner.cleanUp, owner.outputFileName, this, owner.configuring);
         }
     }
 }

src/main/java/com/enot/cmd/core/Cmd.java

@@ -0,0 +1,15 @@
+package com.enot.cmd.core;
+
+import org.zeroturnaround.exec.ProcessResult;
+import org.zeroturnaround.exec.StartedProcess;
+
+import java.io.IOException;
+import java.util.concurrent.TimeoutException;
+
+public interface Command {
+    ProcessResult execute() throws IOException, TimeoutException, InterruptedException;
+
+    ProcessResult executeNoTimeout() throws IOException, InterruptedException;
+
+    StartedProcess start() throws IOException;
+}

src/main/java/com/enot/cmd/core/Command.java

@@ -5,7 +5,21 @@ public interface ICmd {
 
     Cmd outputFileName(String outputFileName);
 
+    Cmd configuring(LambdaListenerAdapter.BeforeStart configuring);
+
     CmdListening listening();
 
-    Executing executing();
+    /**
+     * Create executable shell script
+     * <p>
+     * Note: Windows OS doesn't supported, use {@link #command(String...)}} instead
+     */
+    Command script(String script);
+
+    /**
+     * Create executable command
+     * @param command
+     * @return
+     */
+    Command command(String... command);
 }

src/main/java/com/enot/cmd/core/Executing.java

@@ -19,27 +19,30 @@ public class CmdTest {
     @Test
     public void execute() throws Exception {
         Assert.assertEquals("Hello\n",
-                new Cmd(e -> e.readOutput(true))
-                        .executing()
-                        .execute("echo", "Hello")
+                new Cmd()
+                        .configuring(e -> e.readOutput(true))
+                        .command("echo", "Hello")
+                        .execute()
                         .outputUTF8());
     }
 
     @Test
     public void executeNoTimeout() throws Exception {
         Assert.assertEquals("Hello\n",
-                new Cmd(e -> e.readOutput(true))
-                        .executing()
-                        .executeNoTimeout("echo", "Hello")
+                new Cmd()
+                        .configuring(e -> e.readOutput(true))
+                        .command("echo", "Hello")
+                        .executeNoTimeout()
                         .outputUTF8());
     }
 
     @Test
     public void start() throws Exception {
         Assert.assertEquals("Hello\n",
-                new Cmd(e -> e.readOutput(true))
-                        .executing()
-                        .start("echo", "Hello")
+                new Cmd()
+                        .configuring(e -> e.readOutput(true))
+                        .command("echo", "Hello")
+                        .start()
                         .getFuture()
                         .get()
                         .outputUTF8());
@@ -48,9 +51,10 @@ public void start() throws Exception {
     @Test
     public void executeScript() throws Exception {
         Assert.assertEquals("Hello\n",
-                new Cmd(e -> e.readOutput(true))
-                        .executing()
-                        .executeInShell("s='Hello'; echo $s;")
+                new Cmd()
+                        .configuring(e -> e.readOutput(true))
+                        .script("s='Hello'; echo $s;")
+                        .execute()
                         .outputUTF8());
     }
 
@@ -60,9 +64,10 @@ public void createWorkDir() throws Exception {
 
         assertFalse(workDir.exists());
 
-        new Cmd(e -> e.directory(workDir))
-                .executing()
-                .execute("echo", "hello world");
+        new Cmd()
+                .configuring(e -> e.directory(workDir))
+                .command("echo", "hello world")
+                .execute();
 
         assertTrue(workDir.exists());
     }
@@ -73,10 +78,11 @@ public void cleanUp() throws Exception {
 
         assertFalse(workDir.exists());
 
-        new Cmd(e -> e.directory(workDir))
+        new Cmd()
+                .configuring(e -> e.directory(workDir))
                 .cleanUp(true)
-                .executing()
-                .execute("echo", "hello world");
+                .command("echo", "hello world")
+                .execute();
 
         assertFalse("Directory should be deleted", workDir.exists());
     }
@@ -85,10 +91,11 @@ public void cleanUp() throws Exception {
     public void outputFile() throws Exception {
         Path execDir = generateRandomPath();
         String outputFileName = "test.output";
-        new Cmd(e -> e.directory(execDir.toFile()))
+        new Cmd()
+                .configuring(e -> e.directory(execDir.toFile()))
                 .outputFileName(outputFileName)
-                .executing()
-                .execute("echo", "hello world");
+                .command("echo", "hello world")
+                .execute();
         assertTrue("Output file should be exists", Paths.get(execDir.toString(), outputFileName).toFile().exists());
     }
 
@@ -105,8 +112,8 @@ protected void processLine(String line) {
                     }
                 }))
                 .back()
-                .executing()
-                .execute("echo", arg);
+                .command("echo", arg)
+                .execute();
 
         assertEquals(1, lines.size());
         assertEquals(arg, lines.get(0));