openvox-strings 5.0.0

data/lib/openvox-strings/yard/templates/default/layout/html/setup.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+# Initializes the template.
+# @return [void]
+def init
+  case object
+  when '_index.html'
+    @page_title = options.title
+    sections :layout, [:index, [:listing, %i[classes data_types defined_types types providers functions tasks plans files objects]]]
+  else
+    super
+  end
+end
+
+# Renders the layout section.
+# @return [String] Returns the rendered section.
+def layout
+  @nav_url = url_for_list(!@file || options.index ? menu_lists.first[:type] : 'file')
+
+  case object
+  when nil, String
+    @path = nil
+  when @file
+    @path = @file.path
+  when !object.is_a?(YARD::CodeObjects::NamespaceObject)
+    @path = object.parent.path
+    @nav_url = url_for_list('class')
+  when YARD::CodeObjects::ClassObject
+    @path = object.path
+    @nav_url = url_for_list('class')
+  when OpenvoxStrings::Yard::CodeObjects::Class
+    @nav_url = url_for_list('puppet_class')
+    @page_title = "Puppet Class: #{object.name}"
+    @path = object.path
+  when OpenvoxStrings::Yard::CodeObjects::DataType, OpenvoxStrings::Yard::CodeObjects::DataTypeAlias
+    @nav_url = url_for_list('puppet_data_type')
+    @page_title = "Data Type: #{object.name}"
+    @path = object.path
+  when OpenvoxStrings::Yard::CodeObjects::DefinedType
+    @nav_url = url_for_list('puppet_defined_type')
+    @page_title = "Defined Type: #{object.name}"
+    @path = object.path
+  when OpenvoxStrings::Yard::CodeObjects::Type
+    @nav_url = url_for_list('puppet_type')
+    @page_title = "Resource Type: #{object.name}"
+    @path = object.path
+  when OpenvoxStrings::Yard::CodeObjects::Provider
+    @nav_url = url_for_list('puppet_provider')
+    @page_title = "Provider: #{object.name}"
+    @path = object.path
+  when OpenvoxStrings::Yard::CodeObjects::Function
+    @nav_url = url_for_list('puppet_function')
+    @page_title = "Puppet Function: #{object.name} (#{object.function_type})"
+    @path = object.path
+  when OpenvoxStrings::Yard::CodeObjects::Task
+    @nav_url = url_for_list('puppet_task')
+    @page_title = "Puppet Task: #{object.name}"
+    @path = object.path
+  when OpenvoxStrings::Yard::CodeObjects::Plan
+    @nav_url = url_for_list('puppet_plan')
+    @page_title = "Puppet Plan: #{object.name}"
+    @path = object.path
+  else
+    @path = object.path
+  end
+
+  final_layout = erb(:layout)
+
+  OpenvoxStrings::Yard::Util.github_to_yard_links(final_layout) if @file && @file.name == 'README'
+
+  final_layout
+end
+
+# Creates the dynamic menu lists.
+# @return [Array<Hash>] Returns the dynamic menu list.
+def create_menu_lists
+  menu_lists = [
+    {
+      type: 'puppet_class',
+      title: 'Puppet Classes',
+      search_title: 'Puppet Classes'
+    },
+    {
+      type: 'puppet_data_type',
+      title: 'Data Types',
+      search_title: 'Data Types'
+    },
+    {
+      type: 'puppet_defined_type',
+      title: 'Defined Types',
+      search_title: 'Defined Types'
+    },
+    {
+      type: 'puppet_type',
+      title: 'Resource Types',
+      search_title: 'Resource Types'
+    },
+    {
+      type: 'puppet_provider',
+      title: 'Providers',
+      search_title: 'Providers'
+    },
+    {
+      type: 'puppet_function',
+      title: 'Puppet Functions',
+      search_title: 'Puppet Functions'
+    },
+    {
+      type: 'puppet_task',
+      title: 'Puppet Tasks',
+      search_totle: 'Puppet Tasks'
+    },
+    {
+      type: 'puppet_plan',
+      title: 'Puppet Plans',
+      search_totle: 'Puppet Plans'
+    },
+    {
+      type: 'class',
+      title: 'Ruby Classes',
+      search_title: 'Class List'
+    },
+    {
+      type: 'method',
+      title: 'Ruby Methods',
+      search_title: 'Method List'
+    }
+  ]
+
+  menu_lists.delete_if { |e| YARD::Registry.all(e[:type].intern).empty? }
+
+  # We must always return at least one group, so always keep the files list
+  if menu_lists.empty? || !YARD::Registry.all(:file).empty?
+    menu_lists << {
+      type: 'file',
+      title: 'Files',
+      search_title: 'File List'
+    }
+  end
+
+  menu_lists
+end
+
+# Gets the menu lists to use.
+# @return [Array<Hash] Returns the menu lists to use.
+def menu_lists
+  @@lists ||= create_menu_lists.freeze
+end
+
+# Builds a list of objects by letter.
+# @param [Array] types The types of objects to find.
+# @return [Hash] Returns a hash of first letter of the object name to list of objects.
+def objects_by_letter(*types)
+  hash = {}
+  objects = Registry.all(*types).sort_by { |o| o.name.to_s }
+  objects = run_verifier(objects)
+  objects.each { |o| (hash[o.name.to_s[0, 1].upcase] ||= []) << o }
+  hash
+end
+
+# Renders the classes section.
+# @return [String] Returns the rendered section.
+def classes
+  @title = 'Puppet Class Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_class)
+  erb(:objects)
+end
+
+# Renders the data types section.
+# @return [String] Returns the rendered section.
+def data_types
+  @title = 'Data Type Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_data_type, :puppet_data_type_alias)
+  erb(:objects)
+end
+
+# Renders the defined types section.
+# @return [String] Returns the rendered section.
+def defined_types
+  @title = 'Defined Type Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_defined_type)
+  erb(:objects)
+end
+
+# Renders the types section.
+# @return [String] Returns the rendered section.
+def types
+  @title = 'Resource Type Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_type)
+  erb(:objects)
+end
+
+# Renders the providers section.
+# @return [String] Returns the rendered section.
+def providers
+  @title = 'Puppet Provider Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_provider)
+  erb(:objects)
+end
+
+# Renders the functions section.
+# @return [String] Returns the rendered section.
+def functions
+  @title = 'Puppet Function Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_function)
+  erb(:objects)
+end
+
+# Renders the tasks section.
+# @return [String] Returns the rendered section.
+def tasks
+  @title = 'Puppet Task Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_task)
+  erb(:objects)
+end
+
+# Renders the plans section.
+# @return [String] Returns the rendered section.
+def plans
+  @title = 'Puppet Plan Listing A-Z'
+  @objects_by_letter = objects_by_letter(:puppet_plan)
+  erb(:objects)
+end
+
+# Renders the objects section.
+# @return [String] Returns the rendered section.
+def objects
+  @title = 'Ruby Namespace Listing A-Z'
+  @objects_by_letter = objects_by_letter(:class, :module)
+  erb(:objects)
+end

