yard 0.6.8 → 0.7.0

data/lib/yard/parser/ruby/legacy/ruby_parser.rb

@@ -8,19 +8,19 @@ module YARD
           def initialize(source, filename)
             @source = source
           end
-          
+
           def parse
             @parse ||= StatementList.new(@source)
           end
-          
+
           def tokenize
             @tokenize ||= TokenList.new(@source)
           end
-          
+
           def enumerator
             @parse
           end
-          
+
           def encoding_line; @parse.encoding_line end
           def shebang_line; @parse.shebang_line end
         end

data/lib/yard/parser/ruby/legacy/statement.rb

@@ -1,6 +1,6 @@
 module YARD
   module Parser::Ruby::Legacy
-    class Statement 
+    class Statement
       attr_reader :tokens, :comments, :block
       attr_accessor :comments_range, :group
       attr_accessor :comments_hash_flag
@@ -11,34 +11,34 @@ module YARD
         @comments = comments
         @comments_hash_flag = false
       end
-      
+
       def first_line
         to_s.split(/\n/)[0]
       end
-      
+
       def to_s(include_block = true)
         tokens.map do |token|
           RubyToken::TkBlockContents === token ? (include_block ? block.to_s : '') : token.text
         end.join
       end
       alias source to_s
-      
+
       def inspect
         l = line - 1
         to_s(false).split(/\n/).map do |text|
           "\t#{l += 1}:  #{text}"
         end.join("\n")
       end
-      
+
       def show
         "\t #{line}: #{first_line}"
       end
-      
+
       # @return [Fixnum] the first line of Ruby source
       def line
         tokens.first.line_no
       end
-      
+
       # @return [Range<Fixnum>] the first to last lines of Ruby source
       # @since 0.5.4
       def line_range
@@ -49,10 +49,10 @@ module YARD
 
       def clean_tokens(tokens)
         last_tk = nil
-        tokens.reject do |tk| 
-          tk.is_a?(RubyToken::TkNL) || 
-          (last_tk.is_a?(RubyToken::TkSPACE) && 
-          last_tk.class == tk.class) && last_tk = tk 
+        tokens.reject do |tk|
+          tk.is_a?(RubyToken::TkNL) ||
+          (last_tk.is_a?(RubyToken::TkSPACE) &&
+          last_tk.class == tk.class) && last_tk = tk
         end
       end
     end

data/lib/yard/parser/ruby/legacy/statement_list.rb

@@ -2,10 +2,10 @@ module YARD
   module Parser::Ruby::Legacy
     class StatementList < Array
       include RubyToken
-      
+
       attr_accessor :shebang_line, :encoding_line
 
-      # The following list of tokens will require a block to be opened 
+      # The following list of tokens will require a block to be opened
       # if used at the beginning of a statement.
       OPEN_BLOCK_TOKENS = [TkCLASS, TkDEF, TkMODULE, TkUNTIL,
                            TkIF, TkELSIF, TkUNLESS, TkWHILE, TkFOR, TkCASE]
@@ -21,13 +21,13 @@ module YARD
           @tokens = content.dup
         elsif content.is_a? String
           @tokens = TokenList.new(content.gsub("\r", ""))
-        else 
+        else
           raise ArgumentError, "Invalid content for StatementList: #{content.inspect}:#{content.class}"
         end
 
         parse_statements
       end
-      
+
       private
 
       def parse_statements
@@ -79,7 +79,7 @@ module YARD
           nil
         end
       end
-      
+
       def sanitize_statement_end
         extra = []
         (@statement.size - 1).downto(0) do |index|
@@ -110,7 +110,7 @@ module YARD
           end
         end
       end
-      
+
       def preprocess_token(tk)
         if tk.is_a?(TkCOMMENT)
           case tk.text
@@ -187,7 +187,7 @@ module YARD
           process_statement_end(tk)
           @state = :block
         end
-        
+
         if @first_line == tk.line_no && !@statement.empty? && TkCOMMENT === tk
           process_initial_comment(tk)
         end
@@ -219,7 +219,7 @@ module YARD
         if @statement.empty? && (@comments_last_line || 0) < tk.line_no - 2
           @comments = nil
         end
-        
+
         return unless tk.class == TkCOMMENT
 
         case tk.text
@@ -237,7 +237,7 @@ module YARD
         end
         return if !@statement.empty? && @comments
         return if @first_line && tk.line_no > @first_line
-        
+
         @comments = nil if @comments_last_line && @comments_last_line < tk.line_no - 1
         @comments_line = tk.line_no unless @comments
 
@@ -303,8 +303,8 @@ module YARD
       def process_statement_end(tk)
         # Whitespace means that we keep the same value of @new_statement as last token
         return if tk.class == TkSPACE
