clamp 0.5.0 → 0.5.1

data/spec/clamp/option_module_spec.rb

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

data/spec/clamp/option_spec.rb

@@ -4,31 +4,31 @@ describe Clamp::Option do
 
   describe "with String argument" do
 
-    before do
-      @option = Clamp::Option.new("--key-file", "FILE", "SSH identity")
+    let(:option) do
+      Clamp::Option.new("--key-file", "FILE", "SSH identity")
     end
 
     it "has a long_switch" do
-      @option.long_switch.should == "--key-file"
+      option.long_switch.should == "--key-file"
     end
 
     it "has a type" do
-      @option.type.should == "FILE"
+      option.type.should == "FILE"
     end
 
     it "has a description" do
-      @option.description.should == "SSH identity"
+      option.description.should == "SSH identity"
     end
 
     describe "#attribute_name" do
 
       it "is derived from the (long) switch" do
-        @option.attribute_name.should == "key_file"
+        option.attribute_name.should == "key_file"
       end
 
       it "can be overridden" do
-        @option = Clamp::Option.new("--key-file", "FILE", "SSH identity", :attribute_name => "ssh_identity")
-        @option.attribute_name.should == "ssh_identity"
+        option = Clamp::Option.new("--key-file", "FILE", "SSH identity", :attribute_name => "ssh_identity")
+        option.attribute_name.should == "ssh_identity"
       end
 
     end
@@ -36,12 +36,13 @@ describe Clamp::Option do
     describe "#default_value" do
 
       it "defaults to nil" do
-        @option.default_value.should == nil
+        option = Clamp::Option.new("-n", "N", "iterations")
+        option.default_value.should == nil
       end
 
       it "can be overridden" do
-        @option = Clamp::Option.new("-n", "N", "iterations", :default => 1)
-        @option.default_value.should == 1
+        option = Clamp::Option.new("-n", "N", "iterations", :default => 1)
+        option.default_value.should == 1
       end
 
     end
@@ -49,7 +50,7 @@ describe Clamp::Option do
     describe "#help" do
 
       it "combines switch, type and description" do
-        @option.help.should == ["--key-file FILE", "SSH identity"]
+        option.help.should == ["--key-file FILE", "SSH identity"]
       end
 
     end
@@ -58,14 +59,14 @@ describe Clamp::Option do
 
   describe "flag" do
 
-    before do
-      @option = Clamp::Option.new("--verbose", :flag, "Blah blah blah")
+    let(:option) do
+      Clamp::Option.new("--verbose", :flag, "Blah blah blah")
     end
 
     describe "#help" do
 
       it "excludes option argument" do
-        @option.help.should == ["--verbose", "Blah blah blah"]
+        option.help.should == ["--verbose", "Blah blah blah"]
       end
 
     end
@@ -74,20 +75,20 @@ describe Clamp::Option do
 
   describe "negatable flag" do
 
-    before do
-      @option = Clamp::Option.new("--[no-]force", :flag, "Force installation")
+    let(:option) do
+      Clamp::Option.new("--[no-]force", :flag, "Force installation")
     end
 
     it "handles both positive and negative forms" do
-      @option.handles?("--force").should be_true
-      @option.handles?("--no-force").should be_true
+      option.handles?("--force").should be_true
+      option.handles?("--no-force").should be_true
     end
 
     describe "#flag_value" do
 
       it "returns true for the positive variant" do
-        @option.flag_value("--force").should be_true
-        @option.flag_value("--no-force").should be_false
+        option.flag_value("--force").should be_true
+        option.flag_value("--no-force").should be_false
       end
 
     end
@@ -95,7 +96,7 @@ describe Clamp::Option do
     describe "#attribute_name" do
 
       it "is derived from the (long) switch" do
-        @option.attribute_name.should == "force"
+        option.attribute_name.should == "force"
       end
 
     end
@@ -104,19 +105,19 @@ describe Clamp::Option do
 
   describe "with both short and long switches" do
 
-    before do
-      @option = Clamp::Option.new(["-k", "--key-file"], "FILE", "SSH identity")
+    let(:option) do
+      Clamp::Option.new(["-k", "--key-file"], "FILE", "SSH identity")
     end
 
     it "handles both switches" do
