Merge pull request #876 from andrewn617/improve-boolean-parse-documentation

Document the '--skip-' option for boolean options.

Author: rafaelfranca

lib/thor/parser/option.rb

@@ -89,8 +89,8 @@ def usage(padding = 0)
 
       sample = "[#{sample}]".dup unless required?
 
-      if boolean?
-        sample << ", [#{dasherize('no-' + human_name)}]" unless (name == "force") || name.match(/\Ano[\-_]/)
+      if boolean? && name != "force" && !name.match(/\A(no|skip)[\-_]/)
+        sample << ", [#{dasherize('no-' + human_name)}], [#{dasherize('skip-' + human_name)}]"
       end
 
       aliases_for_usage.ljust(padding) + sample

lib/thor/parser/options.rb

@@ -250,7 +250,8 @@ def parsing_options?
       @parsing_options
     end
 
-    # Parse boolean values which can be given as --foo=true, --foo or --no-foo.
+    # Parse boolean values which can be given as --foo=true or --foo for true values, or
+    # --foo=false, --no-foo or --skip-foo for false values.
     #
     def parse_boolean(switch)
       if current_is_value?

spec/parser/option_spec.rb

@@ -218,11 +218,11 @@ def option(name, options = {})
     end
 
     it "returns usage for boolean types" do
-      expect(parse(:foo, :boolean).usage).to eq("[--foo], [--no-foo]")
+      expect(parse(:foo, :boolean).usage).to eq("[--foo], [--no-foo], [--skip-foo]")
     end
 
     it "does not use padding when no aliases are given" do
-      expect(parse(:foo, :boolean).usage).to eq("[--foo], [--no-foo]")
+      expect(parse(:foo, :boolean).usage).to eq("[--foo], [--no-foo], [--skip-foo]")
     end
 
     it "documents a negative option when boolean" do
@@ -231,6 +231,9 @@ def option(name, options = {})
 
     it "does not document a negative option for a negative boolean" do
       expect(parse(:'no-foo', :boolean).usage).not_to include("[--no-no-foo]")
+      expect(parse(:'no-foo', :boolean).usage).not_to include("[--skip-no-foo]")
+      expect(parse(:'skip-foo', :boolean).usage).not_to include("[--no-skip-foo]")
+      expect(parse(:'skip-foo', :boolean).usage).not_to include("[--skip-skip-foo]")
     end
 
     it "does not document a negative option for an underscored negative boolean" do
@@ -261,7 +264,7 @@ def option(name, options = {})
       end
 
       it "does not negate the aliases" do
-        expect(parse([:foo, "-f", "-b"], :boolean).usage).to eq("-f, -b, [--foo], [--no-foo]")
+        expect(parse([:foo, "-f", "-b"], :boolean).usage).to eq("-f, -b, [--foo], [--no-foo], [--skip-foo]")
       end
 
       it "normalizes the aliases" do