yard 0.7.2 → 0.7.3

data/lib/yard.rb

@@ -1,5 +1,5 @@
 module YARD
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 
   # The root path for YARD source libraries
   ROOT = File.expand_path(File.dirname(__FILE__))

data/lib/yard/cli/yri.rb

@@ -49,7 +49,7 @@ module YARD
       def run(*args)
         optparse(*args)
 
-        if ::Config::CONFIG['host_os'] =~ /mingw|win32/
+        if ::RbConfig::CONFIG['host_os'] =~ /mingw|win32/
           @serializer ||= YARD::Serializers::StdoutSerializer.new
         else
           @serializer ||= YARD::Serializers::ProcessSerializer.new('less')

data/lib/yard/code_objects/macro_object.rb

@@ -81,7 +81,7 @@ module YARD
         # Interpolation rules:
         # * $0, $1, $2, ... = the Nth parameter in +call_params+
         # * $* = the full statement source (excluding block)
-        # * Also supports $\{N-M} ranges, as well as negative indexes on N or M
+        # * Also supports $!{N-M} ranges, as well as negative indexes on N or M
         # * Use \$ to escape the variable name in a macro.
         # 
         # @macro [new] macro.expand

data/lib/yard/handlers/base.rb

@@ -489,7 +489,7 @@ module YARD
         if object.is_a?(Proxy)
           if retries <= max_retries
             log.debug "Missing object #{object} in file `#{parser.file}', moving it to the back of the line."
-            raise Parser::LoadOrderError, context
+            raise Parser::LoadOrderError.new(context)
           else
             raise NamespaceMissingError, object
           end

data/lib/yard/handlers/ruby/attribute_handler.rb

@@ -7,7 +7,7 @@ class YARD::Handlers::Ruby::AttributeHandler < YARD::Handlers::Ruby::Base
   namespace_only
 
   process do
-    return if statement.type == :var_ref
+    return if statement.type == :var_ref || statement.type == :vcall
     read, write = true, false
     params = statement.parameters(false).dup
 

data/lib/yard/handlers/ruby/base.rb

@@ -38,7 +38,7 @@ module YARD
             if !node.parent || node.parent.type == :list
               return true if node[0].type == :ident && (name.nil? || node[0][0] == name)
             end
-          when :fcall, :command
+          when :fcall, :command, :vcall
             return true if name.nil? || node[0][0] == name
           when :call, :command_call
             return true if name.nil? || node[2][0] == name
@@ -148,7 +148,7 @@ module YARD
         def caller_method
           if statement.call?
             statement.method_name(true).to_s
-          elsif statement.type == :var_ref
+          elsif statement.type == :var_ref || statement.type == :vcall
             statement[0].jump(:ident).source
           else
             nil

data/lib/yard/handlers/ruby/exception_handler.rb

@@ -8,15 +8,17 @@ class YARD::Handlers::Ruby::ExceptionHandler < YARD::Handlers::Ruby::Base
     return if owner.has_tag?(:raise)
 
     klass = nil
-    params = statement.parameters(false)
-    if params.size == 1
-      if params.first.ref? && params.first.first.type != :ident
+    if statement.call?
+      params = statement.parameters(false)
+      if params.size == 1
+        if params.first.ref? && params.first.first.type != :ident
+          klass = params.first.source
+        elsif params.first.call? && params.first.method_name(true) == :new
+          klass = params.first.namespace.source
+        end
+      elsif params.size > 1
         klass = params.first.source
-      elsif params.first.call? && params.first.method_name(true) == :new
-        klass = params.first.namespace.source
       end
-    elsif params.size > 1
-      klass = params.first.source
     end
 
     owner.docstring.add_tag YARD::Tags::Tag.new(:raise, '', klass) if klass

data/lib/yard/handlers/ruby/legacy/exception_handler.rb

