clamp 0.1.8 → 0.2.0

data/README.markdown

@@ -203,6 +203,22 @@ Clamp generates an anonymous subclass of the current class, to represent the sub
 
     end
 
+### 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.
+
+    class MainCommand < Clamp::Command
+
+      default_subcommand "status", "Display current status" do
+
+        def execute
+          # ...
+        end
+
+      end
+      
+    end
+
 ### 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.

data/examples/flipflop

@@ -3,10 +3,16 @@
 # An example of subcommands
 
 require "clamp"
+require "clamp/version"
 
 class FlipFlop < Clamp::Command
 
-  subcommand "flip", "flip it" do
+  option ["--version", "-v"], :flag, "Show version" do
+    puts "Powered by Clamp-#{Clamp::VERSION}"
+    exit(0)
+  end
+
+  default_subcommand "flip", "flip it" do
     def execute
       puts "FLIPPED"
     end

data/lib/clamp/option/declaration.rb

@@ -10,12 +10,12 @@ module Clamp
 
       def option(switches, type, description, opts = {}, &block)
         option = Clamp::Option.new(switches, type, description, opts)
-        my_declared_options << option
+        declared_options << option
         define_accessors_for(option, &block)
       end
 
       def has_options?
-        !declared_options.empty?
+        !documented_options.empty?
       end
 
       def find_option(switch)
@@ -23,24 +23,26 @@ module Clamp
       end
 
       def declared_options
-        my_declared_options + inherited_declared_options
+        @declared_options ||= []
       end
 
-      private
+      def documented_options
+        declared_options + inherited_declared_options
+      end
 
       def recognised_options
-        declared_options + standard_options
+        documented_options + standard_options
       end
 
-      def my_declared_options
-        @my_declared_options ||= []
-      end
+      private
 
       def inherited_declared_options
-        if superclass.respond_to?(:declared_options)
-          superclass.declared_options
-        else
-          []
+        ancestors.inject([]) do |options, ancestor| 
+          if ancestor.kind_of?(Clamp::Option::Declaration)
+            options + ancestor.declared_options
+          else
+            options
+          end
         end
       end
 

data/lib/clamp/subcommand/declaration.rb

@@ -11,28 +11,47 @@ module Clamp
 
       def subcommand(name, description, subcommand_class = self, &block)
         has_subcommands!
-        if block
-          # generate a anonymous sub-class
-          subcommand_class = Class.new(subcommand_class, &block)
-        end
-        recognised_subcommands << Subcommand.new(name, description, subcommand_class)
+        declare_subcommand(name, description, subcommand_class, &block)
+      end
+
+      def default_subcommand(name, description, subcommand_class = self, &block)
+        has_subcommands!(name)
+        declare_subcommand(name, description, subcommand_class, &block)
       end
 
       def has_subcommands?
-        !recognised_subcommands.empty?
+        @has_subcommands
       end
 
       def find_subcommand(name)
         recognised_subcommands.find { |sc| sc.is_called?(name) }
       end
       
-      def has_subcommands!
-        unless @has_subcommands
-          parameter "SUBCOMMAND", "subcommand name", :attribute_name => :subcommand_name
+      def has_subcommands!(default = nil)
+        if @has_subcommands
+          if default
+            raise "You must declare the default_subcommand before any other subcommands"
+          end
+        else
+          if default
+            parameter "[SUBCOMMAND]", "subcommand name", :attribute_name => :subcommand_name, :default => default
+          else
+            parameter "SUBCOMMAND", "subcommand name", :attribute_name => :subcommand_name
+          end
           parameter "[ARGS] ...", "subcommand arguments", :attribute_name => :subcommand_arguments
           @has_subcommands = true
         end
       end
+      
+      private
+      
+      def declare_subcommand(name, description, subcommand_class = self, &block)
+        if block
+          # generate a anonymous sub-class
+          subcommand_class = Class.new(subcommand_class, &block)
+        end
+        recognised_subcommands << Subcommand.new(name, description, subcommand_class)
+      end
 
     end
 

