Parent

Methods

Class/Module Index [+]

Quicksearch

Nanoc::Extra::VCS

A very simple representation of a version control system (VCS) that abstracts the add, remove and move operations. It does not commit. This class is primarily used by data sources that store data as flat files on the disk.

@abstract Subclass and override {add}, {remove} and {move} to implement

a custom VCS.

Public Instance Methods

add(filename) click to toggle source

Adds the file with the given filename to the working copy.

@param [String] filename The name of the file to add

@return [void]

@abstract

# File lib/nanoc/extra/vcs.rb, line 22
def add(filename)
  not_implemented('add')
end
move(src, dst) click to toggle source

Moves the file with the given filename to a new location. When this method is executed, the original file should no longer be present on the disk.

@param [String] src The old filename

@param [String] dst The new filename

@return [void]

@abstract

# File lib/nanoc/extra/vcs.rb, line 50
def move(src, dst)
  not_implemented('move')
end
remove(filename) click to toggle source

Removes the file with the given filename from the working copy. When this method is executed, the file should no longer be present on the disk.

@param [String] filename The name of the file to remove

@return [void]

@abstract

# File lib/nanoc/extra/vcs.rb, line 35
def remove(filename)
  not_implemented('remove')
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.