acclaim 0.2.3 → 0.3.0

data/lib/acclaim/command.rb

@@ -1,10 +1,8 @@
-require 'acclaim/command/help'
-require 'acclaim/command/parser'
-require 'acclaim/command/version'
-require 'acclaim/option'
-require 'acclaim/option/parser'
-require 'acclaim/option/parser/regexp'
-require 'ribbon'
+%w(option option/parser option/parser/regexp).each do |file|
+  require file.prepend 'acclaim/'
+end
+
+%w(ribbon ribbon/core_extensions/object).each { |file| require file }
 
 module Acclaim
 
@@ -104,9 +102,9 @@ module Acclaim
 
       # Invokes this command with a fresh set of option values.
       def run(*args)
-        invoke Ribbon.new, args
-        rescue Option::Parser::Error => e
-          puts e.message
+        invoke args
+      rescue Option::Parser::Error => error
+        $stderr.puts error.message
       end
 
       # Parses the argument array. The argument array will be searched for
@@ -117,14 +115,15 @@ module Acclaim
       #
       # All argument separators will be deleted from the argument array before a
       # command is executed.
-      def invoke(opts, args = [])
-        Ribbon.merge! opts, parse_options!(args)
+      def invoke(args = [], opts = {})
+        opts = Ribbon.wrap opts
+        opts.merge! parse_options!(args)
         handle_special_options! opts, args
         if subcommand = parse_subcommands!(args)
-          subcommand.invoke(opts, args)
+          subcommand.invoke args, opts
         else
           delete_argument_separators_in! args
-          execute(opts, args)
+          execute opts, args
         end
       end
 
@@ -147,11 +146,6 @@ module Acclaim
         ancestors - Acclaim::Command.ancestors
       end
 
-      # Progresively yields each command ancestor to the given block.
-      def each_command_ancestor(&block)
-        command_ancestors.each &block
-      end
-
       # Returns the root of the command hierarchy.
       def root
         command_ancestors.last
@@ -190,7 +184,13 @@ module Acclaim
       def handle_special_options!(opts, args)
         const_get(:Help).execute opts, args if opts.acclaim_help?
         const_get(:Version).execute opts, args if opts.acclaim_version?
-      # TODO: possibly rescue a NameError and warn user
+      # TODO:
+      #   possibly rescue a NameError and warn user
+      #   fix bug:
+      #     calling this method causes a subcommand to be executed even if it
+      #     wasn't given on the command line. This may result up to **three**
+      #     commands (help, version and the actual command) running in one
+      #     invocation.
       end
 
       # Deletes all argument separators in the given argument array.
@@ -212,3 +212,7 @@ module Acclaim
   end
 
 end
+
+%w(help parser version).each do |command|
+  require command.prepend 'acclaim/command/'
+end

data/lib/acclaim/command/help.rb

@@ -1,72 +1,68 @@
 require 'acclaim/command/help/template'
-require 'ribbon/core_ext/array'
+require 'ribbon/core_extensions/array'
 
 module Acclaim
   class Command
 
     # Module which adds help support to a command.
     module Help
+    end
 
-      class << self
+    class << Help
 
-        # Creates a help subcommand that inherits from the given +base+ command
-        # and stores the class in the +Help+ constant of +base+. When called,
-        # the command displays a help screen including information for all
-        # commands and then exits.
-        #
-        # The last argument can be a configuration hash, which accepts the
-        # following options:
-        #
-        # [:options]       If +true+, will add a help option to the +base+
-        #                  command.
-        # [:switches]      The switches used when creating the help option.
-        # [:exit]          If +true+, +exit+ will be called when the command is
-        #                  done.
-        # [:include_root]  Includes the root command when displaying a command's
-        #                  usage.
-        def create(*args)
-          opts, base = args.extract_ribbon!, args.shift
-          add_options_to! base, opts if opts.options? true
-          base.const_set(:Help, Class.new(base)).tap do |help_command|
-            help_command.when_called do |options, args|
-              # TODO: implement a way to specify a command to the help option
-              # and command.
-              #   display_for options.command || args.pop
-              display_for base.root, opts
-              exit if opts.exit? true
-            end
+      # Creates a help subcommand that inherits from the given +base+ command
+      # and stores the class in the +Help+ constant of +base+. When called, the
+      # command displays a help screen including information for all commands
+      # and then exits.
+      #
+      # The last argument can be a configuration hash, which accepts the
+      # following options:
+      #
+      # [:options]       If +true+, will add a help option to the +base+
+      #                  command.
+      # [:switches]      The switches used when creating the help option.
+      # [:include_root]  Includes the root command when displaying a command's
+      #                  usage.
+      def create(*args)
+        opts, base = args.extract_ribbon!, args.shift
+        add_options_to! base, opts if opts.options? true
+        base.const_set(:Help, Class.new(base)).tap do |help_command|
+          help_command.when_called do |options, args|
+            # TODO: implement a way to specify a command to the help option
+            # and command.
+            #   display_for options.command || args.pop
+            display_for base.root, opts
           end
         end