data/lib/openvox-strings/yard/templates/default/puppet_class/html/box_info.erb

@@ -0,0 +1,26 @@
+<div class="box_info">
+  <% if object.statement.parent_class %>
+  <dl>
+    <dt>Inherits:</dt>
+    <dd><%= linkify(Registry["puppet_classes::#{object.statement.parent_class}"], object.statement.parent_class.dup) %></dd>
+  </dl>
+  <% end %>
+  <% if @subclasses && !@subclasses.empty? %>
+  <dl>
+    <dt>Inherited by:</dt>
+    <dd>
+      <% @subclasses.each do |subclass| %>
+      <%= linkify(subclass, subclass.name.to_s) %><br/>
+      <% end %>
+    </dd>
+  </dl>
+  <% end %>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>
+      <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
+      <% end %>
+    </dd>
+  </dl>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_class/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_class/html/header.erb

@@ -0,0 +1 @@
+<h1>Puppet Class: <%= object.name %></h1>

data/lib/openvox-strings/yard/templates/default/puppet_class/html/note.erb

@@ -0,0 +1,6 @@
+<% object.tags(:note).each do |tag| %>
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_class/html/overview.erb

@@ -0,0 +1,6 @@
+<h2>Overview</h2>
+<div class="docstring">
+  <div class="discussion">
+    <%= htmlify(object.docstring) %>
+  </div>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_class/html/setup.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Initializes the template.
+# @return [void]
+def init
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :source
+end
+
+# Renders the box_info section.
+# @return [String] Returns the rendered section.
+def box_info
+  @subclasses = Registry.all(:puppet_class).find_all do |c|
+    c.statement.parent_class == object.name.to_s
+  end
+  erb(:box_info)
+end

data/lib/openvox-strings/yard/templates/default/puppet_class/html/source.erb

@@ -0,0 +1,12 @@
+<div class="method_details_list">
+  <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 %></pre>
+      </td>
+    </tr>
+  </table>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_class/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_class/html/todo.erb

@@ -0,0 +1,6 @@
+<% object.tags(:todo).each do |tag| %>
+  <div class="note todo">
+    <strong>TODO:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/box_info.erb

@@ -0,0 +1,10 @@
+<div class="box_info">
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>
+      <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
+      <% end %>
+    </dd>
+  </dl>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/header.erb

@@ -0,0 +1 @@
+<h1>Puppet Data Type: <%= object.name %></h1>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/method_details_list.erb

@@ -0,0 +1,6 @@
+<h2>Data Type Functions</h2>
+<% method_listing.each_with_index do |meth, i| %>
+  <div id="<%= meth.name %>-instance_method"><h3><%= meth.name %></h3>
+  <%= yieldall :object => meth, :owner => object, :index => i %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/note.erb

@@ -0,0 +1,6 @@
+<% object.tags(:note).each do |tag| %>
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/overview.erb

