clamp 0.5.1 → 0.6.0

data/spec/clamp/{option_spec.rb → option/definition_spec.rb}

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe Clamp::Option do
+describe Clamp::Option::Definition do
 
   describe "with String argument" do
 
     let(:option) do
-      Clamp::Option.new("--key-file", "FILE", "SSH identity")
+      described_class.new("--key-file", "FILE", "SSH identity")
     end
 
     it "has a long_switch" do
@@ -27,21 +27,29 @@ describe Clamp::Option do
       end
 
       it "can be overridden" do
-        option = Clamp::Option.new("--key-file", "FILE", "SSH identity", :attribute_name => "ssh_identity")
+        option = described_class.new("--key-file", "FILE", "SSH identity", :attribute_name => "ssh_identity")
         option.attribute_name.should == "ssh_identity"
       end
 
     end
 
+    describe "#write_method" do
+
+      it "is derived from the attribute_name" do
+        option.write_method.should == "key_file="
+      end
+
+    end
+
     describe "#default_value" do
 
       it "defaults to nil" do
-        option = Clamp::Option.new("-n", "N", "iterations")
+        option = described_class.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 = described_class.new("-n", "N", "iterations", :default => 1)
         option.default_value.should == 1
       end
 
@@ -60,7 +68,21 @@ describe Clamp::Option do
   describe "flag" do
 
     let(:option) do
-      Clamp::Option.new("--verbose", :flag, "Blah blah blah")
+      described_class.new("--verbose", :flag, "Blah blah blah")
+    end
+
+    describe "#default_conversion_block" do
+
+      it "converts truthy values to true" do
+        option.default_conversion_block.call("true").should == true
+        option.default_conversion_block.call("yes").should == true
+      end
+
+      it "converts falsey values to false" do
+        option.default_conversion_block.call("false").should == false
+        option.default_conversion_block.call("no").should == false
+      end
+
     end
 
     describe "#help" do
@@ -76,7 +98,7 @@ describe Clamp::Option do
   describe "negatable flag" do
 
     let(:option) do
-      Clamp::Option.new("--[no-]force", :flag, "Force installation")
+      described_class.new("--[no-]force", :flag, "Force installation")
     end
 
     it "handles both positive and negative forms" do
@@ -106,7 +128,7 @@ describe Clamp::Option do
   describe "with both short and long switches" do
 
     let(:option) do
-      Clamp::Option.new(["-k", "--key-file"], "FILE", "SSH identity")
+      described_class.new(["-k", "--key-file"], "FILE", "SSH identity")
     end
 
     it "handles both switches" do
@@ -127,7 +149,7 @@ describe Clamp::Option do
   describe "with an associated environment variable" do
 
     let(:option) do
-      Clamp::Option.new("-x", "X", "mystery option", :environment_variable => "APP_X")
+      described_class.new("-x", "X", "mystery option", :environment_variable => "APP_X")
     end
 
     describe "#help" do
@@ -141,7 +163,7 @@ describe Clamp::Option do
     describe "and a default value" do
 
       let(:option) do
-        Clamp::Option.new("-x", "X", "mystery option", :environment_variable => "APP_X", :default => "xyz")
+        described_class.new("-x", "X", "mystery option", :environment_variable => "APP_X", :default => "xyz")
       end
 
       describe "#help" do
@@ -156,6 +178,47 @@ describe Clamp::Option do
 
   end
 
+  describe "multivalued" do
+
+    let(:option) do
+      described_class.new(["-H", "--header"], "HEADER", "extra header", :multivalued => true)
+    end
+
+    it "is multivalued" do
+      option.should be_multivalued
+    end
+
+    describe "#default_value" do
+
+      it "defaults to an empty Array" do
+        option.default_value.should == []
+      end
+
+      it "can be overridden" do
+        option = described_class.new("-H", "HEADER", "extra header", :multivalued => true, :default => [1,2,3])
+        option.default_value.should == [1,2,3]
+      end
+
+    end
+
+    describe "#attribute_name" do
+
+      it "gets a _list suffix" do
+        option.attribute_name.should == "header_list"
+      end
+
+    end
+
+    describe "#write_method" do
+
+      it "is derived from the attribute_name" do
+        option.write_method.should == "append_to_header_list"
+      end
+
+    end
+
+  end
+
   describe "in subcommand" do
 
     let(:command_class) do
