acclaim 0.0.6 → 0.0.7

data/lib/acclaim/command.rb

@@ -49,9 +49,9 @@ module Acclaim
     module ClassMethods
 
       # String which calls this command.
-      def line(value = nil)
-        @line = value
-        @line ||= name.gsub(/^.*::/, '').downcase
+      def line(*args)
+        @line = args.first unless args.empty?
+        @line ||= (name.gsub(/^.*::/, '').downcase rescue nil)
       end
 
       # Commands which may be given to this command.
@@ -72,8 +72,8 @@ module Acclaim
       alias :opt :option
 
       # The block which is executed when this command is called. It is given 2
-      # parameters; the first is an Ribbon::Object instance which can be queried
-      # for settings information; the second is the remaining command line.
+      # parameters; the first is an Ribbon instance which can be queried for
+      # settings information; the second is the remaining command line.
       def action(&block)
         @action = block
       end
@@ -102,7 +102,7 @@ module Acclaim
 
       # Invokes this command with a fresh set of option values.
       def run(*args)
-        invoke Ribbon::Object.new, args
+        invoke Ribbon.new, args
         rescue Option::Parser::Error => e
           puts e.message
       end
@@ -116,7 +116,7 @@ module Acclaim
       # All argument separators will be deleted from the argument array before a
       # command is executed.
       def invoke(opts, args = [])
-        Ribbon::Object.merge! opts, parse_options!(args)
+        Ribbon.merge! opts, parse_options!(args)
         handle_special_options! opts, args
         if subcommand = parse_subcommands!(args)
           subcommand.invoke(opts, args)

data/lib/acclaim/option.rb

@@ -7,7 +7,7 @@ module Acclaim
   # Represents a command-line option.
   class Option
 
-    attr_accessor :key, :names, :description, :type, :default, :handler
+    attr_accessor :key, :names, :description, :type, :default, :handler, :on_multiple
 
     # Initializes a command line option. The +key+ is the object used to
     # associate this option with a value. The other arguments may be:
@@ -45,6 +45,7 @@ module Acclaim
       self.key         = key
       self.names       = matches.fetch true, []
       self.description = matches.fetch(false, []).first
+      self.on_multiple = options.fetch :on_multiple, :replace
       self.arity       = options[:arity]
       self.default     = options[:default]
       self.required    = options[:required]

data/lib/acclaim/option/parser.rb

@@ -14,16 +14,25 @@ module Acclaim
 
         # Raises an Error with the following error message:
         #
-        #   Wrong number of arguments (actual for minimum)
+        #   Wrong number of arguments (#{actual} for #{minimum})
         def self.raise_wrong_arg_number(actual, minimum, optional)
           raise self, "Wrong number of arguments (#{actual} for #{minimum})"
         end
 
         # Raises an Error with the following error message:
         #
-        #   Missing required argument (arg)
-        def self.raise_missing_arg(arg)
-          raise self, "Missing required argument (#{arg})"
+        #   Missing required argument (#{option.names.join '|'})
+        def self.raise_missing_required(option)
+          names = option.names.join '|'
+          raise self, "Missing required argument (#{names})"
+        end
+
+        # Raises an error with the following error message:
+        #
+        #   Multiple instances of [#{options.names.join ''}] encountered
+        def self.raise_multiple(option)
+          names = option.names.join '|'
+          raise self, "Multiple instances of [#{names}] encountered"
         end
 
       end
@@ -34,8 +43,8 @@ module Acclaim
       # options. If no option array is given, the argument array will be
       # preprocessed only.
       def initialize(argv, options = nil)
-        self.argv = argv
-        self.options = options
+        self.argv = argv || []
+        self.options = options || []
       end
 
       # Parses the meaning of the options given to this parser. If none were
@@ -51,13 +60,13 @@ module Acclaim
       #   options << Option.new(:verbose, '--verbose')
       #
       #   Option::Parser.new(args, options).parse!
-      #   => { Ribbon file:log.txt, verbose:true }
+      #   => {Ribbon file: "log.txt", verbose: true}
       #
       #   args
       #   => ["arg1", "arg2"]
       def parse!
         preprocess_argv!
-        parse_values! unless options.nil?
+        parse_values!
       end
 
       private
@@ -98,25 +107,23 @@ module Acclaim
       end
 
       # Parses the options and their arguments, associating that information
-      # with a Ribbon::Object instance.
+      # with a Ribbon instance.
       def parse_values!
-        ribbon = Ribbon::Object.new
+        ribbon = Ribbon.new
         options.each do |option|
           key = option.key
-          ribbon[key] = option.default unless ribbon[key]
+          ribbon[key] = option.default unless Ribbon[ribbon].has_key? key
           switches = argv.find_all { |switch| option =~ switch }
-          if switches.any?
+          Error.raise_missing_required option if option.required? and switches.empty?
+          Error.raise_multiple option if option.on_multiple == :raise and switches.count > 1
+          switches.each do |switch|
             if option.flag?
               found_boolean option, ribbon