+      end
 
-        # Displays a very simple help screen for the given command and all its
-        # subcommands.
-        #
-        # The last argument can be a configuration hash, which accepts the
-        # following options:
-        #
-        # [:include_root]  Includes the root command when displaying a command's
-        #                  usage.
-        def display_for(*args)
-          options, command = args.extract_ribbon!, args.shift
-          puts Template.for(command, options) if command.options.any?
-          command.subcommands.each { |subcommand| display_for(subcommand, options) }
-        end
-
-        private
+      # Displays a very simple help screen for the given command and all its
+      # subcommands.
+      #
+      # The last argument can be a configuration hash, which accepts the
+      # following options:
+      #
+      # [:include_root]  Includes the root command when displaying a command's
+      #                  usage.
+      def display_for(*args)
+        options, command = args.extract_ribbon!, args.shift
+        puts Help::Template.for(command, options) if command.options.any?
+        command.subcommands.each { |subcommand| display_for(subcommand, options) }
+      end
 
-        # Adds a special help option to the given +command+.
-        #
-        # The last argument can be a configuration hash, which accepts the
-        # following options:
-        #
-        # [:switches]  The switches used when creating the help option.
-        def add_options_to!(*args)
-          opts, command = args.extract_ribbon!, args.shift
-          switches = opts.switches? { %w(-h --help) }
-          description = opts.description? { 'Show usage information and exit.' }
-          command.option :acclaim_help, *switches, description
-        end
+      private
 
+      # Adds a special help option to the given +command+.
+      #
+      # The last argument can be a configuration hash, which accepts the
+      # following options:
+      #
+      # [:switches]  The switches used when creating the help option.
+      def add_options_to!(*args)
+        opts, command = args.extract_ribbon!, args.shift
+        switches = opts.switches? { %w(-h --help) }
+        description = opts.description? { 'Show usage information and exit.' }
+        command.option :acclaim_help, *switches, description
       end
 
     end

data/lib/acclaim/command/help/template.rb

@@ -1,5 +1,5 @@
 require 'erb'
-require 'ribbon/core_ext/array'
+require 'ribbon/core_extensions/array'
 
 module Acclaim
   class Command
@@ -7,38 +7,37 @@ module Acclaim
 
       # Manages help templates.
       module Template
+      end
+
+      class << Template
+
+        # Returns the +template+ folder relative to this directory.
+        def folder
+          File.join File.dirname(__FILE__), 'template'
+        end
 
-        class << self
-
-          # Returns the +template+ folder relative to this directory.
-          def folder
-            File.join File.dirname(__FILE__), 'template'
-          end
-
-          # Loads the contents of a template file from the template #folder.
-          def load(template_file)
-            File.read File.join(folder, template_file)
-          end
-
-          # Creates a new ERB instance with the contents of +template+.
-          def create_from(template_file)
-            ERB.new load(template_file), nil, '%<>'
-          end
-
-          # Computes the result of the template +file+ using the +command+'s
-          # binding.
-          def for(*args)
-            template_options, command = args.extract_ribbon!, args.shift
-            template = create_from template_options.file?('command.erb')
-            b = command.instance_eval { binding }
-            # Since blocks are closures, the binding has access to the
-            # template_options ribbon:
-            #
-            # p b.eval 'template_options'
-            #  => {}
-            template.result b
-          end
+        # Loads the contents of a template file from the template #folder.
+        def load(template_file)
+          File.read File.join(folder, template_file)
+        end
+
+        # Creates a new ERB instance with the contents of +template+.
+        def create_from(template_file)
+          ERB.new load(template_file), nil, '%<>'
+        end
 
+        # Computes the result of the template +file+ using the +command+'s
+        # binding.
+        def for(*args)
+          template_options, command = args.extract_ribbon!, args.shift
+          template = create_from template_options.file? 'command.erb'
+          command_binding = command.instance_eval { binding }
+          # Since blocks are closures, the binding has access to the
+          # template_options ribbon:
+          #
+          # p command_binding.eval 'template_options'
+          #  => {}
+          template.result command_binding
         end
 
       end

data/lib/acclaim/command/version.rb

