Provides the primary recipe DSL functionality for defining Chef resource objects via method calls.
Instantiate a resource of the given type with the given name and attributes as given in the resource_attrs_block.
The resource is NOT added to the resource collection.
# File lib/chef/dsl/recipe.rb, line 109 def build_resource(type, name, created_at=nil, &resource_attrs_block) created_at ||= caller[0] # Checks the new platform => short_name => resource mapping initially # then fall back to the older approach (Chef::Resource.const_get) for # backward compatibility resource_class = resource_class_for(type) raise ArgumentError, "You must supply a name when declaring a #{type} resource" if name.nil? resource = resource_class.new(name, run_context) resource.source_line = created_at # If we have a resource like this one, we want to steal its state # This behavior is very counter-intuitive and should be removed. # See CHEF-3694, https://tickets.opscode.com/browse/CHEF-3694 # Moved to this location to resolve CHEF-5052, https://tickets.opscode.com/browse/CHEF-5052 resource.load_prior_resource resource.cookbook_name = cookbook_name resource.recipe_name = recipe_name # Determine whether this resource is being created in the context of an enclosing Provider resource.enclosing_provider = self.is_a?(Chef::Provider) ? self : nil # XXX: This is very crufty, but it's required for resource definitions # to work properly :( resource.params = @params # Evaluate resource attribute DSL resource.instance_eval(&resource_attrs_block) if block_given? # Run optional resource hook resource.after_created resource end
Instantiates a resource (via build_resource), then adds it to the resource collection. Note that resource classes are looked up directly, so this will create the resource you intended even if the method name corresponding to that resource has been overridden.
# File lib/chef/dsl/recipe.rb, line 82 def declare_resource(type, name, created_at=nil, &resource_attrs_block) created_at ||= caller[0] resource = build_resource(type, name, created_at, &resource_attrs_block) # Some resources (freebsd_package) can be invoked with multiple names # (package || freebsd_package). # https://github.com/opscode/chef/issues/1773 # For these resources we want to make sure # their key in resource collection is same as the name they are declared # as. Since this might be a breaking change for resources that define # customer to_s methods, we are working around the issue by letting # resources know of their created_as_type until this issue is fixed in # Chef 12: # https://github.com/opscode/chef/issues/1817 if resource.respond_to?(:created_as_type=) resource.created_as_type = type end run_context.resource_collection.insert(resource) resource end
# File lib/chef/dsl/recipe.rb, line 154 def describe_self_for_error if respond_to?(:name) %[`#{self.class.name} "#{name}"'] elsif respond_to?(:recipe_name) %[`#{self.class.name} "#{recipe_name}"'] else to_s end end
Processes the arguments and block as a resource definition.
# File lib/chef/dsl/recipe.rb, line 60 def evaluate_resource_definition(definition_name, *args, &block) # This dupes the high level object, but we still need to dup the params new_def = run_context.definitions[definition_name].dup new_def.params = new_def.params.dup new_def.node = run_context.node # This sets up the parameter overrides new_def.instance_eval(&block) if block new_recipe = Chef::Recipe.new(cookbook_name, recipe_name, run_context) new_recipe.params = new_def.params new_recipe.params[:name] = args[0] new_recipe.instance_eval(&new_def.recipe) new_recipe end
# File lib/chef/dsl/recipe.rb, line 53 def has_resource_definition?(name) yes_or_no = run_context.definitions.has_key?(name) yes_or_no end
# File lib/chef/dsl/recipe.rb, line 148 def have_resource_class_for?(snake_case_name) not resource_class_for(snake_case_name).nil? rescue NameError false end
# File lib/chef/dsl/recipe.rb, line 33 def method_missing(method_symbol, *args, &block) # If we have a definition that matches, we want to use that instead. This should # let you do some really crazy over-riding of "native" types, if you really want # to. if has_resource_definition?(method_symbol) evaluate_resource_definition(method_symbol, *args, &block) elsif have_resource_class_for?(method_symbol) # Otherwise, we're rocking the regular resource call route. declare_resource(method_symbol, args[0], caller[0], &block) else begin super rescue NoMethodError raise NoMethodError, "No resource or method named `#{method_symbol}' for #{describe_self_for_error}" rescue NameError raise NameError, "No resource, method, or local variable named `#{method_symbol}' for #{describe_self_for_error}" end end end
Generated with the Darkfish Rdoc Generator 2.