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
617
618
|
require 'spec_helper'
Hashie::Hash.class_eval do
def self.inherited(klass)
klass.instance_variable_set('@inheritance_test', true)
end
end
class DashTest < Hashie::Dash
property :first_name, required: true
property :email
property :count, default: 0
end
class DashTestDefaultProc < Hashie::Dash
property :fields, default: -> { [] }
end
class DashNoRequiredTest < Hashie::Dash
property :first_name
property :email
property :count, default: 0
end
class DashWithCoercion < Hashie::Dash
include Hashie::Extensions::Coercion
property :person
property :city
coerce_key :person, ::DashNoRequiredTest
end
class PropertyBangTest < Hashie::Dash
property :important!
end
class SubclassedTest < DashTest
property :last_name, required: true
end
class RequiredMessageTest < DashTest
property :first_name, required: true, message: 'must be set.'
end
class DashDefaultTest < Hashie::Dash
property :aliases, default: ['Snake']
end
class DeferredTest < Hashie::Dash
property :created_at, default: proc { Time.now }
end
class DeferredWithSelfTest < Hashie::Dash
property :created_at, default: -> { Time.now }
property :updated_at, default: ->(test) { test.created_at }
end
describe DashTestDefaultProc do
it 'to_json behaves correctly with default proc' do
object = described_class.new
expect(object.to_json).to be == '{"fields":[]}'
end
end
describe DashTest do
def property_required_error(property)
[ArgumentError, "The property '#{property}' is required for #{subject.class.name}."]
end
def property_required_custom_error(property)
[ArgumentError, "The property '#{property}' must be set."]
end
def property_message_without_required_error
[ArgumentError, 'The :message option should be used with :required option.']
end
def no_property_error(property)
[NoMethodError, "The property '#{property}' is not defined for #{subject.class.name}."]
end
subject { DashTest.new(first_name: 'Bob', email: 'bob@example.com') }
let(:required_message) { RequiredMessageTest.new(first_name: 'Bob') }
it('subclasses Hashie::Hash') { should respond_to(:to_mash) }
describe '#to_s' do
subject { super().to_s }
it { should eq '#<DashTest count=0 email="bob@example.com" first_name="Bob">' }
end
it 'lists all set properties in inspect' do
subject.first_name = 'Bob'
subject.email = 'bob@example.com'
expect(subject.inspect).to eq '#<DashTest count=0 email="bob@example.com" first_name="Bob">'
end
describe '#count' do
subject { super().count }
it { should be_zero }
end
it { should respond_to(:first_name) }
it { should respond_to(:first_name=) }
it { should_not respond_to(:nonexistent) }
it 'errors out for a non-existent property' do
expect { subject['nonexistent'] }.to raise_error(*no_property_error('nonexistent'))
end
it 'errors out when attempting to set a required property to nil' do
expect { subject.first_name = nil }.to raise_error(*property_required_error('first_name'))
end
it 'errors out when message added to not required property' do
expect do
class DashMessageOptionWithoutRequiredTest < Hashie::Dash
property :first_name, message: 'is required.'
end
end.to raise_error(*property_message_without_required_error)
expect do
class DashMessageOptionWithoutRequiredTest < Hashie::Dash
property :first_name, required: false, message: 'is required.'
end
end.to raise_error(*property_message_without_required_error)
end
context 'writing to properties' do
it 'fails writing a required property to nil' do
expect { subject.first_name = nil }.to raise_error(*property_required_error('first_name'))
expect { required_message.first_name = nil }
.to raise_error(*property_required_custom_error('first_name'))
end
it 'fails writing a required property to nil using []=' do
expect { subject[:first_name] = nil }.to raise_error(*property_required_error('first_name'))
expect { required_message[:first_name] = nil }
.to raise_error(*property_required_custom_error('first_name'))
end
it 'fails writing to a non-existent property using []=' do
expect { subject['nonexistent'] = 123 }.to raise_error(*no_property_error('nonexistent'))
end
it 'works for an existing property using []=' do
subject[:first_name] = 'Bob'
expect(subject[:first_name]).to eq 'Bob'
expect { subject['first_name'] }.to raise_error(*no_property_error('first_name'))
end
it 'works for an existing property using a method call' do
subject.first_name = 'Franklin'
expect(subject.first_name).to eq 'Franklin'
end
end
context 'reading from properties' do
it 'fails reading from a non-existent property using []' do
expect { subject['nonexistent'] }.to raise_error(*no_property_error('nonexistent'))
end
it 'is able to retrieve properties through blocks' do
subject[:first_name] = 'Aiden'
value = nil
subject.[](:first_name) { |v| value = v }
expect(value).to eq 'Aiden'
end
it 'is able to retrieve properties through blocks with method calls' do
subject[:first_name] = 'Frodo'
value = nil
subject.first_name { |v| value = v }
expect(value).to eq 'Frodo'
end
end
context 'reading from deferred properties' do
it 'evaluates proc after initial read' do
expect(DeferredTest.new[:created_at]).to be_instance_of(Time)
end
it 'does not evalute proc after subsequent reads' do
deferred = DeferredTest.new
expect(deferred[:created_at].object_id).to eq deferred[:created_at].object_id
end
end
context 'reading from a deferred property based on context' do
it 'provides the current hash as context for evaluation' do
deferred = DeferredWithSelfTest.new
expect(deferred[:created_at].object_id).to eq deferred[:created_at].object_id
expect(deferred[:updated_at].object_id).to eq deferred[:created_at].object_id
end
end
context 'converting from a Mash' do
class ConvertingFromMash < Hashie::Dash
property :property, required: true
end
context 'without keeping the original keys' do
let(:mash) { Hashie::Mash.new(property: 'test') }
it 'does not pick up the property from the stringified key' do
expect { ConvertingFromMash.new(mash) }.to raise_error(NoMethodError)
end
end
context 'when keeping the original keys' do
class KeepingMash < Hashie::Mash
include Hashie::Extensions::Mash::KeepOriginalKeys
end
let(:mash) { KeepingMash.new(property: 'test') }
it 'picks up the property from the original key' do
expect { ConvertingFromMash.new(mash) }.not_to raise_error
end
end
end
describe '#new' do
it 'fails with non-existent properties' do
expect { described_class.new(bork: '') }.to raise_error(*no_property_error('bork'))
end
it 'sets properties that it is able to' do
obj = described_class.new first_name: 'Michael'
expect(obj.first_name).to eq 'Michael'
end
it 'accepts nil' do
expect { DashNoRequiredTest.new(nil) }.not_to raise_error
end
it 'accepts block to define a global default' do
obj = described_class.new { |_, key| key.to_s.upcase }
expect(obj.first_name).to eq 'FIRST_NAME'
expect(obj.count).to be_zero
end
it 'fails when required values are missing' do
expect { DashTest.new }.to raise_error(*property_required_error('first_name'))
end
it 'does not overwrite default values' do
obj1 = DashDefaultTest.new
obj1.aliases << 'El Rey'
obj2 = DashDefaultTest.new
expect(obj2.aliases).not_to include 'El Rey'
end
end
describe '#merge' do
it 'creates a new instance of the Dash' do
new_dash = subject.merge(first_name: 'Robert')
expect(subject.object_id).not_to eq new_dash.object_id
end
it 'merges the given hash' do
new_dash = subject.merge(first_name: 'Robert', email: 'robert@example.com')
expect(new_dash.first_name).to eq 'Robert'
expect(new_dash.email).to eq 'robert@example.com'
end
it 'fails with non-existent properties' do
expect { subject.merge(middle_name: 'James') }
.to raise_error(*no_property_error('middle_name'))
end
it 'errors out when attempting to set a required property to nil' do
expect { subject.merge(first_name: nil) }
.to raise_error(*property_required_error('first_name'))
end
context 'given a block' do
it "sets merged key's values to the block's return value" do
expect(subject.merge(first_name: 'Jim') do |key, oldval, newval|
"#{key}: #{newval} #{oldval}"
end.first_name).to eq 'first_name: Jim Bob'
end
end
end
describe '#merge!' do
it 'modifies the existing instance of the Dash' do
original_dash = subject.merge!(first_name: 'Robert')
expect(subject.object_id).to eq original_dash.object_id
end
it 'merges the given hash' do
subject.merge!(first_name: 'Robert', email: 'robert@example.com')
expect(subject.first_name).to eq 'Robert'
expect(subject.email).to eq 'robert@example.com'
end
it 'fails with non-existent properties' do
expect { subject.merge!(middle_name: 'James') }.to raise_error(NoMethodError)
end
it 'errors out when attempting to set a required property to nil' do
expect { subject.merge!(first_name: nil) }.to raise_error(ArgumentError)
end
context 'given a block' do
it "sets merged key's values to the block's return value" do
expect(subject.merge!(first_name: 'Jim') do |key, oldval, newval|
"#{key}: #{newval} #{oldval}"
end.first_name).to eq 'first_name: Jim Bob'
end
end
end
describe 'properties' do
it 'lists defined properties' do
expect(described_class.properties).to eq Set.new(%i[first_name email count])
end
it 'checks if a property exists' do
expect(described_class.property?(:first_name)).to be_truthy
expect(described_class.property?('first_name')).to be_falsy
end
it 'checks if a property is required' do
expect(described_class.required?(:first_name)).to be_truthy
expect(described_class.required?('first_name')).to be_falsy
end
it 'doesnt include property from subclass' do
expect(described_class.property?(:last_name)).to be_falsy
end
it 'lists declared defaults' do
expect(described_class.defaults).to eq(count: 0)
end
it 'allows properties that end in bang' do
expect(PropertyBangTest.property?(:important!)).to be_truthy
end
end
describe '#replace' do
before { subject.replace(first_name: 'Cain') }
it 'return self' do
expect(subject.replace(email: 'bar').object_id).to eq subject.object_id
end
it 'sets all specified keys to their corresponding values' do
expect(subject.first_name).to eq 'Cain'
end
it 'leaves only specified keys and keys with default values' do
expect(subject.keys.sort_by(&:to_s)).to eq %i[count first_name]
expect(subject.email).to be_nil
expect(subject.count).to eq 0
end
context 'when replacing keys with default values' do
before { subject.replace(count: 3) }
it 'sets all specified keys to their corresponding values' do
expect(subject.count).to eq 3
end
end
end
describe '#update_attributes!(params)' do
let(:params) { { first_name: 'Alice', email: 'alice@example.com' } }
context 'when there is coercion' do
let(:params_before) do
{ city: 'nyc', person: { first_name: 'Bob', email: 'bob@example.com' } }
end
let(:params_after) do
{ city: 'sfo', person: { first_name: 'Alice', email: 'alice@example.com' } }
end
subject { DashWithCoercion.new(params_before) }
it 'update the attributes' do
expect(subject.person.first_name).to eq params_before[:person][:first_name]
subject.update_attributes!(params_after)
expect(subject.person.first_name).to eq params_after[:person][:first_name]
end
end
it 'update the attributes' do
subject.update_attributes!(params)
expect(subject.first_name).to eq params[:first_name]
expect(subject.email).to eq params[:email]
expect(subject.count).to eq subject.class.defaults[:count]
end
context 'when required property is update to nil' do
let(:params) { { first_name: nil, email: 'alice@example.com' } }
it 'raise an ArgumentError' do
expect { subject.update_attributes!(params) }.to raise_error(ArgumentError)
end
end
context 'when a default property is update to nil' do
let(:params) { { count: nil, email: 'alice@example.com' } }
it 'set the property back to the default value' do
subject.update_attributes!(params)
expect(subject.email).to eq params[:email]
expect(subject.count).to eq subject.class.defaults[:count]
end
end
context 'codependent attributes' do
let(:codependent) do
Class.new(Hashie::Dash) do
property :a, required: -> { b.nil? }, message: 'is required if b is not set.'
property :b, required: -> { a.nil? }, message: 'is required if a is not set.'
end
end
it 'does not raise an error when only the first property is set' do
expect { codependent.new(a: 'ant', b: nil) }.not_to raise_error
end
it 'does not raise an error when only the second property is set' do
expect { codependent.new(a: nil, b: 'bat') }.not_to raise_error
end
it 'does not raise an error when both properties are set' do
expect { codependent.new(a: 'ant', b: 'bat') }.not_to raise_error
end
it 'raises an error when neither property is set' do
expect { codependent.new(a: nil, b: nil) }.to raise_error(ArgumentError)
end
end
end
end
describe Hashie::Dash, 'inheritance' do
before do
@top = Class.new(Hashie::Dash)
@middle = Class.new(@top)
@bottom = Class.new(@middle)
end
it 'reports empty properties when nothing defined' do
expect(@top.properties).to be_empty
expect(@top.defaults).to be_empty
end
it 'inherits properties downwards' do
@top.property :echo
expect(@middle.properties).to include(:echo)
expect(@bottom.properties).to include(:echo)
end
it 'doesnt inherit properties upwards' do
@middle.property :echo
expect(@top.properties).not_to include(:echo)
expect(@bottom.properties).to include(:echo)
end
it 'allows overriding a default on an existing property' do
@top.property :echo
@middle.property :echo, default: 123
expect(@bottom.properties.to_a).to eq [:echo]
expect(@bottom.new.echo).to eq 123
end
it 'allows clearing an existing default' do
@top.property :echo
@middle.property :echo, default: 123
@bottom.property :echo
expect(@bottom.properties.to_a).to eq [:echo]
expect(@bottom.new.echo).to be_nil
end
it 'allows nil defaults' do
@bottom.property :echo, default: nil
expect(@bottom.new).to have_key(:echo)
expect(@bottom.new).to_not have_key('echo')
end
end
describe SubclassedTest do
subject { SubclassedTest.new(first_name: 'Bob', last_name: 'McNob', email: 'bob@example.com') }
describe '#count' do
subject { super().count }
it { should be_zero }
end
it { should respond_to(:first_name) }
it { should respond_to(:first_name=) }
it { should respond_to(:last_name) }
it { should respond_to(:last_name=) }
it 'has one additional property' do
expect(described_class.property?(:last_name)).to be_truthy
end
it "didn't override superclass inheritance logic" do
expect(described_class.instance_variable_get('@inheritance_test')).to be_truthy
end
end
class ConditionallyRequiredTest < Hashie::Dash
property :username
property :password, required: -> { !username.nil? }, message: 'must be set, too.'
end
describe ConditionallyRequiredTest do
it 'does not allow a conditionally required property to be set to nil if required' do
expect { ConditionallyRequiredTest.new(username: 'bob.smith', password: nil) }
.to raise_error(ArgumentError, "The property 'password' must be set, too.")
end
it 'allows a conditionally required property to be set to nil if not required' do
expect { ConditionallyRequiredTest.new(username: nil, password: nil) }.not_to raise_error
end
it 'allows a conditionally required property to be set if required' do
expect { ConditionallyRequiredTest.new(username: 'bob.smith', password: '$ecure!') }
.not_to raise_error
end
end
class MixedPropertiesTest < Hashie::Dash
property :symbol
property 'string'
end
describe MixedPropertiesTest do
subject { MixedPropertiesTest.new('string' => 'string', symbol: 'symbol') }
it { should respond_to('string') }
it { should respond_to(:symbol) }
it 'property?' do
expect(described_class.property?('string')).to be_truthy
expect(described_class.property?(:symbol)).to be_truthy
end
it 'fetch' do
expect(subject['string']).to eq('string')
expect { subject[:string] }.to raise_error(NoMethodError)
expect(subject[:symbol]).to eq('symbol')
expect { subject['symbol'] }.to raise_error(NoMethodError)
end
it 'double define' do
klass = Class.new(MixedPropertiesTest) do
property 'symbol'
end
instance = klass.new(symbol: 'one', 'symbol' => 'two')
expect(instance[:symbol]).to eq('one')
expect(instance['symbol']).to eq('two')
end
it 'assign' do
subject['string'] = 'updated'
expect(subject['string']).to eq('updated')
expect { subject[:string] = 'updated' }.to raise_error(NoMethodError)
subject[:symbol] = 'updated'
expect(subject[:symbol]).to eq('updated')
expect { subject['symbol'] = 'updated' }.to raise_error(NoMethodError)
end
end
context 'Dynamic Dash Class' do
it 'define property' do
klass = Class.new(Hashie::Dash)
my_property = 'my_property'
my_orig = my_property.dup
klass.property(my_property)
expect(my_property).to eq(my_orig)
end
end
context 'with method access' do
class DashWithMethodAccess < Hashie::Dash
include Hashie::Extensions::IndifferentAccess
include Hashie::Extensions::MethodQuery
property :test
end
subject(:dash) { DashWithMethodAccess.new(test: 'value') }
describe '#test' do
subject { dash.test }
it { is_expected.to eq('value') }
end
describe '#test?' do
subject { dash.test? }
it { is_expected.to eq true }
end
end
RSpec.describe Hashie::Dash do
let(:test) do
Class.new(Hashie::Dash) do
property :description, default: ''
end
end
include_examples 'Dash default handling', :description
end
|