@@ -1,13 +1,12 @@
 # (see Ruby::ExceptionHandler)
 class YARD::Handlers::Ruby::Legacy::ExceptionHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles /\Araise(\s|\()/
+  handles /\Araise(\s|\(|\Z)/
 
   process do
     return unless owner.is_a?(MethodObject) # Only methods yield
     return if owner.has_tag?(:raise)
 
-    if klass = statement.tokens.to_s[/^raise[\(\s]*(#{NAMESPACEMATCH})\s*(?:\)|,|\s(?:if|unless|until)|;|(?:(?:\.|\:\:)\s*)?new|$)/, 1]
-      owner.docstring.add_tag YARD::Tags::Tag.new(:raise, '', klass)
-    end
+    klass = statement.tokens.to_s[/^raise[\(\s]*(#{NAMESPACEMATCH})\s*(?:\)|,|\s(?:if|unless|until)|;|(?:(?:\.|\:\:)\s*)?new|$)/, 1]
+    owner.docstring.add_tag YARD::Tags::Tag.new(:raise, '', klass) if klass
   end
 end

data/lib/yard/handlers/ruby/visibility_handler.rb

@@ -8,7 +8,7 @@ class YARD::Handlers::Ruby::VisibilityHandler < YARD::Handlers::Ruby::Base
   process do
     return if (ident = statement.jump(:ident)) == statement
     case statement.type
-    when :var_ref
+    when :var_ref, :vcall
       self.visibility = ident.first
     when :fcall, :command
       statement[1].traverse do |node|

data/lib/yard/parser/c_parser.rb

@@ -15,6 +15,7 @@ module YARD
         parse_modules
         parse_classes
         parse_methods
+        parse_attributes
         parse_constants
         parse_includes
       end
@@ -71,6 +72,7 @@ module YARD
         @namespaces[var_name] = obj
       end
 
+      # @return [CodeObjects::Base]
       def handle_method(scope, var_name, name, func_name, source_file = nil)
         case scope
         when "singleton_method", "module_function"; scope = :class
@@ -95,6 +97,18 @@ module YARD
           content ||= @content
         end
         find_method_body(obj, func_name, content)
+        obj
+      end
+      
+      def handle_attribute(var_name, name, func_name, read, write, source_file = nil)
+        values = {:read => read.to_i, :write => write.to_i}
+        {:read => name, :write => "#{name}="}.each do |type, meth_name|
+          next unless values[type] > 0
+          obj = handle_method(:instance, var_name, meth_name, func_name, source_file)
+          ensure_loaded!(obj.namespace)
+          obj.namespace.attributes[:instance][name] ||= SymbolHash[:read => nil, :write => nil]
+          obj.namespace.attributes[:instance][name][type] = obj
+        end
       end
 
       def handle_constants(type, var_name, const_name, definition)
@@ -184,6 +198,7 @@ module YARD
 
       def find_override_comment(object, content = @content)
         name = Regexp.escape(object.name.to_s)
+        name = "(?:initialize|new)" if name == 'initialize'
         class_name = object.parent.path
         if content =~ %r{Document-method:\s+#{class_name}(?:\.|::|#)#{name}\s*?\n((?>.*?\*/))}m then
           $1
@@ -265,7 +280,7 @@ module YARD
             when "class"; "Class"
             when "obj", "object", "anObject"; "Object"
             when "arr", "array", "anArray", /^\[/; "Array"
-            when "str", "string", "new_str"; "String"
+            when /^char\s*\*/, "char", "str", "string", "new_str"; "String"
             when "enum", "anEnumerator"; "Enumerator"
             when "exc", "exception"; "Exception"
             when "proc", "proc_obj", "prc"; "Proc"
@@ -280,15 +295,16 @@ module YARD
             when "matchdata"; "MatchData"
             when "encoding"; "Encoding"
             when "fixnum", "fix"; "Fixnum"
-            when "int", "integer", "Integer"; "Integer"
+            when /^(?:un)?signed$/, /^(?:(?:un)?signed\s*)?(?:short|int|long|long\s+long)$/, "integer", "Integer"; "Integer"
             when "num", "numeric", "Numeric", "number"; "Numeric"
             when "aBignum"; "Bignum"
             when "nil"; "nil"
             when "true"; "true"
             when "false"; "false"
-            when "boolean", "Boolean"; "Boolean"
+            when "bool", "boolean", "Boolean"; "Boolean"
             when "self"; object.namespace.name.to_s
             when /^[-+]?\d/; t
+            when /[A-Z][_a-z0-9]+/; t
             end
           end.compact
         end
@@ -341,7 +357,7 @@ module YARD
                          \s*"([^"]+)",
                          \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
                          \s*(-?\w+)\s*\)
-                       (?:;\s*/[*/]\s+in\s+(\w+?\.[cy]))?
+                       (?:;\s*/[*/]\s+in\s+(.+?\.[cy]))?
                      }xm) do |type, var_name, name, func_name, param_count, source_file|
 
           # Ignore top-object and weird struct.c dynamic stuff
@@ -357,11 +373,30 @@ module YARD
                                  \s*"([^"]+)",
                                  \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
                                  \s*(-?\w+)\s*\)
-                    (?:;\s*/[*/]\s+in\s+(\w+?\.[cy]))?
+                    (?:;\s*/[*/]\s+in\s+(.+?\.[cy]))?
                     }xm) do |name, func_name, param_count, source_file|
           handle_method("method", "rb_mKernel", name, func_name, source_file)
         end
       end