@@ -1,52 +1,47 @@
-require 'ribbon/core_ext/array'
+require 'ribbon/core_extensions/array'
 
 module Acclaim
   class Command
 
     # Module which adds version query support to a command.
     module Version
+    end
 
-      class << self
-
-        # Creates a <tt>version</tt> subcommand that inherits from the given
-        # +base+ command and stores the class in the +Version+ constant of
-        # +base+. When called, the command displays the +version_string+ of the
-        # program and then exits.
-        #
-        # The last argument can be a configuration hash, which accepts the
-        # following options:
-        #
-        # [:options]   If +true+, will add a version option to the +base+
-        #              command.
-        # [:switches]  The switches used when creating the version option.
-        # [:exit]      If +true+, +exit+ will be called when the command is
-        #              done.
-        def create(*args)
-          opts, base, version_string = args.extract_ribbon!, args.shift, args.shift
-          add_options_to! base, opts if opts.options? true
-          base.const_set(:Version, Class.new(base)).tap do |version_command|
-            version_command.when_called do |options, args|
-              puts version_string
-              exit if opts.exit? true
-            end
+    class << Version
+
+      # Creates a <tt>version</tt> subcommand that inherits from the given
+      # +base+ command and stores the class in the +Version+ constant of +base+.
+      # When called, the command displays the +version_string+ of the program
+      # and then exits.
+      #
+      # The last argument can be a configuration hash, which accepts the
+      # following options:
+      #
+      # [:options]   If +true+, will add a version option to the +base+ command.
+      # [:switches]  The switches used when creating the version option.
+      def create(*args)
+        opts, base, version_string = args.extract_ribbon!, args.shift, args.shift
+        add_options_to! base, opts if opts.options? true
+        base.const_set(:Version, Class.new(base)).tap do |version_command|
+          version_command.when_called do |options, args|
+            puts version_string
           end
         end
+      end
 
-        private
-
-        # Adds a special version option to the given +command+.
-        #
-        # The last argument can be a configuration hash, which accepts the
-        # following options:
-        #
-        # [:switches]  The switches used when creating the version option.
-        def add_options_to!(*args)
-          opts, command = args.extract_ribbon!, args.shift
-          switches = opts.switches? { %w(-v --version) }
-          description = opts.description? { 'Show version and exit.' }
-          command.option :acclaim_version, *switches, description
-        end
-
+      private
+
+      # Adds a special version option to the given +command+.
+      #
+      # The last argument can be a configuration hash, which accepts the
+      # following options:
+      #
+      # [:switches]  The switches used when creating the version option.
+      def add_options_to!(*args)
+        opts, command = args.extract_ribbon!, args.shift
+        switches = opts.switches? { %w(-v --version) }
+        description = opts.description? { 'Show version and exit.' }
+        command.option :acclaim_version, *switches, description
       end
 
     end

data/lib/acclaim/option.rb

@@ -1,8 +1,9 @@
-require 'acclaim/option/arity'
-require 'acclaim/option/parser/regexp'
-require 'acclaim/option/type'
+%w(arity parser/regexp type).each do |file|
+  require file.prepend 'acclaim/option/'
+end
+
 require 'ribbon'
-require 'ribbon/core_ext/array'
+%w(array hash).each { |file| require file.prepend 'ribbon/core_extensions/' }
 
 module Acclaim
 
@@ -16,7 +17,7 @@ module Acclaim
     attr_accessor :names
 
     # The description of this option.
-    attr_accessor :description
+    attr_writer :description
 
     # The type the option's value will be converted to. See Option::Type.
     attr_accessor :type
@@ -54,12 +55,14 @@ module Acclaim
     # [:arity]        The number of required and optional arguments. See Arity
     #                 for defails. Defaults to no arguments.
     # [:default]      The default value for this option. Defaults to +nil+.
+    # [:description]  The description. Overrides the one given among the other
+    #                 arguments.
     # [:required]     Whether or not the option must be present on the command
     #                 line. Default is +false+.
     # [:on_multiple]  What to do if the option is encountered multiple times.
-    #                 Supported modes are <tt>:replace</tt>, <tt>:append</tt>
-    #                 and <tt>:raise</tt>. New values will replace old ones by
-    #                 default.
+    #                 Supported modes are <tt>:replace</tt>, <tt>:raise</tt> and
+    #                 <tt>:append</tt> (or <tt>:collect</tt>). New values will
+    #                 replace old ones by default.
     #
     # Additionally, if a block is given, it will be called when the option is
     # parsed with a ribbon instance and the parameters given to the option. The
@@ -68,27 +71,29 @@ module Acclaim
     # registering a custom type handler.
     def initialize(key, *args, &block)
       options = args.extract_ribbon!
