Merge pull request #243 from JacobEvelyn/multiple-flags

Basic implementation of :multiple option for flags

Author: davetron5000

lib/gli/commands/help_modules/options_formatter.rb

@@ -24,12 +24,10 @@ def format
 
         def description_with_default(option)
           if option.kind_of? Flag
-            required = if option.required?
-                         'required, '
-                       else
-                         ''
-                       end
-            String(option.description) + " (#{required}default: #{option.safe_default_value || 'none'})"
+            required = option.required? ? 'required, ' : ''
+            multiple = option.multiple? ? 'may be used more than once, ' : ''
+
+            String(option.description) + " (#{required}#{multiple}default: #{option.safe_default_value || 'none'})"
           else
             String(option.description) +  (option.default_value ?  " (default: enabled)" : "")
           end

lib/gli/dsl.rb

@@ -75,6 +75,7 @@ def default_value(val); @next_default_value = val; end
     #           +:arg_name+:: the arg name, instead of using #arg_name
     #           +:must_match+:: A regexp that the flag's value must match or an array of allowable values
     #           +:type+:: A Class (or object you passed to GLI::App#accept) to trigger type coversion
+    #           +:multiple+:: if true, flag may be used multiple times and values are stored in an array
     #
     # Example:
     #

lib/gli/flag.rb

@@ -24,30 +24,51 @@ class Flag < CommandLineOption # :nodoc:
     #           :must_match:: a regexp that the flag's value must match
     #           :type:: a class to convert the value to
     #           :required:: if true, this flag must be specified on the command line
+    #           :multiple:: if true, flag may be used multiple times and values are stored in an array
     #           :mask:: if true, the default value of this flag will not be output in the help.
     #                   This is useful for password flags where you might not want to show it
     #                   on the command-line.
     def initialize(names,options)
       super(names,options)
       @argument_name = options[:arg_name] || "arg"
-      @default_value = options[:default_value]
       @must_match = options[:must_match]
       @type = options[:type]
       @mask = options[:mask]
       @required = options[:required]
+      @multiple = options[:multiple]
     end
 
     # True if this flag is required on the command line
     def required?
       @required
     end
 
+    # True if the flag may be used multiple times.
+    def multiple?
+      @multiple
+    end
 
     def safe_default_value
       if @mask
         "********"
       else
-        default_value
+        # This uses @default_value instead of the `default_value` method because
+        # this method is only used for display, and for flags that may be passed
+        # multiple times, we want to display whatever is set in the code as the
+        # the default, or the string "none" rather than displaying an empty
+        # array.
+        @default_value
+      end
+    end
+
+    # The default value for this flag. Uses the value passed if one is set;
+    # otherwise uses `[]` if the flag support multiple arguments and `nil` if
+    # it does not.
+    def default_value
+      if @default_value
+        @default_value
+      elsif @multiple
+        []
       end
     end
 

lib/gli/option_parser_factory.rb

@@ -58,8 +58,15 @@ def self.setup_options(opts,tokens,options)
       tokens.each do |ignore,token|
         opts.on(*token.arguments_for_option_parser) do |arg|
           token.names_and_aliases.each do |name|
-            options[name] = arg
-            options[name.to_sym] = arg
+            if token.kind_of?(Flag) && token.multiple?
+              options[name] ||= []
+              options[name.to_sym] ||= []
+              options[name] << arg
+              options[name.to_sym] << arg
+            else
+              options[name] = arg
+              options[name.to_sym] = arg
+            end
           end
         end
       end

test/tc_gli.rb

@@ -717,6 +717,48 @@ def test_that_we_can_add_new_casts_for_flags
     assert_equal 'crud',@baz.value
   end
 
+  def test_that_flags_can_be_used_multiple_times
+    @app.reset
+    @app.flag :flag, :multiple => true
+    @app.command :foo do |c|
+      c.action do |options, _, _|
+        @flag = options[:flag]
+      end
+    end
+
+    assert_equal 0,@app.run(%w(--flag 1 --flag=2 --flag 3 foo)),@fake_stderr.to_s
+
+    assert_equal ['1','2','3'],@flag
+  end
+
+  def test_that_multiple_use_flags_are_empty_arrays_by_default
+    @app.reset
+    @app.flag :flag, :multiple => true
+    @app.command :foo do |c|
+      c.action do |options, _, _|
+        @flag = options[:flag]
+      end
+    end
+
+    assert_equal 0,@app.run(['foo']),@fake_stderr.to_s
+
+    assert_equal [],@flag
+  end
+
+  def test_that_multiple_use_flags_can_take_other_defaults
+    @app.reset
+    @app.flag :flag, :multiple => true, :default_value => ['1']
+    @app.command :foo do |c|
+      c.action do |options, _, _|
+        @flag = options[:flag]
+      end
+    end
+
+    assert_equal 0,@app.run(['foo']),@fake_stderr.to_s
+
+    assert_equal ['1'],@flag
+  end
+
   def test_that_we_mutate_ARGV_by_default
     @app.reset
     @app.flag :f

test/tc_help.rb

@@ -302,20 +302,20 @@ def a_GLI_app(omit_options=false)
         unless omit_options
           flags.each do |(description,arg,flag_names)|
             desc description
-          arg_name arg
-          flag flag_names
+            arg_name arg
+            flag flag_names
           end
 
           switches.each do |(description,switch_names)|
             desc description
-          switch switch_names
+            switch switch_names
           end
         end
 
         commands.each do |(description,command_names)|
           desc description
-          command command_names do |c| 
-            c.action {} 
+          command command_names do |c|
+            c.action {}
           end
         end
       end
@@ -363,7 +363,7 @@ def refute_output_contained(string_or_regexp,desc='')
   def any_option
     ('a'..'z').to_a[@option_index].tap { @option_index += 1 }
   end
-  
+
   def any_long_option
     Faker::Lorem.words(10)[rand(10)]
   end