Contents

module YARD
  module Tags
    class OverloadTag < Tag
      attr_reader :signature, :parameters, :docstring
      
      def initialize(tag_name, text, raw_text)
        super(tag_name, nil)
        parse_tag(raw_text)
        parse_signature
      end
      
      def tag(name) docstring.tag(name) end
      def tags(name = nil) docstring.tags(name) end
      def has_tag?(name) docstring.has_tag?(name) end
        
      def object=(value)
        super(value)
        docstring.object = value
      end

      def name(prefix = false)
        return @name unless prefix
        object.scope == :class ? @name.to_s : "#{object.send(:sep)}#{@name}"
      end
      
      def method_missing(*args, &block)
        object.send(*args, &block)
      end
      
      def type
        object.type
      end
      
      def is_a?(other)
        object.is_a?(other) || self.class >= other.class || false
      end
      alias kind_of? is_a?

      private
      
      def parse_tag(raw_text)
        @signature, text = *raw_text.split(/\r?\n/, 2)
        @signature.strip!
        text ||= ""
        numspaces = text[/\A(\s*)/, 1].length
        text.gsub!(/^[ \t]{#{numspaces}}/, '')
        text.strip!
        @docstring = Docstring.new(text, nil)
      end
      
      def parse_signature
        if signature =~ /^(?:def\s)?\s*(#{CodeObjects::METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
          meth, args = $1, $2
          meth.gsub!(/\s+/,'')
          # FIXME refactor this code to not make use of the Handlers::Base class (tokval_list should be moved)
          toks = YARD::Parser::Ruby::Legacy::TokenList.new(args)
          args = YARD::Handlers::Ruby::Legacy::Base.new(nil, nil).send(:tokval_list, toks, :all)
          args.map! {|a| k, v = *a.split('=', 2); [k.strip.to_sym, (v ? v.strip : nil)] } if args
          @name = meth.to_sym
          @parameters = args
        end
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
yard-0.5.3	lib/yard/tags/overload_tag.rb
yard-0.5.2	lib/yard/tags/overload_tag.rb
yard-0.5.1p1	lib/yard/tags/overload_tag.rb
yard-0.5.1	lib/yard/tags/overload_tag.rb
yard-0.5.0	lib/yard/tags/overload_tag.rb