-      matches = args.select do |arg|
+      type = args.find { |arg| arg.is_a? Module }
+
+      strings = args.flatten.select do |arg|
         arg.is_a? String
       end.group_by do |arg|
-        arg =~ Parser::Regexp::SWITCH ? true : false
-      end
-      klass = args.find { |arg| arg.is_a? Module }
-      self.key         = key
-      self.names       = matches.fetch(true) { [ Option.name_from(key) ] }
-      self.description = matches.fetch(false, []).first
+        arg =~ Parser::Regexp::SWITCH ? :switches : :description
+      end.to_ribbon
+
+      self.key = key
+      self.names = strings.switches? { [ Option.name_from(key) ] }
+      self.description = options.description? strings.description?([]).first
       self.on_multiple = options.on_multiple? :replace
-      self.arity       = options.arity?
-      self.default     = options.default?
-      self.required    = options.required?
-      self.type        = klass || String
-      self.handler     = block
+      self.arity = options.arity?
+      self.default = options.default?
+      self.required = options.required?
+      self.type = type || String
+      self.handler = block
     end
 
     # Converts all given arguments using the type handler for this option's
     # type.
     def convert_parameters(*args)
-      args.map { |arg| Type[type].call arg }
+      args.map { |arg| Type.handler_for(type).call arg }
     end
 
     # Returns true if the given string is equal to any of this option's names.
@@ -111,6 +116,12 @@ module Acclaim
       end
     end
 
+    # The description of this option. If it responds to +call+, it will be
+    # called to determine the description at runtime.
+    def description
+      (@description.respond_to?(:call) ? @description.call : @description).to_s
+    end
+
     # Whether or not this option is required on the command line.
     def required?
       @required
@@ -118,7 +129,7 @@ module Acclaim
 
     # Sets whether or not this option is required.
     def required=(value)
-      @required = (value ? true : false)
+      @required = value ? true : false
     end
 
     # Require that this option be given on the command line.
@@ -140,22 +151,22 @@ module Acclaim
     # Same as <tt>flag?</tt>
     alias switch? flag?
 
-    class << self
-
-      # Derives a name from the given key's string representation. All
-      # underscores will be replaced with dashes.
-      #
-      # If the string is empty, an +ArgumentError+ will be raised. If the
-      # resulting name is not a valid switch, a +NameError+ will be raised.
-      def name_from(key)
-        name = key.to_s
-        raise ArgumentError, "Can't derive name from empty key." if name.empty?
-        name = (name.length == 1 ? '-' : '--') + name
-        name.gsub! '_', '-'
-        raise NameError, "Derived name is invalid: #{name}" unless name =~ Parser::Regexp::SWITCH
-        name
-      end
+  end
 
+  class << Option
+
+    # Derives a name from the given key's string representation. All
+    # underscores will be replaced with dashes.
+    #
+    # If the string is empty, an +ArgumentError+ will be raised. If the
+    # resulting name is not a valid switch, a +NameError+ will be raised.
+    def name_from(key)
+      name = key.to_s
+      raise ArgumentError, "Can't derive name from empty key." if name.empty?
+      name = (name.length == 1 ? '-' : '--') + name
+      name.gsub! '_', '-'
+      raise NameError, "Derived name is invalid: #{name}" unless name =~ Option::Parser::Regexp::SWITCH
+      name
     end
 
   end

data/lib/acclaim/option/parser.rb

@@ -1,5 +1,5 @@
-require 'acclaim/option/parser/error'
-require 'acclaim/option/parser/regexp'
+%w(error regexp).each { |file| require file.prepend 'acclaim/option/parser/' }
+
 require 'ribbon'
 
 module Acclaim
@@ -103,7 +103,7 @@ module Acclaim
             end
           end
         end
-        values.ribbon
+        values
       end
 
       # Finds the +switch+ in #argv and scans the next +option.arity.total+
@@ -154,7 +154,7 @@ module Acclaim
         else
           key = option.key
           value = option.arity.total == 1 ? params.first : params
-          value = [*ribbon[key], *value] if option.on_multiple == :append
+          value = [*ribbon[key], *value] if [:append, :collect].include? option.on_multiple
           ribbon[key] = value unless params.empty?
         end
       end

data/lib/acclaim/option/type.rb

@@ -3,55 +3,54 @@ module Acclaim
 
     # Associates a class with a handler block.
     module Type
+    end
 
-      # The class methods.
-      class << self
+    # The class methods.
+    class << Type
 
-        # Yields class, proc pairs if a block was given. Returns an enumerator
-        # otherwise.
-        def each(&block)
-          table.each &block
-        end
+      # Yields class, proc pairs if a block was given. Returns an enumerator
+      # otherwise.
+      def each(&block)
+        table.each &block
+      end
 
