acclaim 0.0.1.alpha1 → 0.0.1.alpha2

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 1.9.3@acclaim

data/acclaim.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new('acclaim') do |gem|
   gem.version     = Acclaim::Version::STRING
   gem.summary     = 'Command-line option parser and command interface.'
   gem.description = gem.summary
+  gem.homepage    = 'https://github.com/matheusmoreira/acclaim'
 
   gem.author = 'Matheus Afonso Martins Moreira'
   gem.email  = 'matheus.a.m.moreira@gmail.com'

data/lib/acclaim/command.rb

@@ -1,5 +1,6 @@
 require 'acclaim/option'
 require 'acclaim/option/parser'
+require 'acclaim/options'
 
 module Acclaim
 
@@ -15,52 +16,112 @@ module Acclaim
   #
   # A command can be instantiated in the following form:
   #
-  #   cmd = Command.new :foo do
-  #     opt :verbose, short: '-v', long: '--verbose',
-  #                   description: 'Run verbosely', default: false
+  #   class App::Command < Acclaim::Command
+  #     opt :verbose, names: %w(-v --verbose), description: 'Run verbosely'
   #   end
   #
-  # TODO: make these class methods instead of instance methods, with one class
-  #       per command
+  # A subcommand can be created by inheriting from another command:
+  #
+  #   class App::Command::Do < App::Command
+  #     opt :what, names: %w(-W --what), description: 'Do what?', arity: [1, 0], required: true
+  #     when_called do |options, arguments|
+  #       puts "Verbose? #{options.verbose? ? 'yes' : 'no'}"
+  #       puts "Doing #{options.what} with #{arguments.inspect} now!"
+  #     end
+  #   end
+  #
+  # Then, in your application's binary, you may simply write:
+  #
+  #   App::Command.run *ARGV
+  #
+  # Subcommands inherit their parent's option processing:
+  #
+  #   $ app --verbose -W test do arg1 arg2
+  #   Verbose? yes
+  #   Doing test with ["arg1", "arg2"] now!
   class Command
 
-    attr_accessor :name, :action
+    # Module containing the class methods every command class should inherit.
+    module ClassMethods
 
-    # Initializes a command with a name and evalutes the block if one is given.
-    def initialize(name, &block)
-      self.name = name.to_s
-      instance_eval &block if block
-    end
+      # String which calls this command.
+      def line(value = nil)
+        @line = value if value
+        @line
+      end
 
-    # The options this command can take.
-    def options
-      @options ||= []
-    end
+      # Commands which may be given to this command.
+      def subcommands
+        @subcommands ||= []
+      end
 
-    def option(name, args)
-      args.merge!(:name => name) { |key, old, new| new }
-      options << Option.new(args)
-    end
+      # The options this command can take.
+      def options
+        @options ||= []
+      end
 
-    alias :opt :option
+      # Adds an option to this command.
+      def option(key, args = {})
+        args.merge!(key: key)
+        options << Option.new(args)
+      end
 
-    # Executes the command with the given options and arguments.
-    def execute(options, *args)
-      action.call options, *args
-    end
+      alias :opt :option
 
-    def parse_options!(*args)
-    end
+      # The block which is executed when this command is called. It is given 2
+      # parameters; the first is an Options instance which can be queried for
+      # settings information; the second is the remaining command line.
+      def action(&block)
+        @action = block
+      end
+
+      alias :when_called :action
+
+      # Parses the argument array using this command's set of options.
+      def parse_options!(args)
+        Option::Parser.new(args, options).parse!
+      end
+
+      # Invokes this command with a fresh set of options.
+      def run(*args)
+        invoke Options.new, args
+        rescue Option::Parser::Error => e
+          puts e.message
+      end
+
+      # Parses the argument array. If the first element of the argument array
+      # corresponds to a subcommand, it will be invoked with said array and
+      # with this command's parsed options. This command will be executed
+      # otherwise.
+      def invoke(opts, args = [])
+        opts.merge! parse_options!(args)
+        subcommands.find do |subcommand|
+          subcommand.line == args.first
+        end.tap do |subcommand|
+          if subcommand
+            args.delete subcommand.line
+            subcommand.invoke(opts, args)
+          else
+            execute(opts, args)
+          end
+        end
+      end
+
+      # Calls this command's action block with the given options and arguments.
+      def execute(opts, args)
+        @action.call opts, args
+      end
 
-    alias :call :execute
+      alias :call :execute
 
-    # The commands that may be given to this command.
-    def subcommands
-      @subcommands ||= []
     end
 
-    def subcommand(*args, &block)
-      subcommands << Command.new(*args, &block)
+    # Add the class methods to the subclass and add it to this command's list of
+    # subcommands.
+    def self.inherited(sub)
+      sub.extend ClassMethods
+      sub.line sub.name.gsub(/^.*::/, '').downcase
+      subcommands << sub if respond_to? :subcommands
     end
 
   end

data/lib/acclaim/option.rb

@@ -3,7 +3,7 @@ module Acclaim
   # Represents a command-line option.
   class Option
 
-    attributes = %w(name short long description arity default).map!(&:to_sym).freeze
+    attributes = %w(key names description arity default).map!(&:to_sym).freeze
 
     attr_accessor *attributes
 
@@ -15,8 +15,19 @@ module Acclaim
     end
 
     def =~(str)
-      str = str.strip
-      long == str or short == str
+      names.include? str.strip
+    end
+
+    def required?
+      @required
+    end
+
+    def required=(value)
+      @required = value
+    end
+
+    def require
+      self.required = true
     end
 
     def flag?

data/lib/acclaim/option/parser.rb

