acclaim 0.0.3 → 0.0.4

data/Rakefile

@@ -1,44 +1,3 @@
-this_dir  = File.expand_path('..', __FILE__)
-gem_dir   = File.join this_dir, 'gem'
-spec_file = File.join this_dir, 'acclaim.gemspec'
+require 'rookie'
 
-spec = Gem::Specification.load spec_file
-
-task :mkdir do
-  FileUtils.mkdir_p gem_dir
-end
-
-task :gem => :mkdir do
-  gem_file = File.join this_dir, Gem::Builder.new(spec).build
-  FileUtils.mv gem_file, gem_dir
-end
-
-namespace :gem do
-
-  task :build => :gem
-
-  gem_file = File.join gem_dir, "#{spec.name}-#{spec.version}.gem"
-
-  task :push => :gem do
-    sh "gem push #{gem_file}"
-  end
-
-  task :install => :gem do
-    sh "gem install #{gem_file}"
-  end
-
-  task :uninstall do
-    sh "gem uninstall #{spec.name}"
-  end
-
-  task :clean do
-    FileUtils.rm_rf gem_dir
-  end
-
-end
-
-task :clean => 'gem:clean'
-
-task :setup => [ 'gem:install', :clean ]
-
-task :default => :setup
+Rookie::Tasks.new 'acclaim.gemspec'

data/acclaim.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new('acclaim') do |gem|
   gem.files       = `git ls-files`.split "\n"
 
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rookie'
 
 end

data/lib/acclaim/command.rb

@@ -64,25 +64,27 @@ module Acclaim
       end
 
       # Adds an option to this command.
-      def option(*args)
-        options << Option.new(*args)
+      def option(*args, &block)
+        options << Option.new(*args, &block)
       end
 
       alias :opt :option
 
       # 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.
+      # parameters; the first is an Option::Values 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
 
+      # Adds help subcommand and options to this command.
       def help(opts = {})
         subcommands << Help.create(self, opts)
       end
 
+      # Adds help subcommand and options to this command.
       def version(version_string, opts = {})
         subcommands << Version.create(self, version_string, opts)
       end
@@ -92,50 +94,43 @@ module Acclaim
         Option::Parser.new(args, options).parse!
       end
 
-      # Invokes this command with a fresh set of options.
+      # Invokes this command with a fresh set of option values.
       def run(*args)
         invoke Option::Values.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.
+      # Parses the argument array. The argument array will be searched for
+      # subcommands; if one is found, it will be invoked, if not, this command
+      # will be executed. A subcommand may be anywhere in the array as long as
+      # it is before an argument separator, which is tipically a double dash
+      # (<tt>--<\tt>) and may be omitted.
       def invoke(opts, args = [])
         opts.merge! parse_options!(args)
         handle_special_options! opts, args
-        arg_separator = args.find do |arg|
-          arg =~ Option::Parser::Regexp::ARGUMENT_SEPARATOR
-        end
-        separator_index = args.index arg_separator
-        subcommands.find do |subcommand|
-          index = args.index subcommand.line
-          # If we have the subcommand AND the separator, then we have it if the
-          # subcommand is before the separator.
-          index and (not separator_index or index < separator_index)
-        end.tap do |subcommand|
-          if subcommand
-            args.delete subcommand.line
-            subcommand.invoke(opts, args)
-          else
-            execute(opts, args)
-          end
+        if subcommand = find_subcommand_in(separated args)
+          args.delete subcommand.line
+          subcommand.invoke(opts, args)
+        else
+          execute(opts, args)
         end
       end
 
-      # Calls this command's action block with the given options and arguments.
+      # Calls this command's action block with the given option values and
+      # arguments.
       def execute(opts, args)
         @action.call opts, args
       end
 
       alias :call :execute
 
+      # True if this is a top-level command.
       def root?
         superclass == Acclaim::Command
       end
 
+      # Finds the root of the command hierarchy.
       def root
         command = self
         command = command.superclass until command.root?
@@ -150,6 +145,22 @@ module Acclaim
         const_get(:Version).execute opts, args if opts.acclaim_version?
       end
 
