yard 0.9.38 → 0.9.42

data/lib/yard/tags/library.rb

@@ -507,7 +507,7 @@ module YARD
       #
       # @example
       #   # Synchronizes system time using NTP.
-      #   # @see http://ntp.org/documentation.html NTP Documentation
+      #   # @see https://ntp.org/documentation.html NTP Documentation
       #   # @see NTPHelperMethods
       #   class NTPUpdater; end
       define_tag "See Also",           :see,         :with_name
@@ -541,7 +541,7 @@ module YARD
       # @example
       #   # @todo Add support for Jabberwocky service.
       #   #   There is an open source Jabberwocky library available
-      #   #   at http://jbrwcky.org that can be easily integrated.
+      #   #   at https://jbrwcky.org that can be easily integrated.
       #   class Wonderlander; end
       # @see tag:note
       define_tag "Todo Item",          :todo
@@ -554,7 +554,7 @@ module YARD
       # of a specific object.
       #
       # @example
-      #   # The public REST API for http://jbrwcky.org
+      #   # The public REST API for https://jbrwcky.org
       #   # @version 2.0
       #   class JabberwockyAPI; end
       define_tag "Version",            :version

data/lib/yard/tags/types_explainer.rb

@@ -102,6 +102,7 @@ module YARD
           :fixed_collection_start => /\(/,
           :fixed_collection_end => /\)/,
           :type_name => /#{ISEP}#{METHODNAMEMATCH}|#{NAMESPACEMATCH}|\w+/,
+          :symbol => /:#{METHODNAMEMATCH}/,
           :type_next => /[,;]/,
           :whitespace => /\s+/,
           :hash_collection_start => /\{/,
@@ -130,7 +131,7 @@ module YARD
               next unless (match.nil? && @scanner.eos?) || (match && token = @scanner.scan(match))
               found = true
               case token_type
-              when :type_name
+              when :type_name, :symbol
                 raise SyntaxError, "expecting END, got name '#{token}'" if name
                 name = token
               when :type_next

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

@@ -45,7 +45,7 @@ module YARD::Templates::Helpers
     # method depending on the arguments passed in.
     #
     # @example Linking a URL
-    #   linkify('http://example.com')
+    #   linkify('https://example.com')
     # @example Including docstring contents of an object
     #   linkify('include:YARD::Docstring')
     # @example Linking to an extra file

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

@@ -93,10 +93,16 @@ module YARD
                              :tables,
                              :with_toc_data,
                              :no_intraemphasis).to_html
+        when 'Commonmarker'
+          provider.to_html(text, :options => { }, :plugins => { :syntax_highlighter => nil })
         when 'CommonMarker'
-          CommonMarker.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink table])
+          provider.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink table])
         else
-          provider.new(text).to_html
+          if provider.respond_to?(:to_html)
+            provider.to_html(text)
+          else
+            provider.new(text).to_html
+          end
         end
       end
 
@@ -156,7 +162,7 @@ module YARD
       # @return [String] the output HTML
       # @since 0.6.0
       def html_markup_text(text)
-        h(text).gsub(/\r?\n/, '<br/>')
+        h(text).gsub(/\r?\n/, '<br>')
       end
 
       # @return [String] the same text with no markup
@@ -228,7 +234,7 @@ module YARD
       # @return [String] HTML with linkified references
       def resolve_links(text)
         code_tags = 0
-        text.gsub(%r{<(/)?(pre|code|tt)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W<]|.+</|$)}m) do |str|
+        text.gsub(%r{<(/)?(pre|code|tt)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=\W|.+</|$)}m) do |str|
           closed = $1
           tag = $2
           escape = $3
@@ -650,7 +656,12 @@ module YARD
           language ||= detect_lang_in_codeblock_attributes($1, $2)
           language ||= object.source_type
 
-          if options.highlight
+          # Skip re-highlighting if the block is already highlighted (e.g. from a recursive
+          # htmlify call via {include:} or {yard:include_tags}). Passing pre-highlighted HTML
+          # through CGI.unescapeHTML would corrupt deliberately-escaped entities inside spans.
+          # Note: this heuristic suppresses highlighting for code blocks in :html markup that
+          # contain a literal <span> tag in the source being documented (an uncommon edge case).
+          if options.highlight && string !~ HtmlSyntaxHighlightHelper::ALREADY_HIGHLIGHTED_RE
             string = html_syntax_highlight(CGI.unescapeHTML(string), language)
           end
           classes = ['code', language].compact.join(' ')

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

@@ -6,6 +6,11 @@ module YARD
       module HtmlSyntaxHighlightHelper
         include ModuleHelper
 
+        # Matches source that has already been highlighted (i.e. contains a span tag).
+        # Used to avoid double-processing pre-highlighted HTML in the rescue clause of
+        # {#html_syntax_highlight_ruby_ripper} and in the {HtmlHelper#parse_codeblocks} guard.
+        ALREADY_HIGHLIGHTED_RE = /<span[\s>]/
+
         # Highlights Ruby source
         # @param [String] source the Ruby source code
         # @return [String] the highlighted Ruby source
@@ -39,7 +44,7 @@ module YARD
           end
           output
         rescue Parser::ParserSyntaxError
-          source =~ /^<span\s+class=/ ? source : h(source)
+          source =~ ALREADY_HIGHLIGHTED_RE ? source : h(source)
         end
 
         def html_syntax_highlight_ruby_legacy(source)