@@ -6,7 +6,17 @@ module Acclaim
     # Parses arrays of strings and returns an Options instance containing data.
     class Parser
 
-      class Error < StandardError; end
+      class Error < StandardError
+
+        def self.raise_wrong_arg_number(actual, minimum, optional)
+          raise self, "Wrong number of arguments (#{actual} for #{minimum})"
+        end
+
+        def self.raise_missing_arg(arg)
+          raise self, "Missing required argument (#{arg})"
+        end
+
+      end
 
       attr_accessor :argv, :options
 
@@ -55,7 +65,7 @@ module Acclaim
       def build_options_instance!
         Options.new.tap do |options_instance|
           options.each do |option|
-            key = option.name.to_s.to_sym
+            key = option.key.to_sym
             options_instance[key] = option.default
             args = argv.find_all { |arg| option =~ arg }
             if args.any?
@@ -73,13 +83,15 @@ module Acclaim
                   params = argv[arg_index + 1, len]
                   values = []
                   params.each do |param|
-                    break if param.nil? or param =~ /^-{1,2}/ or param =~ /^-{2,}$/
-                    values << param
+                    case param
+                      when nil, /^-{1,2}/, /^-{2,}$/ then break
+                      else
+                        break if optional >= 0 and values.count >= minimum + optional
+                        values << param
+                    end
                   end
                   count = values.count
-                  if count < minimum
-                    raise Error, "Wrong number of arguments (%d for %d)" % [count, minimum]
-                  end
+                  Error.raise_wrong_arg_number count, *option.arity if count < minimum
                   options_instance[key] = if minimum == 1 and optional.zero?
                     values.first
                   else
@@ -89,6 +101,8 @@ module Acclaim
                 end
               end
               args.each { |arg| argv.delete arg }
+            else
+              Error.raise_missing_arg(option.names.join ' | ') if option.required?
             end
           end
         end

data/lib/acclaim/options.rb

@@ -11,6 +11,10 @@ module Acclaim
       data[key] = value
     end
 
+    def merge!(other, &block)
+      data.merge! other.data, &block
+    end
+
     # Handles the following cases:
     #
     #   options.method = value
@@ -28,7 +32,7 @@ module Acclaim
       end
     end
 
-    private
+    protected
 
     # The option values
     def data

data/lib/acclaim/version.rb

@@ -4,7 +4,7 @@ module Acclaim
     MAJOR = 0
     MINOR = 0
     PATCH = 1
-    BUILD = 'alpha1'
+    BUILD = 'alpha2'
 
     STRING = [ MAJOR, MINOR, PATCH, BUILD ].compact.join '.'
 

data/spec/acclaim/option/parser_spec.rb

@@ -6,7 +6,7 @@ describe Acclaim::Option::Parser do
   describe '#parse!' do
 
     let!(:args) do
-      %w(cmd subcmd -a -b PARAM1 -cdef PARAM2 --long --parameters PARAM3 PARAM4 -- FILE1 FILE2)
+      %w(cmd -a subcmd -b PARAM1 -cdef PARAM2 --long --parameters PARAM3 PARAM4 PARAM5 -- FILE1 FILE2)
     end
 
     subject { Acclaim::Option::Parser.new(args) }
@@ -32,13 +32,14 @@ describe Acclaim::Option::Parser do
       let(:options) do
         [].tap do |opts|
           ('a'..'f').each do |c|
-            hash = { name: c, short: "-#{c}" }
+            hash = { key: c, names: ["-#{c}"] }
             hash[:arity] = [1, 0] if c == 'b' or c == 'f'
+            hash[:required] = true if c == 'd'
             opts << Acclaim::Option.new(hash)
           end
-          opts << Acclaim::Option.new(name: 'long', long: '--long')
-          opts << Acclaim::Option.new(name: 'params', long: '--parameters',
-                                      arity: [1, -1], default: [])
+          opts << Acclaim::Option.new(key: 'long', names: ['--long'])
+          opts << Acclaim::Option.new(key: 'params', names: ['--parameters'],
+                                      arity: [1, 1], default: [])
         end
       end
 
@@ -63,7 +64,29 @@ describe Acclaim::Option::Parser do
 
       it 'should leave unparsed arguments in argv' do
         subject.parse!
-        args.should == %w(cmd subcmd -- FILE1 FILE2)
+        args.should == %w(cmd subcmd PARAM5 -- FILE1 FILE2)
+      end
+
+      context 'but not given a required parameter' do
+
+        let!(:args) { %w(-db) }
+
+        it 'should raise an error' do
+          expect { subject.parse! }.to raise_error Acclaim::Option::Parser::Error,
+                                                   /number of arguments/
+        end
+
+      end
+
+      context 'but not passed a required option' do
+
+        let!(:args) { [] }
+
+        it 'should raise an error' do
+          expect { subject.parse! }.to raise_error Acclaim::Option::Parser::Error,
+                                                   /required/
+        end
+
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acclaim
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha1
+  version: 0.0.1.alpha2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000 Z
+date: 2011-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14045320 !ruby/object:Gem::Requirement
+  requirement: &7316860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14045320
+  version_requirements: *7316860
 description: Command-line option parser and command interface.
 email: matheus.a.m.moreira@gmail.com
 executables: []
@@ -29,6 +29,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - LICENSE.GPLv3
 - README.markdown
@@ -41,7 +42,7 @@ files:
 - lib/acclaim/options.rb
 - lib/acclaim/version.rb
 - spec/acclaim/option/parser_spec.rb
-homepage: 
+homepage: https://github.com/matheusmoreira/acclaim
 licenses: []
 post_install_message: 
 rdoc_options: []