The default argument name displayed is now properly controlled by the help formatter (CLI-205)

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@956303 13f79535-47bb-0310-9956-ffa450edef68

Author: ebourg

src/main/java/org/apache/commons/cli/HelpFormatter.java

@@ -648,14 +648,14 @@ private void appendOption(final StringBuffer buff, final Option option, final bo
         {
             buff.append("--").append(option.getLongOpt());
         }
-
-        // if the Option has a value
-        if (option.hasArg() && option.hasArgName())
+        
+        // if the Option has a value and a non blank argname
+        if (option.hasArg() && (option.getArgName() == null || option.getArgName().length() != 0))
         {
             buff.append(option.getOpt() == null ? longOptSeparator : " ");
-            buff.append("<").append(option.getArgName()).append(">");
+            buff.append("<").append(option.getArgName() != null ? option.getArgName() : getArgName()).append(">");
         }
-
+        
         // if the Option is not a required option
         if (!required)
         {
@@ -781,14 +781,16 @@ protected StringBuffer renderOptions(StringBuffer sb, int width, Options options
 
             if (option.hasArg())
             {
-                if (option.hasArgName())
+                String argName = option.getArgName();
+                if (argName != null && argName.length() == 0)
                 {
-                    optBuf.append(option.hasLongOpt() ? longOptSeparator : " ");
-                    optBuf.append("<").append(option.getArgName()).append(">");
+                    // if the option has a blank argname
+                    optBuf.append(' ');
                 }
                 else
                 {
-                    optBuf.append(' ');
+                    optBuf.append(option.hasLongOpt() ? longOptSeparator : " ");
+                    optBuf.append("<").append(argName != null ? option.getArgName() : getArgName()).append(">");
                 }
             }
 

src/main/java/org/apache/commons/cli/Option.java

@@ -54,7 +54,7 @@ public class Option implements Cloneable, Serializable
     private String longOpt;
 
     /** the name of the argument for this option */
-    private String argName = "arg";
+    private String argName;
 
     /** description of the option */
     private String description;
@@ -319,11 +319,9 @@ public String getArgName()
     }
 
     /**
-     * Returns whether the display name for the argument value
-     * has been set.
+     * Returns whether the display name for the argument value has been set.
      *
-     * @return if the display name for the argument value has been
-     * set.
+     * @return if the display name for the argument value has been set.
      */
     public boolean hasArgName()
     {

src/main/java/org/apache/commons/cli/OptionBuilder.java

@@ -77,7 +77,7 @@ private OptionBuilder()
     private static void reset()
     {
         description = null;
-        argName = "arg";
+        argName = null;
         longopt = null;
         type = null;
         required = false;

src/test/java/org/apache/commons/cli/HelpFormatterTest.java

@@ -305,6 +305,22 @@ public void testPrintOptionWithEmptyArgNameUsage()
         assertEquals("usage: app -f" + EOL, out.toString());
     }
 
+    public void testDefaultArgName()
+    {
+        Option option = OptionBuilder.hasArg().isRequired().create("f");
+        
+        Options options = new Options();
+        options.addOption(option);
+        
+        StringWriter out = new StringWriter();
+
+        HelpFormatter formatter = new HelpFormatter();
+        formatter.setArgName("argument");
+        formatter.printUsage(new PrintWriter(out), 80, "app", options);
+
+        assertEquals("usage: app -f <argument>" + EOL, out.toString());
+    }
+
     public void testRtrim()
     {
         HelpFormatter formatter = new HelpFormatter();