Class: Pandoku::Format

Inherits:

Object

• Object
• Pandoku::Format

Defined in:

lib/pandoku/format.rb,
lib/pandoku/lookup_table.rb

Overview

Abstract base class for formats.

Direct Known Subclasses

Pandoku::Formats::ConTeXt, Pandoku::Formats::DocBook, Pandoku::Formats::HTML, Pandoku::Formats::LaTeX, Pandoku::Formats::Man, Pandoku::Formats::Markdown, Pandoku::Formats::MediaWiki, Pandoku::Formats::ODT, Pandoku::Formats::OpenDocument, Pandoku::Formats::ReStructuredText, Pandoku::Formats::RichTextFormat, Pandoku::Formats::S5, Pandoku::Formats::Texinfo

Instance Attribute Summary

• #options ⇒ Object readonly

  Returns the value of attribute options.

Class Method Summary

• .default_options ⇒ Object
• .inherited(subclass) ⇒ Object
• .name ⇒ Object

Instance Method Summary

• #cliopts ⇒ Object
• #initialize(options = {}) ⇒ Format constructor

  A new instance of Format.

Constructor Details

#initialize(options = {}) ⇒ Format

Returns a new instance of Format.

# File 'lib/pandoku/format.rb', line 18

def initialize(options = {})
  @options = self.class.default_options
  keys = @options.keys
  @options.merge!(Hash[options.select {|k, v| keys.include?(k) }])
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.

# File 'lib/pandoku/format.rb', line 7

def options
  @options
end

Class Method Details

.default_options ⇒ Object

# File 'lib/pandoku/format.rb', line 14

def self.default_options
  {}
end

.inherited(subclass) ⇒ Object

# File 'lib/pandoku/lookup_table.rb', line 26

def self.inherited(subclass)
  Formats::LOOKUP_TABLE << subclass
end

.name ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/pandoku/format.rb', line 9

def self.name
  raise NotImplementedError,
        'Format.name should be overrided to return Symbol'
end

Instance Method Details

#cliopts ⇒ Object

# File 'lib/pandoku/format.rb', line 24

def cliopts
  self.options.select {|k, v| v } \
              .collect {|p| %<--#{p[0].to_s.gsub('_', '-')}> +
                            (p[1] != true ? %<=#{p[1]}> : '') }
end