Module: Capistrano

Defined in:
lib/capistrano/cli.rb,
lib/capistrano/ssh.rb,
lib/capistrano/actor.rb,
lib/capistrano/utils.rb,
lib/capistrano/logger.rb,
lib/capistrano/command.rb,
lib/capistrano/gateway.rb,
lib/capistrano/scm/baz.rb,
lib/capistrano/scm/bzr.rb,
lib/capistrano/scm/cvs.rb,
lib/capistrano/version.rb,
lib/capistrano/scm/base.rb,
lib/capistrano/transfer.rb,
lib/capistrano/scm/darcs.rb,
lib/capistrano/extensions.rb,
lib/capistrano/scm/perforce.rb,
lib/capistrano/configuration.rb,
lib/capistrano/scm/subversion.rb,
lib/capistrano/generators/rails/loader.rb

Defined Under Namespace

Modules: Generators, SCM, Version Classes: Actor, CLI, Command, Configuration, ExtensionProxy, Gateway, Logger, SSH, Transfer

Constant Summary collapse

EXTENSIONS = 
{}

Class Method Summary collapse

Class Method Details

.configuration(require_config = false) ⇒ Object

Used by third-party task bundles to identify the capistrano configuration that is loading them. It’s return value is not reliable in other contexts. If require_config is not false, an exception will be raised if the current configuration is not set.



13
14
15
16
17
18
19
 
# File 'lib/capistrano/utils.rb', line 13

def self.configuration(require_config=false)
  config = Thread.current[:capistrano_configuration]
  if require_config && config.nil?
    raise "Please require this file from within a Capistrano recipe"
  end
  config
end

.configuration=(config) ⇒ Object

Used internally by Capistrano to specify the current configuration before loading a third-party task bundle.



23
24
25
 
# File 'lib/capistrano/utils.rb', line 23

def self.configuration=(config)
  Thread.current[:capistrano_configuration] = config
end

.plugin(name, mod) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/capistrano/extensions.rb', line 17

def self.plugin(name, mod)
  return false if EXTENSIONS.has_key?(name)

  Capistrano::Actor.class_eval <<-STR, __FILE__, __LINE__+1
    def #{name}
      @__#{name}_proxy ||= Capistrano::ExtensionProxy.new(self, Capistrano::EXTENSIONS[#{name.inspect}])
    end
  STR

  EXTENSIONS[name] = mod
  return true
end

.remove_plugin(name) ⇒ Object 



30
31
32
33
34
35
36
37
 
# File 'lib/capistrano/extensions.rb', line 30

def self.remove_plugin(name)
  if EXTENSIONS.delete(name)
    Capistrano::Actor.send(:remove_method, name)
    return true
  end

  return false
end

.str2roles(string) ⇒ Object

A helper method for converting a comma-delimited string into an array of roles.



4
5
6
7
 
# File 'lib/capistrano/utils.rb', line 4

def self.str2roles(string)
  list = string.split(/,/).map { |s| s.strip.to_sym }
  list.empty? ? nil : list
end