yard 0.9.5 → 0.9.6

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

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 module YARD
   module Templates
     module Helpers
       # Helper methods for syntax highlighting.
       module HtmlSyntaxHighlightHelper
+        include ModuleHelper
+
         # Highlights Ruby source
         # @param [String] source the Ruby source code
         # @return [String] the highlighted Ruby source
@@ -17,16 +20,18 @@ module YARD
         private
 
         def html_syntax_highlight_ruby_ripper(source)
-          tokenlist = Parser::Ruby::RubyParser.parse(source, "(syntax_highlight)").tokens
-          raise Parser::ParserSyntaxError if tokenlist.empty? && !source.empty?
-          output = ""
-          tokenlist.each do |s|
+          resolver = Parser::Ruby::TokenResolver.new(source, object)
+          output = String.new("")
+          resolver.each do |s, token_obj|
+            token_obj = clean_token_object(token_obj)
             output << "<span class='tstring'>" if [:tstring_beg, :regexp_beg].include?(s[0])
             case s.first
             when :nl, :ignored_nl, :sp
               output << h(s[1])
-            when :ident
-              output << "<span class='id identifier rubyid_#{h(s[1])}'>#{h(s[1])}</span>"
+            when :ident, :const
+              klass = s.first == :ident ? "id identifier rubyid_#{h(s[1])}" : s.first
+              val = token_obj ? link_object(token_obj, s[1]) : h(s[1])
+              output << "<span class='#{klass}'>#{val}</span>"
             else
               output << "<span class='#{s.first}'>#{h(s[1])}</span>"
             end
@@ -54,7 +59,20 @@ module YARD
             end
           end.join
         end
+
+        def clean_token_object(token_obj)
+          return unless token_obj
+          if token_obj == object
+            token_obj = nil
+          elsif token_obj.is_a?(CodeObjects::MethodObject)
+            token_obj = prune_method_listing([token_obj], false).first
+          else
+            token_obj = run_verifier([token_obj]).first
+          end
+
+          token_obj
+        end
       end
     end
   end
-end
+end

data/lib/yard/templates/helpers/markup/rdoc_markdown.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module YARD
   module Templates
     module Helpers
       module Markup
-        begin require 'rdoc'; rescue LoadError; end
+        begin require 'rdoc'; rescue LoadError; nil end
         begin
           require 'rdoc/markdown'
         rescue LoadError

data/lib/yard/templates/helpers/markup/rdoc_markup.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require 'thread'
 
 module YARD
   module Templates
     module Helpers
       module Markup
-        begin require 'rdoc'; rescue LoadError; end
+        begin require 'rdoc'; rescue LoadError; nil end
         begin
           require 'rdoc/markup'
           require 'rdoc/markup/to_html'
@@ -12,7 +13,6 @@ module YARD
           class RDocMarkupToHtml < RDoc::Markup::ToHtml
             if defined?(RDoc::VERSION) && RDoc::VERSION >= '4.0.0' &&
                defined?(RDoc::Options)
-            then
               def initialize
                 options = RDoc::Options.new
                 options.pipe = true
@@ -64,8 +64,11 @@ module YARD
           # @todo Refactor into own SimpleMarkup subclass
           def fix_typewriter(text)
             code_tags = 0
