/usr/lib/ruby/vendor_ruby/sequel/plugins/json_serializer.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 | require 'json'
module Sequel
module Plugins
# The json_serializer plugin handles serializing entire Sequel::Model
# objects to JSON, as well as support for deserializing JSON directly
# into Sequel::Model objects. It requires the json library, and can
# work with either the pure ruby version or the C extension.
#
# Basic Example:
#
# album = Album[1]
# album.to_json
# # => '{"json_class"=>"Album","id"=>1,"name"=>"RF","artist_id"=>2}'
#
# In addition, you can provide options to control the JSON output:
#
# album.to_json(:only=>:name)
# album.to_json(:except=>[:id, :artist_id])
# # => '{"json_class"="Album","name"=>"RF"}'
#
# album.to_json(:include=>:artist)
# # => '{"json_class":"Album","id":1,"name":"RF","artist_id":2,
# "artist":{"json_class":"Artist","id":2,"name":"YJM"}}'
#
# You can use a hash value with <tt>:include</tt> to pass options
# to associations:
#
# album.to_json(:include=>{:artist=>{:only=>:name}})
# # => '{"json_class":"Album","id":1,"name":"RF","artist_id":2,
# "artist":{"json_class":"Artist","name":"YJM"}}'
#
# You can specify the <tt>:root</tt> option to nest the JSON under the
# name of the model:
#
# album.to_json(:root => true)
# # => '{"album":{"id":1,"name":"RF","artist_id":2}}'
#
# Additionally, +to_json+ also exists as a class and dataset method, both
# of which return all objects in the dataset:
#
# Album.to_json
# Album.filter(:artist_id=>1).to_json(:include=>:tags)
#
# If you have an existing array of model instances you want to convert to
# JSON, you can call the class to_json method with the :array option:
#
# Album.to_json(:array=>[Album[1], Album[2]])
#
# In addition to creating JSON, this plugin also enables Sequel::Model
# classes to create instances directly from JSON using the from_json class
# method:
#
# json = album.to_json
# album = Album.from_json(json)
#
# The array_from_json class method exists to parse arrays of model instances
# from json:
#
# json = Album.filter(:artist_id=>1).to_json
# albums = Album.array_from_json(json)
#
# These does not necessarily round trip, since doing so would let users
# create model objects with arbitrary values. By default, from_json will
# call set with the values in the hash. If you want to specify the allowed
# fields, you can use the :fields option, which will call set_fields with
# the given fields:
#
# Album.from_json(album.to_json, :fields=>%w'id name')
#
# If you want to update an existing instance, you can use the from_json
# instance method:
#
# album.from_json(json)
#
# Both of these allow creation of cached associated objects, if you provide
# the :associations option:
#
# album.from_json(json, :associations=>:artist)
#
# You can even provide options when setting up the associated objects:
#
# album.from_json(json, :associations=>{:artist=>{:fields=>%w'id name', :associations=>:tags}})
#
# Note that active_support/json makes incompatible changes to the to_json API,
# and breaks some aspects of the json_serializer plugin. You can undo the damage
# done by active_support/json by doing:
#
# class Array
# def to_json(options = {})
# JSON.generate(self)
# end
# end
#
# class Hash
# def to_json(options = {})
# JSON.generate(self)
# end
# end
#
# Note that this will probably cause active_support/json to no longer work
# correctly in some cases.
#
# Usage:
#
# # Add JSON output capability to all model subclass instances (called before loading subclasses)
# Sequel::Model.plugin :json_serializer
#
# # Add JSON output capability to Album class instances
# Album.plugin :json_serializer
module JsonSerializer
# Set up the column readers to do deserialization and the column writers
# to save the value in deserialized_values.
def self.configure(model, opts={})
model.instance_eval do
@json_serializer_opts = (@json_serializer_opts || {}).merge(opts)
end
end
# Helper class used for making sure that cascading options
# for model associations works correctly. Cascaded options
# work by creating instances of this class, which take a
# literal JSON string and have +to_json+ return it.
class Literal
# Store the literal JSON to use
def initialize(json)
@json = json
end
# Return the literal JSON to use
def to_json(*a)
@json
end
end
module ClassMethods
# The default opts to use when serializing model objects to JSON.
attr_reader :json_serializer_opts
# Attempt to parse a single instance from the given JSON string,
# with options passed to InstanceMethods#from_json_node.
def from_json(json, opts=OPTS)
v = Sequel.parse_json(json)
case v
when self
v
when Hash
new.from_json_node(v, opts)
else
raise Error, "parsed json doesn't return a hash or instance of #{self}"
end
end
# Attempt to parse an array of instances from the given JSON string,
# with options passed to InstanceMethods#from_json_node.
def array_from_json(json, opts=OPTS)
v = Sequel.parse_json(json)
if v.is_a?(Array)
raise(Error, 'parsed json returned an array containing non-hashes') unless v.all?{|ve| ve.is_a?(Hash) || ve.is_a?(self)}
v.map{|ve| ve.is_a?(self) ? ve : new.from_json_node(ve, opts)}
else
raise(Error, 'parsed json did not return an array')
end
end
Plugins.inherited_instance_variables(self, :@json_serializer_opts=>lambda do |json_serializer_opts|
opts = {}
json_serializer_opts.each{|k, v| opts[k] = (v.is_a?(Array) || v.is_a?(Hash)) ? v.dup : v}
opts
end)
Plugins.def_dataset_methods(self, :to_json)
end
module InstanceMethods
# Parse the provided JSON, which should return a hash,
# and process the hash with from_json_node.
def from_json(json, opts=OPTS)
from_json_node(Sequel.parse_json(json), opts)
end
# Using the provided hash, update the instance with data contained in the hash. By default, just
# calls set with the hash values.
#
# Options:
# :associations :: Indicates that the associations cache should be updated by creating
# a new associated object using data from the hash. Should be a Symbol
# for a single association, an array of symbols for multiple associations,
# or a hash with symbol keys and dependent association option hash values.
# :fields :: Changes the behavior to call set_fields using the provided fields, instead of calling set.
def from_json_node(hash, opts=OPTS)
unless hash.is_a?(Hash)
raise Error, "parsed json doesn't return a hash"
end
populate_associations = {}
if assocs = opts[:associations]
assocs = case assocs
when Symbol
{assocs=>{}}
when Array
assocs_tmp = {}
assocs.each{|v| assocs_tmp[v] = {}}
assocs_tmp
when Hash
assocs
else
raise Error, ":associations should be Symbol, Array, or Hash if present"
end
assocs.each do |assoc, assoc_opts|
if assoc_values = hash.delete(assoc.to_s)
unless r = model.association_reflection(assoc)
raise Error, "Association #{assoc} is not defined for #{model}"
end
populate_associations[assoc] = if r.returns_array?
raise Error, "Attempt to populate array association with a non-array" unless assoc_values.is_a?(Array)
assoc_values.map{|v| v.is_a?(r.associated_class) ? v : r.associated_class.new.from_json_node(v, assoc_opts)}
else
raise Error, "Attempt to populate non-array association with an array" if assoc_values.is_a?(Array)
assoc_values.is_a?(r.associated_class) ? assoc_values : r.associated_class.new.from_json_node(assoc_values, assoc_opts)
end
end
end
end
if fields = opts[:fields]
set_fields(hash, fields, opts)
else
set(hash)
end
populate_associations.each do |assoc, values|
associations[assoc] = values
end
self
end
# Return a string in JSON format. Accepts the following
# options:
#
# :except :: Symbol or Array of Symbols of columns not
# to include in the JSON output.
# :include :: Symbol, Array of Symbols, or a Hash with
# Symbol keys and Hash values specifying
# associations or other non-column attributes
# to include in the JSON output. Using a nested
# hash, you can pass options to associations
# to affect the JSON used for associated objects.
# :only :: Symbol or Array of Symbols of columns to only
# include in the JSON output, ignoring all other
# columns.
# :root :: Qualify the JSON with the name of the object.
def to_json(*a)
if opts = a.first.is_a?(Hash)
opts = model.json_serializer_opts.merge(a.first)
a = []
else
opts = model.json_serializer_opts
end
vals = values
cols = if only = opts[:only]
Array(only)
else
vals.keys - Array(opts[:except])
end
h = {}
cols.each{|c| h[c.to_s] = send(c)}
if inc = opts[:include]
if inc.is_a?(Hash)
inc.each do |k, v|
v = v.empty? ? [] : [v]
h[k.to_s] = case objs = send(k)
when Array
objs.map{|obj| Literal.new(Sequel.object_to_json(obj, *v))}
else
Literal.new(Sequel.object_to_json(objs, *v))
end
end
else
Array(inc).each{|c| h[c.to_s] = send(c)}
end
end
h = {model.send(:underscore, model.to_s) => h} if opts[:root]
Sequel.object_to_json(h, *a)
end
end
module DatasetMethods
# Return a JSON string representing an array of all objects in
# this dataset. Takes the same options as the the instance
# method, and passes them to every instance. Additionally,
# respects the following options:
#
# :array :: An array of instances. If this is not provided,
# calls #all on the receiver to get the array.
# :root :: If set to :collection, only wraps the collection
# in a root object. If set to :instance, only wraps
# the instances in a root object. If set to :both,
# wraps both the collection and instances in a root
# object. Unfortunately, for backwards compatibility,
# if this option is true and doesn't match one of those
# symbols, it defaults to both. That may change in a
# future version, so for forwards compatibility, you
# should pick a specific symbol for your desired
# behavior.
def to_json(*a)
if opts = a.first.is_a?(Hash)
opts = model.json_serializer_opts.merge(a.first)
a = []
else
opts = model.json_serializer_opts
end
collection_root = case opts[:root]
when nil, false, :instance
false
when :both
true
else
opts = opts.dup
opts.delete(:root)
true
end
res = if row_proc
array = if opts[:array]
opts = opts.dup
opts.delete(:array)
else
all
end
array.map{|obj| Literal.new(Sequel.object_to_json(obj, opts))}
else
all
end
if collection_root
Sequel.object_to_json({model.send(:pluralize, model.send(:underscore, model.to_s)) => res}, *a)
else
Sequel.object_to_json(res, *a)
end
end
end
end
end
end
|