# 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. require 'yard' module YARD::CodeObjects module Chef # A ResourceObject represents a lightweight resource in chef. # See http://docs.opscode.com/essentials_cookbook_lwrp.html # class ResourceObject < ChefObject register_element :resource # Creates a new instance of ResourceObject. # # @param namespace [NamespaceObject] namespace to which the lightweight # resource belongs # @param name [String] name of the lightweight resource # # @return [ResourceObject] the newly created ResourceObject # def initialize(namespace, name) super(namespace, name) @providers = [] end # Constructs class name for the lightweight resource. # # @return [String] class name for the lightweight resource # def long_name name = '' if @name.to_s =~ /_/ @name.to_s.split('_').each do |str| name << str.to_s.capitalize end else name = @name.to_s.capitalize end namespace = @namespace.to_s.split('::').map { |str| str.capitalize } "#{namespace.join('::')}::#{name}" end # Attributes defined in the lightweight resource. # # @return [Array] attributes in the lightweight resource # def attributes children_by_type(:attribute) end # Actions supported by the lightweight resource. # # @return [Array] actions in the lightweight resource # def actions children_by_type(:action) end end # Register 'resource' as a child of 'chef' namespace RESOURCE = ChefObject.register(CHEF, 'resource', :resource) end end