clamp 0.2.1 → 0.2.2

data/README.markdown

@@ -205,7 +205,7 @@ Clamp generates an anonymous subclass of the current class, to represent the sub
 
 ### Default subcommand
 
-You can mark a subcommand as "default" by using `default_subcommand` to declare it, rather than `subcommand`.  Usually the SUBCOMMAND paramater is mandatory, but if a default subcommand is declared, it becomes optional.
+You can mark a subcommand as "default" by using `default_subcommand` to declare it, rather than `subcommand`.  Usually the SUBCOMMAND parameter is mandatory, but if a default subcommand is declared, it becomes optional.
 
     class MainCommand < Clamp::Command
 
@@ -240,7 +240,7 @@ All Clamp commands support a "`--help`" option, which outputs brief usage docume
     Options:
         --loud                        say it loud
         -n, --iterations N            say it N times (default: 1)
-        --help                        print help
+        -h, --help                    print help
 
 Contributing to Clamp
 ---------------------

data/lib/clamp/help.rb

@@ -19,12 +19,12 @@ module Clamp
       end
       @description.strip!
     end
-    
+
     attr_reader :description
-    
+
     def derived_usage_description
       parts = parameters.map { |a| a.name }
-      parts.unshift("[OPTIONS]") if has_options?
+      parts.unshift("[OPTIONS]")
       parts.join(" ")
     end
 
@@ -55,11 +55,9 @@ module Clamp
           help.puts detail_format % subcommand.help
         end
       end
-      if has_options?
-        help.puts "\nOptions:"
-        recognised_options.each do |option|
-          help.puts detail_format % option.help
-        end
+      help.puts "\nOptions:"
+      recognised_options.each do |option|
+        help.puts detail_format % option.help
       end
       help.string
     end

data/lib/clamp/option/declaration.rb

@@ -14,10 +14,6 @@ module Clamp
         define_accessors_for(option, &block)
       end
 
-      def has_options?
-        !documented_options.empty?
-      end
-
       def find_option(switch)
         recognised_options.find { |o| o.handles?(switch) }
       end
@@ -26,8 +22,27 @@ module Clamp
         @declared_options ||= []
       end
 
-      def documented_options
-        ancestors.inject([]) do |options, ancestor| 
+      def recognised_options
+        declare_implicit_options
+        effective_options
+      end
+
+      private
+
+      def declare_implicit_options
+        return nil if @implicit_options_declared
+        unless effective_options.find { |o| o.handles?("--help") }
+          help_switches = ["--help"]
+          help_switches.unshift("-h") unless effective_options.find { |o| o.handles?("-h") }
+          option help_switches, :flag, "print help" do
+            raise Clamp::HelpWanted.new(self)
+          end
+        end
+        @implicit_options_declared = true
+      end
+
+      def effective_options
+        ancestors.inject([]) do |options, ancestor|
           if ancestor.kind_of?(Clamp::Option::Declaration)
             options + ancestor.declared_options
           else
@@ -36,16 +51,6 @@ module Clamp
         end
       end
 
-      def recognised_options
-        documented_options + standard_options
-      end
-
-      HELP_OPTION = Clamp::Option.new("--help", :flag, "print help", :attribute_name => :help_requested)
-
-      def standard_options
-        [HELP_OPTION]
-      end
-
     end
 
   end

data/lib/clamp/version.rb

@@ -1,3 +1,3 @@
 module Clamp
-  VERSION = "0.2.1".freeze
+  VERSION = "0.2.2".freeze
 end

data/spec/clamp/command_spec.rb

@@ -16,7 +16,7 @@ describe Clamp::Command do
   describe "#help" do
 
     it "describes usage" do
-      @command.help.should include("Usage:\n    cmd\n")
+      @command.help.should =~ /^Usage:\n    cmd.*\n/
     end
 
   end
@@ -54,7 +54,7 @@ describe Clamp::Command do
       end
 
     end
-    
+
     describe "with explicit :attribute_name" do
 
       before do
@@ -87,7 +87,7 @@ describe Clamp::Command do
       it "sets the specified default value" do
         @command.port.should == 4321
       end
-      
+
     end
 
     describe "with :default value" do
@@ -101,13 +101,13 @@ describe Clamp::Command do
       end
 
       describe "#help" do
-        
+
         it "describes the default value" do
           @command.help.should include("port to listen on (default: 4321)")
         end
-        
+
       end
-      
+
     end
 
     describe "with a block" do
@@ -129,7 +129,7 @@ describe Clamp::Command do
     end
 
   end
-  
+
   describe "with options declared" do
 
     before do
@@ -175,7 +175,7 @@ describe Clamp::Command do
           @command.flavour.should == "strawberry"
           @command.color.should == "blue"
         end
-        
+
       end
 
       describe "with combined short options" do
@@ -188,9 +188,9 @@ describe Clamp::Command do
           @command.flavour.should == "strawberry"
           @command.nuts?.should == true
         end
-        
+
       end
-      
+
       describe "with option arguments attached using equals sign" do
 
         before do
@@ -201,9 +201,9 @@ describe Clamp::Command do
           @command.flavour.should == "strawberry"
           @command.color.should == "blue"
         end
-      
+
       end
-      
+
       describe "with option-like things beyond the arguments" do
 
         it "treats them as positional arguments" do
@@ -247,20 +247,40 @@ describe Clamp::Command do
 
       end
 
+      describe "with --help" do
+
+        it "requests help" do
+          lambda do
+            @command.parse(%w(--help))
+          end.should raise_error(Clamp::HelpWanted)
+        end
+
+      end
+
+      describe "with -h" do
+
+        it "requests help" do
+          lambda do
+            @command.parse(%w(-h))
+          end.should raise_error(Clamp::HelpWanted)
+        end
+
+      end
+
       describe "when option-writer raises an ArgumentError" do
