clamp 0.3.0 → 0.3.1

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 .bundle
+.rvmrc
 .yardoc
 doc
 pkg/*

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -4,6 +4,6 @@ gemspec
 
 group :test do
   gem "rake"
-  gem "rspec", "~> 2.0.1"
-  gem "rr", "~> 1.0.0"
+  gem "rspec", "~> 2.6.0"
+  gem "rr", "~> 1.0.4"
 end

data/README.markdown

@@ -246,6 +246,28 @@ All Clamp commands support a "`--help`" option, which outputs brief usage docume
         -n, --iterations N            say it N times (default: 1)
         -h, --help                    print help
 
+License
+-------
+
+Copyright (C) 2011 [Mike Williams](mailto:mdub@dogbiscuit.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 Contributing to Clamp
 ---------------------
 

data/lib/clamp/attribute.rb

@@ -1,5 +1,5 @@
 module Clamp
-  
+
   class Attribute
 
     attr_reader :description, :attribute_name, :default_value
@@ -11,27 +11,27 @@ module Clamp
       end
       rhs
     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
 
   end
-  
+
 end

data/lib/clamp/attribute_declaration.rb

@@ -14,7 +14,7 @@ module Clamp
       define_method(attribute.read_method) do
         if instance_variable_defined?(attribute.ivar_name)
           instance_variable_get(attribute.ivar_name)
-        elsif respond_to?(attribute.default_method)
+        else
           send(attribute.default_method)
         end
       end

data/lib/clamp/option/declaration.rb

@@ -30,7 +30,7 @@ module Clamp
       private
 
       def declare_implicit_options
-        return nil if @implicit_options_declared
+        return nil if defined?(@implicit_options_declared)
         unless effective_options.find { |o| o.handles?("--help") }
           help_switches = ["--help"]
           help_switches.unshift("-h") unless effective_options.find { |o| o.handles?("-h") }

data/lib/clamp/parameter.rb

@@ -9,7 +9,7 @@ module Clamp
       @description = description
       infer_attribute_name_and_multiplicity
       if options.has_key?(:attribute_name)
-        @attribute_name = options[:attribute_name].to_s 
+        @attribute_name = options[:attribute_name].to_s
       end
       if options.has_key?(:default)
         @default_value = options[:default]
@@ -17,7 +17,7 @@ module Clamp
     end
 
     attr_reader :name, :attribute_name
-    
+
     def help_lhs
       name
     end
@@ -27,16 +27,26 @@ module Clamp
         raise ArgumentError, "no value provided"
       end
       if multivalued?
-        arguments.shift(arguments.length)
+        if arguments.length > 0
+          arguments.shift(arguments.length)
+        end
       else
         arguments.shift
       end
     end
-    
+
+    def default_value
+      if defined?(@default_value)
+        @default_value
+      elsif multivalued?
+        []
+      end
+    end
+
     private
 
     NAME_PATTERN = "([A-Za-z0-9_-]+)"
-    
+
     def infer_attribute_name_and_multiplicity
       case @name
       when /^\[#{NAME_PATTERN}\]$/
@@ -56,7 +66,7 @@ module Clamp
       end
       @attribute_name = @attribute_name.downcase.tr('-', '_')
     end
-    
+
     def multivalued?
       @multivalued
     end
@@ -64,7 +74,7 @@ module Clamp
     def required?
       @required
     end
-    
+
   end
 
-end
+end

data/lib/clamp/subcommand/declaration.rb

@@ -29,7 +29,7 @@ module Clamp
 
       def default_subcommand(*args, &block)
         if args.empty?
-          @default_subcommand
+          @default_subcommand ||= nil
         else
           $stderr.puts "WARNING: Clamp default_subcommand syntax has changed; check the README."
           $stderr.puts "  (from #{caller.first})"

data/lib/clamp/subcommand/parsing.rb

@@ -28,9 +28,8 @@ module Clamp
         subcommand_class = find_subcommand(name).subcommand_class
         subcommand = subcommand_class.new("#{invocation_path} #{name}", context)
         self.class.recognised_options.each do |option|
-          option_set = instance_variable_defined?(option.ivar_name)
-          if option_set && subcommand.respond_to?(option.write_method)
-            subcommand.send(option.write_method, self.send(option.read_method))
+          if instance_variable_defined?(option.ivar_name)
+            subcommand.instance_variable_set(option.ivar_name, instance_variable_get(option.ivar_name))
           end
         end
         subcommand
@@ -39,4 +38,4 @@ module Clamp
     end
 
   end
-end
+end

data/lib/clamp/version.rb

@@ -1,3 +1,3 @@
 module Clamp
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

data/spec/clamp/command_group_spec.rb

@@ -243,4 +243,25 @@ describe Clamp::Command do
 
   end
 
+  describe "with a subcommand, with options" do
+
+    given_command 'weeheehee' do
+      option '--json', 'JSON', 'a json blob' do |option|
+        print "parsing!"
+        option
+      end
+
+      subcommand 'woohoohoo', 'like weeheehee but with more o' do
+        def execute
+        end
+      end
+    end
+
+    it "only parses options once" do
+      @command.run(['--json', '{"a":"b"}', 'woohoohoo'])
+      stdout.should == 'parsing!'
+    end
+
+  end
+
 end

data/spec/clamp/command_spec.rb

@@ -301,7 +301,7 @@ describe Clamp::Command do
         @command.help.should =~ %r(--flavour FLAVOUR +Flavour of the month)
         @command.help.should =~ %r(--color COLOR +Preferred hue)
       end
-      
+
       it "handles new lines in option descriptions" do
         @command.help.should =~ %r(--\[no-\]nuts +Nuts \(or not\)\n +May include nuts)
       end
@@ -411,6 +411,33 @@ describe Clamp::Command do
 
     end
 
+    describe "with ellipsis" do
+
+      before do
+        @command.class.parameter "FILE ...", "files"
+      end
+
+      it "accepts multiple arguments" do
+        @command.parse(%w(X Y Z))
+        @command.file_list.should == %w(X Y Z)
+      end
+
+    end
+
+    describe "optional, with ellipsis" do
+
+      before do
+        @command.class.parameter "[FILE] ...", "files"
+      end
+
+      it "default to an empty list" do
+        @command.parse([])
+        @command.default_file_list.should == []
+        @command.file_list.should == []
+      end
+
+    end
+
   end
 
   describe "with no parameters declared" do
@@ -497,9 +524,9 @@ describe Clamp::Command do
       it "includes parameter details" do
         @command.help.should =~ %r(X +x)
         @command.help.should =~ %r(Y +y)
-        @command.help.should =~ %r(\[Z\] +z \(default: "ZZZ"\))        
+        @command.help.should =~ %r(\[Z\] +z \(default: "ZZZ"\))
       end
-      
+
       it "handles new lines in option descriptions" do
         @command.help.should =~ %r(X +x\n +xx)
       end

data/spec/clamp/parameter_spec.rb

@@ -123,4 +123,79 @@ describe Clamp::Parameter do
     end
   end
 
+  describe "optional list" do
+
+    before do
+      @parameter = Clamp::Parameter.new("[FILES] ...", "files to process")
+    end
+
+    describe "#attribute_name" do
+
+      it "indicates multiplicity" do
+        @parameter.attribute_name.should == "files_list"
+      end
+
+    end
+
+    describe "#default_value" do
+
+      it "is an empty list" do
+        @parameter.default_value.should == []
+      end
+
+    end
+
+    describe "#help" do
+
+      it "does not include default" do
+        @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))
+      end
+
+      describe "#default_value" do
+
+        it "is that specified" do
+          @parameter.default_value.should == %w(a b c)
+        end
+
+      end
+
+      describe "#help" do
+
+        it "includes the default value" do
+          @parameter.help_rhs.should include("default:")
+        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 "don't override defaults" do
+            @arguments = []
+            @parameter.consume(@arguments).should == nil
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -2,14 +2,14 @@ require "rspec"
 require "clamp"
 require 'stringio'
 
-Rspec.configure do |config|
-  
+RSpec.configure do |config|
+
   config.mock_with :rr
 
 end
 
 module OutputCapture
-  
+
   def self.included(target)
 
     target.before do
@@ -21,7 +21,7 @@ module OutputCapture
       $stdout = STDOUT
       $stderr = STDERR
     end
-    
+
   end
 
   def stdout
@@ -35,7 +35,7 @@ module OutputCapture
 end
 
 module CommandFactory
-  
+
   def given_command(name, &block)
     before do
       @command = Class.new(Clamp::Command, &block).new(name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clamp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-30 00:00:00.000000000Z
+date: 2012-04-03 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"
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.markdown
 - Rakefile
@@ -63,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2140542804318955849
+      hash: -1856448867096069066
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -72,10 +73,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2140542804318955849
+      hash: -1856448867096069066
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: a minimal framework for command-line utilities