RubyGems - hyper-pro-gem - Versions diffs - 0.0.1 - Mend

hyper-pro-gem 0.0.1

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 (380) hide show

data/yard-0.9.44/templates/default/fulldoc/html/setup.rb ADDED Viewed

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+include Helpers::ModuleHelper
+def init
+  options.objects = objects = run_verifier(options.objects)
+  return serialize_onefile if options.onefile
+  generate_assets
+  serialize('_index.html')
+  options.files.each_with_index do |file, _i|
+    serialize_file(file, file.title)
+  end
+  options.delete(:objects)
+  options.delete(:files)
+  objects.each do |object|
+    begin
+      serialize(object)
+    rescue => e
+      path = options.serializer.serialized_path(object)
+      log.error "Exception occurred while generating '#{path}'"
+      log.backtrace(e)
+    end
+  end
+end
+# Generate an HTML document for the specified object. This method is used by
+# most of the objects found in the Registry.
+# @param [CodeObject] object to be saved to HTML
+def serialize(object)
+  options.object = object
+  serialize_index(options) if object == '_index.html' && options.readme.nil?
+  Templates::Engine.with_serializer(object, options.serializer) do
+    T('layout').run(options)
+  end
+end
+# Generate the documentation output in one file (--one-file) which will load the
+# contents of all the javascript and css and output the entire contents without
+# depending on any additional files
+def serialize_onefile
+  Templates::Engine.with_serializer('index.html', options.serializer) do
+    T('onefile').run(options)
+  end
+end
+# Generate the index document for the output
+# @params [Hash] options contains data and flags that influence the output
+def serialize_index(options)
+  Templates::Engine.with_serializer('index.html', options.serializer) do
+    T('layout').run(options.merge(:index => true))
+  end
+end
+# Generate a single HTML file with the layout template applied. This is generally
+# the README file or files specified on the command-line.
+#
+# @param [File] file object to be saved to the output
+# @param [String] title currently unused
+#
+# @see layout#diskfile
+def serialize_file(file, title = nil) # rubocop:disable Lint/UnusedMethodArgument
+  options.object = Registry.root
+  options.file = file
+  outfile = 'file.' + file.name + '.html'
+  serialize_index(options) if file == options.readme
+  Templates::Engine.with_serializer(outfile, options.serializer) do
+    T('layout').run(options)
+  end
+  options.delete(:file)
+end
+#
+# Generates a file to the output with the specified contents.
+#
+# @example saving a custom html file to the documentation root
+#
+#   asset('my_custom.html','<html><body>Custom File</body></html>')
+#
+# @param [String] path relative to the document output where the file will be
+#   created.
+# @param [String] content the contents that are saved to the file.
+def asset(path, content)
+  if options.serializer
+    log.capture("Generating asset #{path}") do
+      options.serializer.serialize(path, content)
+    end
+  end
+end
+# @return [Array<String>] Stylesheet files that are additionally loaded for the
+#   searchable full lists, e.g., Class List, Method List, File List
+# @since 0.7.0
+def stylesheets_full_list
+  %w(css/full_list.css css/common.css)
+end
+# @return [Array<String>] Javascript files that are additionally loaded for the
+#   searchable full lists, e.g., Class List, Method List, File List.
+# @since 0.7.0
+def javascripts_full_list
+  %w(js/jquery.js js/full_list.js)
+end
+# Sets the HTML language lang="value" where value is the value returned from
+# this method. Defaults to nil which does not set the lang attribute.
+def html_lang
+  nil
+end
+def menu_lists
+  Object.new.extend(T('layout')).menu_lists
+end
+# Generates all the javascript files, stylesheet files, menu lists
+# (i.e. class, method, and file) based on the the values returned from the
+# layout's menu_list method, and the frameset in the documentation output
+#
+def generate_assets
+  @object = Registry.root
+  layout = Object.new.extend(T('layout'))
+  (layout.javascripts + javascripts_full_list +
+      layout.stylesheets + stylesheets_full_list).uniq.each do |file|
+    asset(file, file(file, true))
+  end
+  layout.menu_lists.each do |list|
+    list_generator_method = "generate_#{list[:type]}_list"
+    if respond_to?(list_generator_method)
+      send(list_generator_method)
+    else
+      log.error "Unable to generate '#{list[:title]}' list because no method " \
+                "'#{list_generator_method}' exists"
+    end
+  end
+  generate_frameset
+end
+# Generate a searchable method list in the output
+# @see ModuleHelper#prune_method_listing
+def generate_method_list
+  @items = prune_method_listing(Registry.all(:method), false)
+  @items = @items.reject {|m| m.name.to_s =~ /=$/ && m.is_attribute? }
+  @items = @items.sort_by {|m| m.name.to_s }
+  @list_title = "Method List"
+  @list_type = "method"
+  generate_list_contents
+end
+# Generate a searchable class list in the output
+def generate_class_list
+  @items = options.objects if options.objects
+  @list_title = "Class List"
+  @list_type = "class"
+  generate_list_contents
+end
+# Generate a searchable file list in the output
+def generate_file_list
+  @file_list = true
+  @items = options.files
+  @list_title = "File List"
+  @list_type = "file"
+  generate_list_contents
+  @file_list = nil
+end
+def generate_list_contents
+  asset(url_for_list(@list_type), erb(:full_list))
+end
+# Generate the frame documentation in the output
+def generate_frameset
+  @javascripts = javascripts_full_list
+  @stylesheets = stylesheets_full_list
+  asset(url_for_frameset, erb(:frames))
+end
+# @api private
+class TreeContext
+  def initialize
+    @depth = 0
+    @even_odd = Alternator.new(:even, :odd)
+  end
+  def nest
+    @depth += 1
+    yield
+    @depth -= 1
+  end
+  # @return [String] Returns a css pixel offset, e.g. "30px"
+  def indent
+    "#{(@depth + 2) * 15}px"
+  end
+  def classes
+    classes = []
+    classes << 'collapsed' if @depth > 0
+    classes << @even_odd.next if @depth < 2
+    classes
+  end
+  class Alternator
+    def initialize(first, second)
+      @next = first
+      @after = second
+    end
+    def next
+      @next, @after = @after, @next
+      @after
+    end
+  end
+end
+# @return [String] HTML output of the classes to be displayed in the
+#    full_list_class template.
+def class_list(root = Registry.root, tree = TreeContext.new)
+  out = String.new("")
+  children = run_verifier(root.children)
+  if root == Registry.root
+    children += @items.select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
+  end
+  children.compact.sort_by(&:path).each do |child|
+    next unless child.is_a?(CodeObjects::NamespaceObject)
+    name = child.namespace.is_a?(CodeObjects::Proxy) ? child.path : child.name
+    has_children = run_verifier(child.children).any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
+    out << "<li id='object_#{child.path}' class='#{tree.classes.join(' ')}'>"
+    out << "<div class='item' style='padding-left:#{tree.indent}'>"
+    accessible_props = "aria-label='#{name} child nodes' aria-expanded='false' aria-controls='object_#{child.path}'"
+    out << "<a tabindex='0' class='toggle' role='button' #{accessible_props}></a> " if has_children
+    out << linkify(child, name)
+    out << " &lt; #{child.superclass.name}" if child.is_a?(CodeObjects::ClassObject) && child.superclass
+    out << "<small class='search_info'>"
+    out << child.namespace.title
+    out << "</small>"
+    out << "</div>"
+    tree.nest do
+      labeled_by = "aria-labelledby='object_#{child.path}'"
+      out << "<div #{labeled_by}><ul>#{class_list(child, tree)}</ul></div>" if has_children
+    end
+    out << "</li>"
+  end
+  out
+end