-              argv.delete *switches
+              argv.delete_at argv.index(switch)
             else
-              switches.each do |switch|
-                params = extract_parameters_of! option, switch
-                found_params_for option, ribbon, params
-              end
+              params = extract_parameters_of! option, switch
+              found_params_for option, params, ribbon
             end
-          else
-            Error.raise_missing_arg(option.names.join ' | ') if option.required?
           end
         end
         ribbon
@@ -150,8 +157,8 @@ module Acclaim
         end
         count = values.count
         Error.raise_wrong_arg_number count, *arity if count < arity.required
-        argv.delete switch
-        values.each { |value| argv.delete value }
+        argv.slice! switch_index..(switch_index + count)
+        values
       end
 
       # If the option has an custom handler associated, it will be called with
@@ -160,22 +167,27 @@ module Acclaim
       # <tt>params.first</tt>, if the option takes only one argument, or to
       # +params+ if it takes more.
       #
+      # Appends +params+ to the current values of the option if the it specifies
+      # so. In this case, the value of the option will always be an array.
+      #
       # The parameters will be converted according to the option's type.
-      def found_params_for(option, values, params = [])
+      def found_params_for(option, params = [], ribbon = Ribbon.new)
         params = option.convert_parameters *params
-        if handler = option.handler then handler.call values, params
+        if handler = option.handler then handler.call ribbon, params
         else
+          key = option.key.to_sym
           value = option.arity.total == 1 ? params.first : params
-          values[option.key.to_sym] = value unless params.empty?
+          value = [*ribbon[key], *value] if option.on_multiple == :append
+          ribbon[option.key.to_sym] = value unless params.empty?
         end
       end
 
       # If the option has an custom handler associated, it will be called with
       # only the option values as the first argument. Otherwise, the value will
       # be set to <tt>true</tt>.
-      def found_boolean(option, values)
-        if handler = option.handler then handler.call values
-        else values[option.key.to_sym] = true end
+      def found_boolean(option, ribbon = Ribbon.new)
+        if handler = option.handler then handler.call ribbon
+        else ribbon[option.key.to_sym] = true end
       end
 
     end

data/lib/acclaim/option/parser/regexp.rb

@@ -7,9 +7,6 @@ module Acclaim
 
         # Regular expression for a short option switch.
         #
-        # Matches strings that begin with a single dash and contains only one
-        # word character before the end of the string.
-        #
         # Examples: <tt>-s; -_</tt>
         #
         # <tt>'-mult'</tt> should match MULTIPLE_SHORT_SWITCHES, and will be
@@ -19,11 +16,6 @@ module Acclaim
 
         # Regular expression for a long option switch.
         #
-        # Matches strings that begin with a double dash, contain one or more
-        # word character or digit, and can be followed by either nothing or a
-        # single dash. The latter must be followed by one or more word character
-        # or digit.
-        #
         # Examples: <tt>--long; --no-feature; --with_underscore;
         # --_private-option; --1-1</tt>
         LONG_SWITCH = /\A--[\w\d]+(-[\w\d]+)*\Z/
@@ -31,24 +23,12 @@ module Acclaim
         # Regular expression for multiple short options in a single "short"
         # switch.
         #
-        # Matches strings that begin with a single dash and are followed by 2 or
-        # more word characters, among which is the underscore but not the dash
-        # character.
-        #
-        # Examples: -xvf, -abc, -de_f
+        # Examples: <tt>-xvf; -abc; -de_f</tt>
         MULTIPLE_SHORT_SWITCHES = /\A-\w{2,}\Z/
 
         # Regular expression for a long switch connected to its parameters with
         # an equal sign. Multiple parameters are be separated by commas.
         #
-        # Matches strings that begin with a double dash, are followed by one or
-        # more word character or digit and may be followed by one dash and one
-        # or more word character or digit.
-        #
-        # After that, there must be an equals sign, which must be followed by
-        # either nothing, any number of commmas or any number of word characters
-        # or digits.
-        #
         # Examples:
         # <tt>
         # --switch=PARAM; --files=f1,f2,f3; --weird=,PARAM2; --empty=,,; --none=
@@ -63,15 +43,12 @@ module Acclaim
         SWITCH_PARAM_EQUALS = /\A--[\w\d]+(-[\w\d]+)*=(,*[\w\d]*)*\Z/
 
         # Regular expression for any kind of option switch.
