/usr/lib/ruby/vendor_ruby/sequel/extensions/pg_array.rb is in ruby-sequel 4.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 | # The pg_array extension adds support for Sequel to handle
# PostgreSQL's array types.
#
# This extension integrates with Sequel's native postgres adapter, so
# that when array fields are retrieved, they are parsed and returned
# as instances of Sequel::Postgres::PGArray. PGArray is
# a DelegateClass of Array, so it mostly acts like an array, but not
# completely (is_a?(Array) is false). If you want the actual array,
# you can call PGArray#to_a. This is done so that Sequel does not
# treat a PGArray like an Array by default, which would cause issues.
#
# In addition to the parsers, this extension comes with literalizers
# for PGArray using the standard Sequel literalization callbacks, so
# they work with on all adapters.
#
# To turn an existing Array into a PGArray:
#
# Sequel.pg_array(array)
#
# If you have loaded the {core_extensions extension}[link:files/doc/core_extensions_rdoc.html],
# or you have loaded the {core_refinements extension}[link:files/doc/core_refinements_rdoc.html]
# and have activated refinements for the file, you can also use Array#pg_array:
#
# array.pg_array
#
# You can also provide a type, though it many cases it isn't necessary:
#
# Sequel.pg_array(array, :varchar) # or :integer, :"double precision", etc.
# array.pg_array(:varchar) # or :integer, :"double precision", etc.
#
# So if you want to insert an array into an integer[] database column:
#
# DB[:table].insert(:column=>Sequel.pg_array([1, 2, 3]))
#
# To use this extension, first load it into your Sequel::Database instance:
#
# DB.extension :pg_array
#
# If you are not using the native postgres adapter and are using array
# types as model column values you probably should use the
# pg_typecast_on_load plugin in the model, and set it to typecast the
# array column(s) on load.
#
# This extension by default includes handlers for array types for
# all scalar types that the native postgres adapter handles. It
# also makes it easy to add support for other array types. In
# general, you just need to make sure that the scalar type is
# handled and has the appropriate converter installed in
# Sequel::Postgres::PG_TYPES under the appropriate type OID.
# Then you can call
# Sequel::Postgres::PGArray::DatabaseMethods#register_array_type
# to automatically set up a handler for the array type. So if you
# want to support the foo[] type (assuming the foo type is already
# supported):
#
# DB.register_array_type('foo')
#
# You can also register array types on a global basis using
# Sequel::Postgres::PGArray.register. In this case, you'll have
# to specify the type oids:
#
# Sequel::Postgres::PGArray.register('foo', :oid=>4321, :scalar_oid=>1234)
#
# Both Sequel::Postgres::PGArray::DatabaseMethods#register_array_type
# and Sequel::Postgres::PGArray.register support many options to
# customize the array type handling. See the Sequel::Postgres::PGArray.register
# method documentation.
#
# If you want an easy way to call PostgreSQL array functions and
# operators, look into the pg_array_ops extension.
#
# This extension requires both the json and delegate libraries.
#
# == Additional License
#
# PGArray::Parser code was translated from Javascript code in the
# node-postgres project and has the following additional license:
#
# Copyright (c) 2010 Brian Carlson (brian.m.carlson@gmail.com)
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject
# to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
require 'delegate'
require 'json'
Sequel.require 'adapters/utils/pg_types'
module Sequel
module Postgres
# Represents a PostgreSQL array column value.
class PGArray < DelegateClass(Array)
include Sequel::SQL::AliasMethods
ARRAY = "ARRAY".freeze
DOUBLE_COLON = '::'.freeze
EMPTY_BRACKET = '[]'.freeze
OPEN_BRACKET = '['.freeze
CLOSE_BRACKET = ']'.freeze
COMMA = ','.freeze
BACKSLASH = '\\'.freeze
EMPTY_STRING = ''.freeze
OPEN_BRACE = '{'.freeze
CLOSE_BRACE = '}'.freeze
NULL = 'NULL'.freeze
QUOTE = '"'.freeze
# Global hash of database array type name strings to symbols (e.g. 'double precision' => :float),
# used by the schema parsing for array types registered globally.
ARRAY_TYPES = {}
# Registers an array type that the extension should handle. Makes a Database instance that
# has been extended with DatabaseMethods recognize the array type given and set up the
# appropriate typecasting. Also sets up automatic typecasting for the native postgres
# adapter, so that on retrieval, the values are automatically converted to PGArray instances.
# The db_type argument should be the exact database type used (as returned by the PostgreSQL
# format_type database function). Accepts the following options:
#
# :array_type :: The type to automatically cast the array to when literalizing the array.
# Usually the same as db_type.
# :converter :: A callable object (e.g. Proc), that is called with each element of the array
# (usually a string), and should return the appropriate typecasted object.
# :oid :: The PostgreSQL OID for the array type. This is used by the Sequel postgres adapter
# to set up automatic type conversion on retrieval from the database.
# :parser :: Can be set to :json to use the faster JSON-based parser. Note that the JSON-based
# parser can only correctly handle integers values correctly. It doesn't handle
# full precision for numeric types, and doesn't handle NaN/Infinity values for
# floating point types.
# :scalar_oid :: Should be the PostgreSQL OID for the scalar version of this array type. If given,
# automatically sets the :converter option by looking for scalar conversion
# proc.
# :scalar_typecast :: Should be a symbol indicating the typecast method that should be called on
# each element of the array, when a plain array is passed into a database
# typecast method. For example, for an array of integers, this could be set to
# :integer, so that the typecast_value_integer method is called on all of the
# array elements. Defaults to :type_symbol option.
# :type_procs :: A hash mapping oids to conversion procs, used for looking up the :scalar_oid and
# value and setting the :oid value. Defaults to the global Sequel::Postgres::PG_TYPES.
# :type_symbol :: The base of the schema type symbol for this type. For example, if you provide
# :integer, Sequel will recognize this type as :integer_array during schema parsing.
# Defaults to the db_type argument.
# :typecast_method :: If given, specifies the :type_symbol option, but additionally causes no
# typecasting method to be created in the database. This should only be used
# to alias existing array types. For example, if there is an array type that can be
# treated just like an integer array, you can do :typecast_method=>:integer.
# :typecast_method_map :: The map in which to place the database type string to type symbol mapping.
# Defaults to ARRAY_TYPES.
# :typecast_methods_module :: If given, a module object to add the typecasting method to. Defaults
# to DatabaseMethods.
#
# If a block is given, it is treated as the :converter option.
def self.register(db_type, opts=OPTS, &block)
db_type = db_type.to_s
typecast_method = opts[:typecast_method]
type = (typecast_method || opts[:type_symbol] || db_type).to_sym
type_procs = opts[:type_procs] || PG_TYPES
mod = opts[:typecast_methods_module] || DatabaseMethods
typecast_method_map = opts[:typecast_method_map] || ARRAY_TYPES
if converter = opts[:converter]
raise Error, "can't provide both a block and :converter option to register" if block
else
converter = block
end
if soid = opts[:scalar_oid]
raise Error, "can't provide both a converter and :scalar_oid option to register" if converter
raise Error, "no conversion proc for :scalar_oid=>#{soid.inspect}" unless converter = type_procs[soid]
end
array_type = (opts[:array_type] || db_type).to_s.dup.freeze
creator = (opts[:parser] == :json ? JSONCreator : Creator).new(array_type, converter)
typecast_method_map[db_type] = :"#{type}_array"
define_array_typecast_method(mod, type, creator, opts.fetch(:scalar_typecast, type)) unless typecast_method
if oid = opts[:oid]
type_procs[oid] = creator
end
nil
end
# Define a private array typecasting method in the given module for the given type that uses
# the creator argument to do the type conversion.
def self.define_array_typecast_method(mod, type, creator, scalar_typecast)
mod.class_eval do
meth = :"typecast_value_#{type}_array"
scalar_typecast_method = :"typecast_value_#{scalar_typecast}"
define_method(meth){|v| typecast_value_pg_array(v, creator, scalar_typecast_method)}
private meth
end
end
private_class_method :define_array_typecast_method
module DatabaseMethods
APOS = "'".freeze
DOUBLE_APOS = "''".freeze
ESCAPE_RE = /("|\\)/.freeze
ESCAPE_REPLACEMENT = '\\\\\1'.freeze
BLOB_RANGE = 1...-1
# Create the local hash of database type strings to schema type symbols,
# used for array types local to this database.
def self.extended(db)
db.instance_eval do
@pg_array_schema_types ||= {}
copy_conversion_procs([1009, 1007, 1016, 1231, 1022, 1000, 1001, 1182, 1183, 1270, 1005, 1028, 1021, 1014, 1015])
[:string_array, :integer_array, :decimal_array, :float_array, :boolean_array, :blob_array, :date_array, :time_array, :datetime_array].each do |v|
@schema_type_classes[v] = PGArray
end
end
procs = db.conversion_procs
procs[1115] = Creator.new("timestamp without time zone", procs[1114])
procs[1185] = Creator.new("timestamp with time zone", procs[1184])
end
# Handle arrays in bound variables
def bound_variable_arg(arg, conn)
case arg
when PGArray
bound_variable_array(arg.to_a)
when Array
bound_variable_array(arg)
else
super
end
end
# Register a database specific array type. This can be used to support
# different array types per Database. Use of this method does not
# affect global state, unlike PGArray.register. See PGArray.register for
# possible options.
def register_array_type(db_type, opts=OPTS, &block)
opts = {:type_procs=>conversion_procs, :typecast_method_map=>@pg_array_schema_types, :typecast_methods_module=>(class << self; self; end)}.merge(opts)
unless (opts.has_key?(:scalar_oid) || block) && opts.has_key?(:oid)
array_oid, scalar_oid = from(:pg_type).where(:typname=>db_type.to_s).get([:typarray, :oid])
opts[:scalar_oid] = scalar_oid unless opts.has_key?(:scalar_oid) || block
opts[:oid] = array_oid unless opts.has_key?(:oid)
end
PGArray.register(db_type, opts, &block)
@schema_type_classes[:"#{opts[:typecast_method] || opts[:type_symbol] || db_type}_array"] = PGArray
end
# Return PGArray if this type matches any supported array type.
def schema_type_class(type)
super || (ARRAY_TYPES.each_value{|v| return PGArray if type == v}; nil)
end
private
# Format arrays used in bound variables.
def bound_variable_array(a)
case a
when Array
"{#{a.map{|i| bound_variable_array(i)}.join(COMMA)}}"
when Sequel::SQL::Blob
"\"#{literal(a)[BLOB_RANGE].gsub(DOUBLE_APOS, APOS).gsub(ESCAPE_RE, ESCAPE_REPLACEMENT)}\""
when Sequel::LiteralString
a
when String
"\"#{a.gsub(ESCAPE_RE, ESCAPE_REPLACEMENT)}\""
else
literal(a)
end
end
# Automatically handle array types for the given named types.
def convert_named_procs_to_procs(named_procs)
h = super
unless h.empty?
from(:pg_type).where(:oid=>h.keys).select_map([:typname, :oid, :typarray]).each do |name, scalar_oid, array_oid|
register_array_type(name, :type_procs=>h, :oid=>array_oid.to_i, :scalar_oid=>scalar_oid.to_i)
end
end
h
end
# Manually override the typecasting for timestamp array types so that
# they use the database's timezone instead of the global Sequel
# timezone.
def get_conversion_procs
procs = super
procs[1115] = Creator.new("timestamp without time zone", procs[1114])
procs[1185] = Creator.new("timestamp with time zone", procs[1184])
procs
end
# Look into both the current database's array schema types and the global
# array schema types to get the type symbol for the given database type
# string.
def pg_array_schema_type(type)
@pg_array_schema_types[type] || ARRAY_TYPES[type]
end
# Make the column type detection handle registered array types.
def schema_column_type(db_type)
if (db_type =~ /\A([^(]+)(?:\([^(]+\))?\[\]\z/io) && (type = pg_array_schema_type($1))
type
else
super
end
end
# Given a value to typecast and the type of PGArray subclass:
# * If given a PGArray with a matching array_type, use it directly.
# * If given a PGArray with a different array_type, return a PGArray
# with the creator's type.
# * If given an Array, create a new PGArray instance for it. This does not
# typecast all members of the array in ruby for performance reasons, but
# it will cast the array the appropriate database type when the array is
# literalized.
# * If given a String, call the parser for the subclass with it.
def typecast_value_pg_array(value, creator, scalar_typecast_method=nil)
case value
when PGArray
if value.array_type != creator.type
PGArray.new(value.to_a, creator.type)
else
value
end
when Array
if scalar_typecast_method && respond_to?(scalar_typecast_method, true)
value = Sequel.recursive_map(value, method(scalar_typecast_method))
end
PGArray.new(value, creator.type)
else
raise Sequel::InvalidValue, "invalid value for array type: #{value.inspect}"
end
end
end
# PostgreSQL array parser that handles all types of input.
#
# This parser is very simple and unoptimized, but should still
# be O(n) where n is the length of the input string.
class Parser
# Current position in the input string.
attr_reader :pos
# Set the source for the input, and any converter callable
# to call with objects to be created. For nested parsers
# the source may contain text after the end current parse,
# which will be ignored.
def initialize(source, converter=nil)
@source = source
@source_length = source.length
@converter = converter
@pos = -1
@entries = []
@recorded = ""
@dimension = 0
end
# Return 2 objects, whether the next character in the input
# was escaped with a backslash, and what the next character is.
def next_char
@pos += 1
if (c = @source[@pos..@pos]) == BACKSLASH
@pos += 1
[true, @source[@pos..@pos]]
else
[false, c]
end
end
# Add a new character to the buffer of recorded characters.
def record(c)
@recorded << c
end
# Take the buffer of recorded characters and add it to the array
# of entries, and use a new buffer for recorded characters.
def new_entry(include_empty=false)
if !@recorded.empty? || include_empty
entry = @recorded
if entry == NULL && !include_empty
entry = nil
elsif @converter
entry = @converter.call(entry)
end
@entries.push(entry)
@recorded = ""
end
end
# Parse the input character by character, returning an array
# of parsed (and potentially converted) objects.
def parse(nested=false)
# quote sets whether we are inside of a quoted string.
quote = false
until @pos >= @source_length
escaped, char = next_char
if char == OPEN_BRACE && !quote
@dimension += 1
if (@dimension > 1)
# Multi-dimensional array encounter, use a subparser
# to parse the next level down.
subparser = self.class.new(@source[@pos..-1], @converter)
@entries.push(subparser.parse(true))
@pos += subparser.pos - 1
end
elsif char == CLOSE_BRACE && !quote
@dimension -= 1
if (@dimension == 0)
new_entry
# Exit early if inside a subparser, since the
# text after parsing the current level should be
# ignored as it is handled by the parent parser.
return @entries if nested
end
elsif char == QUOTE && !escaped
# If already inside the quoted string, this is the
# ending quote, so add the entry. Otherwise, this
# is the opening quote, so set the quote flag.
new_entry(true) if quote
quote = !quote
elsif char == COMMA && !quote
# If not inside a string and a comma occurs, it indicates
# the end of the entry, so add the entry.
new_entry
else
# Add the character to the recorded character buffer.
record(char)
end
end
raise Sequel::Error, "array dimensions not balanced" unless @dimension == 0
@entries
end
end unless Sequel::Postgres.respond_to?(:parse_pg_array)
# Callable object that takes the input string and parses it using Parser.
class Creator
# The converter callable that is called on each member of the array
# to convert it to the correct type.
attr_reader :converter
# The database type to set on the PGArray instances returned.
attr_reader :type
# Set the type and optional converter callable that will be used.
def initialize(type, converter=nil)
@type = type
@converter = converter
end
if Sequel::Postgres.respond_to?(:parse_pg_array)
# :nocov:
# Use sequel_pg's C-based parser if it has already been defined.
def call(string)
PGArray.new(Sequel::Postgres.parse_pg_array(string, @converter), @type)
end
# :nocov:
else
# Parse the string using Parser with the appropriate
# converter, and return a PGArray with the appropriate database
# type.
def call(string)
PGArray.new(Parser.new(string, @converter).parse, @type)
end
end
end
# Callable object that takes the input string and parses it using.
# a JSON parser. This should be faster than the standard Creator,
# but only handles integer types correctly.
class JSONCreator < Creator
# Character conversion map mapping input strings to JSON replacements
SUBST = {'{'.freeze=>'['.freeze, '}'.freeze=>']'.freeze, 'NULL'.freeze=>'null'.freeze}
# Regular expression matching input strings to convert
SUBST_RE = %r[\{|\}|NULL].freeze
# Parse the input string by using a gsub to convert non-JSON characters to
# JSON, running it through a regular JSON parser. If a converter is used, a
# recursive map of the output is done to make sure that the entires in the
# correct type.
def call(string)
array = Sequel.parse_json(string.gsub(SUBST_RE){|m| SUBST[m]})
array = Sequel.recursive_map(array, @converter) if @converter
PGArray.new(array, @type)
end
end
# The type of this array. May be nil if no type was given. If a type
# is provided, the array is automatically casted to this type when
# literalizing. This type is the underlying type, not the array type
# itself, so for an int4[] database type, it should be :int4 or 'int4'
attr_accessor :array_type
# Set the array to delegate to, and a database type.
def initialize(array, type=nil)
super(array)
@array_type = type
end
# Append the array SQL to the given sql string.
# If the receiver has a type, add a cast to the
# database array type.
def sql_literal_append(ds, sql)
sql << ARRAY
_literal_append(sql, ds, to_a)
if at = array_type
sql << DOUBLE_COLON << at.to_s << EMPTY_BRACKET
end
end
private
# Recursive method that handles multi-dimensional
# arrays, surrounding each with [] and interspersing
# entries with ,.
def _literal_append(sql, ds, array)
sql << OPEN_BRACKET
comma = false
commas = COMMA
array.each do |i|
sql << commas if comma
if i.is_a?(Array)
_literal_append(sql, ds, i)
else
ds.literal_append(sql, i)
end
comma = true
end
sql << CLOSE_BRACKET
end
# Register all array types that this extension handles by default.
register('text', :oid=>1009, :type_symbol=>:string)
register('integer', :oid=>1007, :parser=>:json)
register('bigint', :oid=>1016, :parser=>:json, :scalar_typecast=>:integer)
register('numeric', :oid=>1231, :scalar_oid=>1700, :type_symbol=>:decimal)
register('double precision', :oid=>1022, :scalar_oid=>701, :type_symbol=>:float)
register('boolean', :oid=>1000, :scalar_oid=>16)
register('bytea', :oid=>1001, :scalar_oid=>17, :type_symbol=>:blob)
register('date', :oid=>1182, :scalar_oid=>1082)
register('time without time zone', :oid=>1183, :scalar_oid=>1083, :type_symbol=>:time)
register('timestamp without time zone', :oid=>1115, :scalar_oid=>1114, :type_symbol=>:datetime)
register('time with time zone', :oid=>1270, :scalar_oid=>1083, :type_symbol=>:time_timezone, :scalar_typecast=>:time)
register('timestamp with time zone', :oid=>1185, :scalar_oid=>1184, :type_symbol=>:datetime_timezone, :scalar_typecast=>:datetime)
register('smallint', :oid=>1005, :parser=>:json, :typecast_method=>:integer)
register('oid', :oid=>1028, :parser=>:json, :typecast_method=>:integer)
register('real', :oid=>1021, :scalar_oid=>701, :typecast_method=>:float)
register('character', :oid=>1014, :array_type=>:text, :typecast_method=>:string)
register('character varying', :oid=>1015, :typecast_method=>:string)
end
end
module SQL::Builders
# Return a Postgres::PGArray proxy for the given array and database array type.
def pg_array(v, array_type=nil)
case v
when Postgres::PGArray
if array_type.nil? || v.array_type == array_type
v
else
Postgres::PGArray.new(v.to_a, array_type)
end
when Array
Postgres::PGArray.new(v, array_type)
else
# May not be defined unless the pg_array_ops extension is used
pg_array_op(v)
end
end
end
Database.register_extension(:pg_array, Postgres::PGArray::DatabaseMethods)
end
# :nocov:
if Sequel.core_extensions?
class Array
# Return a PGArray proxy to the receiver, using a
# specific database type if given. This is mostly useful
# as a short cut for creating PGArray objects that didn't
# come from the database.
def pg_array(type=nil)
Sequel::Postgres::PGArray.new(self, type)
end
end
end
if defined?(Sequel::CoreRefinements)
module Sequel::CoreRefinements
refine Array do
def pg_array(type=nil)
Sequel::Postgres::PGArray.new(self, type)
end
end
end
end
# :nocov:
|