data/lib/clamp/subcommand/execution.rb

@@ -9,7 +9,7 @@ module Clamp
         signal_usage_error "no subcommand specified" unless subcommand_name
         subcommand_class = find_subcommand_class(subcommand_name)
         subcommand = subcommand_class.new("#{invocation_path} #{subcommand_name}", context)
-        self.class.declared_options.each do |option|
+        self.class.recognised_options.each do |option|
           option_set = instance_variable_defined?(option.ivar_name)
           if option_set && subcommand.respond_to?(option.write_method)
             subcommand.send(option.write_method, self.send(option.read_method))

data/lib/clamp/version.rb

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

data/spec/clamp/command_group_spec.rb

@@ -1,16 +1,10 @@
 require 'spec_helper'
-require 'stringio'
 
 describe Clamp::Command do
 
+  extend CommandFactory
   include OutputCapture
 
-  def self.given_command(name, &block)
-    before do
-      @command = Class.new(Clamp::Command, &block).new(name)
-    end
-  end
-
   describe "with subcommands" do
 
     given_command "flipflop" do
@@ -112,6 +106,27 @@ describe Clamp::Command do
 
   end
   
+  describe "with a default subcommand" do
+    
+    given_command "admin" do
+
+      default_subcommand "status", "Show status" do
+
+        def execute
+          puts "All good!"
+        end
+
+      end
+
+    end
+
+    it "delegates multiple levels" do
+      @command.run([])
+      stdout.should =~ /All good/
+    end
+    
+  end
+  
   describe "each subcommand" do
 
     before do

data/spec/clamp/command_spec.rb

@@ -1,16 +1,10 @@
 require 'spec_helper'
-require 'stringio'
 
 describe Clamp::Command do
 
+  extend CommandFactory
   include OutputCapture
 
-  def self.given_command(name, &block)
-    before do
-      @command = Class.new(Clamp::Command, &block).new(name)
-    end
-  end
-
   given_command("cmd") do
 
     def execute

data/spec/clamp/option_module_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Clamp::Command do
+
+  include OutputCapture
+
+  describe "with included module" do
+    
+    before do
+
+      shared_options = Module.new do
+        extend Clamp::Option::Declaration
+        option "--size", "SIZE", :default => 4
+      end
+
+      @command_class = Class.new(Clamp::Command) do
+        
+        include shared_options
+        
+        def execute
+          puts "size = #{size}"
+        end
+        
+      end
+
+      @command = @command_class.new("foo")
+
+    end
+
+    it "accepts options from included module" do
+      @command.run(["--size", "42"])
+      stdout.should == "size = 42\n"
+    end
+  
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require "rspec"
 require "clamp"
+require 'stringio'
 
 Rspec.configure do |config|
   
@@ -32,3 +33,13 @@ module OutputCapture
   end
 
 end
+
+module CommandFactory
+  
+  def given_command(name, &block)
+    before do
+      @command = Class.new(Clamp::Command, &block).new(name)
+    end
+  end
+
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: clamp
 version: !ruby/object:Gem::Version 
-  hash: 11
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 8
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors: 
 - Mike Williams
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 +11:00
-default_executable: 
+date: 2011-05-24 00:00:00 Z
 dependencies: []
 
 description: |
@@ -57,10 +51,10 @@ files:
 - lib/clamp/version.rb
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_spec.rb
+- spec/clamp/option_module_spec.rb
 - spec/clamp/option_spec.rb
 - spec/clamp/parameter_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/mdub/clamp
 licenses: []
 
@@ -74,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 1396886237993251491
       segments: 
       - 0
       version: "0"
@@ -83,20 +77,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 1396886237993251491
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: a minimal framework for command-line utilities
 test_files: 
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_spec.rb
+- spec/clamp/option_module_spec.rb
 - spec/clamp/option_spec.rb
 - spec/clamp/parameter_spec.rb
 - spec/spec_helper.rb