clamp 0.1.5 → 0.1.6

data/README.markdown

@@ -42,7 +42,7 @@ Calling `run` on a command class creates an instance of it, then invokes it usin
 
     SpeakCommand.run
 
-Class-level methods like `option` and `parameter` declare attributes (in a similar way to `attr_accessor`), and arrange for them to be populated automatically based on command-line arguments.  They are aso used to generate `help` documentation.  
+Class-level methods like `option` and `parameter` declare attributes (in a similar way to `attr_accessor`), and arrange for them to be populated automatically based on command-line arguments.  They are also used to generate `help` documentation.  
 
 Declaring options
 -----------------
@@ -148,6 +148,26 @@ While Clamp provides an attribute-writer method for each declared option or para
       @server_address, @server_port = server.split(":")
     end
 
+### Default values
+
+Default values can be specified for options:
+
+    option "--flavour", "FLAVOUR", "ice-cream flavour", :default => "chocolate"
+
+and also for optional parameters
+
+    parameter "[HOST]", "server host", :default => "localhost"
+
+For more advanced cases, you can also specify default values by defining a method called "`default_#{attribute_name}`":
+
+    option "--http-port", "PORT", "web-server port", :default => 9000
+
+    option "--admin-port", "PORT", "admin port"
+
+    def default_admin_port
+       http_port + 1
+    end
+
 Declaring Subcommands
 ---------------------
 

data/clamp.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
 
   s.summary       = %q{a minimal framework for command-line utilities}
   s.description   = <<EOF
-Clamp makes provides an object-model for command-line utilities.  
+Clamp provides an object-model for command-line utilities.  
 It handles parsing of command-line options, and generation of usage help.
 EOF
 

data/lib/clamp/attribute_declaration.rb

@@ -6,6 +6,7 @@ module Clamp
     
     def define_accessors_for(attribute, &block)
       define_reader_for(attribute)
+      define_default_for(attribute)
       define_writer_for(attribute, &block)
     end
     
@@ -18,7 +19,15 @@ module Clamp
           instance_variable_get(ivar_name)
         elsif parent_command && parent_command.respond_to?(reader_name)
           parent_command.send(reader_name)
-        elsif attribute.respond_to?(:default_value)
+        elsif respond_to?("default_#{attribute.attribute_name}")
+          send("default_#{attribute.attribute_name}")
+        end
+      end
+    end
+
+    def define_default_for(attribute)
+      if attribute.respond_to?(:default_value)
+        define_method("default_#{attribute.attribute_name}") do
           attribute.default_value
         end
       end

data/lib/clamp/parameter.rb

@@ -9,12 +9,19 @@ module Clamp
       if options.has_key?(:attribute_name)
         @attribute_name = options[:attribute_name].to_s 
       end
+      if options.has_key?(:default)
+        @default_value = options[:default]
+      end
     end
 
-    attr_reader :name, :description, :attribute_name
+    attr_reader :name, :description, :attribute_name, :default_value
     
     def help
-      [name, description]
+      rhs = description
+      if defined?(@default_value)
+        rhs += " (default: #{@default_value.inspect})"
+      end
+      [name, rhs]
     end
 
     def consume(arguments)

data/lib/clamp/version.rb

@@ -1,3 +1,3 @@
 module Clamp
-  VERSION = "0.1.5".freeze
+  VERSION = "0.1.6".freeze
 end

data/spec/clamp/command_spec.rb

@@ -79,20 +79,37 @@ describe Clamp::Command do
 
     end
 
-    describe "with :default value" do
+    describe "with default method" do
 
-      given_command("cmd") do
-        option "--nodes", "N", "number of nodes", :default => 2
+      before do
+        @command.class.option "--port", "PORT", "port"
+        @command.class.class_eval do
+          def default_port
+            4321
+          end
+        end
       end
 
       it "sets the specified default value" do
-        @command.nodes.should == 2
+        @command.port.should == 4321
+      end
+      
+    end
+
+    describe "with :default value" do
+
+      before do
+        @command.class.option "--port", "PORT", "port to listen on", :default => 4321
+      end
+
+      it "declares default method" do
+        @command.default_port.should == 4321
       end
 
       describe "#help" do
         
         it "describes the default value" do
-          @command.help.should include("number of nodes (default: 2)")
+          @command.help.should include("port to listen on (default: 4321)")
         end
         
       end
@@ -297,6 +314,26 @@ describe Clamp::Command do
 
     end
 
+    describe "with :default value" do
+
+      before do
+        @command.class.parameter "[FLAVOUR]", "flavour of the month", :default => "chocolate"
+      end
+
+      it "sets the specified default value" do
+        @command.flavour.should == "chocolate"
+      end
+
+      describe "#help" do
+        
+        it "describes the default value" do
+          @command.help.should include("flavour of the month (default: \"chocolate\")")
+        end
+        
+      end
+      
+    end
+
     describe "with a block" do
 
       before do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clamp
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Mike Williams
@@ -15,12 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-02 00:00:00 +11:00
+date: 2011-01-29 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
 description: |
-  Clamp makes provides an object-model for command-line utilities.  
+  Clamp provides an object-model for command-line utilities.  
   It handles parsing of command-line options, and generation of usage help.
 
 email: mdub@dogbiscuit.org
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: a minimal framework for command-line utilities