yard-chef 1.0.0

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

@@ -0,0 +1,34 @@
+<%# vim: filetype=eruby.html
+
+Copyright (c) 2007-2012 Loren Segal
+
+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.
+%>
+
+<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/templates/default/resource/html/actions.erb

@@ -0,0 +1,43 @@
+<%# 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 object.actions.size > 0 %>
+  <h4>Actions</h4>
+  <% n = 1 %>
+  <ul><table>
+    <thead>
+      <th>Action</th>
+      <th>Description</th>
+    </thead>
+    <tbody>
+      <% object.actions.each do |action| %>
+        <tr class="r<%= n %>">
+          <td><strong><%= action.name %></strong></td>
+          <td><%= action.docstring %></td>
+        </tr>
+        <% n = n == 2 ? 1 : 2 %>
+      <% end %>
+    </tbody>
+  </table></ul>
+<% end %>

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

@@ -0,0 +1,38 @@
+<%# 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 object.providers.size > 0 %>
+  <h4>Providers</h4>
+  <ul class="summary compact">
+    <% object.providers.each do |provider| %>
+      <li>
+        <span class="summary_signature">
+          <a href="<%= link_to_provider(provider) %>">
+            <%= provider.long_name %>
+          </a>
+        </span>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/templates/default/resource/html/resource_list.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 @resources.size > 0 %>
+  <h2>Lightweight Resources</h2>
+  <% @resources.each do |resource| %>
+    <h3><a name="<%= resource.long_name %>"><%= resource.name %></a></h3>
+    <ul><%= yieldall :object => resource %></ul>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,37 @@
+# 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
+  @resources = object.resources
+
+  sections :resource_list, [:actions, T('attribute'), :providers_list]
+end
+
+# Gets the link to the provider. This is a workaround as 'url_for' method
+# returns "../cookbook_name.html#provider_name" while yard server returns
+# "cookbook_name.html#provider_name". So the links to provider do not work
+# when url_for is used directly.
+#
+def link_to_provider(provider)
+  url = url_for(provider.cookbook, provider.long_name)
+  url.slice!("../")
+  url
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: yard-chef
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Douglas Thrift
+- Nick Stakanov
+- Nitin Mohan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: yard-chef is a YARD plugin for Chef that adds support for documenting
+  Chef cookbooks, resources, providers, and definitions.
+email:
+- douglas@rightscale.com
+- nitin@rightscale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- templates/default/action/html/action_list.erb
+- templates/default/action/html/action_summary.erb
+- templates/default/action/html/source.erb
+- templates/default/attribute/html/attribute_header.erb
+- templates/default/attribute/html/table.erb
+- templates/default/chef/html/cookbook_table.erb
+- templates/default/chef/html/docstring.erb
+- templates/default/cookbook/html/cookbook_title.erb
+- templates/default/cookbook/html/definitions.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/recipes.erb
+- templates/default/definition/html/definition_list.erb
+- templates/default/definition/html/source.erb
+- templates/default/fulldoc/html/full_list_cookbooks.erb
+- templates/default/fulldoc/html/full_list_definitions.erb
+- templates/default/fulldoc/html/full_list_recipes.erb
+- templates/default/fulldoc/html/full_list_resources.erb
+- templates/default/layout/html/cookbook_table.erb
+- templates/default/layout/html/title.erb
+- templates/default/provider/html/providers_summary.erb
+- templates/default/recipe/html/recipe_list.erb
+- templates/default/recipe/html/source.erb
+- templates/default/resource/html/actions.erb
+- templates/default/resource/html/providers_list.erb
+- templates/default/resource/html/resource_list.erb
+- templates/default/action/html/setup.rb
+- templates/default/attribute/html/setup.rb
+- templates/default/chef/html/setup.rb
+- templates/default/cookbook/html/setup.rb
+- templates/default/definition/html/setup.rb
+- templates/default/fulldoc/html/setup.rb
+- templates/default/layout/html/setup.rb
+- templates/default/provider/html/setup.rb
+- templates/default/recipe/html/setup.rb
+- templates/default/resource/html/setup.rb
+- templates/default/fulldoc/html/css/common.css
+- lib/yard-chef/code_objects/action_object.rb
+- lib/yard-chef/code_objects/attribute_object.rb
+- lib/yard-chef/code_objects/chef_object.rb
+- lib/yard-chef/code_objects/cookbook_object.rb
+- lib/yard-chef/code_objects/provider_object.rb
+- lib/yard-chef/code_objects/recipe_object.rb
+- lib/yard-chef/code_objects/resource_object.rb
+- lib/yard-chef/handlers/action.rb
+- lib/yard-chef/handlers/actions.rb
+- lib/yard-chef/handlers/attribute.rb
+- lib/yard-chef/handlers/base.rb
+- lib/yard-chef/handlers/cookbook.rb
+- lib/yard-chef/handlers/define.rb
+- lib/yard-chef/handlers/recipe.rb
+- lib/yard-chef.rb
+homepage: https://github.com/rightscale/yard-chef
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: YARD plugin for Chef
+test_files: []
+has_rdoc: