yard-chef 1.0.0

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

@@ -0,0 +1,37 @@
+<%# vim: filetype=eruby.html
+
+Copyright (c) 2012 RightScale, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+%>
+
+<% n = 1 %>
+<% @items.each do |item| %>
+  <% unless item.namespace.parent.root? %>
+    <li class="r<%= n %>">
+      <span class="object_link">
+        <a href="<%= url_for(item.parent, item.name) %>" title="<%= item.file %>">
+          <%= h(item.name) %>
+        </a>
+      </span>
+    </li>
+    <% n = n == 2 ? 1 : 2 %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,39 @@
+<%# vim: filetype=eruby.html
+
+Copyright (c) 2012 RightScale, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+%>
+
+<% n = 1 %>
+<% @items.each do |item| %>
+  <% unless item.resources.empty? %>
+    <% item.resources.each do |resource| %>
+      <li class="r<%= n %>">
+        <span class="object_link">
+          <a href="<%= url_for(item, resource.long_name) %>" title="<%= resource.file %>">
+            <%= h(resource.name) %>
+          </a>
+        </span>
+      </li>
+      <% n = n == 2 ? 1 : 2 %>
+    <% end %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,99 @@
+# Copyright (c) 2012 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+def init
+  super
+
+  # Register custom stylesheets
+  asset('css/common.css', file('css/common.css', true))
+
+  # Generate cookbook pages
+  chef = YARD::Registry.all(:chef).first
+  chef.cookbooks.each do |cookbook|
+    serialize(cookbook)
+  end
+end
+
+# Generates searchable recipe list in the output.
+#
+def generate_recipes_list
+  recipes = YARD::Registry.all(:recipe).sort_by { |recipe| recipe.name.to_s }
+  generate_full_list(recipes, 'Recipe', 'recipes')
+end
+
+# Generates searchable resource list in the output.
+#
+def generate_resources_list
+  cookbooks = YARD::Registry.all(:cookbook).sort_by { |cookbook| cookbook.name.to_s }
+  generate_full_list(cookbooks, 'Resource', 'resources')
+end
+
+# Called by menu_lists in layout/html/setup.rb by default
+def generate_definitions_list
+  cookbooks = YARD::Registry.all(:cookbook).sort_by { |cookbook| cookbook.name.to_s }
+  definitions = []
+  cookbooks.each { |cookbook| definitions = definitions + cookbook.definitions }
+  generate_full_list(definitions, 'Definition', 'definitions')
+end
+
+# Called by menu_lists in layout/html/setup.rb by default
+def generate_cookbooks_list
+  cookbooks = YARD::Registry.all(:cookbook).sort_by{|cookbook| cookbook.name.to_s}
+  generate_full_list(cookbooks, 'Cookbooks', 'cookbooks')
+end
+
+# Called by menu_lists in layout/html/setup.rb by default
+def generate_libraries_list
+  libraries = options.objects if options.objects
+  generate_full_list(libraries, 'Library', 'class')
+end
+
+def generate_full_list(objects, title, type)
+  @items = objects
+  @list_title = "#{title} List"
+  @list_type = "#{type}"
+  asset(url_for_list(@list_type), erb(:full_list))
+end
+
+def class_list(root = YARD::Registry.root)
+  out = ""
+  children = run_verifier(root.children)
+  children.reject {|c| c.nil? }.sort_by {|child| child.path }.map do |child|
+    if child.is_a?(CodeObjects::ModuleObject)
+      name = child.name
+      has_children = child.children.any? {|o| o.is_a?(CodeObjects::ModuleObject) }
+      out << "<li>"
+      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'>"
+      if !child.namespace || child.namespace.root?
+        out << "Top Level Namespace"
+      else
+        out << child.namespace.path
+      end
+      out << "</small>"
+      out << "</li>"
+      out << "<ul>#{class_list(child)}</ul>" if has_children
+    end
+  end
+  out
+end

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

@@ -0,0 +1,46 @@
+<%# vim: filetype=eruby.html
+
+Copyright (c) 2012 RightScale, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+%>
+
+<h1>Cookbooks List</h1>
+<table>
+  <thead>
+    <tr>
+      <th>Cookbook</th>
+      <th>Description</th>
+      <th>Version</th>
+    </tr>
+  </thead>
+  <tbody>
+  <% n = 1 %>
+  <% cookbooks = Registry.all(:cookbook).uniq.sort_by {|cookbook| cookbook.name.to_s} %>
+  <% cookbooks.each do |cookbook| %>
+    <tr class="r<%= n %>">
+      <td><%= linkify cookbook %></td>
+      <td><%= cookbook.short_desc %></td>
+      <td><%= cookbook.version %></td>
+    </tr>
+    <% n = n == 2 ? 1 : 2 %>
+  <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,58 @@
+# Copyright (c) 2012 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+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, [:diskfile, :cookbook_table]]
+  elsif object == '_index.html'
+    sections :layout, [:title, [T('chef')]]
+  end
+end
+
+# Add yard-chef specific menus
+# Methods generate_#{type}_list  must be defined in fulldoc/html/setup.rb
+def menu_lists
+[ { :type => 'cookbooks', :title => 'Cookbooks', :search_title => 'Cookbook List'},
+  { :type => 'recipes', :title => 'Recipes', :search_title => 'Recipe List'},
+  { :type => 'resources', :title => 'Resources', :search_title => 'Resource List'},
+  { :type => 'definitions', :title => 'Definitions', :search_title => 'Definitions List' },
+  { :type => 'class', :title => 'Libraries', :search_title => 'Libraries 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,28 @@
+<%# vim: filetype=eruby.html
+
+Copyright (c) 2012 RightScale, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+%>
+
+<div id="filecontents">
+  <h1>Chef Cookbooks Documentation</h1>
+  <%= yieldall :object => YARD::Registry.all(:chef).first %>
+</div>

data/templates/default/provider/html/providers_summary.erb

@@ -0,0 +1,31 @@
+<%# vim: filetype=eruby.html
+
+Copyright (c) 2012 RightScale, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+%>
+
+<% if @providers.size > 0 %>
+  <h2>Providers</h2>
+  <% @providers.each do |provider| %>
+    <h3><a name="<%= provider.long_name %>"><%= provider.name %></a></h3>
+    <ul><%= yieldall :object => provider %></ul>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,26 @@
+# Copyright (c) 2012 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+def init
+  @providers = object.providers
+
+  sections.push :providers_summary, [T('action')]
+end

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

@@ -0,0 +1,37 @@
+<%# vim: filetype=eruby.html
+
+Copyright (c) 2012 RightScale, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+%>
+
+<% recipes = object.children_by_type(:recipe) %>
+<% if recipes.size > 0 %>
+  <h2>Recipe Details</h2>
+  <% recipes.each_with_index do |recipe, i| %>
+    <div class="method_details <%= 'first' if i == 0 %>">
+      <h3 class="signature"><a name="<%= recipe.name %>">
+        <strong><%= recipe.name %></strong>
+      </a></h3>
+      <%= htmlify recipe.docstring %>
+      <%= yieldall :object => recipe, :owner => object, :index => i %>
+    </div>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,29 @@
+# Copyright (c) 2012 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+def init
+  sections.push :recipe_list, [:source]
+end
+
+def source
+  return if object.source.nil?
+  erb(:source)
+end