Parent

Methods

Class/Module Index [+]

Quicksearch

Nanoc::Extra::Deployer

Represents a deployer, an object that allows uploading the compiled site to a specific (remote) location.

@abstract Subclass and override {run} to implement a custom filter.

Attributes

config[R]

@return [Hash] The deployer configuration

dry_run[R]

@return [Boolean] true if the deployer should only show what would be

deployed instead of doing the actual deployment
dry_run?[R]

@return [Boolean] true if the deployer should only show what would be

deployed instead of doing the actual deployment
source_path[R]

@return [String] The path to the directory that contains the files to

upload. It should not have a trailing slash.

Public Class Methods

new(source_path, config, params={}) click to toggle source

@param [String] source_path The path to the directory that contains the

files to upload. It should not have a trailing slash.

@return [Hash] config The deployer configuration

@option params [Boolean] :dry_run (false) true if the deployer should

only show what would be deployed instead actually deploying
# File lib/nanoc/extra/deployer.rb, line 31
def initialize(source_path, config, params={})
  @source_path  = source_path
  @config       = config
  @dry_run      = params.fetch(:dry_run) { false }
end

Public Instance Methods

run() click to toggle source

Performs the actual deployment.

@abstract

# File lib/nanoc/extra/deployer.rb, line 40
def run
  raise NotImplementedError.new("Nanoc::Extra::Deployer subclasses must implement #run")
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.