Parent

Class/Module Index [+]

Quicksearch

YARD::Serializers::Base

The abstract base serializer. Serializers allow templates to be rendered to various endpoints. For instance, a {FileSystemSerializer} would allow template contents to be written to the filesystem

To implement a custom serializer, override the following methods:

Optionally, a serializer can implement before and after filters:

@abstract Override this class to implement a custom serializer.

Attributes

options[R]

All serializer options are saved so they can be passed to other serializers.

@return [SymbolHash] the serializer options

Public Class Methods

new(opts = {}) click to toggle source

Creates a new serializer with options

@param [Hash] opts the options to assign to {options}

# File lib/yard/serializers/base.rb, line 27
def initialize(opts = {})
  @options = SymbolHash.new(false).update(opts)
end

Public Instance Methods

after_serialize(data) click to toggle source

Called after serialization.

@abstract Should run code after serialization. @param [String] data the data that was serialized. @return [void]

# File lib/yard/serializers/base.rb, line 77
def after_serialize(data); end
before_serialize() click to toggle source

Called before serialization.

@abstract Should run code before serialization. Should return false

if serialization should not occur.

@return [Boolean] whether or not serialization should occur

# File lib/yard/serializers/base.rb, line 70
def before_serialize; end
exists?(object) click to toggle source

Returns whether an object has been serialized

@abstract This method should return whether the endpoint already exists.

For instance, a file system serializer would check if the file exists
on disk. You will most likely use +#basepath+ and {#serialized_path} to
get the endpoint's location.

@param [CodeObjects::Base] object the object to check existence of @return [Boolean] whether the endpoint exists. @since 0.6.0

# File lib/yard/serializers/base.rb, line 61
def exists?(object) false end
serialize(object, data) click to toggle source

Serializes an object.

@abstract This method should implement the logic that serializes

+data+ to the respective endpoint. This method should also call
the before and after callbacks {#before_serialize} and {#after_serialize}

@param [CodeObjects::Base, String] object the object to serialize the

data for. The object can also be a string (for non-object serialization)

@param [String] data the contents that should be serialized

# File lib/yard/serializers/base.rb, line 41
def serialize(object, data) end
serialized_path(object) click to toggle source

The serialized path of an object

@abstract This method should return the path of the object on the

endpoint. For instance, for a file serializer, this should return
the filename that represents the object on disk.

@param [CodeObjects::Base] object the object to return a path for @return [String] the serialized path of an object

# File lib/yard/serializers/base.rb, line 50
def serialized_path(object) end

[Validate]

Generated with the Darkfish Rdoc Generator 2.