jls-clamp 0.3.1

data/spec/clamp/option_module_spec.rb

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

data/spec/clamp/option_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+describe Clamp::Option do
+
+  describe "with String argument" do
+
+    before do
+      @option = Clamp::Option.new("--key-file", "FILE", "SSH identity")
+    end
+
+    it "has a long_switch" do
+      @option.long_switch.should == "--key-file"
+    end
+
+    it "has a type" do
+      @option.type.should == "FILE"
+    end
+
+    it "has a description" do
+      @option.description.should == "SSH identity"
+    end
+
+    describe "#attribute_name" do
+
+      it "is derived from the (long) switch" do
+        @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"
+      end
+
+    end
+
+    describe "#default_value" do
+
+      it "defaults to nil" do
+        @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
+      end
+
+    end
+
+    describe "#help" do
+
+      it "combines switch, type and description" do
+        @option.help.should == ["--key-file FILE", "SSH identity"]
+      end
+
+    end
+
+  end
+
+  describe "flag" do
+    
+    before do
+      @option = Clamp::Option.new("--verbose", :flag, "Blah blah blah")
+    end
+
+    describe "#help" do
+
+      it "excludes option argument" do
+        @option.help.should == ["--verbose", "Blah blah blah"]
+      end
+
+    end
+    
+  end
+
+  describe "negatable flag" do
+    
+    before do
+      @option = 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
+    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
+      end
+
+    end
+    
+    describe "#attribute_name" do
+
+      it "is derived from the (long) switch" do
+        @option.attribute_name.should == "force"
+      end
+
+    end
+    
+  end
+
+  describe "with both short and long switches" do
+
+    before do
+      @option = 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
+    end
+
+    describe "#help" do
+
+      it "includes both switches" do
+        @option.help.should == ["-k, --key-file FILE", "SSH identity"]
+      end
+
+    end
+
+  end
+
+  describe "in subcommand" do
+    before do
+
+      @command = Class.new(Clamp::Command) do
+        subcommand "foo", "FOO!" do
+          option "--bar", "BAR", "Bars foo."
+        end
+      end
+
+    end
+
+    describe "Command#help" do
+
+      it "includes help for each option exactly once" do
+        subcommand = @command.new("").send(:find_subcommand, 'foo')
+        subcommand_help = subcommand.subcommand_class.help("")
+        subcommand_help.lines.grep(/--bar BAR/).count.should == 1
+      end
+
+    end
+
+  end
+  
+end

data/spec/clamp/parameter_spec.rb

@@ -0,0 +1,201 @@
+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
+
+  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

@@ -0,0 +1,45 @@
+require "rspec"
+require "clamp"
+require 'stringio'
+
+RSpec.configure do |config|
+
+  config.mock_with :rr
+
+end
+
+module OutputCapture
+
+  def self.included(target)
+
+    target.before do
+      $stdout = @out = StringIO.new
+      $stderr = @err = StringIO.new
+    end
+
+    target.after do
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+
+  end
+
+  def stdout
+    @out.string
+  end
+
+  def stderr
+    @err.string
+  end
+
+end
+
+module CommandFactory
+
+  def given_command(name, &block)
+    before do
+      @command = Class.new(Clamp::Command, &block).new(name)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: jls-clamp
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 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"
+email: mdub@dogbiscuit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.markdown
+- Rakefile
+- clamp.gemspec
+- examples/flipflop
+- examples/fubar
+- examples/gitdown
+- examples/speak
+- lib/clamp.rb
+- lib/clamp/attribute.rb
+- lib/clamp/attribute_declaration.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/parsing.rb
+- lib/clamp/parameter.rb
+- lib/clamp/parameter/declaration.rb
+- lib/clamp/parameter/parsing.rb
+- lib/clamp/subcommand.rb
+- lib/clamp/subcommand/declaration.rb
+- lib/clamp/subcommand/parsing.rb
+- lib/clamp/version.rb
+- spec/clamp/command_group_spec.rb
+- spec/clamp/command_spec.rb
+- spec/clamp/option_module_spec.rb
+- spec/clamp/option_spec.rb
+- spec/clamp/parameter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mdub/clamp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: a minimal framework for command-line utilities
+test_files:
+- spec/clamp/command_group_spec.rb
+- spec/clamp/command_spec.rb
+- spec/clamp/option_module_spec.rb
+- spec/clamp/option_spec.rb
+- spec/clamp/parameter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: