/usr/lib/ruby/vendor_ruby/sequel/extensions/pg_json.rb is in ruby-sequel 4.15.0-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 | # The pg_json extension adds support for Sequel to handle
# PostgreSQL's json and jsonb types. It is slightly more strict than the
# PostgreSQL json types in that the object returned should be an
# array or object (PostgreSQL's json type considers plain numbers
# strings, true, false, and null as valid). Sequel will work with
# PostgreSQL json values that are not arrays or objects, but support
# is fairly limited and the values do not roundtrip.
#
# This extension integrates with Sequel's native postgres adapter, so
# that when json fields are retrieved, they are parsed and returned
# as instances of Sequel::Postgres::JSONArray or
# Sequel::Postgres::JSONHash (or JSONBArray or JSONBHash for jsonb
# columns). JSONArray and JSONHash are
# DelegateClasses of Array and Hash, so they mostly act the same, but
# not completely (json_array.is_a?(Array) is false). If you want
# the actual array for a JSONArray, call JSONArray#to_a. If you want
# the actual hash for a JSONHash, call JSONHash#to_hash.
# This is done so that Sequel does not treat JSONArray and JSONHash
# like Array and Hash by default, which would cause issues.
#
# To turn an existing Array or Hash into a JSONArray or JSONHash,
# use Sequel.pg_json:
#
# Sequel.pg_json(array) # or Sequel.pg_jsonb(array) for jsonb type
# Sequel.pg_json(hash) # or Sequel.pg_jsonb(hash) for jsonb type
#
# If you have loaded the {core_extensions extension}[rdoc-ref:doc/core_extensions.rdoc],
# or you have loaded the core_refinements extension
# and have activated refinements for the file, you can also use Array#pg_json and Hash#pg_json:
#
# array.pg_json # or array.pg_jsonb for jsonb type
# hash.pg_json # or hash.pg_jsonb for jsonb type
#
# So if you want to insert an array or hash into an json database column:
#
# DB[:table].insert(:column=>Sequel.pg_json([1, 2, 3]))
# DB[:table].insert(:column=>Sequel.pg_json({'a'=>1, 'b'=>2}))
#
# If you would like to use PostgreSQL json columns in your model
# objects, you probably want to modify the schema parsing/typecasting
# so that it recognizes and correctly handles the json type, which
# you can do by:
#
# DB.extension :pg_json
#
# If you are not using the native postgres adapter and are using json
# types as model column values you probably should use the
# pg_typecast_on_load plugin if the column values are returned as a string.
#
# See the {schema modification guide}[rdoc-ref:doc/schema_modification.rdoc]
# for details on using json columns in CREATE/ALTER TABLE statements.
#
# This extension integrates with the pg_array extension. If you plan
# to use the json[] type, load the pg_array extension before the
# pg_json extension:
#
# DB.extension :pg_array, :pg_json
#
# Note that when accessing json hashes, you should always use strings for keys.
# Attempting to use other values (such as symbols) will not work correctly.
#
# This extension requires both the json and delegate libraries.
require 'delegate'
require 'json'
Sequel.require 'adapters/utils/pg_types'
module Sequel
module Postgres
CAST_JSON = '::json'.freeze
CAST_JSONB = '::jsonb'.freeze
# Class representing PostgreSQL JSON/JSONB column array values.
class JSONArrayBase < DelegateClass(Array)
include Sequel::SQL::AliasMethods
include Sequel::SQL::CastMethods
# Convert the array to a json string and append a
# literalized version of the string to the sql.
def sql_literal_append(ds, sql)
ds.literal_append(sql, Sequel.object_to_json(self))
end
end
class JSONArray < JSONArrayBase
# Cast as json
def sql_literal_append(ds, sql)
super
sql << CAST_JSON
end
end
class JSONBArray < JSONArrayBase
# Cast as jsonb
def sql_literal_append(ds, sql)
super
sql << CAST_JSONB
end
end
# Class representing PostgreSQL JSON/JSONB column hash/object values.
class JSONHashBase < DelegateClass(Hash)
include Sequel::SQL::AliasMethods
include Sequel::SQL::CastMethods
# Convert the hash to a json string and append a
# literalized version of the string to the sql.
def sql_literal_append(ds, sql)
ds.literal_append(sql, Sequel.object_to_json(self))
end
# Return the object being delegated to.
alias to_hash __getobj__
end
class JSONHash < JSONHashBase
# Cast as json
def sql_literal_append(ds, sql)
super
sql << CAST_JSON
end
end
class JSONBHash < JSONHashBase
# Cast as jsonb
def sql_literal_append(ds, sql)
super
sql << CAST_JSONB
end
end
# Methods enabling Database object integration with the json type.
module JSONDatabaseMethods
def self.extended(db)
db.instance_eval do
copy_conversion_procs([114, 199, 3802, 3807])
@schema_type_classes[:json] = [JSONHash, JSONArray]
@schema_type_classes[:jsonb] = [JSONBHash, JSONBArray]
end
end
# Parse JSON data coming from the database. Since PostgreSQL allows
# non JSON data in JSON fields (such as plain numbers and strings),
# we don't want to raise an exception for that.
def self.db_parse_json(s)
parse_json(s)
rescue Sequel::InvalidValue
raise unless s.is_a?(String)
parse_json("[#{s}]").first
end
# Same as db_parse_json, but consider the input as jsonb.
def self.db_parse_jsonb(s)
parse_json(s, true)
rescue Sequel::InvalidValue
raise unless s.is_a?(String)
parse_json("[#{s}]").first
end
# Parse the given string as json, returning either a JSONArray
# or JSONHash instance (or JSONBArray or JSONBHash instance if jsonb
# argument is true), or a String, Numeric, true, false, or nil
# if the json library used supports that.
def self.parse_json(s, jsonb=false)
begin
value = Sequel.parse_json(s)
rescue Sequel.json_parser_error_class => e
raise Sequel.convert_exception_class(e, Sequel::InvalidValue)
end
case value
when Array
(jsonb ? JSONBArray : JSONArray).new(value)
when Hash
(jsonb ? JSONBHash : JSONHash).new(value)
when String, Numeric, true, false, nil
value
else
raise Sequel::InvalidValue, "unhandled json value: #{value.inspect} (from #{s.inspect})"
end
end
# Handle JSONArray and JSONHash in bound variables
def bound_variable_arg(arg, conn)
case arg
when JSONArrayBase, JSONHashBase
Sequel.object_to_json(arg)
else
super
end
end
private
# Handle json[] types in bound variables.
def bound_variable_array(a)
case a
when JSONHashBase, JSONArrayBase
"\"#{Sequel.object_to_json(a).gsub('"', '\\"')}\""
else
super
end
end
# Make the column type detection recognize the json type.
def schema_column_type(db_type)
case db_type
when 'json'
:json
when 'jsonb'
:jsonb
else
super
end
end
# Convert the value given to a JSONArray or JSONHash
def typecast_value_json(value)
case value
when JSONArray, JSONHash
value
when Array
JSONArray.new(value)
when Hash
JSONHash.new(value)
when JSONBArray
JSONArray.new(value.to_a)
when JSONBHash
JSONHash.new(value.to_hash)
when String
JSONDatabaseMethods.parse_json(value)
else
raise Sequel::InvalidValue, "invalid value for json: #{value.inspect}"
end
end
# Convert the value given to a JSONBArray or JSONBHash
def typecast_value_jsonb(value)
case value
when JSONBArray, JSONBHash
value
when Array
JSONBArray.new(value)
when Hash
JSONBHash.new(value)
when JSONArray
JSONBArray.new(value.to_a)
when JSONHash
JSONBHash.new(value.to_hash)
when String
JSONDatabaseMethods.parse_json(value, true)
else
raise Sequel::InvalidValue, "invalid value for jsonb: #{value.inspect}"
end
end
end
PG_TYPES[114] = JSONDatabaseMethods.method(:db_parse_json)
PG_TYPES[3802] = JSONDatabaseMethods.method(:db_parse_jsonb)
if defined?(PGArray) && PGArray.respond_to?(:register)
PGArray.register('json', :oid=>199, :scalar_oid=>114)
PGArray.register('jsonb', :oid=>3807, :scalar_oid=>3802)
end
end
module SQL::Builders
# Wrap the array or hash in a Postgres::JSONArray or Postgres::JSONHash.
def pg_json(v)
case v
when Postgres::JSONArray, Postgres::JSONHash
v
when Array
Postgres::JSONArray.new(v)
when Hash
Postgres::JSONHash.new(v)
when Postgres::JSONBArray
Postgres::JSONArray.new(v.to_a)
when Postgres::JSONBHash
Postgres::JSONHash.new(v.to_hash)
else
Sequel.pg_json_op(v)
end
end
# Wrap the array or hash in a Postgres::JSONArray or Postgres::JSONHash.
def pg_jsonb(v)
case v
when Postgres::JSONBArray, Postgres::JSONBHash
v
when Array
Postgres::JSONBArray.new(v)
when Hash
Postgres::JSONBHash.new(v)
when Postgres::JSONArray
Postgres::JSONBArray.new(v.to_a)
when Postgres::JSONHash
Postgres::JSONBHash.new(v.to_hash)
else
Sequel.pg_json_op(v)
end
end
end
Database.register_extension(:pg_json, Postgres::JSONDatabaseMethods)
end
# :nocov:
if Sequel.core_extensions?
class Array
# Return a Sequel::Postgres::JSONArray proxy to the receiver.
# This is mostly useful as a short cut for creating JSONArray
# objects that didn't come from the database.
def pg_json
Sequel::Postgres::JSONArray.new(self)
end
# Return a Sequel::Postgres::JSONArray proxy to the receiver.
# This is mostly useful as a short cut for creating JSONArray
# objects that didn't come from the database.
def pg_jsonb
Sequel::Postgres::JSONBArray.new(self)
end
end
class Hash
# Return a Sequel::Postgres::JSONHash proxy to the receiver.
# This is mostly useful as a short cut for creating JSONHash
# objects that didn't come from the database.
def pg_json
Sequel::Postgres::JSONHash.new(self)
end
# Return a Sequel::Postgres::JSONHash proxy to the receiver.
# This is mostly useful as a short cut for creating JSONHash
# objects that didn't come from the database.
def pg_jsonb
Sequel::Postgres::JSONBHash.new(self)
end
end
end
if defined?(Sequel::CoreRefinements)
module Sequel::CoreRefinements
refine Array do
def pg_json
Sequel::Postgres::JSONArray.new(self)
end
def pg_jsonb
Sequel::Postgres::JSONBArray.new(self)
end
end
refine Hash do
def pg_json
Sequel::Postgres::JSONHash.new(self)
end
def pg_jsonb
Sequel::Postgres::JSONBHash.new(self)
end
end
end
end
# :nocov:
|