+      # Attempts to find a subcommand of this command in the given argument
+      # array. If a subcommand is found, it is returned, if not, nil is
+      # returned.
+      def find_subcommand_in(args)
+        subcommands.find do |subcommand|
+          args.include? subcommand.line
+        end
+      end
+
+      # Finds the argument separator and returns an array containing all the
+      # elements before it. If a separator is not present, the original array
+      # is returned.
+      def separated(args)
+        args.take_while { |arg| arg !~ Option::Parser::Regexp::ARGUMENT_SEPARATOR }
+      end
+
     end
 
     # Add the class methods to the subclass and add it to this command's list of

data/lib/acclaim/option.rb

@@ -1,23 +1,32 @@
 require 'acclaim/option/arity'
 require 'acclaim/option/parser/regexp'
+require 'acclaim/option/type'
 
 module Acclaim
 
   # Represents a command-line option.
   class Option
 
-    attr_accessor :key, :names, :description, :type, :default
+    attr_accessor :key, :names, :description, :type, :default, :handler
 
-    def initialize(key, *args)
+    def initialize(key, *args, &block)
       options = args.last.is_a?(Hash) ? args.pop : {}
+      matches = args.select { |arg| arg.is_a? String }.group_by do |arg|
+        arg =~ Parser::Regexp::SWITCH ? true : false
+      end
+      klass = args.find { |arg| arg.is_a? Class }
       self.key         = key
-      self.names       = args.find_all { |arg| arg =~ Parser::Regexp::SWITCH }
-      self.description = args.find     { |arg| arg !~ Parser::Regexp::SWITCH }
-      self.type        = args.find     { |arg| arg.is_a? Class }
+      self.names       = matches.fetch true, []
+      self.description = matches.fetch(false, []).first
       self.arity       = options[:arity]
       self.default     = options[:default]
       self.required    = options[:required]
-      yield self if block_given?
+      self.type        = klass || String
+      self.handler     = block
+    end
+
+    def convert_parameters(*args)
+      args.map { |arg| Type[type].call arg }
     end
 
     def =~(str)

data/lib/acclaim/option/parser.rb

@@ -73,39 +73,19 @@ module Acclaim
       def parse_values!
         Values.new.tap do |options_instance|
           options.each do |option|
-            key = option.key.to_sym
-            options_instance[key] = option.default
-            args = argv.find_all { |arg| option =~ arg }
-            if args.any?
+            key = option.key
+            options_instance[key] = option.default unless options_instance[key]
+            switches = argv.find_all { |switch| option =~ switch }
+            if switches.any?
               if option.flag?
-                options_instance[key] = true
+                set_option_value option, options_instance
               else
-                arity = option.arity
-                args.each do |arg|
-                  arg_index = argv.index arg
-                  len = if arity.bound?
-                    arg_index + arity.total
-                  else
-                    argv.length - 1
-                  end
-                  params = argv[arg_index + 1, len]
-                  values = []
-                  params.each do |param|
-                    case param
-                      when nil, SWITCH, ARGUMENT_SEPARATOR then break
-                      else
-                        break if arity.bound? and values.count >= arity.total
-                        values << param
-                    end
-                  end
-                  count = values.count
-                  Error.raise_wrong_arg_number count, *option.arity if count < arity.required
-                  value = if arity.total == 1 then values.first else values end
-                  options_instance[key] = value unless values.empty?
-                  values.each { |value| argv.delete value }
+                switches.each do |switch|
+                  params = extract_parameters_of! option, switch
+                  argv.delete switch
+                  set_option_value option, options_instance, params
                 end
               end
-              args.each { |arg| argv.delete arg }
             else
               Error.raise_missing_arg(option.names.join ' | ') if option.required?
             end
@@ -113,6 +93,44 @@ module Acclaim
         end
       end
 