@@ -171,7 +234,7 @@ describe Clamp::Option do
     describe "Command#help" do
 
       it "includes help for each option exactly once" do
-        subcommand = command_class.new("").send(:find_subcommand, 'foo')
+        subcommand = command_class.send(:find_subcommand, 'foo')
         subcommand_help = subcommand.subcommand_class.help("")
         subcommand_help.lines.grep(/--bar BAR/).count.should == 1
       end
@@ -183,14 +246,14 @@ describe Clamp::Option do
   describe "a required option" do
     it "rejects :default" do
       expect do
-        Clamp::Option.new("--key-file", "FILE", "SSH identity",
+        described_class.new("--key-file", "FILE", "SSH identity",
                           :required => true, :default => "hello")
       end.to raise_error(ArgumentError)
     end
 
     it "rejects :flag options" do
       expect do
-        Clamp::Option.new("--awesome", :flag, "Be awesome?", :required => true)
+        described_class.new("--awesome", :flag, "Be awesome?", :required => true)
       end.to raise_error(ArgumentError)
     end
   end

data/spec/clamp/{parameter_spec.rb → parameter/definition_spec.rb}

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe Clamp::Parameter do
+describe Clamp::Parameter::Definition do
 
   describe "normal" do
 
     let(:parameter) do
-      Clamp::Parameter.new("COLOR", "hue of choice")
+      described_class.new("COLOR", "hue of choice")
     end
 
     it "has a name" do
@@ -27,7 +27,7 @@ describe Clamp::Parameter do
       end
 
       it "can be overridden" do
-        parameter = Clamp::Parameter.new("COLOR", "hue of choice", :attribute_name => "hue")
+        parameter = described_class.new("COLOR", "hue of choice", :attribute_name => "hue")
         parameter.attribute_name.should == "hue"
       end
 
@@ -37,7 +37,7 @@ describe Clamp::Parameter do
 
       it "consumes one argument" do
         arguments = %w(a b c)
-        parameter.consume(arguments).should == "a"
+        parameter.consume(arguments).should == ["a"]
         arguments.should == %w(b c)
       end
 
@@ -59,7 +59,7 @@ describe Clamp::Parameter do
   describe "optional (name in square brackets)" do
 
     let(:parameter) do
-      Clamp::Parameter.new("[COLOR]", "hue of choice")
+      described_class.new("[COLOR]", "hue of choice")
     end
 
     it "is single-valued" do
@@ -78,15 +78,15 @@ describe Clamp::Parameter do
 
       it "consumes one argument" do
         arguments = %w(a b c)
-        parameter.consume(arguments).should == "a"
+        parameter.consume(arguments).should == ["a"]
         arguments.should == %w(b c)
       end
 
       describe "with no arguments" do
 
-        it "returns nil" do
+        it "consumes nothing" do
           arguments = []
-          parameter.consume(arguments).should == nil
+          parameter.consume(arguments).should == []
         end
 
       end
@@ -98,7 +98,7 @@ describe Clamp::Parameter do
   describe "list (name followed by ellipsis)" do
 
     let(:parameter) do
-      Clamp::Parameter.new("FILE ...", "files to process")
+      described_class.new("FILE ...", "files to process")
     end
 
     it "is multi-valued" do
@@ -113,6 +113,14 @@ describe Clamp::Parameter do
 
     end
 
+    describe "#write_method" do
+
+      it "is derived from the attribute_name" do
+        parameter.write_method.should == "append_to_file_list"
+      end
+
+    end
+
     describe "#consume" do
 
       it "consumes all the remaining arguments" do
@@ -137,7 +145,7 @@ describe Clamp::Parameter do
     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)
+        described_class.new("KEY=VALUE ...", "config-settings", :attribute_name => :config_settings)
       end
 
       describe "#attribute_name" do
@@ -155,7 +163,7 @@ describe Clamp::Parameter do
   describe "optional list" do
 
     let(:parameter) do
-      Clamp::Parameter.new("[FILES] ...", "files to process")
+      described_class.new("[FILES] ...", "files to process")
     end
 
     it "is multi-valued" do
@@ -189,7 +197,7 @@ describe Clamp::Parameter do
     describe "with specified default value" do
 
       let(:parameter) do
-        Clamp::Parameter.new("[FILES] ...", "files to process", :default => %w(a b c))
+        described_class.new("[FILES] ...", "files to process", :default => %w(a b c))
       end
 
       describe "#default_value" do
