Class: Chef::Resource::Scm

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

Direct Known Subclasses

Git, Subversion

Instance Attribute Summary

Attributes inherited from Chef::Resource

#actions, #allowed_actions, #collection, #cookbook_name, #enclosing_provider, #node, #params, #provider, #recipe_name, #resource_name, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, attribute, build_from_file, #epic_fail, #ignore_failure, #is, json_create, #load_prior_resource, #method_missing, #name, #noop, #not_if, #notifies, #only_if, provider_base, #resources, #run_action, #subscribes, #supports, #to_hash, #to_json, #to_s

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #filename_to_qualified_string

Methods included from Mixin::Language

#platform?, #value_for_platform

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, collection = nil, node = nil) ⇒ Scm

Returns a new instance of Scm.



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/chef/resource/scm.rb', line 26

def initialize(name, collection=nil, node=nil)
  super(name, collection, node)
  @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)
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”



95
96
97
98
99
100
101
 
# File 'lib/chef/resource/scm.rb', line 95

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

#destination(arg = nil) ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/chef/resource/scm.rb', line 38

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

#enable_submodules(arg = nil) ⇒ Object 



103
104
105
106
107
108
109
 
# File 'lib/chef/resource/scm.rb', line 103

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

#remote(arg = nil) ⇒ Object 



111
112
113
114
115
116
117
 
# File 'lib/chef/resource/scm.rb', line 111

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

#repository(arg = nil) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/chef/resource/scm.rb', line 46

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

#revision(arg = nil) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/chef/resource/scm.rb', line 54

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

#ssh_wrapper(arg = nil) ⇒ Object 



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

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

#svn_arguments(arg = nil) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'lib/chef/resource/scm.rb', line 86

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

#svn_password(arg = nil) ⇒ Object 



78
79
80
81
82
83
84
 
# File 'lib/chef/resource/scm.rb', line 78

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

#svn_username(arg = nil) ⇒ Object 



70
71
72
73
74
75
76
 
# File 'lib/chef/resource/scm.rb', line 70

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

#user(arg = nil) ⇒ Object 



62
63
64
65
66
67
68
 
# File 'lib/chef/resource/scm.rb', line 62

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