Class: Chef::Resource::Scm

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/scm.rb

Direct Known Subclasses

Git, Subversion

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #elapsed_time, #enclosing_provider, #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 Chef::Resource

#action, #add_notification, #after_created, #as_json, attribute, build_from_file, #cookbook_version, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, platform_map, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_for_platform, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_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?, #platform_family?, #search, #value_for_platform, #value_for_platform_family

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, run_context = nil) ⇒ Scm

Returns a new instance of Scm.



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/chef/resource/scm.rb', line 30

def initialize(name, run_context=nil)
  super
  @destination = name
  @resource_name = :scm
  @enable_submodules = false
  @revision = "HEAD"
  @remote = "origin"
  @ssh_wrapper = nil
  @depth = nil
  @allowed_actions.push(:checkout, :export, :sync, :diff, :log)
  @action = [:sync]
end

Dynamic Method Handling

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

Instance Method Details

#depth(arg = nil) ⇒ Object

Capistrano and git-deploy use “shallow clone”



117
118
119
120
121
122
123
 
# File 'lib/chef/resource/scm.rb', line 117

def depth(arg=nil)
  set_or_return(
    :depth,
    arg,
    :kind_of => Integer
  )
end

#destination(arg = nil) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/chef/resource/scm.rb', line 43

def destination(arg=nil)
  set_or_return(
    :destination,
    arg,
    :kind_of => String
  )
end

#enable_submodules(arg = nil) ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/chef/resource/scm.rb', line 125

def enable_submodules(arg=nil)
  set_or_return(
    :enable_submodules,
    arg,
    :kind_of => [TrueClass, FalseClass]
  )
end

#group(arg = nil) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/chef/resource/scm.rb', line 75

def group(arg=nil)
  set_or_return(
    :group,
    arg,
    :kind_of => [String, Integer]
  )
end

#remote(arg = nil) ⇒ Object 



133
134
135
136
137
138
139
 
# File 'lib/chef/resource/scm.rb', line 133

def remote(arg=nil)
  set_or_return(
    :remote,
    arg,
    :kind_of => String
  )
end

#repository(arg = nil) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/chef/resource/scm.rb', line 51

def repository(arg=nil)
  set_or_return(
    :repository,
    arg,
    :kind_of => String
  )
end

#revision(arg = nil) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/chef/resource/scm.rb', line 59

def revision(arg=nil)
  set_or_return(
    :revision,
    arg,
    :kind_of => String
  )
end

#ssh_wrapper(arg = nil) ⇒ Object 



141
142
143
144
145
146
147
 
# File 'lib/chef/resource/scm.rb', line 141

def ssh_wrapper(arg=nil)
  set_or_return(
    :ssh_wrapper,
    arg,
    :kind_of => String
  )
end

#svn_arguments(arg = nil) ⇒ Object 



99
100
101
102
103
104
105
106
 
# File 'lib/chef/resource/scm.rb', line 99

def svn_arguments(arg=nil)
  @svn_arguments, arg = nil, nil if arg == false
  set_or_return(
    :svn_arguments,
    arg,
    :kind_of => String
  )
end

#svn_info_args(arg = nil) ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/chef/resource/scm.rb', line 108

def svn_info_args(arg=nil)
  @svn_info_args, arg = nil, nil if arg == false
  set_or_return(
    :svn_info_args,
    arg,
    :kind_of => String)
end

#svn_password(arg = nil) ⇒ Object 



91
92
93
94
95
96
97
 
# File 'lib/chef/resource/scm.rb', line 91

def svn_password(arg=nil)
  set_or_return(
    :svn_password,
    arg,
    :kind_of => String
  )
end

#svn_username(arg = nil) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/chef/resource/scm.rb', line 83

def svn_username(arg=nil)
  set_or_return(
    :svn_username,
    arg,
    :kind_of => String
  )
end

#user(arg = nil) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/chef/resource/scm.rb', line 67

def user(arg=nil)
  set_or_return(
    :user,
    arg,
    :kind_of => [String, Integer]
  )
end