yard-chefdoc 0.1.0

data/templates/default/fulldoc/html/css/chefdoc.css

@@ -0,0 +1,52 @@
+table {
+  border: 0px;
+}
+
+th {
+  color: black;
+  padding: 5px;
+}
+
+td {
+  padding: 10px;
+}
+
+tr.r1 { background: #FFFFFF; }
+tr.r2 { background: #EFEFEF; }
+
+.visible {
+  display: table;
+}
+
+/* Makes the line below not go under metadata table */
+h2 {
+  display: flex
+}
+
+.metadata-box {
+  width: 24em;
+  border-collapse: collapse;
+  line-height: 1.2em;
+  font-size: 88%;
+  border: 1px solid #aaa;
+  border-spacing: 3px;
+  background-color: #f9f9f9;
+  color: black;
+  margin: 0.5em 0 0.5em 1em;
+  padding: 0.2em;
+  float: right;
+  clear: right;
+}
+
+.metadata-box .merged {
+  text-align: center;
+  padding: 0.25em 0.33em 0.33em;
+  line-height: 1.2em;
+  font-size: 1.25em;
+}
+
+.metadata-box .section {
+  text-align: center;
+  padding: 0.25em 0.33em 0.33em;
+  background-color: #ebebeb;
+}

data/templates/default/fulldoc/html/full_list_attributes.erb

@@ -0,0 +1,14 @@
+<% even_odd = 'odd'  %>
+<% @items.each do |item| %>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+    <li id="object_<%= item.path %>" class="<%= even_odd %>">
+      <div class="item" style="padding-left:30px">
+        <span class='object_link'>
+          <a href="<%= url_for(item) %>" title="<%= item.name %>">
+            <%= h(item.name) %>
+          </a>
+        </span>
+      <small class='search_info'><%= item.name %></small>
+      </div>
+    </li>
+<% end %>

data/templates/default/fulldoc/html/full_list_libraries.erb

@@ -0,0 +1,6 @@
+<li id="object_" class="odd">
+  <div class="item" style="padding-left:30px">
+    <%= link_object(Registry.root, Registry.root.title, nil, false) %>
+  </div>
+</li>
+<%= class_list %>

data/templates/default/fulldoc/html/full_list_recipes.erb

@@ -0,0 +1,13 @@
+<% even_odd = 'odd'  %>
+<% @items.each do |item| %>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+    <li id="object_<%= item.path %>" class="<%= even_odd %>">
+      <div class="item" style="padding-left:30px">
+        <span class='object_link'>
+          <a href="<%= url_for(item) %>" title="<%= item.file %>">
+            <%= h(item.name) %>
+          </a>
+        </span>
+      </div>
+    </li>
+<% end %>

data/templates/default/fulldoc/html/full_list_resources.erb

@@ -0,0 +1,13 @@
+<% even_odd = 'odd'  %>
+<% @items.each do |item| %>
+  <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+    <li id="object_<%= item.path %>" class="<%= even_odd %>">
+      <div class="item" style="padding-left:30px">
+        <span class='object_link'>
+          <a href="<%= url_for(item) %>" title="<%= item.file %>">
+            <%= h(item.name) %>
+          </a>
+        </span>
+      </div>
+    </li>
+<% end %>

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

@@ -0,0 +1,117 @@
+include Helpers::ChefHelper
+
+# Register custom stylesheets
+def init
+  # Maybe add an API endpoint for stats at some time
+  # asset('api/stats.json', JSON.pretty_generate(YARD::CLI::Stats.new(false).statistics_hash))
+
+  asset('css/chefdoc.css', file('css/chefdoc.css', true))
+
+  super
+end
+
+def stylesheets_full_list
+  %w[css/full_list.css css/common.css]
+end
+
+# Generates searchable recipe list in the output.
+def generate_recipes_list
+  recipes = chefsorted_objects(:recipe)
+  generate_full_list(recipes, 'Recipe', 'recipes')
+end
+
+# Generates searchable attribute list in the output.
+def generate_attributes_list
+  attributes = chefsorted_objects(:attribute)
+  generate_full_list(attributes, 'Attribute', 'attributes')
+end
+
+# Generates searchable resource list in the output.
+def generate_resources_list
+  resources = chefsorted_objects(:resource)
+  generate_full_list(resources, 'Resource', 'resources')
+end
+
+# Called by menu_lists in layout/html/setup.rb by default
+def generate_libraries_list
+  libraries = YARD::Registry.all(:cookbook).first.libraries
+  generate_full_list(libraries, 'Library', 'libraries')
+end
+
+def generate_full_list(objects, title, type)
+  @items = objects
+  @list_title = "#{title} List"
+  @list_type = type.to_s
+  asset(url_for_list(@list_type), erb(:full_list))
+end
+
+# The Class and class_list definition below are copies taken from YARD.
+# @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
+
+# rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+# @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 = ''
+  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 if child.is_a?(::YARD::CodeObjects::Chef::RecipeObject)
+    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}'>"
+    out << "<a class='toggle'></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
+      out << "<ul>#{class_list(child, tree)}</ul>" if has_children
+    end
+    out << '</li>'
+  end
+  out
+end
+# rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity

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

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= erb(:headers) %>
+  </head>
+  <body>
+    <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/templates/default/layout/html/setup.rb

@@ -0,0 +1,81 @@
+def init
+  super
+  @page_title = page_title
+  if @file
+    if @file.attributes[:namespace]
+      @object = options.object = Registry.at(@file.attributes[:namespace]) || Registry.root
+    end
+    @breadcrumb_title = "File: #{@file.title}"
+    @page_title = 'Cookbook Documentation'
+    sections :layout, [:title, [T('cookbook')]]
+  elsif object == '_index.html'
+    @object = options.object = Registry.root
+    sections :layout, [:title, [T('cookbook')]]
+  end
+end
+
+def layout
+  @nav_url = url_for_list(nav_select(options.index || options.object.type))
+
+  @path = if !object || object.is_a?(String)
+            nil
+          elsif @file
+            @file.path
+          elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
+            object.parent.path
+          else
+            object.path
+          end
+
+  erb(:layout)
+end
+
+def nav_select(type)
+  case type.to_s
+  when 'recipe'
+    'recipes'
+  when 'attribute'
+    'attributes'
+  when 'resource'
+    'resources'
+  when 'module', 'class'
+    'libraries'
+  when 'cookbook', 'root'
+    'file'
+  else
+    'recipes'
+  end
+end
+
+def javascripts
+  super
+end
+
+def stylesheets
+  super + %w[css/chefdoc.css]
+end
+
+# Add yard-chef specific menus
+# Methods generate_#{type}_list  must be defined in fulldoc/html/setup.rb
+def menu_lists
+  [
+    { type: 'recipes', title: 'Recipes', search_title: 'Recipe List' },
+    { type: 'attributes', title: 'Attributes', search_title: 'Attributes List' },
+    { type: 'resources', title: 'Resources', search_title: 'Resource List' },
+    { type: 'libraries', title: 'Libraries', search_title: 'Libraries List' },
+    { type: 'file', title: 'Files', search_title: 'File List' }
+  ]
+end
+
+def page_title
+  if object == '_index.html'
+    'Cookbook Documentation'
+  elsif object.is_a? CodeObjects::Base
+    case object.type
+    when :cookbook
+      "Cookbook: #{object.name}"
+    when :module, :class
+      format_object_title(object)
+    end
+  end
+end

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

@@ -0,0 +1 @@
+<%= yieldall :object => YARD::Registry.all(:cookbook).first %>

data/templates/default/recipe/html/recipe.erb

@@ -0,0 +1,8 @@
+<h2>Recipe <%= object.name %></h2>
+<div class="method_details">
+  <h3 class="signature">
+    <a name="<%= object.name %>"><strong><%= object.name %></strong></a>
+  </h3>
+  <%= htmlify(object.docstring, :markdown) %>
+  <%= yieldall :object => object, :owner => object.parent, :index => 1 %>
+</div>

data/templates/default/recipe/html/setup.rb

@@ -0,0 +1,8 @@
+def init
+  sections.push :recipe, [:source]
+end
+
+def source
+  return if object.source.nil?
+  erb(:source)
+end

data/templates/default/recipe/html/source.erb

@@ -0,0 +1,10 @@
+<table class="source_code visible">
+  <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 %>'</span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
+    </td>
+  </tr>
+</table>

data/templates/default/resource/html/actions.erb

@@ -0,0 +1,19 @@
+<h2>Actions</h2>
+  <h3>Default action: <a href="#action_<%= object.default_action %>"><%= object.default_action %></a></h3>
+  <% object.actions.each do |p| %>
+  <div>
+    <h4><a name="action_<%= p.identifier %>"><%= p.identifier %></a>:</h4>
+    <%= htmlify(p.docstring, :markdown) %>
+    <span class="showSource">[<a href="#" class="toggleSource">View source</a>]</span>
+    <table class="source_code invisible">
+      <tr>
+        <td>
+          <pre class="lines"><%= h format_lines(p) %></pre>
+        </td>
+        <td>
+          <pre class="code"><%= html_syntax_highlight p.source %></pre>
+        </td>
+      </tr>
+    </table>
+  </div>
+<% end %>

data/templates/default/resource/html/properties.erb

@@ -0,0 +1,18 @@
+<h2>Properties</h2>
+  <% object.properties.each do |p| %>
+  <div>
+    <h4><%= p.identifier %>:</h4>
+    <% unless p.type.nil? %>
+    Type: <code><%= p.type %></code>
+    <% end %>
+    <% unless p.options.nil? %>
+    <p>Other options</p>
+    <ul>
+      <% p.options.each do |option, value| %>
+      <li><%= option %>: <code><%= value %></code></li>
+      <% end %>
+    </ul>
+    <% end %>
+    <%= htmlify(p.docstring, :markdown) %>
+  </div>
+<% end %>

data/templates/default/resource/html/resource.erb

@@ -0,0 +1,3 @@
+<h2>Resource <%= object.name %></h2>
+<%= htmlify(object.docstring, :markdown) %>
+<%= yieldall :object => object, :owner => object.parent, :index => 1 %>

data/templates/default/resource/html/setup.rb

@@ -0,0 +1,15 @@
+include Helpers::ChefHelper
+
+def init
+  sections.push :resource, %i[properties actions]
+end
+
+def properties
+  return if object.properties.empty?
+  erb(:properties)
+end
+
+def name_property?(options)
+  return false if options.nil?
+  options.key?('name_property') && options['name_property'] == 'true'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: yard-chefdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jörg Herzinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+description: 
+email: joerg.herzinger+chefdoc@oiml.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yard-chefdoc.rb
+- lib/yard-chefdoc/code_objects/attribute.rb
+- lib/yard-chefdoc/code_objects/chef.rb
+- lib/yard-chefdoc/code_objects/cookbook.rb
+- lib/yard-chefdoc/code_objects/recipe.rb
+- lib/yard-chefdoc/code_objects/resource.rb
+- lib/yard-chefdoc/handlers/attribute.rb
+- lib/yard-chefdoc/handlers/base.rb
+- lib/yard-chefdoc/handlers/cookbook.rb
+- lib/yard-chefdoc/handlers/recipe.rb
+- lib/yard-chefdoc/handlers/resource_action.rb
+- lib/yard-chefdoc/handlers/resource_default_action.rb
+- lib/yard-chefdoc/handlers/resource_property.rb
+- lib/yard-chefdoc/handlers/resource_resource_name.rb
+- lib/yard-chefdoc/template_helpers/chef.rb
+- lib/yard-chefdoc/version.rb
+- lib/yard/cli/stats.rb
+- spec/attributes_spec.rb
+- spec/home_spec.rb
+- spec/recipes_spec.rb
+- spec/resources_spec.rb
+- spec/spec_helper.rb
+- templates/default/attribute/html/attribute.erb
+- templates/default/attribute/html/setup.rb
+- templates/default/cookbook/html/attributes.erb
+- templates/default/cookbook/html/cookbook_title.erb
+- templates/default/cookbook/html/docstring.erb
+- templates/default/cookbook/html/element_details.erb
+- templates/default/cookbook/html/generated_docs.erb
+- templates/default/cookbook/html/libraries.erb
+- templates/default/cookbook/html/metadata.erb
+- templates/default/cookbook/html/recipes.erb
+- templates/default/cookbook/html/resources.erb
+- templates/default/cookbook/html/setup.rb
+- templates/default/fulldoc/html/css/chefdoc.css
+- templates/default/fulldoc/html/full_list_attributes.erb
+- templates/default/fulldoc/html/full_list_libraries.erb
+- templates/default/fulldoc/html/full_list_recipes.erb
+- templates/default/fulldoc/html/full_list_resources.erb
+- templates/default/fulldoc/html/setup.rb
+- templates/default/layout/html/layout.erb
+- templates/default/layout/html/setup.rb
+- templates/default/layout/html/title.erb
+- templates/default/recipe/html/recipe.erb
+- templates/default/recipe/html/setup.rb
+- templates/default/recipe/html/source.erb
+- templates/default/resource/html/actions.erb
+- templates/default/resource/html/properties.erb
+- templates/default/resource/html/resource.erb
+- templates/default/resource/html/setup.rb
+homepage: https://github.com/chefdoc/yard-chefdoc
+licenses:
+- MIT
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A ruby yard extension for docuementing Chef cookbooks
+test_files: []