data/yard-0.9.44/templates/default/layout/dot/header.erb ADDED Viewed

@@ -0,0 +1,6 @@
+digraph yard {
+  graph [rankdir=BT rank=sink outputMode=nodesfirst packMode="graph" splines=true];
+  node [shape=record rank=sink rankType=sink];
+  <%= yieldall %>
+}

data/yard-0.9.44/templates/default/layout/dot/setup.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+attr_reader :contents
+def init
+  if object
+    type = object.root? ? :module : object.type
+    sections :header, [T(type)]
+  else
+    sections :header, [:contents]
+  end
+end
+def header
+  tidy erb(:header)
+end

data/yard-0.9.44/templates/default/layout/html/breadcrumb.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<div id="menu">
+  <% if @contents || @file %>
+    <% if object != '_index.html' %><a href="<%= url_for_index %>">Index</a> &raquo; <% end %>
+    <span class="title"><%= @breadcrumb_title %></span>
+  <% elsif object.is_a?(CodeObjects::Base) %>
+    <a href="<%= url_for_index %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0,1] %>)<% end %></a> &raquo;
+    <%= @breadcrumb.map {|obj| "<span class='title'>" + linkify(obj, obj.name) + "</span>" }.join(" &raquo; ") %>
+    <%= @breadcrumb.size > 0 ? " &raquo; " : "" %>
+    <span class="title"><%= object.root? ? "Top Level Namespace" : object.name(true) %></span>
+  <% end %>
+</div>

