RubyGems - yard-go - Versions diffs - 0.5.0 - Mend

yard-go 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

checksums.yaml +7 -0
data/LICENSE.txt +22 -0
data/README.md +5 -0
data/lib/yard-go.rb +14 -0
data/lib/yard-go/code_objects.rb +86 -0
data/lib/yard-go/extensions.rb +64 -0
data/lib/yard-go/handlers.rb +186 -0
data/lib/yard-go/helpers.rb +94 -0
data/lib/yard-go/parser.rb +194 -0
data/lib/yard-go/version.rb +3 -0
data/templates/default/bare_struct/html/fields.erb +15 -0
data/templates/default/bare_struct/html/inherited_fields.erb +15 -0
data/templates/default/bare_struct/html/method_signature.erb +18 -0
data/templates/default/bare_struct/html/setup.rb +11 -0
data/templates/default/field/html/method_signature.erb +4 -0
data/templates/default/field/html/setup.rb +1 -0
data/templates/default/fulldoc/html/css/common.css +33 -0
data/templates/default/fulldoc/html/css/highlight.github.css +123 -0
data/templates/default/fulldoc/html/full_list_package.erb +2 -0
data/templates/default/fulldoc/html/setup.rb +10 -0
data/templates/default/interface/html/implemented_by.erb +5 -0
data/templates/default/interface/html/setup.rb +6 -0
data/templates/default/layout/html/layout.erb +29 -0
data/templates/default/layout/html/setup.rb +33 -0
data/templates/default/method_details/html/source.erb +10 -0
data/templates/default/module/html/box_info.erb +3 -0
data/templates/default/module/html/constant_summary.erb +22 -0
data/templates/default/module/html/inherited_methods.erb +18 -0
data/templates/default/module/html/item_summary.erb +23 -0
data/templates/default/module/html/method_details_list.erb +9 -0
data/templates/default/module/html/packages.erb +4 -0
data/templates/default/module/html/setup.rb +33 -0
data/templates/default/package/html/list_summary.erb +12 -0
data/templates/default/package/html/setup.rb +22 -0
data/templates/default/package/html/type_details.erb +9 -0
data/templates/default/struct/html/fields_details.erb +9 -0
data/templates/default/struct/html/fields_summary.erb +12 -0
data/templates/default/struct/html/implemented_interfaces.erb +5 -0
data/templates/default/struct/html/inherited_fields.erb +15 -0
data/templates/default/struct/html/setup.rb +9 -0
data/yard-go.gemspec +15 -0
metadata +83 -0

data/templates/default/interface/html/setup.rb ADDED

@@ -0,0 +1,6 @@
+include T('default/module/html')
+def init
+  super
+  sections.place(:implemented_by).before(:constant_summary)
+end

data/templates/default/layout/html/layout.erb ADDED

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= erb(:headers) %>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="<%= @nav_url %>"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <%= erb(:breadcrumb) %>
+        <%= erb(:search) %>
+        <div class="clear"></div>
+      </div>
+      <iframe id="search_frame"></iframe>
+      <div id="content">
+        <!--REGION_DISCLAIMER_DO_NOT_REMOVE-->
+        <%= yieldall %>
+      </div>
+      <%= erb(:footer) %>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,33 @@
+def stylesheets
+  super + %w(css/highlight.github.css)
+end
+def menu_lists
+[ { :type => 'package', :title => 'Packages', :search_title => 'Package List' },
+  { :type => 'method', :title => 'Methods', :search_title => 'Method List' },
+  { :type => 'file', :title => 'Files', :search_title => 'File List' } ]
+end
+def index
+  @objects_by_letter = {}
+  objects = Registry.all(:struct).sort_by {|o| o.name.to_s }
+  objects = run_verifier(objects)
+  objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
+  erb(:index)
+end
+def layout
+  @nav_url = url_for_list(!@file || options.index ? 'package' : 'file')
+  if !object || object.is_a?(String)
+    @path = nil
+  elsif @file
+    @path = @file.path
+  elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
+    @path = object.parent.path
+  else
+    @path = object.path
+  end
+  erb(:layout)
+end