-        
+
         before do
           @command.class.class_eval do
-            
+
             def color=(c)
               unless c == "black"
                 raise ArgumentError, "sorry, we're out of #{c}"
               end
             end
-            
+
           end
         end
-          
+
         it "re-raises it as a UsageError" do
           lambda do
             @command.parse(%w(--color red))
@@ -286,6 +306,47 @@ describe Clamp::Command do
 
   end
 
+  describe "with an explicit --help option declared" do
+
+    before do
+      @command.class.option ["--help"], :flag, "help wanted"
+    end
+
+    it "does not generate implicit help option" do
+      lambda do
+        @command.parse(%w(--help))
+      end.should_not raise_error
+      @command.help.should be_true
+    end
+
+    it "does not recognise -h" do
+      lambda do
+        @command.parse(%w(-h))
+      end.should raise_error(Clamp::UsageError)
+    end
+
+  end
+
+  describe "with an explicit -h option declared" do
+
+    before do
+      @command.class.option ["-h", "--humidity"], "PERCENT", "relative humidity" do |n|
+        Integer(n)
+      end
+    end
+
+    it "does not map -h to help" do
+      @command.help.should_not =~ %r( -h[, ].*help)
+    end
+
+    it "still recognises --help" do
+      lambda do
+        @command.parse(%w(--help))
+      end.should raise_error(Clamp::HelpWanted)
+    end
+
+  end
+
   describe ".parameter" do
 
     it "declares option argument accessors" do
@@ -319,13 +380,13 @@ describe Clamp::Command do
       end
 
       describe "#help" do
-        
+
         it "describes the default value" do
           @command.help.should include("direction (default: \"west\")")
         end
-        
+
       end
-      
+
     end
 
     describe "with a block" do
@@ -351,23 +412,23 @@ describe Clamp::Command do
   describe "with no parameters declared" do
 
     describe "#parse" do
-    
+
       describe "with arguments" do
-        
+
         it "raises a UsageError" do
           lambda do
             @command.parse(["crash"])
           end.should raise_error(Clamp::UsageError, "too many arguments")
         end
-        
+
       end
-      
+
     end
-    
+
   end
 
   describe "with parameters declared" do
-    
+
     before do
       @command.class.parameter "X", "x"
       @command.class.parameter "Y", "y"
@@ -375,9 +436,9 @@ describe Clamp::Command do
     end
 
     describe "#parse" do
-      
+
       describe "with arguments for all parameters" do
-        
+
         before do
           @command.parse(["crash", "bang", "wallop"])
         end
@@ -391,13 +452,13 @@ describe Clamp::Command do
       end
 
       describe "with insufficient arguments" do
-        
+
         it "raises a UsageError" do
           lambda do
             @command.parse(["crash"])
           end.should raise_error(Clamp::UsageError, "parameter 'Y': no value provided")
         end
-        
+
       end
 
       describe "with optional argument omitted" do
@@ -408,23 +469,23 @@ describe Clamp::Command do
           @command.y.should == "bang"
           @command.z.should == "ZZZ"
         end
-        
+
       end
 
       describe "with too many arguments" do
-        
+
         it "raises a UsageError" do
           lambda do
             @command.parse(["crash", "bang", "wallop", "kapow"])
           end.should raise_error(Clamp::UsageError, "too many arguments")
         end
-        
+
       end
-      
+
     end
-    
+
   end
-  
+
   describe "with explicit usage" do
 
     given_command("blah") do
@@ -469,11 +530,11 @@ describe Clamp::Command do
 
       self.description = <<-EOF
         Punt is an example command.  It doesn't do much, really.
-        
+
         The prefix at the beginning of this description should be normalised
         to two spaces.
       EOF
-      
+
     end
 
     describe "#help" do
@@ -486,6 +547,7 @@ describe Clamp::Command do
     end
 
   end
+
   describe ".run" do
 
     it "creates a new Command instance and runs it" do
@@ -501,7 +563,7 @@ describe Clamp::Command do
     end
 
     describe "invoked with a context hash" do
-      
+
       it "makes the context available within the command" do
         @command.class.class_eval do
           def execute
@@ -509,11 +571,11 @@ describe Clamp::Command do
           end
         end
         @command.class.run("xyz", [], :foo => "bar")
-        stdout.should == "bar"        
+        stdout.should == "bar"
       end
-      
+
     end
-    
+
     describe "when there's a UsageError" do
 
       before do
@@ -524,7 +586,7 @@ describe Clamp::Command do
           end
         end
 
-        begin 
+        begin
           @command.class.run("cmd", [])
         rescue SystemExit => e
           @system_exit = e
@@ -559,7 +621,7 @@ describe Clamp::Command do
   end
 
   describe "subclass" do
-    
+
     before do
       @parent_command_class = Class.new(Clamp::Command) do
         option "--verbose", :flag, "be louder"
@@ -569,12 +631,12 @@ describe Clamp::Command do
       end
       @command = @derived_command_class.new("cmd")
     end
-    
+
     it "inherits options from it's superclass" do
       @command.parse(["--verbose"])
       @command.should be_verbose
     end
 
   end
-  
+
 end

metadata

@@ -2,7 +2,7 @@
 name: clamp
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Mike Williams
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 Z
+date: 2011-07-18 00:00:00 Z
 dependencies: []
 
 description: |
@@ -69,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3288603544677427312
+      hash: 4567728835353449333
       segments: 
       - 0
       version: "0"
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3288603544677427312
+      hash: 4567728835353449333
       segments: 
       - 0
       version: "0"