Class: Chef::Resource::GemPackage

Inherits:
Package show all
Defined in:
lib/chef/resource/gem_package.rb

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #delayed_notifications, #enclosing_provider, #immediate_notifications, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Package

#package_name, #response_file, #version

Methods inherited from Chef::Resource

#action, #add_notification, attribute, build_from_file, #defined_at, #epic_fail, #ignore_failure, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #resolve_notification_references, #resources, #run_action, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, run_context = nil) ⇒ GemPackage

Returns a new instance of GemPackage.



25
26
27
28
29
 
# File 'lib/chef/resource/gem_package.rb', line 25

def initialize(name, run_context=nil)
  super
  @resource_name = :gem_package
  @provider = Chef::Provider::Package::Rubygems
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#gem_binary(gem_cmd = nil) ⇒ Object

Sets a custom gem_binary to run for gem commands.



36
37
38
 
# File 'lib/chef/resource/gem_package.rb', line 36

def gem_binary(gem_cmd=nil)
  set_or_return(:gem_binary,gem_cmd,:kind_of => [ String ])
end

#options(opts = nil) ⇒ Object

Options for the gem install, either a Hash or a String. When a hash is given, the options are passed to Gem::DependencyInstaller.new, and the gem will be installed via the gems API. When a String is given, the gem will be installed by shelling out to the gem command. Using a Hash of options with an explicit gem_binary will result in undefined behavior.



46
47
48
 
# File 'lib/chef/resource/gem_package.rb', line 46

def options(opts=nil)
  set_or_return(:options,opts,:kind_of => [String,Hash])
end

#source(arg = nil) ⇒ Object 



31
32
33
 
# File 'lib/chef/resource/gem_package.rb', line 31

def source(arg=nil)
  set_or_return(:source, arg, :kind_of => [ String, Array ])
end