data/templates/default/method_details/html/source.erb ADDED

@@ -0,0 +1,10 @@
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file">// File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source, :go %></pre>
+    </td>
+  </tr>
+</table>

data/templates/default/module/html/box_info.erb ADDED

@@ -0,0 +1,3 @@
+<div class="package signature">
+import "<%= object.type == :package || object.root? ? object.full_path : object.namespace.full_path %>"
+</div>

data/templates/default/module/html/constant_summary.erb ADDED

@@ -0,0 +1,22 @@
+<% {"Constants" => constant_listing, "Variables" => variable_listing}.each do |title, cnsts| %>
+  <% if cnsts.size > 0 %>
+    <h2><%= title %></h2>
+    <% if cnsts.size > 0 %>
+      <dl class="constants">
+        <% cnsts.each do |cnst| %>
+          <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+          <div class="defn"><%= cnst.tag(:constant_type).text %> <strong><%= cnst.name %></strong> <%= signature_types cnst %> =
+          <% if cnst.has_tag?(:readonly) %><span class="note title readonly">readonly</span>
+          <% else %><span class="note title writeonly">writable</span><% end %>
+          </div>
+            <%= yieldall :object => cnst %>
+          </dt>
+          <dd>
+            <h3>Value:</h3>
+            <pre class="code"><%= link_types(format_constant(cnst.value)) %></pre>
+          </dd>
+        <% end %>
+      </dl>
+    <% end %>
+  <% end %>
+<% end %>

data/templates/default/module/html/inherited_methods.erb ADDED

@@ -0,0 +1,18 @@
+<% found_method = false %>
+<% object.inheritance_tree(true)[1..-1].each do |superclass| %>
+  <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
+  <% next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false %>
+  <% meths = prune_method_listing(superclass.meths(:included => false, :inherited => false)) %>
+  <% meths.reject! {|m| object.child(:scope => m.scope, :name => m.name) != nil } %>
+  <% meths.reject! {|m| m.is_alias? || m.is_attribute? } %>
+  <% meths.reject! {|m| m.scope == :class } %>
+  <% next if meths.size == 0 %>
+  <% if method_listing.size == 0 && !found_method %><h2>Method Summary</h2><% end %>
+  <% found_method = true %>
+  <h3 class="inherited">Methods <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
+  <p class="inherited"><%=
+    meths.sort_by {|o| o.name.to_s }.map do |m|
+      linkify(m)
+    end.join(", ")
+  %></p>
+<% end %>

data/templates/default/module/html/item_summary.erb ADDED

@@ -0,0 +1,23 @@
+<li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+  <span class="summary_signature"><%= signature(@item) %></span>
+  <% if object != @item.namespace %>
+    <span class="note title not_defined_here">
+      <%= @item.namespace.type == :class ? 'inherited' : (@item.scope == :class ? 'extended' : 'included') %>
+      from <%= linkify @item, object.relative_path(@item.namespace) %>
+    </span>
+  <% end %>
+  <% if @item.type == :bare_struct || @item.type == :struct %><span class="note title readonly">struct</span><% end %>
+  <% if @item.type == :interface %><span class="note title interface">interface</span><% end %>
+  <% if @item.has_tag?(:readonly) %><span class="note title readonly">readonly</span><% end %>
+  <% if @item.has_tag?(:writeonly) %><span class="note title writeonly">writeonly</span><% end %>
+  <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
+  <% if @item.has_tag?(:abstract) %><span class="abstract note title">interface</span><% end %>
+  <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">deprecated</span><% end %>
+  <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
+  <% if @item.has_tag?(:deprecated) %>
+    <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
+  <% else %>
+    <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
+  <% end %>
+</li>

data/templates/default/module/html/method_details_list.erb ADDED

@@ -0,0 +1,9 @@
+<% scopes(method_listing(false)) do |list, scope| %>
+  <div id="<%= scope %>_method_details" class="method_details_list">
+    <h2><%= scope.to_s %> Details</h2>
+    <% list.each_with_index do |meth, i| %>
+      <%= yieldall :object => meth, :owner => object, :index => i %>
+    <% end %>
+  </div>
+<% end %>

