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
|
require_relative "spec_helper"
require 'yaml'
require 'json'
describe "Serialization plugin" do
before do
@c = Class.new(Sequel::Model(:items)) do
no_primary_key
columns :id, :abc, :def, :ghi
end
DB.reset
end
it "should allow setting additional serializable attributes via plugin :serialization call" do
@c.plugin :serialization, :yaml, :abc
@c.create(:abc => 1, :def=> 2)
DB.sqls.map{|s| s.sub("1\n...", '1')}.must_equal ["INSERT INTO items (def, abc) VALUES (2, '--- 1\n')"]
@c.plugin :serialization, :marshal, :def
@c.create(:abc => 1, :def=> 1)
DB.sqls.map{|s| s.sub("1\n...", '1')}.must_equal ["INSERT INTO items (abc, def) VALUES ('--- 1\n', 'BAhpBg==\n')"]
@c.plugin :serialization, :json, :ghi
@c.create(:ghi => [123])
DB.sqls.must_equal ["INSERT INTO items (ghi) VALUES ('[123]')"]
end
it "should handle validations of underlying column" do
@c.plugin :serialization, :yaml, :abc
o = @c.new
def o.validate
errors.add(:abc, "not present") unless self[:abc]
end
o.valid?.must_equal false
o.abc = {}
o.valid?.must_equal true
end
it "should offer serialize_attributes class method for configuring serialization" do
@c.plugin :serialization
@c.serialize_attributes :yaml, :abc
o = @c.new
def o.validate
errors.add(:abc, "not present") unless self[:abc]
end
o.valid?.must_equal false
o.abc = {}
o.valid?.must_equal true
end
it "should set column values even when not validating" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc
@c.load({:id=>1}).set(:abc=>{}).save(:validate=>false)
DB.sqls.last.gsub("\n", '').must_equal "UPDATE items SET abc = '--- {}' WHERE (id = 1)"
end
it "should allow serializing attributes to yaml" do
@c.plugin :serialization, :yaml, :abc
@c.create(:abc => 1)
@c.create(:abc => "hello")
DB.sqls.map{|s| s.sub("...\n", '')}.must_equal ["INSERT INTO items (abc) VALUES ('--- 1\n')", "INSERT INTO items (abc) VALUES ('--- hello\n')"]
end
it "should allow serializing attributes to marshal" do
@c.plugin :serialization, :marshal, :abc
@c.create(:abc => 1)
@c.create(:abc => "hello")
x = [Marshal.dump("hello")].pack('m')
DB.sqls.must_equal [ \
"INSERT INTO items (abc) VALUES ('BAhpBg==\n')", \
"INSERT INTO items (abc) VALUES ('#{x}')", \
]
end
it "should allow serializing attributes to json" do
@c.plugin :serialization, :json, :ghi
@c.create(:ghi => [1])
@c.create(:ghi => ["hello"])
x = ["hello"].to_json
DB.sqls.must_equal [ \
"INSERT INTO items (ghi) VALUES ('[1]')", \
"INSERT INTO items (ghi) VALUES ('#{x}')", \
]
end
it "should not attempt to serialize nil attributes" do
@c.plugin :serialization, :marshal, :abc
@c.create(:abc => nil)
DB.sqls.must_equal ["INSERT INTO items (abc) VALUES (NULL)"]
end
it "should allow serializing attributes using arbitrary callable" do
@c.plugin :serialization, [proc{|s| s.reverse}, proc{}], :abc
@c.create(:abc => "hello")
DB.sqls.must_equal ["INSERT INTO items (abc) VALUES ('olleh')"]
end
it "should raise an error if specificing serializer as an unregistered symbol" do
proc{@c.plugin :serialization, :foo, :abc}.must_raise(Sequel::Error)
end
it "should translate values to and from yaml serialization format using accessor methods" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc, :def
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
o = @c.first
o.id.must_equal 1
o.abc.must_equal 1
o.abc.must_equal 1
o.def.must_equal "hello"
o.def.must_equal "hello"
o.update(:abc => 23)
@c.create(:abc => [1, 2, 3])
DB.sqls.must_equal ["SELECT * FROM items LIMIT 1",
"UPDATE items SET abc = '#{23.to_yaml}' WHERE (id = 1)",
"INSERT INTO items (abc) VALUES ('#{[1, 2, 3].to_yaml}')",
"SELECT * FROM items WHERE id = 10"]
end
it "should translate values to and from marshal serialization format using accessor methods" do
@c.set_primary_key :id
@c.plugin :serialization, :marshal, :abc, :def
@c.dataset = @c.dataset.with_fetch([:id => 1, :abc =>[Marshal.dump(1)].pack('m'), :def =>[Marshal.dump('hello')].pack('m')])
o = @c.first
o.id.must_equal 1
o.abc.must_equal 1
o.abc.must_equal 1
o.def.must_equal "hello"
o.def.must_equal "hello"
o.update(:abc => 23)
@c.create(:abc => [1, 2, 3])
DB.sqls.must_equal ["SELECT * FROM items LIMIT 1",
"UPDATE items SET abc = '#{[Marshal.dump(23)].pack('m')}' WHERE (id = 1)",
"INSERT INTO items (abc) VALUES ('#{[Marshal.dump([1, 2, 3])].pack('m')}')",
"SELECT * FROM items WHERE id = 10"]
end
it "should handle old non-base-64 encoded marshal serialization format" do
@c.set_primary_key :id
@c.plugin :serialization, :marshal, :abc, :def
@c.dataset = @c.dataset.with_fetch([:id => 1, :abc =>Marshal.dump(1), :def =>Marshal.dump('hello')])
o = @c.first
o.abc.must_equal 1
o.def.must_equal "hello"
end
it "should raise exception for bad marshal data" do
@c.set_primary_key :id
@c.plugin :serialization, :marshal, :abc, :def
@c.dataset = @c.dataset.with_fetch([:id => 1, :abc =>'foo', :def =>'bar'])
o = @c.first
proc{o.abc}.must_raise TypeError, ArgumentError
proc{o.def}.must_raise TypeError, ArgumentError
end
it "should translate values to and from json serialization format using accessor methods" do
@c.set_primary_key :id
@c.plugin :serialization, :json, :abc, :def
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => [1].to_json, :def => ["hello"].to_json)
o = @c.first
o.id.must_equal 1
o.abc.must_equal [1]
o.abc.must_equal [1]
o.def.must_equal ["hello"]
o.def.must_equal ["hello"]
o.update(:abc => [23])
@c.create(:abc => [1,2,3])
DB.sqls.must_equal ["SELECT * FROM items LIMIT 1",
"UPDATE items SET abc = '#{[23].to_json}' WHERE (id = 1)",
"INSERT INTO items (abc) VALUES ('#{[1,2,3].to_json}')",
"SELECT * FROM items WHERE id = 10"]
end
it "should translate values to and from arbitrary callables using accessor methods" do
@c.set_primary_key :id
@c.plugin :serialization, [proc{|s| s.reverse}, proc{|s| s.reverse}], :abc, :def
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => 'cba', :def => 'olleh')
o = @c.first
o.id.must_equal 1
o.abc.must_equal 'abc'
o.abc.must_equal 'abc'
o.def.must_equal "hello"
o.def.must_equal "hello"
o.update(:abc => 'foo')
@c.create(:abc => 'bar')
DB.sqls.must_equal ["SELECT * FROM items LIMIT 1",
"UPDATE items SET abc = 'oof' WHERE (id = 1)",
"INSERT INTO items (abc) VALUES ('rab')",
"SELECT * FROM items WHERE id = 10"]
end
it "should handle registration of custom serializer/deserializer pairs" do
@c.set_primary_key :id
require 'sequel/plugins/serialization'
Sequel::Plugins::Serialization.register_format(:reverse, proc{|s| s.reverse}, proc{|s| s.reverse})
@c.plugin :serialization, :reverse, :abc, :def
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => 'cba', :def => 'olleh')
o = @c.first
o.id.must_equal 1
o.abc.must_equal 'abc'
o.abc.must_equal 'abc'
o.def.must_equal "hello"
o.def.must_equal "hello"
o.update(:abc => 'foo')
@c.create(:abc => 'bar')
DB.sqls.must_equal ["SELECT * FROM items LIMIT 1",
"UPDATE items SET abc = 'oof' WHERE (id = 1)",
"INSERT INTO items (abc) VALUES ('rab')",
"SELECT * FROM items WHERE id = 10"]
end
it "should copy serialization formats and columns to subclasses" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc, :def
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
o = Class.new(@c).first
o.id.must_equal 1
o.abc.must_equal 1
o.abc.must_equal 1
o.def.must_equal "hello"
o.def.must_equal "hello"
o.update(:abc => 23)
Class.new(@c).create(:abc => [1, 2, 3])
DB.sqls.must_equal ["SELECT * FROM items LIMIT 1",
"UPDATE items SET abc = '#{23.to_yaml}' WHERE (id = 1)",
"INSERT INTO items (abc) VALUES ('#{[1, 2, 3].to_yaml}')",
"SELECT * FROM items WHERE id = 10"]
end
it "should clear the deserialized columns when refreshing" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc, :def
o = @c.load(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
o.abc = 23
o.deserialized_values.length.must_equal 1
o.abc.must_equal 23
o.refresh
o.deserialized_values.length.must_equal 0
end
it "should handle case where there are no deserialized columns when refreshing" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc, :def
o = @c.load(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
o.refresh
o.deserialized_values.length.must_equal 0
end
it "should not clear the deserialized columns when refreshing after saving a new object" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc, :def
o = @c.new(:abc => "--- 1\n", :def => "--- hello\n")
o.deserialized_values.length.must_equal 2
o.save
o.deserialized_values.length.must_equal 2
end
it "should not clear the deserialized columns when refreshing after saving a new object with insert_select" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc, :def
@c.dataset = @c.dataset.with_extend do
def supports_insert_select?; true end
def insert_select(*) {:id=>1} end
end
o = @c.new(:abc => "--- 1\n", :def => "--- hello\n")
o.deserialized_values.length.must_equal 2
o.save
o.deserialized_values.length.must_equal 2
end
it "should raise an error if calling internal serialization methods with bad columns" do
@c.set_primary_key :id
@c.plugin :serialization
o = @c.load(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
lambda{o.send(:serialize_value, :abc, 1)}.must_raise(Sequel::Error)
lambda{o.send(:deserialize_value, :abc, "--- hello\n")}.must_raise(Sequel::Error)
end
it "should add the accessors to a module included in the class, so they can be easily overridden" do
@c.class_eval do
def abc
"#{super}-blah"
end
end
@c.plugin :serialization, :yaml, :abc
o = @c.load(:abc => "--- 1\n")
o.abc.must_equal "1-blah"
end
it "should call super to get the deserialized value from a previous accessor" do
m = Module.new do
def abc
"--- #{@values[:abc]*3}\n"
end
end
@c.send(:include, m)
@c.plugin :serialization, :yaml, :abc
o = @c.load(:abc => 3)
o.abc.must_equal 9
end
it "should work correctly with frozen instances" do
@c.set_primary_key :id
@c.plugin :serialization, :yaml, :abc, :def
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
o = @c.first
o.freeze
o.abc.must_equal 1
o.abc.must_equal 1
o.def.must_equal "hello"
o.def.must_equal "hello"
proc{o.abc = 2}.must_raise
proc{o.def = 'h'}.must_raise
end
it "should have dup duplicate internal structures" do
@c.plugin :serialization, :yaml, :abc, :def
o = @c.new
o.dup.deserialized_values.must_equal o.deserialized_values
o.dup.deserialized_values.wont_be_same_as(o.deserialized_values)
end
it "should have changed_columns include serialized columns if those columns have changed" do
@c.plugin :serialization, :yaml, :abc, :def
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
o = @c.first
o.changed_columns.must_equal []
o.abc = 1
o.changed_columns.must_equal []
o.abc = 1
o.changed_columns.must_equal []
o.abc = 2
o.changed_columns.must_equal [:abc]
o.def = 'hello'
o.changed_columns.must_equal [:abc]
o.def = 'hello'
o.changed_columns.must_equal [:abc]
o.def = 'hello2'
o.changed_columns.must_equal [:abc, :def]
end
it "should update column_changes if the dirty plugin is used" do
@c.plugin :serialization, :yaml, :abc, :def
@c.plugin :dirty
@c.dataset = @c.dataset.with_fetch(:id => 1, :abc => "--- 1\n", :def => "--- hello\n")
o = @c.first
o.column_changes.must_equal({})
o.abc = 1
o.column_changes.must_equal({})
o.abc = 1
o.column_changes.must_equal({})
o.abc = 2
o.column_changes.must_equal(:abc=>[1, 2])
o.def = 'hello'
o.column_changes.must_equal(:abc=>[1, 2])
o.def = 'hello'
o.column_changes.must_equal(:abc=>[1, 2])
o.def = 'hello2'
o.column_changes.must_equal(:abc=>[1, 2], :def=>["hello", "hello2"])
end
it "should freeze serialization metadata when freezing model class" do
@c.plugin :serialization, :yaml, :abc, :def
@c.freeze
@c.serialization_map.frozen?.must_equal true
@c.deserialization_map.frozen?.must_equal true
end
it "should handle freezing model class without defining any serializers" do
@c.plugin :serialization
@c.freeze
@c.serialization_map.frozen?.must_equal true
@c.deserialization_map.frozen?.must_equal true
end
it "should raise error when calling serialize_attributes without any columns" do
@c.plugin :serialization
proc{@c.serialize_attributes :yaml}.must_raise Sequel::Error
end
end
|