# File lib/capistrano/task_definition.rb, line 9 def initialize(name, namespace, options={}, &block) @name, @namespace, @options = name, namespace, options @desc = @options.delete(:desc) @on_error = options.delete(:on_error) @max_hosts = options[:max_hosts] && options[:max_hosts].to_i @body = block or raise ArgumentError, "a task requires a block" @servers = nil end
Returns the first sentence of the full description. If max_length is given, the result will be truncated if it is longer than max_length, and an ellipsis appended.
# File lib/capistrano/task_definition.rb, line 60 def brief_description(max_length=nil) brief = description[/^.*?\.(?=\s|$)/] || description if max_length && brief.length > max_length brief = brief[0,max_length-3] + "..." end brief end
Indicates whether the task wants to continue, even if a server has failed previously
# File lib/capistrano/task_definition.rb, line 72 def continue_on_error? @on_error == :continue end
Returns the description for this task, with newlines collapsed and whitespace stripped. Returns the empty string if there is no description for this task.
# File lib/capistrano/task_definition.rb, line 37 def description(rebuild=false) @description = nil if rebuild @description ||= begin description = @desc || "" indentation = description[/\A\s+/] if indentation reformatted_description = "" description.strip.each_line do |line| line = line.chomp.sub(/^#{indentation}/, "") line = line.gsub(/#{indentation}\s*/, " ") if line[/^\S/] reformatted_description << line << "\n" end description = reformatted_description end description.strip.gsub(/\r\n/, "\n") end end
Returns the task's fully-qualified name, including the namespace
# File lib/capistrano/task_definition.rb, line 19 def fully_qualified_name @fully_qualified_name ||= begin if namespace.default_task == self namespace.fully_qualified_name else [namespace.fully_qualified_name, name].compact.join(":") end end end
Generated with the Darkfish Rdoc Generator 2.