Class: Odin::Parsing::ParseResult

Inherits:

Object

• Object
• Odin::Parsing::ParseResult

Defined in:

lib/odin/parsing/parser.rb

Overview

Result wrapper for chained documents

Instance Attribute Summary

• #assignments ⇒ Object readonly

  Returns the value of attribute assignments.

• #chained_documents ⇒ Object readonly

  Returns the value of attribute chained_documents.

• #metadata ⇒ Object readonly

  Returns the value of attribute metadata.

• #modifiers ⇒ Object readonly

  Returns the value of attribute modifiers.

• #raw_documents ⇒ Object readonly

  Returns the value of attribute raw_documents.

Instance Method Summary

• #[](path) ⇒ Object
• #all_comments ⇒ Object
• #all_modifiers ⇒ Object
• #comment_for(path) ⇒ Object
• #documents ⇒ Object
• #each_assignment(&block) ⇒ Object
• #each_metadata(&block) ⇒ Object
• #empty? ⇒ Boolean
• #get(path) ⇒ Object
• #include?(path) ⇒ Boolean
• #initialize(primary_doc, chained_docs, raw_docs) ⇒ ParseResult constructor

  A new instance of ParseResult.

• #metadata_value(key) ⇒ Object
• #modifiers_for(path) ⇒ Object
• #paths ⇒ Object
• #size ⇒ Object

Constructor Details

#initialize(primary_doc, chained_docs, raw_docs) ⇒ ParseResult

Returns a new instance of ParseResult.

# File 'lib/odin/parsing/parser.rb', line 1151

def initialize(primary_doc, chained_docs, raw_docs)
  @primary = primary_doc
  @chained_documents = chained_docs
  @raw_documents = raw_docs
  @assignments = primary_doc.assignments
  @metadata = primary_doc.metadata
  @modifiers = primary_doc.all_modifiers
end

Instance Attribute Details

#assignments ⇒ Object (readonly)

Returns the value of attribute assignments.

# File 'lib/odin/parsing/parser.rb', line 1149

def assignments
  @assignments
end

#chained_documents ⇒ Object (readonly)

Returns the value of attribute chained_documents.

# File 'lib/odin/parsing/parser.rb', line 1149

def chained_documents
  @chained_documents
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.

# File 'lib/odin/parsing/parser.rb', line 1149

def metadata
  @metadata
end

#modifiers ⇒ Object (readonly)

Returns the value of attribute modifiers.

# File 'lib/odin/parsing/parser.rb', line 1149

def modifiers
  @modifiers
end

#raw_documents ⇒ Object (readonly)

Returns the value of attribute raw_documents.

# File 'lib/odin/parsing/parser.rb', line 1149

def raw_documents
  @raw_documents
end

Instance Method Details

#[](path) ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1164

def [](path)
  get(path)
end

#all_comments ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1204

def all_comments
  @primary.all_comments
end

#all_modifiers ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1196

def all_modifiers
  @primary.all_modifiers
end

#comment_for(path) ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1200

def comment_for(path)
  @primary.comment_for(path)
end

#documents ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1212

def documents
  @chained_documents
end

#each_assignment(&block) ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1184

def each_assignment(&block)
  @primary.each_assignment(&block)
end

#each_metadata(&block) ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1188

def each_metadata(&block)
  @primary.each_metadata(&block)
end

#empty? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/odin/parsing/parser.rb', line 1180

def empty?
  @primary.empty?
end

#get(path) ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1160

def get(path)
  @primary.get(path)
end

#include?(path) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/odin/parsing/parser.rb', line 1168

def include?(path)
  @primary.include?(path)
end

#metadata_value(key) ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1208

def metadata_value(key)
  @metadata[key]
end

#modifiers_for(path) ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1192

def modifiers_for(path)
  @primary.modifiers_for(path)
end

#paths ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1176

def paths
  @primary.paths
end

#size ⇒ Object

# File 'lib/odin/parsing/parser.rb', line 1172

def size
  @primary.size
end