Class: FileComposer::Documents

Inherits:
Object
  • Object
show all
Defined in:
lib/file_composer/documents.rb,
lib/file_composer/documents/zip.rb,
lib/file_composer/documents/base.rb,
lib/file_composer/documents/text.rb,
lib/file_composer/documents/result.rb,
lib/file_composer/documents/file_result.rb

Overview

Factory for building documents. To register new document types:

  • Implement a subclass for FileComposer::Documents::Base or a document compliant class. The only real constraint is that it is hashable using the acts_as_hashable class method and implements #write!(temp_root = '', store = Stores::Null.new)
  • Call FileComposer::Documents#register(name, class_constant_or_name)

Defined Under Namespace

Classes: Base, FileResult, Result, Text, Zip