-        # Take advantage of each method.
-        include Enumerable
+      # Take advantage of each method.
+      include Enumerable
 
-        # Returns all registered classes.
-        def all
-          table.keys
-        end
+      # Returns all registered classes.
+      def all
+        table.keys
+      end
 
-        # Registers a handler for a class.
-        def register(klass, &block)
-          table[klass] = block
-        end
+      # Registers a handler for a class.
+      def register(*klasses, &block)
+        klasses.each { |klass| table[klass] = block }
+      end
 
-        # Returns the handler for the given class.
-        def handler_for(klass)
-          table.fetch klass do
-            raise "#{klass} does not have an associated handler"
-          end
+      # Returns the handler for the given class.
+      def handler_for(klass)
+        table.fetch klass do
+          raise "#{klass} does not have an associated handler"
         end
+      end
 
-        # Same as <tt>all</tt>.
-        alias registered all
-
-        # Same as <tt>register</tt>.
-        alias add_handler_for register
+      # Same as <tt>all</tt>.
+      alias registered all
 
-        # Same as <tt>register</tt>.
-        alias accept register
+      # Same as <tt>register</tt>.
+      alias add_handler_for register
 
-        # Same as <tt>handler_for</tt>.
-        alias [] handler_for
+      # Same as <tt>register</tt>.
+      alias accept register
 
-        private
+      # Same as <tt>handler_for</tt>.
+      alias [] handler_for
 
-        # The hash used to associate classes with their handlers.
-        def table
-          @table ||= {}
-        end
+      private
 
+      # The hash used to associate classes with their handlers.
+      def table
+        @table ||= {}
       end
 
     end
@@ -59,6 +58,6 @@ module Acclaim
   end
 end
 
-%w(date date_time string symbol time uri).each do |type|
+%w(big_decimal complex date date_time float integer rational string symbol time uri).each do |type|
   require type.prepend 'acclaim/option/type/'
 end

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

@@ -0,0 +1,22 @@
+require 'acclaim/option/type'
+require 'bigdecimal'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles big decimals given as arguments in the command line.
+      module BigDecimal
+
+        # Returns +BigDecimal.new(str)+.
+        def self.handle(str)
+          ::BigDecimal.new str
+        end
+
+      end
+
+      self.accept ::BigDecimal, &BigDecimal.method(:handle)
+
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles complex numbers given as arguments in the command line.
+      module Complex
+
+        # Simply returns +str.to_c+.
+        def self.handle(str)
+          str.to_c
+        end
+
+      end
+
+      self.accept ::Complex, &Complex.method(:handle)
+
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles floating point numbers given as arguments in the command line.
+      module Float
+
+        # Simply returns +str.to_f+.
+        def self.handle(str)
+          str.to_f
+        end
+
+      end
+
+      self.accept ::Float, &Float.method(:handle)
+
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+require 'acclaim/option/type'
+
+module Acclaim
+  class Option
+    module Type
+
+      # Handles rational numbers given as arguments in the command line.
+      module Rational
+
+        # Simply returns +str.to_r+.
+        def self.handle(str)
+          str.to_r
+        end
+
+      end
+
+      self.accept ::Rational, &Rational.method(:handle)
+
+    end
+  end
+end

data/lib/acclaim/version.rb

@@ -11,12 +11,12 @@ module Acclaim
     # Minor version.
     #
     # Increments denote backward-compatible changes and additions.
-    MINOR = 2
+    MINOR = 3
 
     # Patch version.
     #
     # Increments denote changes in implementation.
-    PATCH = 3
+    PATCH = 0
 
     # Build version.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acclaim
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-16 00:00:00.000000000 Z
+date: 2012-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ribbon
@@ -85,8 +85,13 @@ files:
 - lib/acclaim/option/parser/error.rb
 - lib/acclaim/option/parser/regexp.rb
 - lib/acclaim/option/type.rb
+- lib/acclaim/option/type/big_decimal.rb
+- lib/acclaim/option/type/complex.rb
 - lib/acclaim/option/type/date.rb
 - lib/acclaim/option/type/date_time.rb
+- lib/acclaim/option/type/float.rb
+- lib/acclaim/option/type/integer.rb
+- lib/acclaim/option/type/rational.rb
 - lib/acclaim/option/type/string.rb
 - lib/acclaim/option/type/symbol.rb
 - lib/acclaim/option/type/time.rb
@@ -111,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3961771875420064857
+      hash: 2327924451788950921
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3961771875420064857
+      hash: 2327924451788950921
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21