clamp 0.2.2 → 0.2.3

data/lib/clamp/help.rb

@@ -33,33 +33,62 @@ module Clamp
     end
 
     def help(invocation_path)
-      help = StringIO.new
-      help.puts "Usage:"
-      usage_descriptions.each_with_index do |usage, i|
-        help.puts "    #{invocation_path} #{usage}".rstrip
+      help = Builder.new
+      help.add_usage(invocation_path, usage_descriptions)
+      help.add_description(description)
+      if has_parameters?
+        help.add_list("Parameters", parameters)
       end
-      if description
-        help.puts ""
-        help.puts description.gsub(/^/, "  ")
+      if has_subcommands?
+        help.add_list("Subcommands", recognised_subcommands)
       end
-      detail_format = "    %-29s %s"
-      if has_parameters?
-        help.puts "\nParameters:"
-        parameters.each do |parameter|
-          help.puts detail_format % parameter.help
+      help.add_list("Options", recognised_options)
+      help.string
+    end
+
+    class Builder
+
+      def initialize
+        @out = StringIO.new
+      end
+
+      def string
+        @out.string
+      end
+
+      def add_usage(invocation_path, usage_descriptions)
+        puts "Usage:"
+        usage_descriptions.each do |usage|
+          puts "    #{invocation_path} #{usage}".rstrip
         end
       end
-      if has_subcommands?
-        help.puts "\nSubcommands:"
-        recognised_subcommands.each do |subcommand|
-          help.puts detail_format % subcommand.help
+
+      def add_description(description)
+        if description
+          puts ""
+          puts description.gsub(/^/, "  ")
+        end
+      end
+
+      DETAIL_FORMAT = "    %-29s %s"
+
+      def add_list(heading, items)
+        puts "\n#{heading}:"
+        items.each do |item|
+          label, description = item.help
+          description.each_line do |line|
+            puts DETAIL_FORMAT % [label, line]
+            label = ''
+          end
         end
       end
-      help.puts "\nOptions:"
-      recognised_options.each do |option|
-        help.puts detail_format % option.help
+
+      private
+
+      def puts(*args)
+        @out.puts(*args)
       end
-      help.string
+
     end
 
   end

data/lib/clamp/version.rb

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

data/spec/clamp/command_group_spec.rb

@@ -15,7 +15,7 @@ describe Clamp::Command do
         end
       end
 
-      subcommand "flop", "flop it" do
+      subcommand "flop", "flop it\nfor extra flop" do
         def execute
           puts "FLOPPED"
         end
@@ -42,6 +42,11 @@ describe Clamp::Command do
         @help.should =~ /flop +flop it/
       end
       
+      it "handles new lines in subcommand descriptions" do
+        @help = @command.help        
+        @help.should =~ /flop +flop it\n +for extra flop/
+      end
+      
     end
     
   end

data/spec/clamp/command_spec.rb

@@ -135,7 +135,7 @@ describe Clamp::Command do
     before do
       @command.class.option ["-f", "--flavour"], "FLAVOUR", "Flavour of the month"
       @command.class.option ["-c", "--color"], "COLOR", "Preferred hue"
-      @command.class.option ["-n", "--[no-]nuts"], :flag, "Nuts (or not)"
+      @command.class.option ["-n", "--[no-]nuts"], :flag, "Nuts (or not)\nMay include nuts"
       @command.class.parameter "[ARG] ...", "extra arguments", :attribute_name => :arguments
     end
 
@@ -301,6 +301,10 @@ describe Clamp::Command do
         @command.help.should =~ %r(--flavour FLAVOUR +Flavour of the month)
         @command.help.should =~ %r(--color COLOR +Preferred hue)
       end
+      
+      it "handles new lines in option descriptions" do
+        @command.help.should =~ %r(--\[no-\]nuts +Nuts \(or not\)\n +May include nuts)
+      end
 
     end
 
@@ -430,7 +434,7 @@ describe Clamp::Command do
   describe "with parameters declared" do
 
     before do
-      @command.class.parameter "X", "x"
+      @command.class.parameter "X", "x\nxx"
       @command.class.parameter "Y", "y"
       @command.class.parameter "[Z]", "z", :default => "ZZZ"
     end
@@ -484,6 +488,25 @@ describe Clamp::Command do
 
     end
 
+    describe "#help" do
+
+      it "indicates that there are parameters" do
+        @command.help.should include("cmd [OPTIONS] X Y [Z]")
+      end
+
+      it "includes parameter details" do
+        @command.help.should =~ %r(X +x)
+        @command.help.should =~ %r(Y +y)
+        @command.help.should =~ %r(\[Z\] +z \(default: "ZZZ"\))        
+      end
+      
+      it "handles new lines in option descriptions" do
+        @command.help.should =~ %r(X +x\n +xx)
+      end
+
+    end
+
+
   end
 
   describe "with explicit usage" do

metadata

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