clamp 0.1.0 → 0.1.1

data/README.markdown

@@ -121,7 +121,7 @@ Parsing and validation of options and parameters
 
 When you `#run` a command, it will first attempt to `#parse` command-line arguments, and map them onto the declared options and parameters, before invoking your `#execute` method.
 
-If parameters are declared, Clamp will verify that all required (ie. non-optional) parameters are present, and signal a error if they aren't. Otherwise, arguments that remain after option parsing will be made available via `#arguments`.
+Clamp will verify that all required (ie. non-optional) parameters are present, and signal a error if they aren't.
 
 ### Validation block
 

data/lib/clamp/command.rb

@@ -35,8 +35,8 @@ module Clamp
     
     # @return [Array<String>] unconsumed command-line arguments
     #
-    def arguments
-      @arguments
+    def remaining_arguments
+      @remaining_arguments
     end
 
     # Parse command-line arguments.
@@ -45,10 +45,10 @@ module Clamp
     # @return [Array<String>] unconsumed arguments
     #
     def parse(arguments)
-      @arguments = arguments.dup
+      @remaining_arguments = arguments.dup
       parse_options
       parse_parameters
-      @arguments
+      @remaining_arguments
     end
 
     # Run the command, with the specified arguments.

data/lib/clamp/help.rb

@@ -1,3 +1,5 @@
+require 'stringio'
+
 module Clamp
 
   module Help
@@ -11,7 +13,6 @@ module Clamp
 
     def derived_usage_description
       parts = parameters.map { |a| a.name }
-      parts.unshift("SUBCOMMAND") if has_subcommands?
       parts.unshift("[OPTIONS]") if has_options?
       parts.join(" ")
     end

data/lib/clamp/option/parsing.rb

@@ -6,13 +6,13 @@ module Clamp
       protected
 
       def parse_options
-        while arguments.first =~ /^-/
+        while remaining_arguments.first =~ /^-/
 
-          switch = arguments.shift
+          switch = remaining_arguments.shift
           break if switch == "--"
 
           option = find_option(switch)
-          value = option.extract_value(switch, arguments)
+          value = option.extract_value(switch, remaining_arguments)
 
           begin
             send("#{option.attribute_name}=", value)

data/lib/clamp/parameter/parsing.rb

@@ -7,18 +7,16 @@ module Clamp
       
       def parse_parameters
 
-        return false if self.class.parameters.empty?
-
         self.class.parameters.each do |parameter|
           begin
-            value = parameter.consume(arguments)
+            value = parameter.consume(remaining_arguments)
             send("#{parameter.attribute_name}=", value)
           rescue ArgumentError => e
             signal_usage_error "parameter '#{parameter.name}': #{e.message}"
           end
         end
 
-        unless arguments.empty?
+        unless remaining_arguments.empty?
           signal_usage_error "too many arguments"
         end
 

data/lib/clamp/subcommand/declaration.rb

@@ -13,6 +13,7 @@ module Clamp
       end
 
       def subcommand(name, description, subcommand_class = self, &block)
+        has_subcommands!
         if block
           # generate a anonymous sub-class
           subcommand_class = Class.new(subcommand_class, &block)
@@ -27,6 +28,13 @@ module Clamp
       def find_subcommand(name)
         recognised_subcommands.find { |sc| sc.name == name }
       end
+      
+      def has_subcommands!
+        unless method_defined?(:subcommand_name)
+          parameter "SUBCOMMAND", "subcommand name", :attribute_name => :subcommand_name
+          parameter "[ARGS] ...", "subcommand arguments", :attribute_name => :subcommand_arguments
+        end
+      end
 
     end
 

data/lib/clamp/subcommand/execution.rb

@@ -6,12 +6,11 @@ module Clamp
       protected
       
       def execute_subcommand
-        signal_usage_error "no subcommand specified" if arguments.empty?
-        subcommand_name = arguments.shift
+        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)
         subcommand.parent_command = self
-        subcommand.run(arguments)
+        subcommand.run(subcommand_arguments)
       end
 
       private

data/lib/clamp/version.rb

@@ -1,3 +1,3 @@
 module Clamp
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/spec/clamp/command_spec.rb

@@ -14,7 +14,7 @@ describe Clamp::Command do
   given_command("cmd") do
 
     def execute
-      print arguments.inspect
+      puts "Hello, world"
     end
 
   end
@@ -30,18 +30,13 @@ describe Clamp::Command do
   describe "#run" do
 
     before do
-      @abc = %w(a b c)
-      @command.run(@abc)
+      @command.run([])
     end
 
     it "executes the #execute method" do
       stdout.should_not be_empty
     end
 
-    it "provides access to the argument list" do
-      stdout.should == @abc.inspect
-    end
-
   end
 
   describe ".option" do
@@ -122,6 +117,7 @@ describe Clamp::Command do
       @command.class.option "--flavour", "FLAVOUR", "Flavour of the month"
       @command.class.option "--color", "COLOR", "Preferred hue"
       @command.class.option "--[no-]nuts", :flag, "Nuts (or not)"
+      @command.class.parameter "[ARG] ...", "extra arguments", :attribute_name => :arguments
     end
 
     describe "#parse" do
@@ -139,7 +135,7 @@ describe Clamp::Command do
       describe "with options" do
 
         before do
-          @command.parse(%w(--flavour strawberry --nuts --color blue a b c))
+          @command.parse(%w(--flavour strawberry --nuts --color blue))
         end
 
         it "maps the option values onto the command object" do
@@ -148,10 +144,6 @@ describe Clamp::Command do
           @command.nuts?.should == true
         end
 
-        it "retains unconsumed arguments" do
-          @command.arguments.should == %w(a b c)
-        end
-
       end
 
       describe "with option-like things beyond the arguments" do
@@ -282,9 +274,14 @@ describe Clamp::Command do
 
     describe "#parse" do
     
-      it "retains arguments for handling by #execute" do
-        @command.parse(["crash", "bang", "wallop"])
-        @command.arguments.should == ["crash", "bang", "wallop"]
+      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
@@ -313,10 +310,6 @@ describe Clamp::Command do
           @command.z.should == "wallop"
         end
 
-        it "consumes all the arguments" do
-          @command.arguments.should == []
-        end
-        
       end
 
       describe "with insufficient arguments" do
@@ -395,6 +388,12 @@ describe Clamp::Command do
   describe ".run" do
 
     it "creates a new Command instance and runs it" do
+      @command.class.class_eval do
+        parameter "WORD ...", "words"
+        def execute
+          print word_list.inspect
+        end
+      end
       @xyz = %w(x y z)
       @command.class.run("cmd", @xyz)
       stdout.should == @xyz.inspect

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clamp
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mike Williams