data/yard-0.9.44/templates/default/layout/html/files.erb ADDED Viewed

@@ -0,0 +1,11 @@
+<% if @files && @files.size > 0 %>
+  <h2>File Listing</h2>
+  <ul id="files" class="index_inline_list">
+  <% n = 1 %>
+  <% @files.each_with_index do |file, i| %>
+    <li class="r<%= n %>"><%= link_file(file) %></li>
+    <% n = n == 2 ? 1 : 2 %>
+  <% end %>
+  </ul>
+<% end %>
+<div class="clear"></div>

data/yard-0.9.44/templates/default/layout/html/footer.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
+</div>

data/yard-0.9.44/templates/default/layout/html/headers.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<meta charset="<%= charset %>">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  <%= h @page_title %>
+  <% if options.title && @page_title != options.title %>
+    &mdash; <%= h options.title %>
+  <% end %>
+</title>
+<% stylesheets.each do |stylesheet| %>
+  <link rel="stylesheet" href="<%= mtime_url(stylesheet) %>" type="text/css">
+<% end %>
+<%= erb :script_setup %>
+<% javascripts.each do |javascript| %>
+  <script type="text/javascript" charset="utf-8" src="<%= mtime_url(javascript) %>"></script>
+<% end %>

data/yard-0.9.44/templates/default/layout/html/index.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1 class="noborder title"><%= options.title %></h1>
2	+ <%= yieldall %>

data/yard-0.9.44/templates/default/layout/html/layout.erb ADDED Viewed

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

data/yard-0.9.44/templates/default/layout/html/listing.erb ADDED Viewed

@@ -0,0 +1,4 @@
+<div id="listing">
+  <h1 class="alphaindex">Alphabetic Index</h1>
+  <%= yieldall %>
+</div>

data/yard-0.9.44/templates/default/layout/html/objects.erb ADDED Viewed

@@ -0,0 +1,32 @@
+<h2>Namespace Listing A-Z</h2>
+<% if Registry.root.meths(:included => false).size > 0 %>
+  <ul class="toplevel"><li><%= linkify(Registry.root) %></li></ul>
+<% end %>
+<% i = 0 %>
+<table>
+  <tr>
+    <td valign='top' width="33%">
+      <% @objects_by_letter.sort_by {|l,o| l.to_s }.each do |letter, objects| %>
+        <% if (i += 1) % 8 == 0 %>
+          </td><td valign='top' width="33%">
+          <% i = 0 %>
+        <% end %>
+        <ul id="alpha_<%= letter %>" class="alpha">
+          <li class="letter"><%= letter %></li>
+          <ul>
+            <% objects.each do |obj| %>
+              <li>
+                <%= linkify obj, obj.name %>
+                <% if !obj.namespace.root? %>
+                  <small>(<%= obj.namespace.path %>)</small>
+                <% end %>
+              </li>
+            <% end %>
+          </ul>
+        </ul>
+      <% end %>
+    </td>
+  </tr>
+</table>

data/yard-0.9.44/templates/default/layout/html/script_setup.erb ADDED Viewed

@@ -0,0 +1,4 @@
+<script type="text/javascript">
+  pathId = <%= @path ? @path.inspect : 'null' %>;
+  relpath = '<%= u = url_for(''); u + (u != '' ? '/' : '') %>';
+</script>

