Class: Krikri::Parser

Inherits:

Object

• Object
• Krikri::Parser

Defined in:

lib/krikri/parser.rb

Overview

Provides a generic interface for accessing properties from OriginalRecords. Implement the interface, and that of ‘Value` on an record-type basis.

parser = Krikri::Parser::MyParser.new(record)
parser.root # => #<Krikri::MyParser::Value:0x007f861888fea0>

Direct Known Subclasses

JsonParser, XmlParser

Defined Under Namespace

Classes: Value, ValueArray

Instance Attribute Summary

• #record ⇒ Object readonly

  Returns the value of attribute record.

• #root ⇒ Object readonly

  Returns the value of attribute root.

Class Method Summary

• .parse(record, *args) ⇒ Krikri::Parser

  Instantiates a parser object to wrap the record.

Instance Method Summary

• #initialize(record) ⇒ Parser constructor

  A new instance of Parser.

• #local_name ⇒ String

  The local_name of the OriginalRecord wrapped by this parser.

Constructor Details

#initialize(record) ⇒ Parser

Returns a new instance of Parser.

Parameters:

• record (Krikri::OriginalRecord) —

  a record whose properties can be parsed by the parser instance.

# File 'lib/krikri/parser.rb', line 15

def initialize(record)
  @record = record
end

Instance Attribute Details

#record ⇒ Object (readonly)

Returns the value of attribute record.

# File 'lib/krikri/parser.rb', line 10

def record
  @record
end

#root ⇒ Object (readonly)

Returns the value of attribute root.

# File 'lib/krikri/parser.rb', line 10

def root
  @root
end

Class Method Details

.parse(record, *args) ⇒ Krikri::Parser

Instantiates a parser object to wrap the record. Returns the record as is if it is already parsed.

Parameters:

• record (Krikri::OriginalRecord, Krikri::Parser) —

  the record to parse

• args (Array, nil) —

  the arguments to pass to the parser instance, if any

Returns:

• (Krikri::Parser) —

  a parsed record object

# File 'lib/krikri/parser.rb', line 27

def self.parse(record, *args)
  record.is_a?(Krikri::Parser) ? record : new(record, *args)
end

Instance Method Details

#local_name ⇒ String

Returns the local_name of the OriginalRecord wrapped by this parser.

Returns:

• (String) —

  the local_name of the OriginalRecord wrapped by this parser

# File 'lib/krikri/parser.rb', line 34

def local_name
  record.local_name
end