@@ -0,0 +1,6 @@
+<h2>Overview</h2>
+<div class="docstring">
+  <div class="discussion">
+    <%= htmlify(object.docstring) %>
+  </div>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/setup.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Initializes the template.
+# @return [void]
+def init
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :method_details_list, [T('method_details')], :source
+end
+
+def method_listing
+  sort_listing(object.functions)
+end
+
+def sort_listing(list)
+  list.sort_by { |o| [o.scope.to_s, o.name.to_s.downcase] }
+end

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/source.erb

@@ -0,0 +1,12 @@
+<div class="method_details_list">
+  <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 %></pre>
+      </td>
+    </tr>
+  </table>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type/html/todo.erb

@@ -0,0 +1,6 @@
+<% object.tags(:todo).each do |tag| %>
+  <div class="note todo">
+    <strong>TODO:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/alias_of.erb

@@ -0,0 +1,10 @@
+<% if @alias_of && !@alias_of.empty? %>
+<div class="tags">
+  <p class="tag_title"><%= @tag_title %></p>
+  <div class="docstring">
+    <div class="discussion">
+      <pre class="code"><span class="info"><%= @alias_of %></span></pre>
+    </div>
+  </div>
+</div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/box_info.erb

@@ -0,0 +1,10 @@
+<div class="box_info">
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>
+      <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
+      <% end %>
+    </dd>
+  </dl>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/header.erb

@@ -0,0 +1 @@
+<h1>Puppet Data Type Alias: <%= object.name %></h1>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/note.erb

@@ -0,0 +1,6 @@
+<% object.tags(:note).each do |tag| %>
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/overview.erb

@@ -0,0 +1,6 @@
+<h2>Overview</h2>
+<div class="docstring">
+  <div class="discussion">
+    <%= htmlify(object.docstring) %>
+  </div>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/setup.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Initializes the template.
+# @return [void]
+def init
+  sections :header, :box_info, :summary, :overview, :alias_of, :note, :todo, :deprecated, T('tags'), :source
+end
+
+# Renders the alias_of section.
+# @return [String] Returns the rendered section.
+def alias_of
+  # Properties are the same thing as parameters (from the documentation standpoint),
+  # so reuse the same template but with a different title and data source.
+  # @parameters = object.properties || []
+  # @parameters.sort_by! { |p| p.name }
+  @tag_title = 'Alias of'
+  @alias_of = object.alias_of
+  erb(:alias_of)
+end

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/source.erb

@@ -0,0 +1,12 @@
+<div class="method_details_list">
+  <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 %></pre>
+      </td>
+    </tr>
+  </table>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_data_type_alias/html/todo.erb

@@ -0,0 +1,6 @@
+<% object.tags(:todo).each do |tag| %>
+  <div class="note todo">
+    <strong>TODO:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/box_info.erb

@@ -0,0 +1,10 @@
+<div class="box_info">
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>
+      <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
+      <% end %>
+    </dd>
+  </dl>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/header.erb

@@ -0,0 +1 @@
+<h1>Defined Type: <%= object.name %></h1>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/note.erb

@@ -0,0 +1,6 @@
+<% object.tags(:note).each do |tag| %>
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/overview.erb

@@ -0,0 +1,6 @@
+<h2>Overview</h2>
+<div class="docstring">
+  <div class="discussion">
+    <%= htmlify(object.docstring) %>
+  </div>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/setup.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Initializes the template.
+# @return [void]
+def init
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :source
+end

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/source.erb

@@ -0,0 +1,12 @@
+<div class="method_details_list">
+  <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 %></pre>
+      </td>
+    </tr>
+  </table>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_defined_type/html/todo.erb

@@ -0,0 +1,6 @@
+<% object.tags(:todo).each do |tag| %>
+  <div class="note todo">
+    <strong>TODO:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_function/html/box_info.erb

@@ -0,0 +1,14 @@
+<div class="box_info">
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>
+      <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
+      <% end %>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Function type:</dt>
+    <dd><%= object.function_type %></dd>
+  </dl>
+</div>

data/lib/openvox-strings/yard/templates/default/puppet_function/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_function/html/header.erb

@@ -0,0 +1 @@
+<h1>Puppet Function: <%= object.name %></h1>

data/lib/openvox-strings/yard/templates/default/puppet_function/html/note.erb

@@ -0,0 +1,6 @@
+<% object.tags(:note).each do |tag| %>
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>

data/lib/openvox-strings/yard/templates/default/puppet_function/html/overview.erb

@@ -0,0 +1,18 @@
+<h2>Overview</h2>
+<div class="method_details first">
+  <% unless object.has_tag? :overload %>
+  <div class="tags overload overload_item">
+    <span class="overload">
+      <span class="overload_item">
+        <span class="signature first" style="margin-left: 0px;"><%= "<strong>#{h(object.signature)}</strong> &#x21d2; #{signature_types(object, false)}" %></span>
+      </span>
+    </span>
+  </div>
+  <% end %>
+  <div class="docstring">
+    <div class="discussion">
+      <%= htmlify(object.docstring) %>
+    </div>
+  </div>
+  <%= yieldall %>
+</div>