data/yard-0.9.44/templates/default/layout/html/search.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<div id="search">
+  <% [menu_lists.first].each do |field| %>
+    <a class="full_list_link" id="<%= field[:type] %>_list_link"
+        href="<%= url_for_list(field[:type]) %>">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  <% end %>
+</div>

data/yard-0.9.44/templates/default/layout/html/setup.rb ADDED Viewed

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+def init
+  @breadcrumb = []
+  @page_title = ''
+  @breadcrumb_title = ''
+  if @onefile
+    sections :layout
+  elsif defined?(@file) && @file
+    if @file.attributes[:namespace]
+      @object = options.object = Registry.at(@file.attributes[:namespace]) || Registry.root
+    end
+    @breadcrumb_title = "File: " + @file.title
+    @page_title = @breadcrumb_title
+    sections :layout, [:diskfile]
+  elsif @contents
+    sections :layout, [:contents]
+  else
+    case object
+    when '_index.html'
+      @page_title = options.title
+      sections :layout, [:index, [:listing, [:files, :objects]]]
+    when CodeObjects::Base
+      unless object.root?
+        cur = object.namespace
+        until cur.root?
+          @breadcrumb.unshift(cur)
+          cur = cur.namespace
+        end
+      end
+      @page_title = format_object_title(object)
+      type = object.root? ? :module : object.type
+      sections :layout, [T(type)]
+    end
+  end
+end
+attr_reader :contents
+def index
+  @objects_by_letter = {}
+  objects = Registry.all(:class, :module).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(!(defined?(@file) && @file) || options.index ? 'class' : 'file')
+  @path =
+    if !object || object.is_a?(String)
+      nil
+    elsif defined?(@file) && @file
+      @file.path
+    elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
+      object.parent.path
+    else
+      object.path
+    end
+  erb(:layout)
+end
+def diskfile
+  @file.attributes[:markup] ||= markup_for_file('', @file.filename)
+  data = htmlify(@file.contents, @file.attributes[:markup])
+  "<div id='filecontents'>" + data + "</div>"
+end
+# @return [Array<String>] core javascript files for layout
+# @since 0.7.0
+def javascripts
+  %w(js/jquery.js js/app.js)
+end
+# @return [Array<String>] core stylesheets for the layout
+# @since 0.7.0
+def stylesheets
+  %w(css/style.css css/common.css)
+end
+# @return [Array<Hash{Symbol=>String}>] the list of search links and drop-down menus
+# @since 0.7.0
+def menu_lists
+  [{:type => 'class', :title => 'Classes', :search_title => 'Class List'},
+    {:type => 'method', :title => 'Methods', :search_title => 'Method List'},
+    {:type => 'file', :title => 'Files', :search_title => 'File List'}]
+end

data/yard-0.9.44/templates/default/method/html/header.erb ADDED Viewed

@@ -0,0 +1,17 @@
+<h1>Method: <%= object.path %></h1>
+<div class="box_info">
+  <dl>
+    <dt class="">Defined in:</dt>
+    <dd class="">
+    <%= 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>
+<div class="method_details_list">
+  <div id="method_details">
+    <%= yieldall :index => 0 %>
+  </div>
+</div>

data/yard-0.9.44/templates/default/method/setup.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+def init
+  sections :header, [T('method_details')]
+end

data/yard-0.9.44/templates/default/method/text/header.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= yieldall %>

data/yard-0.9.44/templates/default/method_details/html/header.erb ADDED Viewed

@@ -0,0 +1,3 @@
+<div class="method_details <%= @index == 0 ? 'first' : '' %>">
+  <%= yieldall %>
+</div>

data/yard-0.9.44/templates/default/method_details/html/method_signature.erb ADDED Viewed

