class YARD::CodeObjects::Chef::CookbookObject

A CookbookObject represents a Chef cookbook. See wiki.opscode.com/display/chef/Cookbooks for more information about cookbooks.

Attributes

dependencies[RW]

Cookbook metadata

docstring_type[RW]
gems[RW]
issues_url[RW]
license[RW]
maintainer[RW]
maintainer_email[RW]
platforms[RW]
source_url[RW]
version[RW]

Public Class Methods

new(namespace, name) click to toggle source

Creates a new CookbookObject instance. @param namespace [NamespaceObject] namespace to which the cookbook belongs @param name [String] name of the cookbook

@return [CookbookObject] the newly created CookbookObject

# File lib/yard-chefdoc/code_objects/cookbook.rb, line 32
def initialize(namespace, name)
  super(namespace, name)
  @docstring_type = :markdown
end

Public Instance Methods

libraries() click to toggle source

Libraries defined in the cookbook. Catches all classes, modules and defintion directly defined without a namespace

@return [Array] libraries in the cookbook

# File lib/yard-chefdoc/code_objects/cookbook.rb, line 42
def libraries
  modules = YARD::Registry.all(:module)
  classes = YARD::Registry.all(:class)
  root_definitions = YARD::Registry.all(:method).select { |m| m.path =~ /^root#/ }

  classes + modules + root_definitions
end
metadata() click to toggle source
# File lib/yard-chefdoc/code_objects/cookbook.rb, line 50
def metadata
  [@version, @maintainer, @dependencies]
end