data/templates/default/module/html/packages.erb ADDED

@@ -0,0 +1,4 @@
+<div id="subpackages">
+<h2 class="packages">Sub-Packages</h2>
+<p class="children"><%= @packages.map {|pkg| link_object(pkg, pkg.name) }.join(", ") %></p>
+</div>

data/templates/default/module/html/setup.rb ADDED

@@ -0,0 +1,33 @@
+def init
+  super
+  sections.place(:packages).before(:constant_summary)
+end
+alias orig_constant_listing constant_listing
+def constant_listing
+  @go_constant_listing ||= orig_constant_listing.select {|o| o.tag(:constant_type).text == "const" }
+end
+def variable_listing
+  @go_variable_listing ||= orig_constant_listing.select {|o| o.tag(:constant_type).text == "var" }
+end
+def scopes(list)
+  [:class, :instance].each do |scope|
+    items = list.select {|m| m.scope == scope }
+    yield(items, items.first.scope_name) unless items.empty?
+  end
+end
+def groups(list, type = "")
+  super(list, "") do |items, scope|
+    yield(items, scope.gsub(/\b[a-z]/) {|m| m.upcase })
+  end
+end
+def packages
+  @packages = object.children.select {|c| c.type == :package }.sort_by {|c| c.name.to_s }
+  return if @packages.size == 0
+  erb :packages
+end

data/templates/default/package/html/list_summary.erb ADDED

@@ -0,0 +1,12 @@
+<% if @items.size > 0 %>
+  <h2>
+    <%= @name %> Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+  <ul class="summary">
+    <% @items.each do |t| %>
+      <%= yieldall :item => t %>
+    <% end %>
+  </ul>
+<% end %>

data/templates/default/package/html/setup.rb ADDED

@@ -0,0 +1,22 @@
+include T('default/module/html')
+include YARDGo::CodeObjects
+def init
+  super
+  sections.place(:type_summary, [:item_summary], :interface_summary, [:item_summary]).before(:method_summary)
+  sections.place(:type_details, [T('bare_struct')]).before(:method_details_list)
+  @types = object.children.select {|c| c.type == :bare_struct }.sort_by {|c| c.name.to_s }
+end
+def type_summary
+  @items = object.children.select {|c| c.type == :bare_struct || c.type == :struct }.sort_by {|c| c.name.to_s }
+  @name = "Type"
+  erb :list_summary
+end
+def interface_summary
+  @items = object.children.select {|c| c.type == :interface }.sort_by {|c| c.name.to_s }
+  @name = "Interface"
+  erb :list_summary
+end

data/templates/default/package/html/type_details.erb ADDED

@@ -0,0 +1,9 @@
+<% if @types.size > 0 %>
+  <div id="type_details" class="method_details_list">
+    <h2>Type Details</h2>
+    <% @types.each_with_index do |type, i| %>
+      <%= yieldall :object => type, :owner => object, :index => i %>
+    <% end %>
+  </div>
+<% end %>

data/templates/default/struct/html/fields_details.erb ADDED

@@ -0,0 +1,9 @@
+<% if @fields.size > 0 %>
+  <div id="type_details" class="method_details_list">
+    <h2>Structure Field Details</h2>
+    <% @fields.each_with_index do |field, i| %>
+      <%= yieldall :object => field, :owner => object, :index => i %>
+    <% end %>
+  </div>
+<% end %>

data/templates/default/struct/html/fields_summary.erb ADDED

@@ -0,0 +1,12 @@
+<% if @fields.size > 0 %>
+  <h2>
+    Structure Field Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+  <ul class="summary">
+    <% @fields.each do |t| %>
+      <%= yieldall :item => t %>
+    <% end %>
+  </ul>
+<% end %>

data/templates/default/struct/html/implemented_interfaces.erb ADDED

@@ -0,0 +1,5 @@
+<% list = object.implemented_interfaces %>
+<% if list.size > 0 %>
+  <h3 class="inherited">Implemented Interfaces</h3>
+  <p class="inherited"><%= list.sort_by {|o| o.name.to_s }.map {|m| linkify(m) }.join(", ") %></p>
+<% end %>

