clamp 0.0.7 → 0.0.9

data/spec/clamp/option_spec.rb

@@ -12,8 +12,8 @@ describe Clamp::Option do
       @option.long_switch.should == "--key-file"
     end
 
-    it "has an argument_type" do
-      @option.argument_type.should == "FILE"
+    it "has a type" do
+      @option.type.should == "FILE"
     end
 
     it "has a description" do
@@ -48,7 +48,7 @@ describe Clamp::Option do
 
     describe "#help" do
 
-      it "combines switch, argument_type and description" do
+      it "combines switch, type and description" do
         @option.help.should == ["--key-file FILE", "SSH identity"]
       end
 

data/spec/clamp/parameter_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe Clamp::Parameter do
+
+  describe "normal" do
+
+    before do
+      @parameter = Clamp::Parameter.new("COLOR", "hue of choice")
+    end
+
+    it "has a name" do
+      @parameter.name.should == "COLOR"
+    end
+
+    it "has a description" do
+      @parameter.description.should == "hue of choice"
+    end
+
+    describe "#attribute_name" do
+
+      it "is derived from the name" do
+        @parameter.attribute_name.should == "color"
+      end
+
+      it "can be overridden" do
+        @parameter = Clamp::Parameter.new("COLOR", "hue of choice", :attribute_name => "hue")
+        @parameter.attribute_name.should == "hue"
+      end
+
+    end
+
+    describe "#consume" do
+
+      it "consumes one argument" do
+        @arguments = %w(a b c)
+        @parameter.consume(@arguments).should == "a"
+        @arguments.should == %w(b c)
+      end
+
+      describe "with no arguments" do
+
+        it "raises an Argument error" do
+          @arguments = []
+          lambda do
+            @parameter.consume(@arguments)
+          end.should raise_error(ArgumentError)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "optional (name in square brackets)" do
+
+    before do
+      @parameter = Clamp::Parameter.new("[COLOR]", "hue of choice")
+    end
+
+    describe "#attribute_name" do
+
+      it "omits the brackets" do
+        @parameter.attribute_name.should == "color"
+      end
+
+    end
+
+    describe "#consume" do
+
+      it "consumes one argument" do
+        @arguments = %w(a b c)
+        @parameter.consume(@arguments).should == "a"
+        @arguments.should == %w(b c)
+      end
+
+      describe "with no arguments" do
+
+        it "returns nil" do
+          @arguments = []
+          @parameter.consume(@arguments).should == nil
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "list (name followed by ellipsis)" do
+
+    before do
+      @parameter = Clamp::Parameter.new("FILE ...", "files to process")
+    end
+
+    describe "#attribute_name" do
+
+      it "indicates multiplicity" do
+        @parameter.attribute_name.should == "file_list"
+      end
+
+    end
+
+    describe "#consume" do
+
+      it "consumes all the remaining arguments" do
+        @arguments = %w(a b c)
+        @parameter.consume(@arguments).should == %w(a b c)
+        @arguments.should == []
+      end
+
+      describe "with no arguments" do
+
+        it "raises an Argument error" do
+          @arguments = []
+          lambda do
+            @parameter.consume(@arguments)
+          end.should raise_error(ArgumentError)
+        end
+
+      end
+
+    end
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clamp
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Mike Williams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 +11:00
+date: 2010-11-11 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -41,15 +41,24 @@ files:
 - examples/rename
 - examples/speak
 - lib/clamp.rb
+- lib/clamp/attribute_declaration.rb
 - lib/clamp/command.rb
-- lib/clamp/help_support.rb
+- lib/clamp/command/declaration.rb
+- lib/clamp/errors.rb
+- lib/clamp/help.rb
 - lib/clamp/option.rb
-- lib/clamp/option_support.rb
-- lib/clamp/subcommand_support.rb
+- lib/clamp/option/declaration.rb
+- lib/clamp/option/parsing.rb
+- lib/clamp/parameter.rb
+- lib/clamp/parameter/declaration.rb
+- lib/clamp/parameter/parsing.rb
+- lib/clamp/subcommand/declaration.rb
+- lib/clamp/subcommand/execution.rb
 - lib/clamp/version.rb
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_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
@@ -89,4 +98,5 @@ test_files:
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_spec.rb
 - spec/clamp/option_spec.rb
+- spec/clamp/parameter_spec.rb
 - spec/spec_helper.rb

data/lib/clamp/option_support.rb

@@ -1,75 +0,0 @@
-require 'clamp/option'
-
-module Clamp
-
-  module OptionSupport
-
-    def option(switches, argument_type, description, opts = {}, &block)
-      option = Clamp::Option.new(switches, argument_type, description, opts)
-      declare_option(option, &block)
-    end
-
-    def has_options?
-      !declared_options.empty?
-    end
-
-    def declared_options
-      my_declared_options + inherited_declared_options
-    end
-
-    def recognised_options
-      declared_options + standard_options
-    end
-
-    def find_option(switch)
-      recognised_options.find { |o| o.handles?(switch) }
-    end
-
-    private
-
-    def my_declared_options
-      @my_declared_options ||= []
-    end
-
-    def declare_option(option, &block)
-      my_declared_options << option
-      declare_option_reader(option)
-      declare_option_writer(option, &block)
-    end
-
-    def inherited_declared_options
-      if superclass.respond_to?(:declared_options)
-        superclass.declared_options
-      else
-        []
-      end
-    end
-
-    HELP_OPTION = Clamp::Option.new("--help", :flag, "print help", :attribute_name => :help_requested)
-
-    def standard_options
-      [HELP_OPTION]
-    end
-
-    def declare_option_reader(option)
-      reader_name = option.attribute_name
-      reader_name += "?" if option.flag?
-      define_method(reader_name) do
-        value = instance_variable_get("@#{option.attribute_name}")
-        value = option.default_value if value.nil?
-        value
-      end
-    end
-
-    def declare_option_writer(option, &block)
-      define_method("#{option.attribute_name}=") do |value|
-        if block
-          value = instance_exec(value, &block)
-        end
-        instance_variable_set("@#{option.attribute_name}", value)
-      end
-    end
-
-  end
-
-end

data/lib/clamp/subcommand_support.rb

@@ -1,35 +0,0 @@
-module Clamp
-
-  class Subcommand < Struct.new(:name, :description, :subcommand_class)
-
-    def help
-      [name, description]
-    end
-
-  end
-
-  module SubcommandSupport
-
-    def recognised_subcommands
-      @recognised_subcommands ||= []
-    end
-
-    def 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
-
-    def has_subcommands?
-      !recognised_subcommands.empty?
-    end
-
-    def find_subcommand(name)
-      recognised_subcommands.find { |sc| sc.name == name }
-    end
-
-  end
-
-end