Class: Capistrano::Deploy::SCM::Base

Class | Capistrano::Deploy::SCM::Base
In: | lib/capistrano/recipes/deploy/scm/base.rb
Parent: | Object

The ancestor class for all Capistrano SCM implementations. It provides minimal infrastructure for subclasses to build upon and override.

Note that subclasses that implement this abstract class only return the commands that need to be executed—they do not execute the commands themselves. In this way, the deployment method may execute the commands either locally or remotely, as necessary.

### Methods

checkout command default_command diff handle_data head local local? log new next_revision query_revision scm sync

### Classes and Modules

Class Capistrano::Deploy::SCM::Base::LocalProxy

### Attributes

configuration | [R] | The options available for this SCM instance to reference. Should be treated like a hash.

### Public Class methods

default_command(value=nil)

If no parameters are given, it returns the current configured name of the command-line utility of this SCM. If a parameter is given, the defeault command is set to that value.

new(configuration={})

Creates a new SCM instance with the given configuration options.

### Public Instance methods

checkout(revision, destination)

Checkout a copy of the repository, at the given `revision`, to the given `destination`. The checkout is suitable for doing development work in, e.g. allowing subsequent commits and updates.

command()

Returns the name of the command-line utility for this SCM. It first looks at the :scm_command variable, and if it does not exist, it then falls back to whatever was defined by `default_command`.

If scm_command is set to :default, the default_command will be returned.

diff(from, to=nil)

Compute the difference between the two revisions, `from` and `to`.

handle_data(state, stream, text)

Should analyze the given text and determine whether or not a response is expected, and if so, return the appropriate response. If no response is expected, return nil. The `state` parameter is a hash that may be used to preserve state between calls. This method is used to define how Capistrano should respond to common prompts and messages from the SCM, like password prompts and such. By default, the output is simply displayed.

head()

Returns the string used to identify the latest revision in the repository. This will be passed as the "revision" parameter of the methods below.

local() {|| ...}

Returns a proxy that wraps the SCM instance and forces it to operate in "local" mode, which changes how variables are looked up in the configuration. Normally, if the value of a variable "foo" is needed, it is queried for in the configuration as "foo". However, in "local" mode, first "local_foo" would be looked for, and only if it is not found would "foo" be used. This allows for both (e.g.) "scm_command" and "local_scm_command" to be set, if the two differ.

Alternatively, it may be called with a block, and for the duration of the block, all requests on this configuration object will be considered local.

local?()

Returns true if running in "local" mode. See local.

log(from, to=nil)

Return a log of all changes between the two specified revisions, `from` and `to`, inclusive.

next_revision(revision)

Returns the revision number immediately following revision, if at all possible. A block should always be passed to this method, which accepts a command to invoke and returns the result, although a particular SCM‘s implementation is not required to invoke the block.

By default, this method simply returns the revision itself. If a particular SCM is able to determine a subsequent revision given a revision identifier, it should override this method.

query_revision(revision)

If the given revision represents a "real" revision, this should simply return the revision value. If it represends a pseudo-revision (like Subversions "HEAD" identifier), it should yield a string containing the commands that, when executed will return a string that this method can then extract the real revision from.

scm(*args)

A helper method that can be used to define SCM commands naturally. It returns a single string with all arguments joined by spaces, with the scm command prefixed onto it.

sync(revision, destination)

Resynchronize the working copy in `destination` to the specified `revision`.

[Validate]