-        #
-        # Matches anything that matches any of the other switch regular
-        # expressions.
         SWITCH = /(#{SHORT_SWITCH})|(#{LONG_SWITCH})|(#{MULTIPLE_SHORT_SWITCHES})|(#{SWITCH_PARAM_EQUALS})/
 
         # Regular expression for the string that separates options and their
         # parameters from arguments like filenames.
         #
-        # Matches strings made up of 2 or more dashes.
+        # Examples: <tt>--; ---</tt>
         ARGUMENT_SEPARATOR = /\A-{2,}\Z/
 
       end

data/lib/acclaim/version.rb

@@ -16,7 +16,7 @@ module Acclaim
     # Patch version.
     #
     # Increments denote changes in implementation.
-    PATCH = 6
+    PATCH = 7
 
     # Build version.
     #

data/spec/acclaim/command_spec.rb

@@ -0,0 +1,69 @@
+require 'acclaim/command'
+
+module Test; end
+class Test::Command < Acclaim::Command; end
+class Test::Command::Subcommand < Test::Command; end
+
+describe Acclaim::Command do
+
+  describe Test::Command do
+    subject { Test::Command }
+
+    describe '::line' do
+      context 'when not given a parameter' do
+        it 'should return the default command name of the class' do
+          subject.line.should == 'command'
+        end
+      end
+
+      context 'when given a parameter' do
+        let(:param) { 'test2' }
+        before(:all) { subject.line param }
+        after(:all) { subject.line nil } # Reset command name.
+
+        it 'should set the command name of the class' do
+          subject.line.should == param
+        end
+      end
+    end
+
+    describe '::subcommands' do
+      it 'should not be empty' do
+        subject.subcommands.should_not be_empty
+      end
+
+      it 'should include the subcommand' do
+        subject.subcommands.should include(Test::Command::Subcommand)
+      end
+    end
+  end
+
+  describe Test::Command::Subcommand do
+    subject { Test::Command::Subcommand }
+
+    describe '::line' do
+      context 'when not given a parameter' do
+        it 'should return the default command name of the class' do
+          subject.line.should == 'subcommand'
+        end
+      end
+
+      context 'when given a parameter' do
+        let(:param) { 'subcommand2' }
+        before(:all) { subject.line param }
+        after(:all) { subject.line nil } # Reset command name.
+
+        it 'should set the command name of the class' do
+          subject.line.should == param
+        end
+      end
+    end
+
+    describe '::subcommands' do
+      it 'should be empty' do
+        subject.subcommands.should be_empty
+      end
+    end
+  end
+
+end

data/spec/acclaim/option/parser_spec.rb

@@ -74,8 +74,8 @@ describe Acclaim::Option::Parser do
     end
 
     context 'when not given an array of options' do
-      it 'should not return any option values' do
-        subject.parse!.should be_nil
+      it 'should return an empty ribbon' do
+        subject.parse!.should_not be_nil
       end
     end
 
@@ -200,6 +200,49 @@ describe Acclaim::Option::Parser do
           end
         end
       end
+
+      context 'containing an option which' do
+        let!(:options) { [ Acclaim::Option.new(:files, '-f', arity: [1,0], on_multiple: on_multiple, &block) ] }
+        let!(:args) { %w(-f f1 -f f2 -f f3) }
+        let(:block) { nil }
+
+        context 'replaces the previously found value' do
+          let(:on_multiple) { :replace }
+
+          it 'should replace the value with the last argument found' do
+            subject.parse!.files.should == 'f3'
+          end
+        end
+
+        context 'appends to the previously found values' do
+          let(:on_multiple) { :append }
+
+          it 'should return all arguments' do
+            subject.parse!.files.should == %w(f1 f2 f3)
+          end
+
+          context 'but that was passed a handler block' do
+            let(:block) { proc { |values| values.files = :block } }
+
+            it 'should parse all options and arguments' do
+              subject.parse!
+              args.should be_empty
+            end
+
+            it "should use the handler to obtain the option's value" do
+              subject.parse!.files.should == :block
+            end
+          end
+        end
+
+        context 'raises an error if encountered multiple times' do
+          let(:on_multiple) { :raise }
+
+          it 'should raise a parser error' do
+            expect { subject.parse! }.to raise_error Acclaim::Option::Parser::Error, /multiple/i
+          end
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acclaim
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-27 00:00:00.000000000 Z
+date: 2012-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ribbon
-  requirement: &19367260 !ruby/object:Gem::Requirement
+  requirement: &17514000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19367260
+  version_requirements: *17514000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19366760 !ruby/object:Gem::Requirement
+  requirement: &17513440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19366760
+  version_requirements: *17513440
 - !ruby/object:Gem::Dependency
   name: rookie
-  requirement: &19366220 !ruby/object:Gem::Requirement
+  requirement: &17513000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19366220
+  version_requirements: *17513000
 description: Command-line option parser and command interface.
 email: matheus.a.m.moreira@gmail.com
 executables: []
@@ -76,6 +76,7 @@ files:
 - lib/acclaim/option/type/time.rb
 - lib/acclaim/option/type/uri.rb
 - lib/acclaim/version.rb
+- spec/acclaim/command_spec.rb
 - spec/acclaim/option/arity_spec.rb
 - spec/acclaim/option/parser_spec.rb
 - spec/acclaim/option_spec.rb
@@ -93,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 407623794010834174
+      hash: 1879446143954765838
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 407623794010834174
+      hash: 1879446143954765838
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10