le1t0-capistrano 2.5.18.001
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +9 -0
- data/CHANGELOG +843 -0
- data/README +102 -0
- data/Rakefile +36 -0
- data/VERSION +1 -0
- data/bin/cap +4 -0
- data/bin/capify +86 -0
- data/lib/capistrano.rb +2 -0
- data/lib/capistrano/callback.rb +45 -0
- data/lib/capistrano/cli.rb +47 -0
- data/lib/capistrano/cli/execute.rb +85 -0
- data/lib/capistrano/cli/help.rb +125 -0
- data/lib/capistrano/cli/help.txt +78 -0
- data/lib/capistrano/cli/options.rb +243 -0
- data/lib/capistrano/cli/ui.rb +40 -0
- data/lib/capistrano/command.rb +283 -0
- data/lib/capistrano/configuration.rb +44 -0
- data/lib/capistrano/configuration/actions/file_transfer.rb +52 -0
- data/lib/capistrano/configuration/actions/inspect.rb +46 -0
- data/lib/capistrano/configuration/actions/invocation.rb +295 -0
- data/lib/capistrano/configuration/callbacks.rb +148 -0
- data/lib/capistrano/configuration/connections.rb +204 -0
- data/lib/capistrano/configuration/execution.rb +143 -0
- data/lib/capistrano/configuration/loading.rb +197 -0
- data/lib/capistrano/configuration/namespaces.rb +197 -0
- data/lib/capistrano/configuration/roles.rb +73 -0
- data/lib/capistrano/configuration/servers.rb +98 -0
- data/lib/capistrano/configuration/variables.rb +127 -0
- data/lib/capistrano/errors.rb +19 -0
- data/lib/capistrano/extensions.rb +57 -0
- data/lib/capistrano/logger.rb +59 -0
- data/lib/capistrano/processable.rb +53 -0
- data/lib/capistrano/recipes/compat.rb +32 -0
- data/lib/capistrano/recipes/deploy.rb +589 -0
- data/lib/capistrano/recipes/deploy/dependencies.rb +44 -0
- data/lib/capistrano/recipes/deploy/local_dependency.rb +54 -0
- data/lib/capistrano/recipes/deploy/remote_dependency.rb +105 -0
- data/lib/capistrano/recipes/deploy/scm.rb +19 -0
- data/lib/capistrano/recipes/deploy/scm/accurev.rb +169 -0
- data/lib/capistrano/recipes/deploy/scm/base.rb +196 -0
- data/lib/capistrano/recipes/deploy/scm/bzr.rb +86 -0
- data/lib/capistrano/recipes/deploy/scm/cvs.rb +152 -0
- data/lib/capistrano/recipes/deploy/scm/darcs.rb +96 -0
- data/lib/capistrano/recipes/deploy/scm/git.rb +278 -0
- data/lib/capistrano/recipes/deploy/scm/mercurial.rb +137 -0
- data/lib/capistrano/recipes/deploy/scm/none.rb +44 -0
- data/lib/capistrano/recipes/deploy/scm/perforce.rb +138 -0
- data/lib/capistrano/recipes/deploy/scm/subversion.rb +121 -0
- data/lib/capistrano/recipes/deploy/strategy.rb +19 -0
- data/lib/capistrano/recipes/deploy/strategy/base.rb +79 -0
- data/lib/capistrano/recipes/deploy/strategy/checkout.rb +20 -0
- data/lib/capistrano/recipes/deploy/strategy/copy.rb +218 -0
- data/lib/capistrano/recipes/deploy/strategy/export.rb +20 -0
- data/lib/capistrano/recipes/deploy/strategy/remote.rb +52 -0
- data/lib/capistrano/recipes/deploy/strategy/remote_cache.rb +56 -0
- data/lib/capistrano/recipes/deploy/templates/maintenance.rhtml +53 -0
- data/lib/capistrano/recipes/standard.rb +37 -0
- data/lib/capistrano/recipes/templates/maintenance.rhtml +53 -0
- data/lib/capistrano/role.rb +102 -0
- data/lib/capistrano/server_definition.rb +56 -0
- data/lib/capistrano/shell.rb +260 -0
- data/lib/capistrano/ssh.rb +99 -0
- data/lib/capistrano/task_definition.rb +75 -0
- data/lib/capistrano/transfer.rb +216 -0
- data/lib/capistrano/version.rb +18 -0
- data/test/cli/execute_test.rb +132 -0
- data/test/cli/help_test.rb +165 -0
- data/test/cli/options_test.rb +329 -0
- data/test/cli/ui_test.rb +28 -0
- data/test/cli_test.rb +17 -0
- data/test/command_test.rb +286 -0
- data/test/configuration/actions/file_transfer_test.rb +61 -0
- data/test/configuration/actions/inspect_test.rb +65 -0
- data/test/configuration/actions/invocation_test.rb +225 -0
- data/test/configuration/callbacks_test.rb +220 -0
- data/test/configuration/connections_test.rb +349 -0
- data/test/configuration/execution_test.rb +175 -0
- data/test/configuration/loading_test.rb +132 -0
- data/test/configuration/namespace_dsl_test.rb +311 -0
- data/test/configuration/roles_test.rb +144 -0
- data/test/configuration/servers_test.rb +158 -0
- data/test/configuration/variables_test.rb +184 -0
- data/test/configuration_test.rb +88 -0
- data/test/deploy/local_dependency_test.rb +76 -0
- data/test/deploy/remote_dependency_test.rb +114 -0
- data/test/deploy/scm/accurev_test.rb +23 -0
- data/test/deploy/scm/base_test.rb +55 -0
- data/test/deploy/scm/bzr_test.rb +51 -0
- data/test/deploy/scm/darcs_test.rb +37 -0
- data/test/deploy/scm/git_test.rb +184 -0
- data/test/deploy/scm/mercurial_test.rb +134 -0
- data/test/deploy/scm/none_test.rb +35 -0
- data/test/deploy/scm/subversion_test.rb +32 -0
- data/test/deploy/strategy/copy_test.rb +302 -0
- data/test/extensions_test.rb +69 -0
- data/test/fixtures/cli_integration.rb +5 -0
- data/test/fixtures/config.rb +5 -0
- data/test/fixtures/custom.rb +3 -0
- data/test/logger_test.rb +123 -0
- data/test/role_test.rb +11 -0
- data/test/server_definition_test.rb +121 -0
- data/test/shell_test.rb +90 -0
- data/test/ssh_test.rb +104 -0
- data/test/task_definition_test.rb +116 -0
- data/test/transfer_test.rb +160 -0
- data/test/utils.rb +39 -0
- metadata +289 -0
@@ -0,0 +1,197 @@
|
|
1
|
+
require 'capistrano/task_definition'
|
2
|
+
|
3
|
+
module Capistrano
|
4
|
+
class Configuration
|
5
|
+
module Namespaces
|
6
|
+
DEFAULT_TASK = :default
|
7
|
+
|
8
|
+
def self.included(base) #:nodoc:
|
9
|
+
base.send :alias_method, :initialize_without_namespaces, :initialize
|
10
|
+
base.send :alias_method, :initialize, :initialize_with_namespaces
|
11
|
+
end
|
12
|
+
|
13
|
+
# The name of this namespace. Defaults to +nil+ for the top-level
|
14
|
+
# namespace.
|
15
|
+
attr_reader :name
|
16
|
+
|
17
|
+
# The parent namespace of this namespace. Returns +nil+ for the top-level
|
18
|
+
# namespace.
|
19
|
+
attr_reader :parent
|
20
|
+
|
21
|
+
# The hash of tasks defined for this namespace.
|
22
|
+
attr_reader :tasks
|
23
|
+
|
24
|
+
# The hash of namespaces defined for this namespace.
|
25
|
+
attr_reader :namespaces
|
26
|
+
|
27
|
+
def initialize_with_namespaces(*args) #:nodoc:
|
28
|
+
@name = @parent = nil
|
29
|
+
initialize_without_namespaces(*args)
|
30
|
+
@tasks = {}
|
31
|
+
@namespaces = {}
|
32
|
+
end
|
33
|
+
private :initialize_with_namespaces
|
34
|
+
|
35
|
+
# Returns the top-level namespace (the one with no parent).
|
36
|
+
def top
|
37
|
+
return parent.top if parent
|
38
|
+
return self
|
39
|
+
end
|
40
|
+
|
41
|
+
# Returns the fully-qualified name of this namespace, or nil if the
|
42
|
+
# namespace is at the top-level.
|
43
|
+
def fully_qualified_name
|
44
|
+
return nil if name.nil?
|
45
|
+
[parent.fully_qualified_name, name].compact.join(":")
|
46
|
+
end
|
47
|
+
|
48
|
+
# Describe the next task to be defined. The given text will be attached to
|
49
|
+
# the next task that is defined and used as its description.
|
50
|
+
def desc(text)
|
51
|
+
@next_description = text
|
52
|
+
end
|
53
|
+
|
54
|
+
# Returns the value set by the last, pending "desc" call. If +reset+ is
|
55
|
+
# not false, the value will be reset immediately afterwards.
|
56
|
+
def next_description(reset=false)
|
57
|
+
@next_description
|
58
|
+
ensure
|
59
|
+
@next_description = nil if reset
|
60
|
+
end
|
61
|
+
|
62
|
+
# Open a namespace in which to define new tasks. If the namespace was
|
63
|
+
# defined previously, it will be reopened, otherwise a new namespace
|
64
|
+
# will be created for the given name.
|
65
|
+
def namespace(name, &block)
|
66
|
+
name = name.to_sym
|
67
|
+
raise ArgumentError, "expected a block" unless block_given?
|
68
|
+
|
69
|
+
namespace_already_defined = namespaces.key?(name)
|
70
|
+
if all_methods.any? { |m| m.to_sym == name } && !namespace_already_defined
|
71
|
+
thing = tasks.key?(name) ? "task" : "method"
|
72
|
+
raise ArgumentError, "defining a namespace named `#{name}' would shadow an existing #{thing} with that name"
|
73
|
+
end
|
74
|
+
|
75
|
+
namespaces[name] ||= Namespace.new(name, self)
|
76
|
+
namespaces[name].instance_eval(&block)
|
77
|
+
|
78
|
+
# make sure any open description gets terminated
|
79
|
+
namespaces[name].desc(nil)
|
80
|
+
|
81
|
+
if !namespace_already_defined
|
82
|
+
metaclass = class << self; self; end
|
83
|
+
metaclass.send(:define_method, name) { namespaces[name] }
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# Describe a new task. If a description is active (see #desc), it is added
|
88
|
+
# to the options under the <tt>:desc</tt> key. The new task is added to
|
89
|
+
# the namespace.
|
90
|
+
def task(name, options={}, &block)
|
91
|
+
name = name.to_sym
|
92
|
+
raise ArgumentError, "expected a block" unless block_given?
|
93
|
+
|
94
|
+
task_already_defined = tasks.key?(name)
|
95
|
+
if all_methods.any? { |m| m.to_sym == name } && !task_already_defined
|
96
|
+
thing = namespaces.key?(name) ? "namespace" : "method"
|
97
|
+
raise ArgumentError, "defining a task named `#{name}' would shadow an existing #{thing} with that name"
|
98
|
+
end
|
99
|
+
|
100
|
+
tasks[name] = TaskDefinition.new(name, self, {:desc => next_description(:reset)}.merge(options), &block)
|
101
|
+
|
102
|
+
if !task_already_defined
|
103
|
+
metaclass = class << self; self; end
|
104
|
+
metaclass.send(:define_method, name) { execute_task(tasks[name]) }
|
105
|
+
end
|
106
|
+
end
|
107
|
+
|
108
|
+
# Find the task with the given name, where name is the fully-qualified
|
109
|
+
# name of the task. This will search into the namespaces and return
|
110
|
+
# the referenced task, or nil if no such task can be found. If the name
|
111
|
+
# refers to a namespace, the task in that namespace named "default"
|
112
|
+
# will be returned instead, if one exists.
|
113
|
+
def find_task(name)
|
114
|
+
parts = name.to_s.split(/:/)
|
115
|
+
tail = parts.pop.to_sym
|
116
|
+
|
117
|
+
ns = self
|
118
|
+
until parts.empty?
|
119
|
+
next_part = parts.shift
|
120
|
+
ns = next_part.empty? ? nil : ns.namespaces[next_part.to_sym]
|
121
|
+
return nil if ns.nil?
|
122
|
+
end
|
123
|
+
|
124
|
+
if ns.namespaces.key?(tail)
|
125
|
+
ns = ns.namespaces[tail]
|
126
|
+
tail = DEFAULT_TASK
|
127
|
+
end
|
128
|
+
|
129
|
+
ns.tasks[tail]
|
130
|
+
end
|
131
|
+
|
132
|
+
# Given a task name, this will search the current namespace, and all
|
133
|
+
# parent namespaces, looking for a task that matches the name, exactly.
|
134
|
+
# It returns the task, if found, or nil, if not.
|
135
|
+
def search_task(name)
|
136
|
+
name = name.to_sym
|
137
|
+
ns = self
|
138
|
+
|
139
|
+
until ns.nil?
|
140
|
+
return ns.tasks[name] if ns.tasks.key?(name)
|
141
|
+
ns = ns.parent
|
142
|
+
end
|
143
|
+
|
144
|
+
return nil
|
145
|
+
end
|
146
|
+
|
147
|
+
# Returns the default task for this namespace. This will be +nil+ if
|
148
|
+
# the namespace is at the top-level, and will otherwise return the
|
149
|
+
# task named "default". If no such task exists, +nil+ will be returned.
|
150
|
+
def default_task
|
151
|
+
return nil if parent.nil?
|
152
|
+
return tasks[DEFAULT_TASK]
|
153
|
+
end
|
154
|
+
|
155
|
+
# Returns the tasks in this namespace as an array of TaskDefinition
|
156
|
+
# objects. If a non-false parameter is given, all tasks in all
|
157
|
+
# namespaces under this namespace will be returned as well.
|
158
|
+
def task_list(all=false)
|
159
|
+
list = tasks.values
|
160
|
+
namespaces.each { |name,space| list.concat(space.task_list(:all)) } if all
|
161
|
+
list
|
162
|
+
end
|
163
|
+
|
164
|
+
private
|
165
|
+
|
166
|
+
def all_methods
|
167
|
+
public_methods.concat(protected_methods).concat(private_methods)
|
168
|
+
end
|
169
|
+
|
170
|
+
class Namespace
|
171
|
+
def initialize(name, parent)
|
172
|
+
@parent = parent
|
173
|
+
@name = name
|
174
|
+
end
|
175
|
+
|
176
|
+
def role(*args)
|
177
|
+
raise NotImplementedError, "roles cannot be defined in a namespace"
|
178
|
+
end
|
179
|
+
|
180
|
+
def respond_to?(sym, include_priv=false)
|
181
|
+
super || parent.respond_to?(sym, include_priv)
|
182
|
+
end
|
183
|
+
|
184
|
+
def method_missing(sym, *args, &block)
|
185
|
+
if parent.respond_to?(sym)
|
186
|
+
parent.send(sym, *args, &block)
|
187
|
+
else
|
188
|
+
super
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
include Capistrano::Configuration::Namespaces
|
193
|
+
undef :desc, :next_description
|
194
|
+
end
|
195
|
+
end
|
196
|
+
end
|
197
|
+
end
|
@@ -0,0 +1,73 @@
|
|
1
|
+
require 'capistrano/server_definition'
|
2
|
+
require 'capistrano/role'
|
3
|
+
|
4
|
+
module Capistrano
|
5
|
+
class Configuration
|
6
|
+
module Roles
|
7
|
+
def self.included(base) #:nodoc:
|
8
|
+
base.send :alias_method, :initialize_without_roles, :initialize
|
9
|
+
base.send :alias_method, :initialize, :initialize_with_roles
|
10
|
+
end
|
11
|
+
|
12
|
+
# The hash of roles defined for this configuration. Each entry in the
|
13
|
+
# hash points to an array of server definitions that belong in that
|
14
|
+
# role.
|
15
|
+
attr_reader :roles
|
16
|
+
|
17
|
+
def initialize_with_roles(*args) #:nodoc:
|
18
|
+
initialize_without_roles(*args)
|
19
|
+
@roles = Hash.new { |h,k| h[k] = Role.new }
|
20
|
+
end
|
21
|
+
|
22
|
+
# Define a new role and its associated servers. You must specify at least
|
23
|
+
# one host for each role. Also, you can specify additional information
|
24
|
+
# (in the form of a Hash) which can be used to more uniquely specify the
|
25
|
+
# subset of servers specified by this specific role definition.
|
26
|
+
#
|
27
|
+
# Usage:
|
28
|
+
#
|
29
|
+
# role :db, "db1.example.com", "db2.example.com"
|
30
|
+
# role :db, "master.example.com", :primary => true
|
31
|
+
# role :app, "app1.example.com", "app2.example.com"
|
32
|
+
#
|
33
|
+
# You can also encode the username and port number for each host in the
|
34
|
+
# server string, if needed:
|
35
|
+
#
|
36
|
+
# role :web, "www@web1.example.com"
|
37
|
+
# role :file, "files.example.com:4144"
|
38
|
+
# role :db, "admin@db3.example.com:1234"
|
39
|
+
#
|
40
|
+
# Lastly, username and port number may be passed as options, if that is
|
41
|
+
# preferred; note that the options apply to all servers defined in
|
42
|
+
# that call to "role":
|
43
|
+
#
|
44
|
+
# role :web, "web2", "web3", :user => "www", :port => 2345
|
45
|
+
def role(which, *args, &block)
|
46
|
+
options = args.last.is_a?(Hash) ? args.pop : {}
|
47
|
+
which = which.to_sym
|
48
|
+
|
49
|
+
# The roles Hash is defined so that unrecognized keys always auto-initialize
|
50
|
+
# to a new Role instance (see the assignment in the initialize_with_roles method,
|
51
|
+
# above). However, we explicitly assign here so that role declarations will
|
52
|
+
# vivify the role object even if there are no server arguments. (Otherwise,
|
53
|
+
# role(:app) won't actually instantiate a Role object for :app.)
|
54
|
+
roles[which] ||= Role.new
|
55
|
+
|
56
|
+
roles[which].push(block, options) if block_given?
|
57
|
+
args.each { |host| roles[which] << ServerDefinition.new(host, options) }
|
58
|
+
end
|
59
|
+
|
60
|
+
# An alternative way to associate servers with roles. If you have a server
|
61
|
+
# that participates in multiple roles, this can be a DRYer way to describe
|
62
|
+
# the relationships. Pass the host definition as the first parameter, and
|
63
|
+
# the roles as the remaining parameters:
|
64
|
+
#
|
65
|
+
# server "master.example.com", :web, :app
|
66
|
+
def server(host, *roles)
|
67
|
+
options = roles.last.is_a?(Hash) ? roles.pop : {}
|
68
|
+
raise ArgumentError, "you must associate a server with at least one role" if roles.empty?
|
69
|
+
roles.each { |name| role(name, host, options) }
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
@@ -0,0 +1,98 @@
|
|
1
|
+
module Capistrano
|
2
|
+
class Configuration
|
3
|
+
module Servers
|
4
|
+
# Identifies all servers that the given task should be executed on.
|
5
|
+
# The options hash accepts the same arguments as #find_servers, and any
|
6
|
+
# preexisting options there will take precedence over the options in
|
7
|
+
# the task.
|
8
|
+
def find_servers_for_task(task, options={})
|
9
|
+
find_servers(task.options.merge(options))
|
10
|
+
end
|
11
|
+
|
12
|
+
# Attempts to find all defined servers that match the given criteria.
|
13
|
+
# The options hash may include a :hosts option (which should specify
|
14
|
+
# an array of host names or ServerDefinition instances), a :roles
|
15
|
+
# option (specifying an array of roles), an :only option (specifying
|
16
|
+
# a hash of key/value pairs that any matching server must match),
|
17
|
+
# an :exception option (like :only, but the inverse), and a
|
18
|
+
# :skip_hostfilter option to ignore the HOSTFILTER environment variable
|
19
|
+
# described below.
|
20
|
+
#
|
21
|
+
# Additionally, if the HOSTS environment variable is set, it will take
|
22
|
+
# precedence over any other options. Similarly, the ROLES environment
|
23
|
+
# variable will take precedence over other options. If both HOSTS and
|
24
|
+
# ROLES are given, HOSTS wins.
|
25
|
+
#
|
26
|
+
# Yet additionally, if the HOSTFILTER environment variable is set, it
|
27
|
+
# will limit the result to hosts found in that (comma-separated) list.
|
28
|
+
#
|
29
|
+
# Usage:
|
30
|
+
#
|
31
|
+
# # return all known servers
|
32
|
+
# servers = find_servers
|
33
|
+
#
|
34
|
+
# # find all servers in the app role that are not exempted from
|
35
|
+
# # deployment
|
36
|
+
# servers = find_servers :roles => :app,
|
37
|
+
# :except => { :no_release => true }
|
38
|
+
#
|
39
|
+
# # returns the given hosts, translated to ServerDefinition objects
|
40
|
+
# servers = find_servers :hosts => "jamis@example.host.com"
|
41
|
+
def find_servers(options={})
|
42
|
+
hosts = server_list_from(ENV['HOSTS'] || options[:hosts])
|
43
|
+
|
44
|
+
if hosts.any?
|
45
|
+
if options[:skip_hostfilter]
|
46
|
+
hosts.uniq
|
47
|
+
else
|
48
|
+
filter_server_list(hosts.uniq)
|
49
|
+
end
|
50
|
+
else
|
51
|
+
roles = role_list_from(ENV['ROLES'] || options[:roles] || self.roles.keys)
|
52
|
+
roles = roles & Array(options[:roles]) if preserve_roles && !options[:roles].nil?
|
53
|
+
|
54
|
+
only = options[:only] || {}
|
55
|
+
except = options[:except] || {}
|
56
|
+
|
57
|
+
servers = roles.inject([]) { |list, role| list.concat(self.roles[role]) }
|
58
|
+
servers = servers.select { |server| only.all? { |key,value| server.options[key] == value } }
|
59
|
+
servers = servers.reject { |server| except.any? { |key,value| server.options[key] == value } }
|
60
|
+
|
61
|
+
if options[:skip_hostfilter]
|
62
|
+
servers.uniq
|
63
|
+
else
|
64
|
+
filter_server_list(servers.uniq)
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
protected
|
70
|
+
|
71
|
+
def filter_server_list(servers)
|
72
|
+
return servers unless ENV['HOSTFILTER']
|
73
|
+
filters = ENV['HOSTFILTER'].split(/,/)
|
74
|
+
servers.select { |server| filters.include?(server.host) }
|
75
|
+
end
|
76
|
+
|
77
|
+
def server_list_from(hosts)
|
78
|
+
hosts = hosts.split(/,/) if String === hosts
|
79
|
+
hosts = build_list(hosts)
|
80
|
+
hosts.map { |s| String === s ? ServerDefinition.new(s.strip) : s }
|
81
|
+
end
|
82
|
+
|
83
|
+
def role_list_from(roles)
|
84
|
+
roles = roles.split(/,/) if String === roles
|
85
|
+
roles = build_list(roles)
|
86
|
+
roles.map do |role|
|
87
|
+
role = String === role ? role.strip.to_sym : role
|
88
|
+
raise ArgumentError, "unknown role `#{role}'" unless self.roles.key?(role)
|
89
|
+
role
|
90
|
+
end
|
91
|
+
end
|
92
|
+
|
93
|
+
def build_list(list)
|
94
|
+
Array(list).map { |item| item.respond_to?(:call) ? item.call : item }.flatten
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
@@ -0,0 +1,127 @@
|
|
1
|
+
require 'thread'
|
2
|
+
|
3
|
+
module Capistrano
|
4
|
+
class Configuration
|
5
|
+
module Variables
|
6
|
+
def self.included(base) #:nodoc:
|
7
|
+
%w(initialize respond_to? method_missing).each do |m|
|
8
|
+
base_name = m[/^\w+/]
|
9
|
+
punct = m[/\W+$/]
|
10
|
+
base.send :alias_method, "#{base_name}_without_variables#{punct}", m
|
11
|
+
base.send :alias_method, m, "#{base_name}_with_variables#{punct}"
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
# The hash of variables that have been defined in this configuration
|
16
|
+
# instance.
|
17
|
+
attr_reader :variables
|
18
|
+
|
19
|
+
# Set a variable to the given value.
|
20
|
+
def set(variable, *args, &block)
|
21
|
+
if variable.to_s !~ /^[_a-z]/
|
22
|
+
raise ArgumentError, "invalid variable `#{variable}' (variables must begin with an underscore, or a lower-case letter)"
|
23
|
+
end
|
24
|
+
|
25
|
+
if !block_given? && args.empty? || block_given? && !args.empty?
|
26
|
+
raise ArgumentError, "you must specify exactly one of either a value or a block"
|
27
|
+
end
|
28
|
+
|
29
|
+
if args.length > 1
|
30
|
+
raise ArgumentError, "wrong number of arguments (#{args.length} for 1)"
|
31
|
+
end
|
32
|
+
|
33
|
+
value = args.empty? ? block : args.first
|
34
|
+
sym = variable.to_sym
|
35
|
+
protect(sym) { @variables[sym] = value }
|
36
|
+
end
|
37
|
+
|
38
|
+
alias :[]= :set
|
39
|
+
|
40
|
+
# Removes any trace of the given variable.
|
41
|
+
def unset(variable)
|
42
|
+
sym = variable.to_sym
|
43
|
+
protect(sym) do
|
44
|
+
@original_procs.delete(sym)
|
45
|
+
@variables.delete(sym)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
# Returns true if the variable has been defined, and false otherwise.
|
50
|
+
def exists?(variable)
|
51
|
+
@variables.key?(variable.to_sym)
|
52
|
+
end
|
53
|
+
|
54
|
+
# If the variable was originally a proc value, it will be reset to it's
|
55
|
+
# original proc value. Otherwise, this method does nothing. It returns
|
56
|
+
# true if the variable was actually reset.
|
57
|
+
def reset!(variable)
|
58
|
+
sym = variable.to_sym
|
59
|
+
protect(sym) do
|
60
|
+
if @original_procs.key?(sym)
|
61
|
+
@variables[sym] = @original_procs.delete(sym)
|
62
|
+
true
|
63
|
+
else
|
64
|
+
false
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
# Access a named variable. If the value of the variable responds_to? :call,
|
70
|
+
# #call will be invoked (without parameters) and the return value cached
|
71
|
+
# and returned.
|
72
|
+
def fetch(variable, *args)
|
73
|
+
if !args.empty? && block_given?
|
74
|
+
raise ArgumentError, "you must specify either a default value or a block, but not both"
|
75
|
+
end
|
76
|
+
|
77
|
+
sym = variable.to_sym
|
78
|
+
protect(sym) do
|
79
|
+
if !@variables.key?(sym)
|
80
|
+
return args.first unless args.empty?
|
81
|
+
return yield(variable) if block_given?
|
82
|
+
raise IndexError, "`#{variable}' not found"
|
83
|
+
end
|
84
|
+
|
85
|
+
if @variables[sym].respond_to?(:call)
|
86
|
+
@original_procs[sym] = @variables[sym]
|
87
|
+
@variables[sym] = @variables[sym].call
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
@variables[sym]
|
92
|
+
end
|
93
|
+
|
94
|
+
def [](variable)
|
95
|
+
fetch(variable, nil)
|
96
|
+
end
|
97
|
+
|
98
|
+
def initialize_with_variables(*args) #:nodoc:
|
99
|
+
initialize_without_variables(*args)
|
100
|
+
@variables = {}
|
101
|
+
@original_procs = {}
|
102
|
+
@variable_locks = Hash.new { |h,k| h[k] = Mutex.new }
|
103
|
+
|
104
|
+
set :ssh_options, {}
|
105
|
+
set :logger, logger
|
106
|
+
end
|
107
|
+
private :initialize_with_variables
|
108
|
+
|
109
|
+
def protect(variable)
|
110
|
+
@variable_locks[variable.to_sym].synchronize { yield }
|
111
|
+
end
|
112
|
+
private :protect
|
113
|
+
|
114
|
+
def respond_to_with_variables?(sym, include_priv=false) #:nodoc:
|
115
|
+
@variables.has_key?(sym) || respond_to_without_variables?(sym, include_priv)
|
116
|
+
end
|
117
|
+
|
118
|
+
def method_missing_with_variables(sym, *args, &block) #:nodoc:
|
119
|
+
if args.length == 0 && block.nil? && @variables.has_key?(sym)
|
120
|
+
self[sym]
|
121
|
+
else
|
122
|
+
method_missing_without_variables(sym, *args, &block)
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|