-            text.gsub(/<(\/)?(pre|code|tt)|(\s|^|>)\+(?! )([^\n\+]{1,900})(?! )\+/) do |str|
-              closed, tag, first_text, type_text, pre_text, no_match = $1, $2, $3, $4, $`, $&
+            text.gsub(%r{<(/)?(pre|code|tt)|(\s|^|>)\+(?! )([^\n\+]{1,900})(?! )\+}) do |str|
+              closed = $1
+              tag = $2
+              first_text = $3
+              type_text = $4
 
               if tag
                 code_tags += (closed ? -1 : 1)
@@ -89,18 +92,18 @@ module YARD
           attr_accessor :from_path
 
           # Disable auto-link of URLs
-          def handle_special_HYPERLINK(special)
+          def handle_special_HYPERLINK(special) # rubocop:disable Style/MethodName
             @hyperlink ? special.text : super
           end
 
           def accept_paragraph(*args)
             par = args.last
             text = par.respond_to?(:txt) ? par.txt : par.text
-            @hyperlink = !!(text =~ /\{(https?:|mailto:|link:|www\.)/)
+            @hyperlink = text =~ /\{(https?:|mailto:|link:|www\.)/ ? true : false
             super
           end
         end
       end
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 
 module YARD
@@ -28,16 +29,16 @@ module YARD
           {:lib => :bluecloth, :const => 'BlueCloth'},
           {:lib => :maruku, :const => 'Maruku'},
           {:lib => :'rpeg-markdown', :const => 'PEGMarkdown'},
-          {:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'},
+          {:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'}
         ],
         :textile => [
-          {:lib => :redcloth, :const => 'RedCloth'},
+          {:lib => :redcloth, :const => 'RedCloth'}
         ],
         :textile_strict => [
-          {:lib => :redcloth, :const => 'RedCloth'},
+          {:lib => :redcloth, :const => 'RedCloth'}
         ],
         :rdoc => [
-          {:lib => nil, :const => 'YARD::Templates::Helpers::Markup::RDocMarkup'},
+          {:lib => nil, :const => 'YARD::Templates::Helpers::Markup::RDocMarkup'}
         ],
         :asciidoc => [
           {:lib => :asciidoctor, :const => 'Asciidoctor'}
@@ -46,7 +47,7 @@ module YARD
         :text => [],
         :pre  => [],
         :html => [],
-        :none => [],
+        :none => []
       }
 
       # Returns a list of extensions for various markup types. To register
@@ -88,23 +89,23 @@ module YARD
           providers = providers.select {|p| p[:lib] == options.markup_provider }
         end
 
-        if providers == nil || providers.empty?
-          log.error "Invalid markup type '#{type}' or markup provider " +
-            "(#{options.markup_provider}) is not registered."
+        if providers.nil? || providers.empty?
+          log.error "Invalid markup type '#{type}' or markup provider " \
+                    "(#{options.markup_provider}) is not registered."
           return false
         end
 
         # Search for provider, return the library class name as const if found
         providers.each do |provider|
           begin require provider[:lib].to_s; rescue LoadError; next end if provider[:lib]
-          begin klass = eval("::" + provider[:const]); rescue NameError; next end
+          begin klass = eval("::" + provider[:const]); rescue NameError; next end # rubocop:disable Lint/Eval
           MarkupHelper.markup_cache[type][:provider] = provider[:lib] # Cache the provider
           MarkupHelper.markup_cache[type][:class] = klass
           return true
         end
 
         # Show error message telling user to install first potential provider
-        name, lib = *[providers.first[:const], providers.first[:lib] || type]
+        lib = providers.first[:lib] || type
         log.error "Missing '#{lib}' gem for #{type.to_s.capitalize} formatting. Install it with `gem install #{lib}`"
         false
       end
@@ -125,9 +126,7 @@ module YARD
       # @see MARKUP_EXTENSIONS
       # @since 0.6.0
       def markup_for_file(contents, filename)
-        if contents && contents =~ MARKUP_FILE_SHEBANG # Shebang support
-          return $1.to_sym
-        end
+        return $1.to_sym if contents && contents =~ MARKUP_FILE_SHEBANG # Shebang support
 
         ext = (File.extname(filename)[1..-1] || '').downcase
         MARKUP_EXTENSIONS.each do |type, exts|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Templates::Helpers
     # Helper methods for method objects.
@@ -8,18 +9,18 @@ module YARD
         params = object.parameters
         if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
           params.reject! do |param|
-            param[0].to_s[0,1] == "&" &&
+            param[0].to_s[0, 1] == "&" &&
               !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
           end
         end
 
-        unless params.empty?
+        if params.empty?
+          ""
+        else
           args = params.map do |n, v|
-            v ? "#{n}#{n[-1,1] == ':' ? '' : ' ='} #{v}" : n.to_s
+            v ? "#{n}#{n[-1, 1] == ':' ? '' : ' ='} #{v}" : n.to_s
           end.join(", ")
           h("(#{args})")
-        else
-          ""
         end
       end
 
@@ -35,7 +36,7 @@ module YARD
         if object.has_tag?(:yield) && object.tag(:yield).types
           params = object.tag(:yield).types
         elsif object.has_tag?(:yieldparam)
-          params = object.tags(:yieldparam).map {|t| t.name }
+          params = object.tags(:yieldparam).map(&:name)
         elsif object.has_tag?(:yield)
           return "{ ... }"
         else
@@ -53,7 +54,7 @@ module YARD
       end
 
       # @return [String] formats source of an object
-      def format_code(object, show_lines = false)
+      def format_code(object, _show_lines = false)
         i = -1
         lines = object.source.split(/\n/)
         longestline = (object.line + lines.size).to_s.length

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Templates
     module Helpers

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Templates
     module Helpers
@@ -5,16 +6,16 @@ module YARD
       module TextHelper
         # @return [String] escapes text
         def h(text)
-          out = ""
+          out = String.new("")
           text = resolve_links(text)
           text = text.split(/\n/)
           text.each_with_index do |line, i|
             out <<
-            case line
-            when /^\s*$/; "\n\n"
-            when /^\s+\S/, /^=/; line + "\n"
-            else; line + (text[i + 1] =~ /^\s+\S/ ? "\n" : " ")
-            end
+              case line
+              when /^\s*$/; "\n\n"
+              when /^\s+\S/, /^=/; line + "\n"
+              else; line + (text[i + 1] =~ /^\s+\S/ ? "\n" : " ")
+              end
           end
           out
         end