+      def extract_parameters_of!(option, switch)
+        arity = option.arity
+        switch_index = argv.index switch
+        len = if arity.bound?
+          switch_index + arity.total
+        else
+          argv.length - 1
+        end
+        params = argv[switch_index + 1, len]
+        values = []
+        params.each do |param|
+          case param
+            when nil, SWITCH, ARGUMENT_SEPARATOR then break
+            else
+              break if arity.bound? and values.count >= arity.total
+              values << param
+          end
+        end
+        count = values.count
+        Error.raise_wrong_arg_number count, *arity if count < arity.required
+        values.each { |value| argv.delete value }
+      end
+
+      def set_option_value(option, values, params = [])
+        params = option.convert_parameters *params
+        if handler = option.handler
+          if option.flag? then handler.call values
+          else handler.call values, params end
+        else
+          key = option.key.to_sym
+          if option.flag? then values[key] = true
+          else
+            value = option.arity.total == 1 ? params.first : params
+            values[key] = value unless params.empty?
+          end
+        end
+      end
+
     end
   end
 end

data/lib/acclaim/option/type.rb

@@ -0,0 +1,55 @@
+module Acclaim
+  class Option
+
+    # Associates a class with a handler block.
+    module Type
+
+      instance_eval do
+
+        # Yields class, proc pairs if a block was given. Returns an enumerator
+        # otherwise.
+        def each(&block)
+          table.each &block
+        end
+
+        # Returns all registered classes.
+        def all
+          table.keys
+        end
+
+        alias registered all
+
+        # Registers a handler for a class.
+        def register(klass, &block)
+          table[klass] = block
+        end
+
+        alias add_handler_for register
+        alias accept register
+
+        # Returns the handler for the given class.
+        def handler_for(klass)
+          table[klass]
+        end
+
+        alias [] handler_for
+
+        private
+
+        # The hash used to associate classes with their handlers.
+        def table
+          @table ||= {}
+        end
+
+      end
+
+    end
+
+  end
+end
+
+require 'acclaim/option/type/date'
+require 'acclaim/option/type/date_time'
+require 'acclaim/option/type/string'
+require 'acclaim/option/type/time'
+require 'acclaim/option/type/uri'

data/lib/acclaim/option/type/date.rb

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+require 'date'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles dates given as arguments in the command line.
+      module Date
+
+        def self.handle(str)
+          ::Date.parse str
+        end
+
+      end
+
+      self.accept ::Date, &Date.method(:handle)
+
+    end
+  end
+end

data/lib/acclaim/option/type/date_time.rb

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+require 'date'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles dates and times given as arguments in the command line.
+      module DateTime
+
+        def self.handle(str)
+          ::DateTime.parse str
+        end
+
+      end
+
+      self.accept ::DateTime, &DateTime.method(:handle)
+
+    end
+  end
+end

data/lib/acclaim/option/type/string.rb

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+require 'time'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles strings given as arguments in the command line.
+      module String
+
+        def self.handle(str)
+          str.to_s
+        end
+
+      end
+
+      self.accept ::String, &String.method(:handle)
+
+    end
+  end
+end

data/lib/acclaim/option/type/time.rb

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+require 'time'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles times given as arguments in the command line.
+      module Time
+
+        def self.handle(str)
+          ::Time.parse str
+        end
+
+      end
+
+      self.accept ::Time, &Time.method(:handle)
+
+    end
+  end
+end

data/lib/acclaim/option/type/uri.rb

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+require 'uri'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles URIs given as arguments in the command line.
+      module URI
+
+        def self.handle(str)
+          ::URI.parse str
+        end
+
+      end
+
+      self.accept ::URI, &URI.method(:handle)
+
+    end
+  end
+end

data/lib/acclaim/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acclaim
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000 Z
+date: 2011-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13323500 !ruby/object:Gem::Requirement
+  requirement: &13170100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13323500
+  version_requirements: *13170100
+- !ruby/object:Gem::Dependency
+  name: rookie
+  requirement: &13169620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *13169620
 description: Command-line option parser and command interface.
 email: matheus.a.m.moreira@gmail.com
 executables: []
@@ -43,6 +54,12 @@ files:
 - lib/acclaim/option/arity.rb
 - lib/acclaim/option/parser.rb
 - lib/acclaim/option/parser/regexp.rb
+- lib/acclaim/option/type.rb
+- lib/acclaim/option/type/date.rb
+- lib/acclaim/option/type/date_time.rb
+- lib/acclaim/option/type/string.rb
+- lib/acclaim/option/type/time.rb
+- lib/acclaim/option/type/uri.rb
 - lib/acclaim/option/values.rb
 - lib/acclaim/version.rb
 - spec/acclaim/option/arity_spec.rb