-      @option.handles?("--key-file").should be_true
-      @option.handles?("-k").should be_true
+      option.handles?("--key-file").should be_true
+      option.handles?("-k").should be_true
     end
 
     describe "#help" do
 
       it "includes both switches" do
-        @option.help.should == ["-k, --key-file FILE", "SSH identity"]
+        option.help.should == ["-k, --key-file FILE", "SSH identity"]
       end
 
     end
@@ -125,28 +126,28 @@ describe Clamp::Option do
 
   describe "with an associated environment variable" do
 
-    before do
-      @option = Clamp::Option.new("-x", "X", "mystery option", :environment_variable => "APP_X")
+    let(:option) do
+      Clamp::Option.new("-x", "X", "mystery option", :environment_variable => "APP_X")
     end
 
     describe "#help" do
 
       it "describes environment variable" do
-        @option.help.should == ["-x X", "mystery option (default: $APP_X)"]
+        option.help.should == ["-x X", "mystery option (default: $APP_X)"]
       end
 
     end
 
     describe "and a default value" do
 
-      before do
-        @option = Clamp::Option.new("-x", "X", "mystery option", :environment_variable => "APP_X", :default => "xyz")
+      let(:option) do
+        Clamp::Option.new("-x", "X", "mystery option", :environment_variable => "APP_X", :default => "xyz")
       end
 
       describe "#help" do
 
         it "describes both environment variable and default" do
-          @option.help.should == ["-x X", %{mystery option (default: $APP_X, or "xyz")}]
+          option.help.should == ["-x X", %{mystery option (default: $APP_X, or "xyz")}]
         end
 
       end
@@ -157,9 +158,9 @@ describe Clamp::Option do
 
   describe "in subcommand" do
 
-    before do
+    let(:command_class) do
 
-      @command = Class.new(Clamp::Command) do
+      Class.new(Clamp::Command) do
         subcommand "foo", "FOO!" do
           option "--bar", "BAR", "Bars foo."
         end
@@ -170,7 +171,7 @@ describe Clamp::Option do
     describe "Command#help" do
 
       it "includes help for each option exactly once" do
-        subcommand = @command.new("").send(:find_subcommand, 'foo')
+        subcommand = command_class.new("").send(:find_subcommand, 'foo')
         subcommand_help = subcommand.subcommand_class.help("")
         subcommand_help.lines.grep(/--bar BAR/).count.should == 1
       end

data/spec/clamp/parameter_spec.rb

@@ -4,27 +4,31 @@ describe Clamp::Parameter do
 
   describe "normal" do
 
-    before do
-      @parameter = Clamp::Parameter.new("COLOR", "hue of choice")
+    let(:parameter) do
+      Clamp::Parameter.new("COLOR", "hue of choice")
     end
 
     it "has a name" do
-      @parameter.name.should == "COLOR"
+      parameter.name.should == "COLOR"
     end
 
     it "has a description" do
-      @parameter.description.should == "hue of choice"
+      parameter.description.should == "hue of choice"
+    end
+
+    it "is single-valued" do
+      parameter.should_not be_multivalued
     end
 
     describe "#attribute_name" do
 
       it "is derived from the name" do
-        @parameter.attribute_name.should == "color"
+        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"
+        parameter = Clamp::Parameter.new("COLOR", "hue of choice", :attribute_name => "hue")
+        parameter.attribute_name.should == "hue"
       end
 
     end
@@ -32,17 +36,17 @@ describe Clamp::Parameter do
     describe "#consume" do
 
       it "consumes one argument" do
-        @arguments = %w(a b c)
-        @parameter.consume(@arguments).should == "a"
-        @arguments.should == %w(b c)
+        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 = []
+          arguments = []
           lambda do
-            @parameter.consume(@arguments)
+            parameter.consume(arguments)
           end.should raise_error(ArgumentError)
         end
 
@@ -54,14 +58,18 @@ describe Clamp::Parameter do
 
   describe "optional (name in square brackets)" do
 
-    before do
-      @parameter = Clamp::Parameter.new("[COLOR]", "hue of choice")
+    let(:parameter) do
+      Clamp::Parameter.new("[COLOR]", "hue of choice")
+    end
+
+    it "is single-valued" do
+      parameter.should_not be_multivalued
     end
 
     describe "#attribute_name" do
 
       it "omits the brackets" do