+      
+      def parse_attributes
+        @content.scan(%r{rb_define_attr
+                       \s*\(\s*([\w\.]+),
+                         \s*"([^"]+)",
+                         \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
+                         \s*(0|1)\s*,\s*(0|1)\s*\)
+                       (?:;\s*/[*/]\s+in\s+(.+?\.[cy]))?
+                     }xm) do |var_name, name, func_name, read, write, source_file|
+
+          # Ignore top-object and weird struct.c dynamic stuff
+          next if var_name == "ruby_top_self"
+          next if var_name == "nstr"
+          next if var_name == "envtbl"
+
+          var_name = "rb_cObject" if var_name == "rb_mKernel"
+          handle_attribute(var_name, name, func_name, read, write, source_file)
+        end
+      end
 
       def parse_includes
         @content.scan(/rb_include_module\s*\(\s*(\w+?),\s*(\w+?)\s*\)/) do |klass, mod|

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

@@ -106,7 +106,7 @@ module YARD
           case type
           when :params
             ParameterNode
-          when :call, :fcall, :command, :command_call
+          when :call, :fcall, :vcall, :command, :command_call
             MethodCallNode
           when :if, :elsif, :if_mod, :unless, :unless_mod
             ConditionalNode
@@ -358,6 +358,7 @@ module YARD
         end
 
         def parameters(include_block_param = true)
+          return [] if type == :vcall
           params = self[1 + index_adjust]
           return [] unless params
           params = call_has_paren? ? params.first : params

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

@@ -34,7 +34,8 @@ module YARD
           @tokens = []
           @comments = {}
           @comments_flags = {}
-          @heredoc_tokens = []
+          @heredoc_tokens = nil
+          @heredoc_state = nil
           @map = {}
           @ns_charno = 0
           @list = []
@@ -203,7 +204,7 @@ module YARD
 
         def visit_event(node)
           map = @map[MAPPINGS[node.type]]
-          lstart, sstart = *(map ? map.pop : [lineno, lineno])
+          lstart, sstart = *(map ? map.pop : [lineno, @ns_charno - 1])
           node.source_range = Range.new(sstart, @ns_charno - 1)
           node.line_range = Range.new(lstart, lineno)
           node
@@ -231,27 +232,37 @@ module YARD
         def add_token(token, data)
           if @tokens.last && @tokens.last[0] == :symbeg
             @tokens[-1] = [:symbol, ":" + data]
