Class: Sequel::Postgres::PGRow::Parser
- 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
-
#column_converters ⇒ Object
readonly
Converters for each member in the composite type.
-
#column_oids ⇒ Object
readonly
The OIDs for each member in the composite type.
-
#columns ⇒ Object
readonly
The columns for the parser, if any.
-
#converter ⇒ Object
readonly
A converter for the object as a whole.
-
#oid ⇒ Object
readonly
The oid for the composite type itself.
-
#typecaster ⇒ Object
readonly
A callable object used for typecasting the object.
Instance Method Summary collapse
-
#call(s) ⇒ Object
Convert the PostgreSQL composite type input format into an appropriate ruby object.
-
#initialize(h = OPTS) ⇒ Parser
constructor
Sets each of the parser’s attributes, using options with the same name (e.g. :columns sets the columns attribute).
-
#typecast(obj) ⇒ Object
Typecast the given object to the appropriate type using the typecaster.
Constructor Details
#initialize(h = OPTS) ⇒ Parser
Sets each of the parser’s attributes, using options with the same name (e.g. :columns sets the columns attribute).
293 294 295 296 297 298 299 300 |
# File 'lib/sequel/extensions/pg_row.rb', line 293 def initialize(h=OPTS) @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.
269 270 271 |
# File 'lib/sequel/extensions/pg_row.rb', line 269 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.
273 274 275 |
# File 'lib/sequel/extensions/pg_row.rb', line 273 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.
263 264 265 |
# File 'lib/sequel/extensions/pg_row.rb', line 263 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.
278 279 280 |
# File 'lib/sequel/extensions/pg_row.rb', line 278 def converter @converter end |
#oid ⇒ Object (readonly)
The oid for the composite type itself.
281 282 283 |
# File 'lib/sequel/extensions/pg_row.rb', line 281 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.
289 290 291 |
# File 'lib/sequel/extensions/pg_row.rb', line 289 def typecaster @typecaster end |
Instance Method Details
#call(s) ⇒ Object
Convert the PostgreSQL composite type input format into an appropriate ruby object.
304 305 306 |
# File 'lib/sequel/extensions/pg_row.rb', line 304 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.
312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/sequel/extensions/pg_row.rb', line 312 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 |