Parent

Class/Module Index [+]

Quicksearch

Webgen::Page

A Page object wraps a meta information hash and an array of Block objects. It is normally generated from a file or string in Webgen Page Format using the provided class methods.

Attributes

blocks[R]

The hash of blocks for the page.

meta_info[R]

The contents of the meta information block.

Public Class Methods

from_data(data, meta_info = {}) click to toggle source

Parse the given string data in Webgen Page Format and initialize a new Page object with the information. The meta_info parameter can be used to provide default meta information.

# File lib/webgen/page.rb, line 66
def from_data(data, meta_info = {})
  md = /(#{RE_META_INFO})?(.*)/.match(normalize_eol(data))
  meta_info = meta_info.merge(parse_meta_info(md[1], data))
  blocks = parse_blocks(md[2] || '', meta_info)
  new(meta_info, blocks)
end
meta_info_from_data(data) click to toggle source

Parse the given string data in Webgen Page Format and return the found meta information.

# File lib/webgen/page.rb, line 74
def meta_info_from_data(data)
  md = /(#{RE_META_INFO})?/.match(normalize_eol(data))
  parse_meta_info(md[1], data)
end
new(meta_info = {}, blocks = {}) click to toggle source

Create a new Page object with the meta information provided in meta_info and the given blocks.

# File lib/webgen/page.rb, line 146
def initialize(meta_info = {}, blocks = {})
  @meta_info = meta_info
  @blocks = blocks
end

Private Class Methods

normalize_eol(data) click to toggle source

Normalize the end-of-line encodings to Unix style.

# File lib/webgen/page.rb, line 84
def normalize_eol(data)
  data.gsub(/\r\n?/, "\n")
end
parse_blocks(data, meta_info) click to toggle source

Parse all blocks in data and return them. Meta information can be provided in meta_info which is used for setting the block names and options.

# File lib/webgen/page.rb, line 110
def parse_blocks(data, meta_info)
  scanned = data.scan(RE_BLOCKS)
  raise(FormatError, 'No content blocks specified') if scanned.length == 0

  blocks = {}
  scanned.each_with_index do |block_data, index|
    options, content = *block_data
    md = RE_BLOCKS_OPTIONS.match(options.to_s)
    raise(FormatError, "Found invalid blocks starting line for block #{index+1}: #{options}") if content =~ /\A---/ || md.nil?
    options = Hash[*md[1].to_s.scan(/(\w+):([^\s]*)/).map {|k,v| [k, (v == '' ? nil : YAML::load(v))]}.flatten]
    options = (meta_info['blocks']['default'] || {} rescue {}).
      merge((meta_info['blocks'][index+1] || {} rescue {})).
      merge(options)

    name = options.delete('name') || (index == 0 ? 'content' : 'block' + (index + 1).to_s)
    raise(FormatError, "Previously used name '#{name}' also used for block #{index+1}") if blocks.has_key?(name)
    content ||= ''
    content.gsub!(/^(\\+)(---.*?)$/) {|m| "\\" * ($1.length / 2) + $2}
    content.chomp!("\n") unless index + 1 == scanned.length
    blocks[name] = blocks[index+1] = Block.new(name, content, options)
  end
  meta_info.delete('blocks')
  blocks
end
parse_meta_info(mi_data, data) click to toggle source

Parse the meta info string in mi_data and return the hash with the meta information. The original data is used for checking the validness of the meta information block.

# File lib/webgen/page.rb, line 90
def parse_meta_info(mi_data, data)
  if mi_data.nil? && data =~ RE_META_INFO_START
    raise FormatError, 'Found start line for meta information block but no valid meta information block'
  elsif mi_data.nil?
    {}
  else
    begin
      meta_info = YAML::load(mi_data.to_s)
      unless meta_info.kind_of?(Hash)
        raise FormatError, "Invalid structure of meta information block: expected YAML hash but found #{meta_info.class}"
      end
    rescue ArgumentError => e
      raise FormatError, "Invalid YAML syntax in meta information block: #{e.message}"
    end
    meta_info
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.