clamp 0.1.2 → 0.1.3

data/examples/speak

@@ -6,6 +6,10 @@ require "clamp"
 
 class SpeakCommand < Clamp::Command
 
+  self.description = %{
+    Say something.
+  }
+
   option "--loud", :flag, "say it loud"
   option ["-n", "--iterations"], "N", "say it N times", :default => 1 do |s|
     Integer(s)

data/lib/clamp/command.rb

@@ -115,13 +115,13 @@ module Clamp
       # @param [Array<String>] arguments command-line arguments
       # @param [Hash] context additional data the command may need
       # 
-      def run(invocation_path = $0, arguments = ARGV, context = {})
+      def run(invocation_path = File.basename($0), arguments = ARGV, context = {})
         begin 
           new(invocation_path, context).run(arguments)
         rescue Clamp::UsageError => e
           $stderr.puts "ERROR: #{e.message}"
           $stderr.puts ""
-          $stderr.puts "See: '#{invocation_path} --help'"
+          $stderr.puts "See: '#{e.command.invocation_path} --help'"
           exit(1)
         rescue Clamp::HelpWanted => e
           puts e.command.help

data/lib/clamp/help.rb

@@ -11,6 +11,17 @@ module Clamp
 
     attr_reader :declared_usage_descriptions
 
+    def description=(description)
+      @description = description.dup
+      if @description =~ /^\A\n*( +)/
+        indent = $1
+        @description.gsub!(/^#{indent}/, '')
+      end
+      @description.strip!
+    end
+    
+    attr_reader :description
+    
     def derived_usage_description
       parts = parameters.map { |a| a.name }
       parts.unshift("[OPTIONS]") if has_options?
@@ -27,6 +38,10 @@ module Clamp
       usage_descriptions.each_with_index do |usage, i|
         help.puts "    #{invocation_path} #{usage}".rstrip
       end
+      if description
+        help.puts ""
+        help.puts description.gsub(/^/, "  ")
+      end
       detail_format = "    %-29s %s"
       if has_parameters?
         help.puts "\nParameters:"

data/lib/clamp/subcommand.rb

@@ -0,0 +1,23 @@
+module Clamp
+
+  class Subcommand < Struct.new(:name, :description, :subcommand_class)
+
+    def initialize(names, description, subcommand_class)
+      @names = Array(names)
+      @description = description
+      @subcommand_class = subcommand_class
+    end
+
+    attr_reader :names, :description, :subcommand_class
+
+    def is_called?(name)
+      names.member?(name)
+    end
+
+    def help
+      [names.join(", "), description]
+    end
+
+  end
+
+end

data/lib/clamp/subcommand/declaration.rb

@@ -1,10 +1,7 @@
-module Clamp
-
-  class Subcommand < Struct.new(:name, :description, :subcommand_class)
+require 'clamp/subcommand'
 
-    def help
-      [name, description]
-    end
+module Clamp
+  class Subcommand
 
     module Declaration
 
@@ -26,7 +23,7 @@ module Clamp
       end
 
       def find_subcommand(name)
-        recognised_subcommands.find { |sc| sc.name == name }
+        recognised_subcommands.find { |sc| sc.is_called?(name) }
       end
       
       def has_subcommands!
@@ -40,5 +37,4 @@ module Clamp
     end
 
   end
-
 end

data/lib/clamp/version.rb

@@ -1,3 +1,3 @@
 module Clamp
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

data/spec/clamp/command_group_spec.rb

@@ -52,6 +52,43 @@ describe Clamp::Command do
     
   end
 
+  describe "with an aliased subcommand" do
+    
+    given_command "blah" do
+
+      subcommand ["say", "talk"], "Say something" do
+        
+        parameter "WORD ...", "stuff to say"
+        
+        def execute
+          puts word_list
+        end
+        
+      end
+      
+    end
+    
+    it "responds to both aliases" do
+
+      @command.run(["say", "boo"])
+      stdout.should =~ /boo/
+
+      @command.run(["talk", "jive"])
+      stdout.should =~ /jive/
+
+    end
+    
+    describe "#help" do 
+
+      it "lists all aliases" do
+        @help = @command.help
+        @help.should =~ /say, talk .* Say something/
+      end
+
+    end
+    
+  end
+  
   describe "with nested subcommands" do
 
     given_command "fubar" do

data/spec/clamp/command_spec.rb

@@ -385,6 +385,29 @@ describe Clamp::Command do
 
   end
 
+  describe "with a description" do
+
+    given_command("punt") 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
+
+      it "includes the description" do
+        @command.help.should =~ /^  Punt is an example command/
+        @command.help.should =~ /^  The prefix/
+      end
+
+    end
+
+  end
   describe ".run" do
 
     it "creates a new Command instance and runs it" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clamp
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Mike Williams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-22 00:00:00 +11:00
+date: 2010-11-24 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -50,6 +50,7 @@ files:
 - lib/clamp/parameter.rb
 - lib/clamp/parameter/declaration.rb
 - lib/clamp/parameter/parsing.rb
+- lib/clamp/subcommand.rb
 - lib/clamp/subcommand/declaration.rb
 - lib/clamp/subcommand/execution.rb
 - lib/clamp/version.rb