-        @parameter.attribute_name.should == "color"
+        parameter.attribute_name.should == "color"
       end
 
     end
@@ -69,16 +77,16 @@ describe Clamp::Parameter do
     describe "#consume" do
 
       it "consumes one argument" do
-        @arguments = %w(a b c)
-        @parameter.consume(@arguments).should == "a"
-        @arguments.should == %w(b c)
+        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
+          arguments = []
+          parameter.consume(arguments).should == nil
         end
 
       end
@@ -89,14 +97,18 @@ describe Clamp::Parameter do
 
   describe "list (name followed by ellipsis)" do
 
-    before do
-      @parameter = Clamp::Parameter.new("FILE ...", "files to process")
+    let(:parameter) do
+      Clamp::Parameter.new("FILE ...", "files to process")
+    end
+
+    it "is multi-valued" do
+      parameter.should be_multivalued
     end
 
     describe "#attribute_name" do
 
-      it "indicates multiplicity" do
-        @parameter.attribute_name.should == "file_list"
+      it "gets a _list suffix" do
+        parameter.attribute_name.should == "file_list"
       end
 
     end
@@ -104,35 +116,56 @@ describe Clamp::Parameter do
     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 == []
+        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 = []
+          arguments = []
           lambda do
-            @parameter.consume(@arguments)
+            parameter.consume(arguments)
           end.should raise_error(ArgumentError)
         end
 
       end
 
     end
+
+    context "with a weird parameter name, and an explicit attribute_name" do
+
+      let(:parameter) do
+        Clamp::Parameter.new("KEY=VALUE ...", "config-settings", :attribute_name => :config_settings)
+      end
+
+      describe "#attribute_name" do
+
+        it "is the specified one" do
+          parameter.attribute_name.should == "config_settings"
+        end
+
+      end
+
+    end
+
   end
 
   describe "optional list" do
 
-    before do
-      @parameter = Clamp::Parameter.new("[FILES] ...", "files to process")
+    let(:parameter) do
+      Clamp::Parameter.new("[FILES] ...", "files to process")
+    end
+
+    it "is multi-valued" do
+      parameter.should be_multivalued
     end
 
     describe "#attribute_name" do
 
-      it "indicates multiplicity" do
-        @parameter.attribute_name.should == "files_list"
+      it "gets a _list suffix" do
+        parameter.attribute_name.should == "files_list"
       end
 
     end
@@ -140,7 +173,7 @@ describe Clamp::Parameter do
     describe "#default_value" do
 
       it "is an empty list" do
-        @parameter.default_value.should == []
+        parameter.default_value.should == []
       end
 
     end
@@ -148,21 +181,21 @@ describe Clamp::Parameter do
     describe "#help" do
 
       it "does not include default" do
-        @parameter.help_rhs.should_not include("default:")
+        parameter.help_rhs.should_not include("default:")
       end
 
     end
 
     describe "with specified default value" do
 
-      before do
-        @parameter = Clamp::Parameter.new("[FILES] ...", "files to process", :default => %w(a b c))
+      let(:parameter) do
+        Clamp::Parameter.new("[FILES] ...", "files to process", :default => %w(a b c))
       end
 
       describe "#default_value" do
 
         it "is that specified" do
-          @parameter.default_value.should == %w(a b c)
+          parameter.default_value.should == %w(a b c)
         end
 
       end
@@ -170,7 +203,7 @@ describe Clamp::Parameter do
       describe "#help" do
 
         it "includes the default value" do
-          @parameter.help_rhs.should include("default:")
+          parameter.help_rhs.should include("default:")
         end
 
       end
@@ -178,16 +211,16 @@ describe Clamp::Parameter do
       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 == []
+          arguments = %w(a b c)
+          parameter.consume(arguments).should == %w(a b c)
+          arguments.should == []
         end
 
         describe "with no arguments" do
 
           it "don't override defaults" do
-            @arguments = []
-            @parameter.consume(@arguments).should == nil
+            arguments = []
+            parameter.consume(arguments).should == nil
           end
 
         end