-          elsif token == :heredoc_end
-            @heredoc_tokens << [@tokens.pop, [token, data]]
+          elsif @heredoc_state == :started
+            @heredoc_tokens << [token, data]
+            @heredoc_state = :ended if token == :heredoc_end
+          elsif (token == :nl || token == :comment) && @heredoc_state == :ended
+            @heredoc_tokens.unshift([token, data])
+            @tokens += @heredoc_tokens
+            @heredoc_tokens = nil
+            @heredoc_state = nil
           else
             @tokens << [token, data]
-            if token == :nl && @heredoc_tokens.size > 0
-              @tokens += @heredoc_tokens.pop
+            if token == :heredoc_beg
+              @heredoc_state = :started
+              @heredoc_tokens = [] 
             end
           end
         end
 
         undef on_program
         undef on_assoc_new
+        undef on_array
         undef on_hash
         undef on_bare_assoc_hash
         undef on_assoclist_from_args
         undef on_aref
+        undef on_lbracket
         undef on_rbracket
         undef on_qwords_new
         undef on_qwords_add
         undef on_string_literal
         undef on_lambda
+        undef on_unary
         undef on_string_content
         undef on_rescue
         undef on_void_stmt
@@ -287,6 +298,15 @@ module YARD
         def on_assoclist_from_args(*args)
           args.first
         end
+        
+        def on_unary(op, val)
+          map = @map[op.to_s[0,1]]
+          lstart, sstart = *(map ? map.pop : [lineno, @ns_charno - 1])
+          node = AstNode.node_class_for(:unary).new(:unary, [op, val])
+          node.source_range = Range.new(sstart, @ns_charno - 1)
+          node.line_range = Range.new(lstart, lineno)
+          node
+        end
 
         def on_aref(*args)
           ll, lc = *@map[:aref].pop
@@ -294,6 +314,25 @@ module YARD
           lr = args.first.line_range.first..ll
           AstNode.new(:aref, args, :char => sr, :line => lr)
         end
+        
+        def on_array(other)
+          node = AstNode.node_class_for(:array).new(:array, [other])
+          map = @map[MAPPINGS[node.type]]
+          if map && !map.empty?
+            lstart, sstart = *map.pop
+            node.source_range = Range.new(sstart, @ns_charno - 1)
+            node.line_range = Range.new(lstart, lineno)
+          else
+            node.source_range = other.source_range
+            node.line_range = other.line_range
+          end
+          node
+        end
+        
+        def on_lbracket(tok)
+          (@map[:lbracket] ||= []) << [lineno, charno]
+          visit_ns_token(:lbracket, tok, false)
+        end
 
         def on_rbracket(tok)
           (@map[:aref] ||= []) << [lineno, charno]
@@ -339,7 +378,8 @@ module YARD
         end
         
         def on_qwords_add(list, item)
-          list.source_range = (list.source_range.first..@ns_charno-1)
+          last = @source[@ns_charno,1] == "\n" ? @ns_charno - 1 : @ns_charno
+          list.source_range = (list.source_range.first..last)
           list.line_range = (list.line_range.first..lineno)
           list.push(item)
           list

data/lib/yard/parser/source_parser.rb

@@ -18,7 +18,16 @@ module YARD
     # that has not yet been resolved.
     #
     # @see Handers::Base#ensure_loaded!
-    class LoadOrderError < Exception; end
+    class LoadOrderError < Exception
+      # @return [Continuation] the context representing the
+      #   point at which the load order error occurred.
+      attr_accessor :context
+      
+      # @param [Continuation] context see {#context}
+      def initialize(context)
+        @context = context
+      end
+    end
 
     # Responsible for parsing a source file into the namespace. Parsing
     # also invokes handlers to process the parsed statements and generate
@@ -353,7 +362,7 @@ module YARD
               end
             rescue LoadOrderError => e
               # Out of order file. Push the context to the end and we'll call it
-              files.push([file, e.message])
+              files.push([file, e.context])
             end
           end
           
@@ -436,8 +445,10 @@ module YARD
         @parser
       rescue ArgumentError, NotImplementedError => e
         log.warn("Cannot parse `#{file}': #{e.message}")
