class Webgen::Page

A Page object wraps a meta information hash and a hash of {block name => block content} associations.

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) click to toggle source

Parse the given string data in Webgen Page Format.

This method returns a Page object containing the hash with the meta information and the parsed blocks.

# File lib/webgen/page.rb, line 35
def from_data(data)
  md = RE_PAGE.match(data)
  meta_info = parse_meta_info(md[1], data =~ RE_META_INFO_START)
  blocks = parse_blocks(md[2] || '', meta_info)
  new(meta_info, blocks)
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 109
def initialize(meta_info = {}, blocks = {})
  @meta_info = meta_info
  @blocks = blocks
end

Private Class Methods

parse_blocks(data, meta_info) click to toggle source

Parse all blocks in data and return them.

The key 'blocks' of the meta information hash is updated with information found on block starting lines.

# File lib/webgen/page.rb, line 67
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|
    index += 1
    options, content = *block_data
    if md = RE_BLOCKS_START_SIMPLE.match(options.to_s)
      options = {'name' => md[1]}
    else
      md = RE_BLOCKS_START_COMPLEX.match(options.to_s)
      raise(FormatError, "Found invalid blocks starting line for block #{index}: #{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]
    end

    name = options.delete('name') || (index == 1 ? 'content' : 'block' + (index).to_s)
    raise(FormatError, "Previously used name '#{name}' also used for block #{index}") if blocks.has_key?(name)
    content ||= ''
    content.gsub!(/^(\\+)(---.*?)$/) {|m| "\\" * ($1.length / 2) + $2}
    content.chomp! unless index == scanned.length

    blocks[name] = content
    ((meta_info['blocks'] ||= {})[name] ||= {}).merge!(options) unless options.empty?
  end
  meta_info['blocks'].delete_if {|k,v| v.empty?} if meta_info.has_key?('blocks')
  meta_info.delete('blocks') if meta_info.has_key?('blocks') && meta_info['blocks'].empty?
  blocks
end

parse_meta_info(mi_data, has_mi_start) 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 44
def parse_meta_info(mi_data, has_mi_start)
  if mi_data.nil? && has_mi_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, SyntaxError, YAML::SyntaxError => e
      raise FormatError, "Invalid YAML syntax in meta information block: #{e.message}"
    end
    meta_info
  end
end

Public Instance Methods

to_s() click to toggle source

Convert the Page object back into a string.

# File lib/webgen/page.rb, line 115
def to_s
  str = ""
  str << @meta_info.to_yaml
  blocks.each do |name, value|
    str << "--- #{name}\n" << value.gsub(/^---.*?$/) {|m| "\\#{m}" } << (value =~ /\n$/ ? "" : "\n")
  end
  str
end