@@ -80,7 +81,8 @@ module YARD
           args = format_args(meth)
           extras = []
           extras_text = ''
-          if rw = meth.namespace.attributes[meth.scope][meth.name]
+          rw = meth.namespace.attributes[meth.scope][meth.name]
+          if rw
             attname = [rw[:read] ? 'read' : nil, rw[:write] ? 'write' : nil].compact
             attname = attname.size == 1 ? attname.join('') + 'only' : nil
             extras << attname if attname
@@ -94,14 +96,17 @@ module YARD
         private
 
         def resolve_links(text)
-          text.gsub(/(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W]|$)/m) do |str|
-            escape, name, title, match = $1, $2, $3, $&
+          text.gsub(/(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W]|$)/m) do |_str|
+            escape = $1
+            name = $2
+            title = $3
+            match = $&
             next(match[1..-1]) if escape
-            next(match) if name[0,1] == '|'
+            next(match) if name[0, 1] == '|'
             linkify(name, title)
           end
         end
       end
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Templates::Helpers
     # Helpers for UML template format
@@ -43,4 +44,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/templates/section.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Templates
     # Abstracts the structure for a section and its subsections into an ordered
@@ -93,9 +94,7 @@ module YARD
           when Array;   next
           else
             subsections = args[index + 1].is_a?(Array) ? args[index + 1] : []
-            if subsections.is_a?(Section)
-              subsections = []
-            end
+            subsections = [] if subsections.is_a?(Section)
             sections << Section.new(name, subsections)
           end
         end
@@ -103,4 +102,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/templates/template.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'erb'
 
 module YARD
@@ -44,11 +45,11 @@ module YARD
       end
 
       self.extra_includes = [
-        proc {|options|
-          { :html => Helpers::HtmlHelper,
+        proc do |options|
+          {:html => Helpers::HtmlHelper,
             :text => Helpers::TextHelper,
-            :dot  => Helpers::UMLHelper }[options.format]
-        }
+            :dot  => Helpers::UMLHelper}[options.format]
+        end
       ]
 
       include ErbCache
@@ -135,6 +136,9 @@ module YARD
           new(*args).run
         end
 
+        # rubocop:disable Style/MethodName
+
+        # Alias for creating {Engine.template}.
         def T(*path)
           Engine.template(*path)
         end
@@ -146,6 +150,8 @@ module YARD
           Section.new(*args)
         end
 
+        # rubocop:enable Style/MethodName
+
         private
 
         def include_parent
@@ -178,8 +184,10 @@ module YARD
       def initialize(opts = TemplateOptions.new)
         opts_class = opts.class
         opts_class = TemplateOptions if opts_class == Hash
-        @cache, @cache_filename = {}, {}
-        @sections, @options = [], opts_class.new
+        @cache = {}
+        @cache_filename = {}
+        @sections = []
+        @options = opts_class.new
         add_options(opts)
         Template.include_extra(self, options)
         init
@@ -191,7 +199,7 @@ module YARD
       #
       # @param [Array<String, Symbol>] path the path of the template
       # @return [Template] the loaded template module
-      def T(*path)
+      def T(*path) # rubocop:disable Style/MethodName
         path.unshift(options.template) if options.template
         path.push(options.format) if options.format
         self.class.T(*path)
@@ -214,7 +222,7 @@ module YARD
       #   templates, they will have {Template::ClassMethods#run} called on them.
       #   Any subsections can be yielded to using yield or {#yieldall}
       def sections(*args)
-        @sections = Section.new(nil, *args) if args.size > 0
+        @sections = Section.new(nil, *args) unless args.empty?
         @sections
       end
 
@@ -240,7 +248,7 @@ module YARD
       # @yieldparam [Hash] opts any extra options to yield
       # @return [String] the rendered sections joined together
       def run(opts = nil, sects = sections, start_at = 0, break_first = false, &block)
-        out = ""
+        out = String.new("")
         return out if sects.nil?
         sects = sects[start_at..-1] if start_at > 0
         sects = Section.new(nil, sects) unless sects.is_a?(Section)
@@ -395,7 +403,7 @@ module YARD
         end
       end
 
-      def with_section(&block)
+      def with_section
         sect = section
         value = yield
         self.section = sect
@@ -404,4 +412,3 @@ module YARD
     end
   end
 end
-

data/lib/yard/templates/template_options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ostruct'
 
 module YARD

data/lib/yard/verifier.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   # Similar to a Proc, but runs a set of Ruby expressions using a small
   # DSL to make tag lookups easier.
@@ -130,6 +131,7 @@ module YARD
       expr = expressions.map {|e| "(#{parse_expression(e)})" }.join(" && ")
 
       instance_eval(<<-eof, __FILE__, __LINE__ + 1)
+        begin; undef __execute; rescue NameError; end
         def __execute; #{expr}; end
       eof
     end