gli 2.4.1 → 2.5.0

data/.gitignore

@@ -10,3 +10,4 @@ gli.wiki
 Gemfile.lock
 results.html
 .rbx
+.DS_Store

data/features/todo.feature

@@ -115,10 +115,10 @@ Feature: The todo app has a nice user interface
 
     GLOBAL OPTIONS
         --flag=arg         - (default: none)
-        --help             - Show this message
-        --[no-]otherswitch - 
         --[no-]switch      - 
+        --[no-]otherswitch - 
         --version          - 
+        --help             - Show this message
 
     COMMANDS
         help          - Shows a list of commands or help for one command

data/lib/gli/app.rb

@@ -224,10 +224,10 @@ module GLI
       raise exception
     end
 
-    # Control how help commands are sorted.  By default, the commands are sorted alphabetically.
+    # Control how commands and options are sorted in help output.  By default, they are sorted alphabetically.
     #
-    # sort_type:: How you want help commands sorted:
-    #             +:manually+:: help commands are ordered in the order declared.
+    # sort_type:: How you want help commands/options sorted:
+    #             +:manually+:: help commands/options are ordered in the order declared.
     #             +:alpha+:: sort alphabetically (default)
     def sort_help(sort_type)
       @help_sort_type = sort_type

data/lib/gli/commands/help_modules/command_help_format.rb

@@ -16,7 +16,7 @@ module GLI
           command_wrapper = @wrapper_class.new(Terminal.instance.size[0],4 + @command.name.to_s.size + 3)
           wrapper = @wrapper_class.new(Terminal.instance.size[0],4)
           flags_and_switches = Hash[@command.topmost_ancestor.flags.merge(@command.topmost_ancestor.switches).select { |_,option| option.associated_command == @command }]
-          options_description = OptionsFormatter.new(flags_and_switches,@wrapper_class).format
+          options_description = OptionsFormatter.new(flags_and_switches,@sorter,@wrapper_class).format
           commands_description = format_subcommands(@command)
 
           synopses = []

data/lib/gli/commands/help_modules/global_help_format.rb

@@ -27,7 +27,7 @@ module GLI
           command_formatter.output(stringio)
           commands = stringio.string
 
-          global_option_descriptions = OptionsFormatter.new(global_flags_and_switches,@wrapper_class).format
+          global_option_descriptions = OptionsFormatter.new(global_flags_and_switches,@sorter,@wrapper_class).format
 
           GLOBAL_HELP.result(binding)
         end

data/lib/gli/commands/help_modules/options_formatter.rb

@@ -2,15 +2,15 @@ module GLI
   module Commands
     module HelpModules
       class OptionsFormatter
-        def initialize(flags_and_switches,wrapper_class)
+        def initialize(flags_and_switches,sorter,wrapper_class)
           @flags_and_switches = flags_and_switches
+          @sorter = sorter
           @wrapper_class = wrapper_class
         end
 
         def format
