Class: Nanoc::CodeSnippet
- Inherits:
-
Object
- Object
- Nanoc::CodeSnippet
- Defined in:
- lib/nanoc/base/source_data/code_snippet.rb
Overview
Nanoc::CodeSnippet represent a piece of custom code of a nanoc site.
Instance Attribute Summary (collapse)
-
- (String) data
readonly
A string containing the actual code in this code snippet.
-
- (String) filename
readonly
The filename corresponding to this code snippet.
Instance Method Summary (collapse)
-
- (String) checksum
The checksum for this object.
-
- (CodeSnippet) initialize(data, filename, params = nil)
constructor
Creates a new code snippet.
-
- (Object) inspect
-
- (void) load
Loads the code by executing it.
-
- (Object) reference
Returns an object that can be used for uniquely identifying objects.
Constructor Details
- (CodeSnippet) initialize(data, filename, params = nil)
Creates a new code snippet.
27 28 29 30 |
# File 'lib/nanoc/base/source_data/code_snippet.rb', line 27 def initialize(data, filename, params = nil) @data = data @filename = filename end |
Instance Attribute Details
- (String) data (readonly)
A string containing the actual code in this code snippet.
11 12 13 |
# File 'lib/nanoc/base/source_data/code_snippet.rb', line 11 def data @data end |
- (String) filename (readonly)
The filename corresponding to this code snippet.
16 17 18 |
# File 'lib/nanoc/base/source_data/code_snippet.rb', line 16 def filename @filename end |
Instance Method Details
- (String) checksum
Returns The checksum for this object. If its contents change, the checksum will change as well.
52 53 54 |
# File 'lib/nanoc/base/source_data/code_snippet.rb', line 52 def checksum Nanoc::Checksummer.calc(self) end |
- (Object) inspect
46 47 48 |
# File 'lib/nanoc/base/source_data/code_snippet.rb', line 46 def inspect "<#{self.class} filename=\"#{filename}\">" end |
- (void) load
This method returns an undefined value.
Loads the code by executing it.
35 36 37 |
# File 'lib/nanoc/base/source_data/code_snippet.rb', line 35 def load eval(@data, TOPLEVEL_BINDING, @filename) end |
- (Object) reference
Returns an object that can be used for uniquely identifying objects.
42 43 44 |
# File 'lib/nanoc/base/source_data/code_snippet.rb', line 42 def reference [ :code_snippet, filename ] end |