+        log.backtrace(e) if log.level >= Logger::DEBUG
       rescue ParserSyntaxError => e
         log.warn(e.message.capitalize)
+        log.backtrace(e) if log.level >= Logger::DEBUG
       end
 
       # Tokenizes but does not parse the block of code using the current {#parser_type}

data/lib/yard/rubygems/specification.rb

@@ -25,10 +25,10 @@ class Gem::Specification
     attr_accessor :has_rdoc
   end
 
-  if defined?(Gem::VERSION) && Gem::VERSION =~ /^1\.7\./
+  if defined?(Gem::VERSION) && Gem::VERSION >= '1.7.'
     def _dump_with_rdoc(limit)
       dmp = _dump_without_rdoc(limit)
-      dmp[15] = @has_rdoc
+      dmp[15] = @has_rdoc if dmp[15] == true
       dmp
     end
     alias _dump_without_rdoc _dump

data/lib/yard/templates/helpers/html_helper.rb

@@ -44,10 +44,13 @@ module YARD
           html = html.encode(:invalid => :replace, :replace => '?')
         end
         html = resolve_links(html)
-        html = html.gsub(/<pre>(?:\s*<code>)?(.+?)(?:<\/code>\s*)?<\/pre>/m) do
-          str = $1
-          str = html_syntax_highlight(CGI.unescapeHTML(str)) unless options[:no_highlight]
-          %Q{<pre class="code">#{str}</pre>}
+        html = html.gsub(/<pre\s*(?:lang="(.+?)")?>(?:\s*<code>)?(.+?)(?:<\/code>\s*)?<\/pre>/m) do
+          language = $1
+          string   = $2 
+          
+          string = html_syntax_highlight(CGI.unescapeHTML(string), language) unless options[:no_highlight]
+          classes = ['code', language].compact.join(' ')
+          %Q{<pre class="#{classes}">#{string}</pre>}
         end unless markup == :text
         html
       end
@@ -61,6 +64,8 @@ module YARD
         provider = markup_class(:markdown)
         if provider.to_s == 'RDiscount'
           markup_class(:markdown).new(text, :autolink).to_html
+        elsif provider.to_s == 'RedcarpetCompat'
+          provider.new(text, :gh_blockcode, :fenced_code).to_html
         else
           markup_class(:markdown).new(text).to_html
         end
@@ -91,7 +96,7 @@ module YARD
       # @return [String] the output HTML
       # @since 0.6.0
       def html_markup_text(text)
-        "<pre>" + text + "</pre>"
+        "<pre>" + h(text) + "</pre>"
       end
 
       # @return [String] the same text with no markup
@@ -116,7 +121,7 @@ module YARD
       # @return [String] the highlighted HTML
       # @since 0.7.0
       def html_markup_ruby(source)
-        '<pre class="code">' + html_syntax_highlight(source, :ruby) + '</pre>'
+        '<pre class="code ruby">' + html_syntax_highlight(source, :ruby) + '</pre>'
       end
 
       # @return [String] HTMLified text as a single line (paragraphs removed)
@@ -169,7 +174,7 @@ module YARD
       # @return [String] HTML with linkified references
       def resolve_links(text)
         code_tags = 0
-        text.gsub(/<(\/)?(pre|code|tt)|(\\)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W<]|.+<\/|$)/m) do |str|
+        text.gsub(/<(\/)?(pre|code|tt)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W<]|.+<\/|$)/m) do |str|
           closed, tag, escape, name, title, match = $1, $2, $3, $4, $5, $&
           if tag
             code_tags += (closed ? -1 : 1)
@@ -246,7 +251,7 @@ module YARD
         return title if obj.is_a?(CodeObjects::Proxy)
 
         link = url_for(obj, anchor, relative)
-        link = link ? link_url(link, title, :title => "#{obj.path} (#{obj.type})") : title
+        link = link ? link_url(link, title, :title => h("#{obj.path} (#{obj.type})")) : title
         "<span class='object_link'>" + link + "</span>"
       end