clamp 0.2.0 → 0.2.1

data/README.markdown

@@ -221,7 +221,7 @@ You can mark a subcommand as "default" by using `default_subcommand` to declare
 
 ### Subcommand options and parameters
 
-Options are inheritable, so any options declared for a parent command are supported for it's subcommands.  Parameters, on the other hand, are not inherited - each subcommand must declare it's own parameter list.
+Options are inheritable, so any options declared for a command are supported for it's sub-classes (e.g. those created using `subcommand`).  Parameters, on the other hand, are not inherited - each subcommand must declare it's own parameter list.
 
 Note that, if a subcommand accepts options, they must be specified on the command-line _after_ the subcommand name.  
 

data/examples/gitdown

@@ -0,0 +1,61 @@
+#! /usr/bin/env ruby
+
+# Demonstrate how subcommands can be declared as classes
+
+require "clamp"
+
+module GitDown
+
+  class AbstractCommand < Clamp::Command
+
+    option ["-v", "--verbose"], :flag, "be verbose"
+
+    option "--version", :flag, "show version" do
+      puts "GitDown-0.0.0a"
+      exit(0)
+    end
+
+  end
+
+  class CloneCommand < AbstractCommand
+    
+    parameter "REPOSITORY", "repository to clone"
+    parameter "[DIR]", "working directory", :default => "."
+
+    def execute
+      raise NotImplementedError
+    end
+    
+  end
+
+  class PullCommand < AbstractCommand
+
+    option "--[no-]commit", :flag, "Perform the merge and commit the result."
+
+    def execute
+      raise NotImplementedError
+    end
+    
+  end
+
+  class StatusCommand < AbstractCommand
+    
+    option ["-s", "--short"], :flag, "Give the output in the short-format."
+
+    def execute
+      raise NotImplementedError
+    end
+    
+  end
+
+  class MainCommand < AbstractCommand
+    
+    subcommand "clone", "Clone a remote repository.", CloneCommand
+    subcommand "pull", "Fetch and merge updates.", PullCommand
+    subcommand "status", "Display status of local repository.", StatusCommand
+
+  end
+
+end
+
+GitDown::MainCommand.run

data/lib/clamp/option/declaration.rb

@@ -27,16 +27,6 @@ module Clamp
       end
 
       def documented_options
-        declared_options + inherited_declared_options
-      end
-
-      def recognised_options
-        documented_options + standard_options
-      end
-
-      private
-
-      def inherited_declared_options
         ancestors.inject([]) do |options, ancestor| 
           if ancestor.kind_of?(Clamp::Option::Declaration)
             options + ancestor.declared_options
@@ -46,6 +36,10 @@ 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

data/lib/clamp/version.rb

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

data/spec/clamp/command_group_spec.rb

@@ -131,15 +131,22 @@ describe Clamp::Command do
 
     before do
 
+      speed_options = Module.new do
+        extend Clamp::Option::Declaration
+        option "--speed", "SPEED", "how fast", :default => "slowly"
+      end
+
       @command_class = Class.new(Clamp::Command) do
 
         option "--direction", "DIR", "which way", :default => "home"
 
+        include speed_options
+        
         subcommand "move", "move in the appointed direction" do
 
           def execute
             motion = context[:motion] || "walking"
-            puts "#{motion} #{direction}"
+            puts "#{motion} #{direction} #{speed}"
           end
 
         end
@@ -150,16 +157,21 @@ describe Clamp::Command do
 
     end
 
-    it "accepts parents options (specified after the subcommand)" do
+    it "accepts options defined in superclass (specified after the subcommand)" do
       @command.run(["move", "--direction", "north"])
       stdout.should =~ /walking north/
     end
 
-    it "accepts parents options (specified before the subcommand)" do
+    it "accepts options defined in superclass (specified before the subcommand)" do
       @command.run(["--direction", "north", "move"])
       stdout.should =~ /walking north/
     end
 
+    it "accepts options defined in included modules" do
+      @command.run(["move", "--speed", "very quickly"])
+      stdout.should =~ /walking home very quickly/
+    end
+
     it "has access to command context" do
       @command = @command_class.new("go", :motion => "wandering")
       @command.run(["move"])

data/spec/clamp/option_spec.rb

@@ -122,5 +122,28 @@ describe Clamp::Option do
     end
 
   end
+
+  describe "in subcommand" do
+    before do
+
+      @command = Class.new(Clamp::Command) do
+        subcommand "foo", "FOO!" do
+          option "--bar", "BAR", "Bars foo."
+        end
+      end
+
+    end
+
+    describe "Command#help" do
+
+      it "includes help for each option exactly once" do
+        subcommand = @command.new("").send(:find_subcommand, 'foo')
+        subcommand_help = subcommand.subcommand_class.help("")
+        subcommand_help.lines.grep(/--bar BAR/).count.should == 1
+      end
+
+    end
+
+  end
   
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: clamp
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Mike Williams
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 Z
+date: 2011-06-27 00:00:00 Z
 dependencies: []
 
 description: |
@@ -32,6 +32,7 @@ files:
 - clamp.gemspec
 - examples/flipflop
 - examples/fubar
+- examples/gitdown
 - examples/speak
 - lib/clamp.rb
 - lib/clamp/attribute.rb
@@ -68,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1396886237993251491
+      hash: -3288603544677427312
       segments: 
       - 0
       version: "0"
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1396886237993251491
+      hash: -3288603544677427312
       segments: 
       - 0
       version: "0"