Class Nanoc::DataSource
In: lib/nanoc/base/source_data/data_source.rb
Parent: Object

Responsible for loading site data. It is the (abstract) superclass for all data sources. Subclasses must at least implement the data reading methods ({items} and {layouts}); all other methods involving data manipulation are optional.

Apart from the methods for loading and storing data, there are the {up} and {down} methods for bringing up and tearing down the connection to the data source. These should be overridden in subclasses. The {loading} method wraps {up} and {down}. {loading} is a convenience method for the more low-level methods {use} and {unuse}, which respectively increment and decrement the reference count; when the reference count goes from 0 to 1, the data source will be loaded ({up} will be called) and when the reference count goes from 1 to 0, the data source will be unloaded ({down} will be called).

The {setup} method is used for setting up a site‘s data source for the first time.

@abstract Subclasses should at least implement {items} and {layouts}. If

  the data source should support creating items and layouts using the
  `create_item` and `create_layout` CLI commands, the {#setup},
  {#create_item} and {#create_layout} methods should be implemented as
  well.

Methods

create_item   create_layout   down   items   layouts   loading   new   setup   sync   unuse   up   update   use  

Attributes

config  [R]  @return [Hash] The configuration for this data source. For example,
  online data sources could contain authentication details.
items_root  [R]  @return [String] The root path where items returned by this data source
  should be mounted.
layouts_root  [R]  @return [String] The root path where layouts returned by this data
  source should be mounted.

Public Class methods

Creates a new data source for the given site.

@param [Nanoc::Site] site The site this data source belongs to.

@param [String] items_root The prefix that should be given to all items

  returned by the #items method (comparable to mount points for
  filesystems in Unix-ish OSes).

@param [String] layouts_root The prefix that should be given to all

  layouts returned by the #layouts method (comparable to mount points
  for filesystems in Unix-ish OSes).

@param [Hash] config The configuration for this data source.

Public Instance methods

Creates a new item with the given content, attributes and identifier. No instance of {Nanoc::Item} will be created; this method creates the item in the data source so that it can be loaded and turned into a {Nanoc::Item} instance by the {items} method.

@abstract

@param [String] content

@param [Hash] attributes

@param [String] identifier

@param [Hash] params Extra parameters to give to the data source. This

  can be used to influence the way items are stored. For example,
  filesystem data sources could use this to pass the extension of the
  files that should be generated.

@return [void]

Creates a new layout with the given content, attributes and identifier. No instance of {Nanoc::Layout} will be created; this method creates the layout in the data source so that it can be loaded and turned into a {Nanoc::Layout} instance by the {layouts} method.

@abstract

@param [String] content

@param [Hash] attributes

@param [String] identifier

@param [Hash] params Extra parameters to give to the data source. This

  can be used to influence the way items are stored. For example,
  filesystem data sources could use this to pass the extension of the
  files that should be generated.

@return [void]

Brings down the connection to the data. This method should undo the effects of the {up} method. For example, a database connection established in {up} should be closed in this method.

Subclasses may override this method, but are not required to do so; the default implementation simply does nothing.

@return [void]

Returns the list of items (represented by {Nanoc::Item}) in this site. The default implementation simply returns an empty array.

Subclasses should not prepend `items_root` to the item‘s identifiers, as this will be done automatically.

Subclasses may override this method, but are not required to do so; the default implementation simply does nothing.

@return [Array<Nanoc::Item>] A list of items

Returns the list of layouts (represented by {Nanoc::Layout}) in this site. The default implementation simply returns an empty array.

Subclasses should prepend `layout_root` to the layout‘s identifiers, since this is not done automatically.

Subclasses may override this method, but are not required to do so; the default implementation simply does nothing.

@return [Array<Nanoc::Layout>] A list of layouts

Loads the data source when necessary (calling {up}), yields, and unloads (using {down}) the data source when it is not being used elsewhere. All data source queries and data manipulations should be wrapped in a {loading} block; it ensures that the data source is loaded when necessary and makes sure the data source does not get unloaded while it is still being used elsewhere.

@return [void]

Creates the bare minimum essentials for this data source to work. This action will likely be destructive. This method should not create sample data such as a default home page, a default layout, etc. For example, when using a database, this is where you should create the necessary tables for the data source to function properly.

@abstract

@return [void]

Sync the content for this data source with an external source. This method is called by the `nanoc sync` command so that data sources may update local caches of external data, such as items fetched from third-party APIs.

Subclasses may override this method, but are not required to do so; the default implementation simply does nothing.

@return [void]

Marks the data source as unused by the caller.

Calling this method decreases the internal reference count. When the reference count reaches zero, i.e. when the data source is not used any more, the data source will be unloaded ({down} will be called).

@return [void]

Brings up the connection to the data. Depending on the way data is stored, this may not be necessary. This is the ideal place to connect to the database, for example.

Subclasses may override this method, but are not required to do so; the default implementation simply does nothing.

@return [void]

Updated the content stored in this site to a newer version. A newer version of a data source may store content in a different format, and this method will update the stored content to this newer format.

Subclasses may override this method, but are not required to do so; the default implementation simply does nothing.

@return [void]

Marks the data source as used by the caller.

Calling this method increases the internal reference count. When the data source is used for the first time (first {use} call), the data source will be loaded ({up} will be called).

@return [void]

[Validate]