@@ -0,0 +1,25 @@
+<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <% if object.tags(:overload).size == 1 %>
+    <%= signature(object.tag(:overload), false) %>
+  <% elsif object.tags(:overload).size > 1 %>
+    <% object.tags(:overload).each do |overload| %>
+      <span class="overload"><%= signature(overload, false) %></span>
+    <% end %>
+  <% else %>
+    <%= signature(object, false) %>
+  <% end %>
+  <% if object.aliases.size > 0 %>
+    <span class="aliases">Also known as:
+    <span class="names"><%= object.aliases.map {|o|
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
+    </span>
+  <% end %>
+  <% if owner != object.namespace %>
+    <span class="not_defined_here">
+      Originally defined in <%= object.namespace.type %>
+        <%= linkify object, owner.relative_path(object.namespace) %>
+    </span>
+  <% end %>
+</h3>

data/yard-0.9.44/templates/default/method_details/html/source.erb ADDED Viewed

@@ -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 %></pre>
+    </td>
+  </tr>
+</table>

data/yard-0.9.44/templates/default/method_details/setup.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+def init
+  sections :header, [:method_signature, T('docstring'), :source]
+end
+def source
+  return if owner != object.namespace
+  return if Tags::OverloadTag === object
+  return if object.source.nil?
+  erb(:source)
+end

data/yard-0.9.44/templates/default/method_details/text/header.erb ADDED Viewed

@@ -0,0 +1,10 @@
+<%= title_align_right format_object_title(object) %>
+<%= align_right "(Defined in: #{object.file})" %>
+<% if object.aliases.size > 0 %>
+<%= align_right "(Also known as: #{object.aliases.map {|o| o.name(true).to_s }.join(',')})" %>
+<% end %>
+<%= yieldall %>

data/yard-0.9.44/templates/default/method_details/text/method_signature.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<% if object.tags(:overload).size == 1 %>
+<%= indent wrap(signature(object.tag(:overload))) %>
+<% elsif object.tags(:overload).size > 1 %>
+<% object.tags(:overload).each do |overload| %>
+<%= indent wrap(signature(overload)) %>
+<% end %>
+<% else %>
+<%= indent wrap(signature(object)) %>
+<% end %>
+<%= hr %>

data/yard-0.9.44/templates/default/method_details/text/setup.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+def init
+  super
+  sections.last.pop
+end
+def format_object_title(object)
+  title = "Method: #{object.name(true)}"
+  title += " (#{object.namespace})" unless object.namespace.root?
+  title
+end

data/yard-0.9.44/templates/default/module/dot/child.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= format_path object %> [label="{<%= yieldall.gsub("\n", '') %>}" rank=sink];

data/yard-0.9.44/templates/default/module/dot/dependencies.erb ADDED Viewed

@@ -0,0 +1,3 @@
+<% object.mixins(:instance).each do |obj| %>
+  <%= format_path object %> -> <%= format_path obj %> [style=dotted arrowType=none];
+<% end %>

data/yard-0.9.44/templates/default/module/dot/header.erb ADDED Viewed

@@ -0,0 +1,6 @@
+subgraph cluster_<%= format_path object %> {
+  label = "<%= h(object.name) unless object.path == "" %>"; labelloc=b;
+  <% for obj in @modules %>
+    <%= yieldall :object => obj %>
+  <% end %>
+}

data/yard-0.9.44/templates/default/module/dot/info.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<%= object.type %> <%= h object.name %>
+<% if options.full %>
+|
+<% object.attributes.each do |scope, list| %>
+<% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>
+<%= uml_visibility(rw.values.compact.first) %> <%= h (rw[:read]||rw[:write]).name(true).gsub(/=$/,'') %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
+<% end %>
+<% end %>
+|
+<% method_listing.each do |obj| %>
+<%= uml_visibility obj %> <%= h obj.name(true) %>
+<%= h(" : #{obj.tag(:return).types.first}") if obj.has_tag?(:return) && obj.tag(:return).types && obj.tag(:return).types.size > 0 %>\l
+<% end %>
+<% end %>

data/yard-0.9.44/templates/default/module/dot/setup.rb ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+def init
+  @modules = object.children.select {|o| o.type == :module }
+  @classes = object.children.select {|o| o.type == :class }
+  sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
+end
+def dependencies
+  return unless options.dependencies
+  erb(:dependencies)
+end
+def classes
+  @classes.map {|k| yieldall :object => k }.join("\n")
+end