Class: Sequel::Postgres::PGRow::Parser

Inherits:
Object
  • Object
show all
Defined in:
lib/sequel/extensions/pg_row.rb

Overview

The Parser is responsible for taking the input string from PostgreSQL, and returning an appropriate ruby object that the type represents, such as an ArrayRow or HashRow.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(h = {}) ⇒ Parser

Sets each of the parser’s attributes, using options with the same name (e.g. :columns sets the columns attribute).



274
275
276
277
278
279
280
281
 
# File 'lib/sequel/extensions/pg_row.rb', line 274

def initialize(h={})
  @columns = h[:columns]
  @column_converters = h[:column_converters]
  @column_oids = h[:column_oids]
  @converter = h[:converter]
  @typecaster = h[:typecaster]
  @oid = h[:oid]
end

Instance Attribute Details

#column_converters ⇒ Object (readonly)

Converters for each member in the composite type. If not present, no conversion will be done, so values will remain strings. If present, should be an array of callable objects.



250
251
252
 
# File 'lib/sequel/extensions/pg_row.rb', line 250

def column_converters
  @column_converters
end

#column_oids ⇒ Object (readonly)

The OIDs for each member in the composite type. Not currently used, but made available for user code.



254
255
256
 
# File 'lib/sequel/extensions/pg_row.rb', line 254

def column_oids
  @column_oids
end

#columns ⇒ Object (readonly)

The columns for the parser, if any. If the parser has no columns, it will treat the input as an array. If it has columns, it will treat the input as a hash. If present, should be an array of strings.



244
245
246
 
# File 'lib/sequel/extensions/pg_row.rb', line 244

def columns
  @columns
end

#converter ⇒ Object (readonly)

A converter for the object as a whole. Used to wrap the returned array/hash in another object, such as an ArrayRow or HashRow. If present, should be callable.



259
260
261
 
# File 'lib/sequel/extensions/pg_row.rb', line 259

def converter
  @converter
end

#oid ⇒ Object (readonly)

The oid for the composite type itself.



262
263
264
 
# File 'lib/sequel/extensions/pg_row.rb', line 262

def oid
  @oid
end

#typecaster ⇒ Object (readonly)

A callable object used for typecasting the object. This is similar to the converter, but it is called by the typecasting code, which has different assumptions than the converter. For instance, the converter should be called with all of the member values already typecast, but the typecaster may not be.



270
271
272
 
# File 'lib/sequel/extensions/pg_row.rb', line 270

def typecaster
  @typecaster
end

Instance Method Details

#call(s) ⇒ Object

Convert the PostgreSQL composite type input format into an appropriate ruby object.



285
286
287
 
# File 'lib/sequel/extensions/pg_row.rb', line 285

def call(s)
  convert(convert_format(convert_columns(Splitter.new(s).parse)))
end

#typecast(obj) ⇒ Object

Typecast the given object to the appropriate type using the typecaster. Note that this does not conversion for the members of the composite type, since those conversion expect strings and strings may not be provided.



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/sequel/extensions/pg_row.rb', line 293

def typecast(obj)
  case obj 
  when Array
    _typecast(convert_format(obj))
  when Hash
    unless @columns
      raise Error, 'PGRow::Parser without columns cannot typecast from a hash'
    end
    _typecast(obj)
  else
    raise Error, 'PGRow::Parser can only typecast arrays and hashes'
  end
end