yard 0.9.29 → 0.9.31

data/docs/templates/default/fulldoc/html/full_list_tag.erb

@@ -0,0 +1,9 @@
+<% even_odd = 'odd'  %>
+<% collect_tags.each do |tag| %>
+  <li class="<%= even_odd %> <%= tag.object.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+    <div class="item">
+      <span class="object_link"><%= tag_link(tag) %></span>
+    </div>
+  </li>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+<% end %>

data/docs/templates/default/fulldoc/html/setup.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+def generate_tag_list
+  @list_title = "Tag List"
+  @list_type = "tag"
+  asset('tag_list.html', erb(:full_list))
+end

data/docs/templates/default/layout/html/setup.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+def init
+  super
+  sections.place(:tag_list).after_any(:files)
+end
+
+def menu_lists
+  super + [{:type => 'tag', :title => 'Tags', :search_title => 'Tag List'}]
+end

data/docs/templates/default/layout/html/tag_list.erb

@@ -0,0 +1,11 @@
+<h2>Tag Listing</h2>
+<p>The following are a brief list of tags that can be used in YARD formatted
+  documentation. See <%= link_file "docs/Tags.md" %> for information on using tags.</p>
+<ul id="tags" class="index_inline_list">
+<% n = 1 %>
+<% collect_tags.each do |tag| %>
+  <li class="r<%= n %>"><%= tag_link(tag) %></li>
+  <% n = n == 2 ? 1 : 2 %>
+<% end %>
+</ul>
+<div class="clear"></div>

data/docs/templates/default/yard_tags/html/list.erb

@@ -0,0 +1,18 @@
+<% [["Tag", all_tags], ["Directive", all_directives]].each do |(name, list)| %>
+<h2><%= name %> List</h2>
+
+<% list.each_with_index do |tag, i| %>
+<div class="method_details <%= i == 0 ? 'first' : '' %>">
+  <h3 class="signature"
+      id="<%= tag.name %>" toc-title="<%= tag_link_name(tag) %>">
+    <%= tag_signature tag %>
+  </h3>
+  <% if name == "Directive" %>
+    <%= yieldall :object => P("YARD::Tags::#{tag.text}") %>
+  <% else %>
+    <%= yieldall :object => tag.object %>
+  <% end %>
+</div>
+<% end %>
+
+<% end%>

data/docs/templates/default/yard_tags/html/setup.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+def init
+  sections :list, [T('docstring')]
+end
+
+def tag_signature(tag)
+  types = tag.types || []
+  signature = "<strong>#{tag_link_name(tag)}</strong> "
+  sig_tag = tag.object.tag('yard.signature')
+  extra = sig_tag.text if sig_tag
+  extra ||= case types.first
+            when 'with_name'
+              "name description"
+            when 'with_types'
+              "[Types] description"
+            when 'with_types_and_name'
+              "name [Types] description"
+            when 'with_title_and_text'
+              "title\ndescription"
+            when 'with_types_and_title'
+              "[Types] title\ndescription"
+            else
+              "description"
+            end
+  signature + h(extra).gsub(/\n/, "<br/>&nbsp;&nbsp;&nbsp;")
+end

data/docs/templates/plugin.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+include YARD
+include Templates
+
+module TagTemplateHelper
+  def all_tags
+    Registry.all(:method).map {|m| m.tag('yard.tag') }.compact
+  end
+
+  def all_directives
+    Registry.all(:method).map {|m| m.tag('yard.directive') }.compact
+  end
+
+  def collect_tags
+    (all_tags + all_directives).sort_by(&:name)
+  end
+
+  def tag_link(tag)
+    link_file("docs/Tags.md", tag_link_name(tag), tag.name)
+  end
+
+  def tag_link_name(tag)
+    prefix = tag.tag_name == 'yard.directive' ? '@!' : '@'
+    h(prefix + tag.name)
+  end
+
+  # Wrap url_for and url_for_file to rewrite object when generating docs for
+  # yard.tag/directive objects.
+  %w(url_for url_for_file).each do |meth|
+    self.class.send(:define_method, meth) do
+      if object.is_a?(CodeObjects::Base) &&
+         (object.tag('yard.tag') || object.tag('yard.directive') ||
+         (object.type == :class && object.superclass.name == :Directive))
+        obj = object
+        self.object = Registry.root
+        url = super
+        self.object = obj
+        url
+      else
+        super
+      end
+    end
+  end
+
+  def linkify(*args)
+    if args.first.is_a?(String)
+      case args.first
+      when "yard:include_tags"
+        return T('yard_tags').run(options)
+      when /^tag:(\S+)/
+        tag_name = $1
+        suffix = "tag"
+        if tag_name =~ /^!/
+          tag_name = tag_name[1..-1]
+          suffix = "directive"
+        end
+
+        obj = Registry.at("YARD::Tags::Library##{tag_name}_#{suffix}")
+        return tag_link(obj.tag("yard.#{suffix}")) if obj
+
+        log.warn "Cannot find tag: #{args.first}"
+        return args.first
+      end
+    end
+    super
+  end
+end
+
+Template.extra_includes << TagTemplateHelper
+Engine.register_template_path(File.dirname(__FILE__))

data/lib/yard/server/commands/static_file_helpers.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'webrick/httputils'
 
 module YARD
   module Server
@@ -7,7 +6,7 @@ module YARD
       # Include this module to get access to {#static_template_file?}
       # and {favicon?} helpers.
       module StaticFileHelpers
-        include WEBrick::HTTPUtils
+        include Server::HTTPUtils
 
         # Serves an empty favicon.
         # @raise [FinishRequest] finalizes an empty body if the path matches

data/lib/yard/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module YARD
-  VERSION = '0.9.29'
+  VERSION = '0.9.31'
 end