[maven-release-plugin] prepare release gclc-1.3.7

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>

gclc-socket/src/main/java/fr/bigeon/gclc/socket/SocketConsoleApplicationShell.java

@@ -237,6 +237,14 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
         runnable.setRunning(false);
         try {
             consoleManager.type(applicationShutdown);
+            try {
+                appThNext.join(ONE_TENTH_OF_SECOND);
+            } catch (InterruptedException e) {
+                LOGGER.warning("Application thread was interrupted!"); //$NON-NLS-1$
+                LOGGER.log(Level.FINE,
+                        "Application thread was interrupted while closing", //$NON-NLS-1$
+                        e);
+            }
             consoleManager.close();
         } catch (IOException e) {
             LOGGER.warning("Unable to close application correctly"); //$NON-NLS-1$

gclc-swt/pom.xml

@@ -35,7 +35,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <artifactId>gclc-swt</artifactId>
-  <version>1.1.3</version>
+  <version>1.1.4-SNAPSHOT</version>
   <packaging>jar</packaging>
   <url>http://www.bigeon.fr/emmanuel</url>
   <properties>
@@ -64,7 +64,7 @@
   <description>provide a swt window for console applications</description>
   <scm>
     <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
-    <tag>gclc-swt-1.1.3</tag>
+    <tag>HEAD</tag>
   </scm>
   <profiles>
     <profile>

gclc/pom.xml

@@ -35,7 +35,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>gclc</artifactId>
-	<version>1.3.7-SNAPSHOT</version>
+	<version>1.3.7</version>
 	<packaging>jar</packaging>
 	<url>http://www.bigeon.fr/emmanuel</url>
 	<properties>
@@ -83,6 +83,6 @@
   <scm>
   
     <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
-	<tag>gclc-1.3.5</tag>
+	<tag>gclc-1.3.7</tag>
   </scm>
 </project>

gclc/src/main/java/fr/bigeon/gclc/ApplicationAttachement.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software.  You can  use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and  rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty  and the software's author,  the holder of the
+ * economic rights,  and the successive licensors  have only  limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading,  using,  modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean  that it is complicated to manipulate,  and  that  also
+ * therefore means  that it is reserved for developers  and  experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and,  more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.ApplicationAttachement.java
+ * Created on: Apr 19, 2017
+ */
+package fr.bigeon.gclc;
+
+import fr.bigeon.gclc.exception.InvalidCommandName;
+
+/**
+ * <p>
+ * TODO
+ *
+ * @author Emmanuel Bigeon
+ *
+ */
+public interface ApplicationAttachement {
+    /** Attach this object to a console application.
+     * <p>
+     * The attaching usually consist in the addition of commands in the console
+     * application. The attached command should be specific to the attachement
+     * (typically, the generic help command or the script command should not be
+     * added through this mechanism).
+     * 
+     * @param application the application
+     * @throws InvalidCommandName if a command name is invalid for the
+     *             application. */
+    void attach(ConsoleApplication application) throws InvalidCommandName;
+}

gclc/src/main/java/fr/bigeon/gclc/ConsoleApplication.java

@@ -73,19 +73,19 @@ import fr.bigeon.gclc.manager.ConsoleManager;
  * start method.
  *
  * @author Emmanuel BIGEON */
-public class ConsoleApplication implements ICommandProvider {
+public final class ConsoleApplication implements ICommandProvider {
 
     /** The class logger */
     private static final Logger LOGGER = Logger
             .getLogger(ConsoleApplication.class.getName());
     /** The welcome message */
-    private final String header;
+    public final String header;
     /** The good bye message */
-    private final String footer;
+    public final String footer;
     /** The console manager */
-    protected final ConsoleManager manager;
+    public final ConsoleManager manager;
     /** The container of commands */
-    private final SubedCommand root;
+    public final SubedCommand root;
     /** The state of this application */
     private boolean running;
     /** The listeners */
@@ -135,11 +135,6 @@ public class ConsoleApplication implements ICommandProvider {
         return root.get(command);
     }
 
-    /** @return the manager */
-    public final ConsoleManager getManager() {
-        return manager;
-    }
-
     /** @param cmd the command
      * @throws IOException if the command could not be parsed */
     public final void interpretCommand(String cmd) throws IOException {
@@ -161,7 +156,7 @@ public class ConsoleApplication implements ICommandProvider {
                         .getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
                 manager.println(e.getLocalizedMessage());
                 if (e.getType() == CommandRunExceptionType.USAGE) {
-                    e.getSource().help(getManager());
+                    e.getSource().help(manager);
                 }
             }
         }
@@ -247,19 +242,4 @@ public class ConsoleApplication implements ICommandProvider {
     public boolean isRunning() {
         return running;
     }
-
-    /** @return the root */
-    public SubedCommand getRoot() {
-        return root;
-    }
-
-    /** @return the header */
-    public String getHeader() {
-        return header;
-    }
-
-    /** @return the footer */
-    public String getFooter() {
-        return footer;
-    }
 }

gclc/src/main/java/fr/bigeon/gclc/command/CommandParameters.java

@@ -184,4 +184,11 @@ public class CommandParameters {
     public Set<String> getStringArgumentKeys() {
         return stringArguments.keySet();
     }
+
+    /** @param key the key
+     * @return if the key is present in string arguments or boolean ones. */
+    public boolean hasArgument(String key) {
+        return stringArguments.containsKey(key) ||
+               booleanArguments.containsKey(key);
+    }
 }

gclc/src/main/java/fr/bigeon/gclc/command/ParametrizedCommand.java

@@ -247,9 +247,10 @@ public abstract class ParametrizedCommand extends Command {
         for (final String string : toProvide) {
             String value;
             try {
-                value = manager.prompt(string);
+                value = manager.prompt("value of " + string + "? ");
                 while (value.isEmpty()) {
-                    value = manager.prompt(string);
+                    value = manager.prompt(
+                            "value of " + string + "? (cannot be empty) ");
                 }
             } catch (IOException e) {
                 throw new CommandRunException(

gclc/src/main/java/fr/bigeon/gclc/command/ScriptExecution.java

@@ -107,8 +107,8 @@ public class ScriptExecution extends Command {
                 application.executeSub(command, ps.toArray(new String[0]));
             }
         } catch (CommandParsingException e) {
-            throw new CommandRunException("Invalid command in script (" + //$NON-NLS-1$
+            throw new CommandRunException(MessageFormat.format(
-                                          e.getLocalizedMessage() + ")", //$NON-NLS-1$
+                    "Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$
                     e, this);
         } catch (IOException e) {
             throw new CommandRunException("Unable to read script", //$NON-NLS-1$
@@ -166,31 +166,41 @@ public class ScriptExecution extends Command {
 
     /* (non-Javadoc)
      * @see fr.bigeon.gclc.command.Command#usageDetail() */
+    @SuppressWarnings("nls")
     @Override
     protected String usageDetail() {
         StringBuilder builder = new StringBuilder();
         builder.append(
-                "  scriptfile: path to the file containing the script to execute."); //$NON-NLS-1$
+                "  scriptfile: path to the file containing the script to execute.");
         builder.append(System.lineSeparator());
         builder.append(System.lineSeparator());
         builder.append(
-                "  The script file must contain one line commands. The lines must never"); //$NON-NLS-1$
+                "  The script file must contain one line commands. The lines must never");
         builder.append(System.lineSeparator());
         builder.append(
-                "start with whitespace characters. The lines starting with"); //$NON-NLS-1$
+                "start with whitespace characters. The lines starting with");
         builder.append(System.lineSeparator());
-        builder.append("\"" + commentPrefix + //$NON-NLS-1$
+        builder.append("\"" + commentPrefix +
-                       "\" will be ignored as well as empty lines."); //$NON-NLS-1$
+                       "\" will be ignored as well as empty lines.");
         builder.append(System.lineSeparator());
 
         return builder.toString();
     }
 
+    /* (non-Javadoc)
+     * @see fr.bigeon.gclc.command.Command#usagePattern() */
+    @SuppressWarnings("nls")
+    @Override
+    protected String usagePattern() {
+        return super.usagePattern() + " <scriptfile>";
+    }
+
     /* (non-Javadoc)
      * @see fr.bigeon.gclc.command.ICommand#tip() */
+    @SuppressWarnings("nls")
     @Override
     public String tip() {
-        return "Execute a script"; //$NON-NLS-1$
+        return "Execute a script";
     }
 
 }

gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleManager.java

@@ -74,12 +74,25 @@ public interface ConsoleManager extends AutoCloseable {
      * @throws InterruptedIOException if the prompt was interrupted */
     String prompt() throws IOException;
 
+    /** @param timeout the time to wait in milliseconds
+     * @return the user inputed string, null if the timeout was reached
+     * @throws IOException if the manager is closed or could not read the prompt
+     * @throws InterruptedIOException if the prompt was interrupted */
+    String prompt(long timeout) throws IOException;
+
     /** @param message the message to prompt the user
      * @return the user inputed string
      * @throws IOException if the manager is closed or could not read the prompt
      * @throws InterruptedIOException if the prompt was interrupted */
     String prompt(String message) throws IOException;
 
+    /** @param timeout the time to wait in milliseconds
+     * @param message the message to prompt the user
+     * @return the user inputed string, null if the timeout was reached
+     * @throws IOException if the manager is closed or could not read the prompt
+     * @throws InterruptedIOException if the prompt was interrupted */
+    String prompt(String message, long timeout) throws IOException;
+
     /** <p>
      * Set a prompting prefix.
      *

gclc/src/main/java/fr/bigeon/gclc/manager/PipedConsoleManager.java

@@ -121,11 +121,23 @@ public final class PipedConsoleManager
                 .prompt(innerManager.getPrompt() + System.lineSeparator());
     }
 
+    /* (non-Javadoc)
+     * @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
+    @Override
+    public String prompt(long timeout) throws IOException {
+        return innerManager.prompt(timeout);
+    }
+
     @Override
     public String prompt(String message) throws IOException {
         return innerManager.prompt(message + System.lineSeparator());
     }
 
+    @Override
+    public String prompt(String message, long timeout) throws IOException {
+        return innerManager.prompt(message + System.lineSeparator(), timeout);
+    }
+
     @Override
     public void setPrompt(String prompt) {
         innerManager.setPrompt(prompt);

gclc/src/main/java/fr/bigeon/gclc/manager/ReadingRunnable.java

@@ -69,8 +69,7 @@ public class ReadingRunnable implements Runnable {
         /** @param obj the object to lock on
          * @param start the object to notify when ready to wait
          * @param message the message to wait for */
-        public ToWaitRunnable(Object obj, Object start,
+        public ToWaitRunnable(Object obj, Object start, String message) {
-                String message) {
             this.obj = obj;
             this.start = start;
             this.message = message;
@@ -91,8 +90,8 @@ public class ReadingRunnable implements Runnable {
                             return;
                         }
                     } catch (InterruptedException e) {
-                        LOGGER.log(Level.SEVERE,
+                        LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
-                                THREAD_INTERRUPTION_EXCEPTION, e); 
+                                e);
                     }
                 }
             }
@@ -126,13 +125,9 @@ public class ReadingRunnable implements Runnable {
     private final Object lock = new Object();
     /** The waiting status for a message */
     private boolean waiting;
-    /**
+    /** The blocker for a given message */
-     * The blocker for a given message
-     */
     private final Map<String, Object> messageBlocker = new HashMap<>();
-    /**
+    /** The lock */
-     * The lock
-     */
     private final Object messageBlockerLock = new Object();
     /** The message being delivered */
     private String delivering;
@@ -202,8 +197,7 @@ public class ReadingRunnable implements Runnable {
                 try {
                     lock.wait(TIMEOUT);
                 } catch (InterruptedException e) {
-                    LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, 
+                    LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
-                            e);
                 }
                 if (messages.isEmpty() && !running) {
                     throw new IOException(CLOSED_PIPE);
@@ -216,6 +210,28 @@ public class ReadingRunnable implements Runnable {
         }
     }
 
+    public String getNextMessage(long timeout) throws IOException {
+        synchronized (lock) {
+            if (!running) {
+                throw new IOException(CLOSED_PIPE);
+            }
+            waiting = true;
+            try {
+                lock.wait(timeout);
+            } catch (InterruptedException e) {
+                LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
+            }
+            if (messages.isEmpty() && !running) {
+                throw new IOException(CLOSED_PIPE);
+            }
+            waiting = false;
+            if (messages.isEmpty()) {
+                return null;
+            }
+            return messages.poll();
+        }
+    }
+
     /** @param running the running to set */
     public void setRunning(boolean running) {
         synchronized (lock) {

gclc/src/main/java/fr/bigeon/gclc/manager/SystemConsoleManager.java

@@ -136,6 +136,13 @@ public final class SystemConsoleManager implements ConsoleManager { // NOSONAR
         return prompt(prompt);
     }
 
+    /* (non-Javadoc)
+     * @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
+    @Override
+    public String prompt(long timeout) throws IOException {
+        return prompt(prompt, timeout);
+    }
+
     /* (non-Javadoc)
      * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
     @Override
@@ -145,6 +152,15 @@ public final class SystemConsoleManager implements ConsoleManager { // NOSONAR
         return reading.getMessage();
     }
 
+    /* (non-Javadoc)
+     * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
+    @Override
+    public String prompt(String message, long timeout) throws IOException {
+        checkOpen();
+        out.print(message);
+        return reading.getNextMessage(timeout);
+    }
+
     /** @param prompt the prompt to set */
     @Override
     public void setPrompt(String prompt) {

gclc/src/test/java/fr/bigeon/gclc/CommandTestingApplication.java

@@ -54,14 +54,15 @@ import fr.bigeon.gclc.manager.PipedConsoleManager;
 @SuppressWarnings("javadoc")
 public class CommandTestingApplication implements AutoCloseable {
 
-    private final ConsoleTestApplication application;
+    private final ConsoleApplication application;
     private final Thread th;
     private final PipedConsoleManager manager;
 
     /** @throws IOException if the streams cannot be build */
     public CommandTestingApplication() throws IOException {
         manager = new PipedConsoleManager();
-        application = new ConsoleTestApplication(manager);
+        application = new ConsoleApplication(manager, "", "");
+        new ConsoleTestApplication().attach(application);
         th = new Thread(new Runnable() {
 
             @SuppressWarnings("synthetic-access")
@@ -93,7 +94,7 @@ public class CommandTestingApplication implements AutoCloseable {
     }
 
     /** @return the application */
-    public ConsoleTestApplication getApplication() {
+    public ConsoleApplication getApplication() {
         return application;
     }
 

gclc/src/test/java/fr/bigeon/gclc/ConsoleApplicationTest.java

@@ -72,7 +72,7 @@ public class ConsoleApplicationTest {
     public void test() {
 
         try (PipedConsoleManager manager = new PipedConsoleManager()) {
-            ConsoleTestApplication app = new ConsoleTestApplication(manager);
+            ConsoleApplication app = new ConsoleApplication(manager, "", "");
             app.exit();
         } catch (IOException e) {
             fail("System Console Manager failed");
@@ -85,7 +85,7 @@ public class ConsoleApplicationTest {
         try (CommandTestingApplication application = new CommandTestingApplication()) {
 
             // remove welcome
-            assertEquals(application.getApplication().getHeader(),
+            assertEquals(application.getApplication().header,
                     application.readNextLine());
             // Remove first prompt
             assertNull(application.readNextLine());
@@ -133,7 +133,7 @@ public class ConsoleApplicationTest {
 
             assertNull(application.readNextLine());
             application.sendCommand("exit");
-            assertEquals(application.getApplication().getFooter(),
+            assertEquals(application.getApplication().footer,
                     application.readNextLine());
             assertFalse(application.getApplication().isRunning());
         } catch (IOException e1) {

gclc/src/test/java/fr/bigeon/gclc/ConsoleTestApplication.java

@@ -41,12 +41,11 @@ import fr.bigeon.gclc.command.ExitCommand;
 import fr.bigeon.gclc.command.HelpExecutor;
 import fr.bigeon.gclc.exception.CommandRunException;
 import fr.bigeon.gclc.exception.InvalidCommandName;
-import fr.bigeon.gclc.manager.ConsoleManager;
 
 /** A test-purpose application
  * 
  * @author Emmanuel Bigeon */
-public class ConsoleTestApplication extends ConsoleApplication {
+public class ConsoleTestApplication implements ApplicationAttachement {
 
     /** Exit command */
     public static final String EXIT = "exit"; //$NON-NLS-1$
@@ -54,14 +53,14 @@ public class ConsoleTestApplication extends ConsoleApplication {
     protected static final long TWO_SECONDS = 2000;
 
     /** @param manager the manager */
+    @Override
     @SuppressWarnings("nls")
-    public ConsoleTestApplication(final ConsoleManager manager) {
+    public void attach(final ConsoleApplication application) {
-        super(manager, "Welcome to the test application. Type help or test.",
-                "See you");
         try {
-            add(new ExitCommand(EXIT, this));
+            application.add(new ExitCommand(EXIT, application));
-            add(new HelpExecutor("help", manager, this.getRoot()));
+            application.add(new HelpExecutor("help", application.manager,
-            add(new Command("test") {
+                    application.root));
+            application.add(new Command("test") {
 
                 @Override
                 public String tip() {
@@ -71,14 +70,14 @@ public class ConsoleTestApplication extends ConsoleApplication {
                 @Override
                 public void execute(String... args) throws CommandRunException {
                     try {
-                        manager.println("Test command ran fine");
+                        application.manager.println("Test command ran fine");
                     } catch (IOException e) {
                         throw new CommandRunException("manager closed", e,
                                 this);
                     }
                 }
             });
-            add(new Command("long") {
+            application.add(new Command("long") {
 
                 @Override
                 public String tip() {
@@ -88,9 +87,9 @@ public class ConsoleTestApplication extends ConsoleApplication {
                 @Override
                 public void execute(String... args) throws CommandRunException {
                     try {
-                        manager.println("Waita minute");
+                        application.manager.println("Waita minute");
                         Thread.sleep(TWO_SECONDS);
-                        manager.println("done!");
+                        application.manager.println("done!");
                     } catch (IOException e) {
                         throw new CommandRunException("manager closed", e,
                                 this);
@@ -100,7 +99,7 @@ public class ConsoleTestApplication extends ConsoleApplication {
                     }
                 }
             });
-            add(new Command("failingCmd") {
+            application.add(new Command("failingCmd") {
 
                 @Override
                 public String tip() {

gclc/src/test/java/fr/bigeon/gclc/command/ParametrizedCommandTest.java

@@ -578,9 +578,16 @@ public class ParametrizedCommandTest {
                     @Override
                     public void run() {
                         try {
-                            assertEquals(str1, test.readNextLine());
+                            assertEquals("value of " + str1 + "? ",
+                                    test.readNextLine());
                             test.type("");
-                            assertEquals(str1, test.readNextLine());
+                            assertEquals(
+                                    "value of " + str1 + "? (cannot be empty) ",
+                                    test.readNextLine());
+                            test.type("");
+                            assertEquals(
+                                    "value of " + str1 + "? (cannot be empty) ",
+                                    test.readNextLine());
                             test.type(str2);
                         } catch (IOException e) {
                             assertNull(e);
@@ -598,7 +605,8 @@ public class ParametrizedCommandTest {
                     @Override
                     public void run() {
                         try {
-                            assertEquals(str1, test.readNextLine());
+                            assertEquals("value of " + str1 + "? ",
+                                    test.readNextLine());
                             test.type(str2);
                         } catch (IOException e) {
                             assertNull(e);

gclc/src/test/java/fr/bigeon/gclc/command/ScriptExecutionTest.java

@@ -47,6 +47,7 @@ import java.nio.charset.Charset;
 
 import org.junit.Test;
 
+import fr.bigeon.gclc.ConsoleApplication;
 import fr.bigeon.gclc.ConsoleTestApplication;
 import fr.bigeon.gclc.exception.CommandRunException;
 import fr.bigeon.gclc.exception.CommandRunExceptionType;
@@ -75,8 +76,9 @@ public class ScriptExecutionTest {
             assertNotNull(e2);
             return;
         }
-        ConsoleTestApplication app = new ConsoleTestApplication(
+        ConsoleApplication app = new ConsoleApplication(
-                test);
+                test, "", "");
+        new ConsoleTestApplication().attach(app);
         ScriptExecution exec = new ScriptExecution("script", app, "#", //$NON-NLS-1$ //$NON-NLS-2$
                 Charset.forName("UTF-8"));
         try {