-          list_formatter = ListFormatter.new(@flags_and_switches.values.sort { |a,b| 
-            a.name.to_s <=> b.name.to_s 
-          }.map { |option|
+          flags_and_switches = @sorter.call(@flags_and_switches.values)
+          list_formatter = ListFormatter.new(flags_and_switches.map { |option|
             if option.respond_to? :argument_name
               [option_names_for_help_string(option,option.argument_name),description_with_default(option)]
             else
@@ -28,7 +28,7 @@ module GLI
           if option.kind_of? Flag
             String(option.description) + " (default: #{option.safe_default_value || 'none'})"
           else
-            String(option.description)
+            String(option.description) +  (option.default_value ?  " (default: enabled)" : "")
           end
         end
 

data/lib/gli/dsl.rb

@@ -36,10 +36,13 @@ module GLI
       @next_arg_options = options
     end
 
-    # set the default value of the next flag
+    # set the default value of the next flag or switch
     #
-    # +val+:: A String reprensenting the default value to be used for the following flag if the user doesn't specify one
-    #         and, when using a config file, the config also doesn't specify one
+    # +val+:: The default value to be used for the following flag if the user doesn't specify one
+    #         and, when using a config file, the config also doesn't specify one.  For a switch, this is
+    #         the value to be used if the switch isn't specified on the command-line.  Note that if you
+    #         set a switch to have a default of true, using the switch on the command-line has no effect.
+    #         To disable a switch where the default is true, use the <tt>--no-</tt> form.
     def default_value(val); @next_default_value = val; end
 
     # Create a flag, which is a switch that takes an argument
@@ -84,6 +87,7 @@ module GLI
     #           and aliases for this switch.  The last element can be a hash of options:
     #           +:desc+:: the description, instead of using #desc
     #           +:long_desc+:: the long_description, instead of using #long_desc
+    #           +:default_value+:: if the switch is omitted, use this as the default value.  By default,  switches default to off, or +false+
     #           +:negatable+:: if true, this switch will get a negatable form (e.g. <tt>--[no-]switch</tt>, false it will not.  Default is true
     def switch(*names)
       options = extract_options(names)

data/lib/gli/gli_option_parser.rb

@@ -26,6 +26,9 @@ module GLI
       @flags.each do |name,flag|
         global_options[name] = flag.default_value unless global_options[name]
       end
+      @switches.each do |name,switch|
+        global_options[name] = switch.default_value if global_options[name].nil?
+      end
 
       command_name ||= @default_command || :help
       command = find_command(command_name)
@@ -43,7 +46,7 @@ module GLI
         command_options[name] = flag.default_value unless command_options[name]
       end
       command.switches.each do |name,switch|
-        command_options[name] = switch.default_value unless command_options[name]
+        command_options[name] = switch.default_value if command_options[name].nil?
       end
 
       [global_options,command,command_options,args]

data/lib/gli/switch.rb

@@ -14,11 +14,14 @@ module GLI
     #           :desc - the short description
     #           :long_desc - the long description
     #           :negatable - true or false if this switch is negatable; defaults to true
-    #           :default_value - ignored, switches default to false
+    #           :default_value - default value if the switch is omitted
     def initialize(names,options = {})
       super(names,options)
-      @default_value = false
+      @default_value = false if options[:default_value].nil?
       @negatable = options[:negatable].nil? ? true : options[:negatable]
+      if @default_value != false && @negatable == false
+        raise "A switch with default #{@default_value} that isn't negetable is useless"
+      end
     end
 
     def arguments_for_option_parser

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.4.1' #:nodoc:
+    VERSION = '2.5.0' #:nodoc:
   end
 end

data/test/tc_gli.rb

@@ -425,6 +425,43 @@ class TC_testGLI < Clean::Test::TestCase
     @app.run(['foo', '-i','5','-s','a'])
   end
 
+  def test_switch_with_default_of_true
+    @app.reset
+    @app.on_error do |ex|
+      raise ex
+    end
+    @switch_value = nil
+
+    @app.command [:foo] do |c|
+      c.default_value true
+      c.switch :switch
+      c.action do |g,o,a|
+        @switch_value = o[:switch]
+      end
+    end
+    @app.run(['foo'])
+
+    assert @switch_value == true,"Got: '#{@switch_value}', but expected true"
+
+    @app.run(['foo','--no-switch'])
+
+    assert @switch_value == false,"Got: '#{@switch_value}', but expected false"
+  end
+
+  def test_switch_with_default_true_and_not_negetable_causes_exception
+    @app.reset
+    @app.on_error do |ex|
+      raise ex
+    end
+    @switch_value = nil
+
+    assert_raises(RuntimeError) do 
+      @app.command [:foo] do |c|
+        c.switch :switch, :default_value => true, :negatable => false
+      end
+    end
+  end
+
   def test_two_flags_using_equals_with_a_default
     @app.reset
     @app.on_error do |ex|

data/test/tc_subcommands.rb

@@ -121,10 +121,11 @@ class TC_testSubCommand < Clean::Test::TestCase
   #   - args => array of expected args
   def assert_command_ran_with(expected_command,options)
     lambda {
+      global_options = options[:global_options] || { :help => false }
       @run_results.each do |command,results|
         if command == expected_command
-          assert_equal(indiffernt_hash(options[:global_options]),results[0])
-          assert_equal(indiffernt_hash(options[:command_options]),results[1])
+          assert_equal(indifferent_hash(global_options),results[0])
+          assert_equal(indifferent_hash(options[:command_options]),results[1])
           assert_equal(options[:args],results[2])
         else
           assert_nil results
@@ -133,7 +134,7 @@ class TC_testSubCommand < Clean::Test::TestCase
     }
   end
 
-  def indiffernt_hash(possibly_nil_hash)
+  def indifferent_hash(possibly_nil_hash)
     return {} if possibly_nil_hash.nil?
     keys = possibly_nil_hash.keys
     keys.map(&:to_s).each do |key|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gli
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-20 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -369,7 +369,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3175102747663964560
+      hash: 3564389066848623229
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -378,7 +378,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3175102747663964560
+      hash: 3564389066848623229
 requirements: []
 rubyforge_project: gli
 rubygems_version: 1.8.24