@@ -220,7 +228,7 @@ describe Clamp::Parameter do
 
           it "don't override defaults" do
             arguments = []
-            parameter.consume(arguments).should == nil
+            parameter.consume(arguments).should == []
           end
 
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamp
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies: []
 description: ! "Clamp provides an object-model for command-line utilities.  \nIt handles
   parsing of command-line options, and generation of usage help.\n"
@@ -17,40 +17,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .autotest
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGES.md
 - Gemfile
-- README.markdown
+- README.md
 - Rakefile
 - clamp.gemspec
 - examples/admin
 - examples/flipflop
 - examples/fubar
 - examples/gitdown
+- examples/scoop
 - examples/speak
 - lib/clamp.rb
-- lib/clamp/attribute.rb
-- lib/clamp/attribute_declaration.rb
+- lib/clamp/attribute/declaration.rb
+- lib/clamp/attribute/definition.rb
 - lib/clamp/command.rb
 - lib/clamp/errors.rb
 - lib/clamp/help.rb
-- lib/clamp/option.rb
 - lib/clamp/option/declaration.rb
+- lib/clamp/option/definition.rb
 - lib/clamp/option/parsing.rb
-- lib/clamp/parameter.rb
 - lib/clamp/parameter/declaration.rb
+- lib/clamp/parameter/definition.rb
 - lib/clamp/parameter/parsing.rb
-- lib/clamp/subcommand.rb
 - lib/clamp/subcommand/declaration.rb
+- lib/clamp/subcommand/definition.rb
 - lib/clamp/subcommand/execution.rb
 - lib/clamp/subcommand/parsing.rb
+- lib/clamp/truthy.rb
 - lib/clamp/version.rb
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_spec.rb
+- spec/clamp/option/definition_spec.rb
 - spec/clamp/option_module_spec.rb
-- spec/clamp/option_spec.rb
-- spec/clamp/parameter_spec.rb
+- spec/clamp/parameter/definition_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/mdub/clamp
 licenses: []
@@ -78,7 +82,7 @@ summary: a minimal framework for command-line utilities
 test_files:
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_spec.rb
+- spec/clamp/option/definition_spec.rb
 - spec/clamp/option_module_spec.rb
-- spec/clamp/option_spec.rb
-- spec/clamp/parameter_spec.rb
+- spec/clamp/parameter/definition_spec.rb
 - spec/spec_helper.rb

data/lib/clamp/attribute.rb

@@ -1,44 +0,0 @@
-module Clamp
-
-  class Attribute
-
-    attr_reader :description, :attribute_name, :default_value, :environment_variable
-
-    def help_rhs
-      description + default_description
-    end
-
-    def help
-      [help_lhs, help_rhs]
-    end
-
-    def ivar_name
-      "@#{attribute_name}"
-    end
-
-    def read_method
-      attribute_name
-    end
-
-    def default_method
-      "default_#{read_method}"
-    end
-
-    def write_method
-      "#{attribute_name}="
-    end
-
-    private
-
-    def default_description
-      default_sources = [
-        ("$#{@environment_variable}" if defined?(@environment_variable)),
-        (@default_value.inspect if defined?(@default_value))
-      ].compact
-      return "" if default_sources.empty?
-      " (default: " + default_sources.join(", or ") + ")"
-    end
-
-  end
-
-end

data/lib/clamp/attribute_declaration.rb

@@ -1,40 +0,0 @@
-module Clamp
-
-  module AttributeDeclaration
-
-    protected
-
-    def define_accessors_for(attribute, &block)
-      define_reader_for(attribute)
-      define_default_for(attribute)
-      define_writer_for(attribute, &block)
-    end
-
-    def define_reader_for(attribute)
-      define_method(attribute.read_method) do
-        if instance_variable_defined?(attribute.ivar_name)
-          instance_variable_get(attribute.ivar_name)
-        else
-          send(attribute.default_method)
-        end
-      end
-    end
-
-    def define_default_for(attribute)
-      define_method(attribute.default_method) do
-        attribute.default_value
-      end
-    end
-
-    def define_writer_for(attribute, &block)
-      define_method(attribute.write_method) do |value|
-        if block
-          value = instance_exec(value, &block)
-        end
-        instance_variable_set(attribute.ivar_name, value)
-      end
-    end
-
-  end
-
-end