-        
-        return unless 
+
+        return unless
           # We might be coming after a statement-ending token...
           ((@last_tk && [TkSEMICOLON, TkNL, TkEND_OF_SCRIPT].include?(tk.class)) ||
            # Or we might be at the beginning of an argument list
@@ -329,13 +329,13 @@ module YARD
 
         # Continue with the statement if we've hit a comma in a def
         return if @current_block == TkDEF && peek_no_space.class == TkCOMMA
-        
-        
+
+
         if [TkEND_OF_SCRIPT, TkNL, TkSEMICOLON].include?(tk.class) && @state == :block_statement &&
             [TkRBRACE, TkEND].include?(@last_ns_tk.class) && @level == 0
           @current_block = nil
         end
-        
+
         unless @current_block
           @done = true
           return
@@ -365,7 +365,7 @@ module YARD
             @level -= 1
           end
         end
-        
+
         @level == 0
       end
 

data/lib/yard/parser/ruby/legacy/token_list.rb

@@ -2,11 +2,11 @@ module YARD
   module Parser::Ruby::Legacy
     class TokenList < Array
       include RubyToken
-      
+
       def initialize(content = nil)
         self << content if content
       end
-      
+
       def to_s(full_statement = false, show_block = true)
         inject([]) do |acc, token|
           break acc if !full_statement && TkStatementEnd === token
@@ -18,7 +18,7 @@ module YARD
           acc
         end.join
       end
-      
+
       # @param [TokenList, Token, String] tokens
       #   A list of tokens. If the token is a string, it
       #   is parsed with {RubyLex}.
@@ -37,28 +37,28 @@ module YARD
         self
       end
       alias_method :<<, :push
-      
+
       def squeeze(type = TkSPACE)
         last = nil
         TokenList.new(map {|t| x = t.is_a?(type) && last.is_a?(type) ? nil : t; last = t; x })
       end
-      
+
       private
-      
+
       def parse_content(content)
         lex = RubyLex.new(content)
-        while tk = lex.token do 
+        while tk = lex.token do
           self << convert_token(lex, tk)
         end
       end
-      
+
       def convert_token(lex, tk)
         if TkSYMBEG === tk && next_tk = lex.token
           sym = TkSYMBOL.new(tk.line_no, tk.char_no, nil)
           sym.lex_state = lex.lex_state
           sym.set_text(tk.text + next_tk.text)
         else
-          tk 
+          tk
         end
       end
     end

data/lib/yard/parser/ruby/ruby_parser.rb

@@ -11,14 +11,14 @@ module YARD
         def initialize(source, filename)
           @parser = RipperParser.new(source, filename)
         end
-        
+
         def parse; @parser.parse end
         def tokenize; @parser.tokens end
         def enumerator; @parser.enumerator end
         def shebang_line; @parser.shebang_line end
         def encoding_line; @parser.encoding_line end
       end
-      
+
       # Internal parser class
       # @since 0.5.6
       class RipperParser < Ripper
@@ -52,13 +52,13 @@ module YARD
           insert_comments
           self
         end
-        
+
         def enumerator
           ast.children
         end
-        
+
         private
-        
+
         MAPPINGS = {
           :BEGIN => "BEGIN",
           :END => "END",
@@ -110,7 +110,7 @@ module YARD
           :zsuper => "super"
         }
         REV_MAPPINGS = {}
-        
+
         AST_TOKENS = [:CHAR, :backref, :const, :cvar, :gvar, :heredoc_end, :ident,
           :int, :float, :ivar, :label, :period, :regexp_end, :tstring_content, :backtick]
 
@@ -124,7 +124,7 @@ module YARD
 
         PARSER_EVENT_TABLE.each do |event, arity|
           node_class = AstNode.node_class_for(event)
-          
+
           if /_new\z/ =~ event.to_s and arity == 0
             module_eval(<<-eof, __FILE__, __LINE__ + 1)
               def on_#{event}(*args)
@@ -165,7 +165,7 @@ module YARD
             end
           eof
         end
-        
+
         REV_MAPPINGS.select {|k,v| k.is_a?(Symbol) }.each do |pair|
           event, value = *pair
           ast_token = AST_TOKENS.include?(event)
@@ -177,7 +177,7 @@ module YARD
             end
           eof
         end
-        
+
         [:kw, :op].each do |event|
           module_eval(<<-eof, __FILE__, __LINE__ + 1)
             begin; undef on_#{event}; rescue NameError; end
@@ -200,7 +200,7 @@ module YARD
             end
           eof
         end
-        
+
         def visit_event(node)
           map = @map[MAPPINGS[node.type]]
           lstart, sstart = *(map ? map.pop : [lineno, lineno])
@@ -208,7 +208,7 @@ module YARD
           node.line_range = Range.new(lstart, lineno)
           node
         end
-        
+
         def visit_event_arr(node)
           mapping = MAPPINGS[node.type].find {|k| @map[k] && !@map[k].empty? }
           lstart, sstart = *@map[mapping].pop
@@ -227,7 +227,7 @@ module YARD
             AstNode.new(token, [data], :line => lineno..lineno, :char => ch..charno-1, :token => true)
           end
         end
-        
+
         def add_token(token, data)
           if @tokens.last && @tokens.last[0] == :symbeg
             @tokens[-1] = [:symbol, ":" + data]
@@ -249,6 +249,7 @@ module YARD
         undef on_aref
         undef on_rbracket
         undef on_qwords_new
+        undef on_qwords_add
         undef on_string_literal
         undef on_lambda
         undef on_string_content
@@ -270,7 +271,7 @@ module YARD
           args.compact.size == 1 ? args.first : AstNode.new(:list, args)
         end
         alias on_bodystmt on_body_stmt
-        
+
         def on_assoc_new(*args)
           AstNode.new(:assoc, args)
         end
@@ -278,27 +279,27 @@ module YARD
         def on_hash(*args)
           visit_event AstNode.new(:hash, args.first || [])
         end
-        
+
         def on_bare_assoc_hash(*args)
           AstNode.new(:list, args.first)
         end
-        
+
         def on_assoclist_from_args(*args)
           args.first
         end
-        
+
         def on_aref(*args)
           ll, lc = *@map[:aref].pop
           sr = args.first.source_range.first..lc
           lr = args.first.line_range.first..ll
           AstNode.new(:aref, args, :char => sr, :line => lr)
         end
-        
+
         def on_rbracket(tok)
           (@map[:aref] ||= []) << [lineno, charno]
           visit_ns_token(:rbracket, tok, false)
         end
-        
+
         def on_top_const_ref(*args)
           type = :top_const_ref
           node = AstNode.node_class_for(type).new(type, args)
@@ -310,11 +311,11 @@ module YARD
           mapping.push(extra_op) if extra_op
           node
         end
-        
+
         def on_const_path_ref(*args)
           ReferenceNode.new(:const_path_ref, args, :listline => lineno..lineno, :listchar => charno..charno)
         end
-        
+
         [:if_mod, :unless_mod, :while_mod].each do |kw|
           node_class = AstNode.node_class_for(kw)
           module_eval(<<-eof, __FILE__, __LINE__ + 1)
@@ -327,10 +328,23 @@ module YARD
           eof
         end
         
-        def on_qwords_new
-          visit_event LiteralNode.new(:qwords_literal, [])
+        def on_qwords_new(*args)
+          node = LiteralNode.new(:qwords_literal, args)
+          if @map[:qwords_beg]
+            sstart, lstart = *@map[:qwords_beg].pop
+            node.source_range = Range.new(sstart-1, @ns_charno)
+            node.line_range = Range.new(lstart, lineno)
+          end
+          node
         end
         
+        def on_qwords_add(list, item)
+          list.source_range = (list.source_range.first..@ns_charno)
+          list.line_range = (list.line_range.first..lineno)
+          list.push(item)
+          list
+        end
+
         def on_string_literal(*args)
           node = visit_event_arr(LiteralNode.new(:string_literal, args))
           if args.size == 1
@@ -343,15 +357,15 @@ module YARD
           end
           node
         end
-        
+
         def on_lambda(*args)
           visit_event_arr AstNode.new(:lambda, args)
         end
-        
+
         def on_string_content(*args)
           AstNode.new(:string_content, args, :listline => lineno..lineno, :listchar => charno..charno)
         end
-        
+
         def on_rescue(exc, *args)
           exc = AstNode.new(:list, exc) if exc
           visit_event AstNode.new(:rescue, [exc, *args])
@@ -380,7 +394,7 @@ module YARD
           end
           ParameterNode.new(:params, args, :listline => lineno..lineno, :listchar => charno..charno)
         end
-        
+
         def on_label(data)
           add_token(:label, data)
           ch = charno
@@ -407,15 +421,15 @@ module YARD
             return
           end
           case comment
-          when /\A# @group\s+(.+)\s*\Z/
+          when /\A#+ @group\s+(.+)\s*\Z/
             @groups.unshift [lineno, $1]
             return
-          when /\A# @endgroup\s*\Z/
+          when /\A#+ @endgroup\s*\Z/
             @groups.unshift [lineno, nil]
             return
           end
-          
-          comment = comment.gsub(/^(\#{1,2})\s{0,1}/, '').chomp
+
+          comment = comment.gsub(/^(\#+)\s{0,1}/, '').chomp
           append_comment = @comments[lineno - 1]
           hash_flag = $1 == '##' ? true : false
 
@@ -425,32 +439,32 @@ module YARD
             @comments_flags.delete(lineno - 1)
             comment = append_comment + "\n" + comment
           end
-          
+
           @comments[lineno] = comment
           @comments_flags[lineno] = hash_flag if !append_comment
           @comments_last_column = column
         end
-        
+
         def on_embdoc_beg(text)
           visit_ns_token(:embdoc_beg, text)
           @embdoc = ""
         end
-        
+
         def on_embdoc(text)
           visit_ns_token(:embdoc, text)
           @embdoc << text
         end
-        
+
         def on_embdoc_end(text)
           visit_ns_token(:embdoc_end, text)
           @comments[lineno] = @embdoc
           @embdoc = nil
         end
-        
+
         def on_parse_error(msg)
           raise ParserSyntaxError, "syntax error in `#{file}`:(#{lineno},#{column}): #{msg}"
         end
-        
+
         def insert_comments
           root.traverse do |node|
             next if node.type == :list || node.parent.type != :list
@@ -474,7 +488,7 @@ module YARD
             end
           end
         end
-        
+
         def freeze_tree(node = nil)
           node ||= root
           node.children.each do |child|