data/templates/default/struct/html/inherited_fields.erb ADDED

@@ -0,0 +1,15 @@
+<% found_method = false %>
+<% object.inheritance_tree(true)[1..-1].each do |superclass| %>
+  <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
+  <% next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false %>
+  <% meths = superclass.children.select {|c| c.type == :field } %>
+  <% next if meths.size == 0 %>
+  <% if method_listing.size == 0 && !found_method %><h2>Method Summary</h2><% end %>
+  <% found_method = true %>
+  <h3 class="inherited">Fields <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
+  <p class="inherited"><%=
+    meths.sort_by {|o| o.name.to_s }.map do |m|
+      linkify(m)
+    end.join(", ")
+  %></p>
+<% end %>

data/templates/default/struct/html/setup.rb ADDED

@@ -0,0 +1,9 @@
+include T('default/class/html')
+def init
+  super
+  sections.place(:implemented_interfaces).before(:constant_summary)
+  sections.place(:fields_summary, [:item_summary], :inherited_fields).before(:method_summary)
+  sections.place(:fields_details, [T('field')]).before(:method_details_list)
+  @fields = object.children.select {|t| t.type == :field }.sort_by {|t| t.name.to_s }
+end

data/yard-go.gemspec ADDED

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/yard-go/version', __FILE__)
+Gem::Specification.new do |s|
+  s.name          = "yard-go"
+  s.summary       = "YARD plugin for documenting Go source code"
+  s.version       = YARDGo::VERSION
+  s.date          = Time.now.strftime('%Y-%m-%d')
+  s.author        = "Loren Segal"
+  s.email         = "lsegal@soen.ca"
+  s.homepage      = "http://github.com/lsegal/yard-go"
+  s.platform      = Gem::Platform::RUBY
+  s.files         = Dir.glob("{lib,templates}/**/*") +
+                    ['LICENSE.txt', 'README.md', __FILE__]
+  s.require_paths = ['lib']
+end

metadata ADDED

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: yard-go
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Loren Segal
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-07-01 00:00:00.000000000 Z
+dependencies: []
+description:
+email: lsegal@soen.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yard-go/code_objects.rb
+- lib/yard-go/extensions.rb
+- lib/yard-go/handlers.rb
+- lib/yard-go/helpers.rb
+- lib/yard-go/parser.rb
+- lib/yard-go/version.rb
+- lib/yard-go.rb
+- templates/default/bare_struct/html/fields.erb
+- templates/default/bare_struct/html/inherited_fields.erb
+- templates/default/bare_struct/html/method_signature.erb
+- templates/default/bare_struct/html/setup.rb
+- templates/default/field/html/method_signature.erb
+- templates/default/field/html/setup.rb
+- templates/default/fulldoc/html/css/common.css
+- templates/default/fulldoc/html/css/highlight.github.css
+- templates/default/fulldoc/html/full_list_package.erb
+- templates/default/fulldoc/html/setup.rb
+- templates/default/interface/html/implemented_by.erb
+- templates/default/interface/html/setup.rb
+- templates/default/layout/html/layout.erb
+- templates/default/layout/html/setup.rb
+- templates/default/method_details/html/source.erb
+- templates/default/module/html/box_info.erb
+- templates/default/module/html/constant_summary.erb
+- templates/default/module/html/inherited_methods.erb
+- templates/default/module/html/item_summary.erb
+- templates/default/module/html/method_details_list.erb
+- templates/default/module/html/packages.erb
+- templates/default/module/html/setup.rb
+- templates/default/package/html/list_summary.erb
+- templates/default/package/html/setup.rb
+- templates/default/package/html/type_details.erb
+- templates/default/struct/html/fields_details.erb
+- templates/default/struct/html/fields_summary.erb
+- templates/default/struct/html/implemented_interfaces.erb
+- templates/default/struct/html/inherited_fields.erb
+- templates/default/struct/html/setup.rb
+- LICENSE.txt
+- README.md
+- yard-go.gemspec
+homepage: http://github.com/lsegal/yard-go
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.0.14
+signing_key:
+specification_version: 4
+summary: YARD plugin for documenting Go source code
+test_files: []
+has_rdoc: