Class: Nanoc::ChecksumStore Private

Inherits:
Store
  • Object
show all
Defined in:
lib/nanoc/base/compilation/checksum_store.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Stores checksums for objects in order to be able to detect whether a file has changed since the last site compilation.

Instance Attribute Summary

Attributes inherited from Store

#filename, #version

Instance Method Summary (collapse)

Methods inherited from Store

#load, #no_data_found, #store, #version_mismatch_detected

Constructor Details

- (ChecksumStore) initialize(params = {})

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ChecksumStore

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • site (Nanoc::Site)

    The site where this checksum store belongs to



11
12
13
14
15
16
17
# File 'lib/nanoc/base/compilation/checksum_store.rb', line 11

def initialize(params = {})
  super('tmp/checksums', 1)

  @site = params[:site] if params.key?(:site)

  @checksums = {}
end

Instance Method Details

- (String) [](obj)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the old checksum for the given object. This makes sense for items, layouts and code snippets.

Parameters:

  • obj (#reference)

    The object for which to fetch the checksum

Returns:

  • (String)

    The checksum for the given object



25
26
27
# File 'lib/nanoc/base/compilation/checksum_store.rb', line 25

def [](obj)
  @checksums[obj.reference]
end

- (Object) []=(obj, checksum)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Sets the checksum for the given object.

Parameters:

  • obj (#reference)

    The object for which to set the checksum

  • checksum (String)

    The checksum



34
35
36
# File 'lib/nanoc/base/compilation/checksum_store.rb', line 34

def []=(obj, checksum)
  @checksums[obj.reference] = checksum
end

- (Object) unload

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:



39
40
41
# File 'lib/nanoc/base/compilation/checksum_store.rb', line 39

def unload
  @checksums = {}
end