-
Notifications
You must be signed in to change notification settings - Fork 877
/
widget_spec.rb
309 lines (251 loc) · 10.1 KB
/
widget_spec.rb
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
require 'rails_helper'
describe Widget, :type => :model do
describe '`be_versioned` matcher' do
it { is_expected.to be_versioned }
end
let(:widget) { Widget.create! :name => 'Bob', :an_integer => 1 }
describe '`have_a_version_with` matcher', :versioning => true do
before do
widget.update_attributes!(:name => 'Leonard', :an_integer => 1 )
widget.update_attributes!(:name => 'Tom')
widget.update_attributes!(:name => 'Bob')
end
it "is possible to do assertions on versions" do
expect(widget).to have_a_version_with :name => 'Leonard', :an_integer => 1
expect(widget).to have_a_version_with :an_integer => 1
expect(widget).to have_a_version_with :name => 'Tom'
end
end
describe "`versioning` option" do
context :enabled, :versioning => true do
it 'should enable versioning for models wrapped within a block' do
expect(widget.versions.size).to eq(1)
end
end
context '`disabled` (default)' do
it 'should not enable versioning for models wrapped within a block not marked to used versioning' do
expect(widget.versions.size).to eq(0)
end
end
end
describe "Callbacks", :versioning => true do
describe :before_save do
context ':on => :update' do
before { widget.update_attributes!(:name => 'Foobar') }
subject { widget.versions.last.reify }
it "should reset the value for the timestamp attrs for update so that value gets updated properly" do
# Travel 1 second because MySQL lacks sub-second resolution
Timecop.travel(1) do
expect { subject.save! }.to change(subject, :updated_at)
end
end
end
end
describe :after_create do
let(:widget) { Widget.create!(:name => 'Foobar', :created_at => Time.now - 1.week) }
it "corresponding version should use the widget's `updated_at`" do
expect(widget.versions.last.created_at.to_i).to eq(widget.updated_at.to_i)
end
end
describe :after_update do
before { widget.update_attributes!(:name => 'Foobar', :updated_at => Time.now + 1.week) }
subject { widget.versions.last.reify }
it { expect(subject).not_to be_live }
it "should clear the `versions_association_name` virtual attribute" do
subject.save!
expect(subject).to be_live
end
it "corresponding version should use the widget updated_at" do
expect(widget.versions.last.created_at.to_i).to eq(widget.updated_at.to_i)
end
end
describe :after_destroy do
it "should create a version for that event" do
expect { widget.destroy }.to change(widget.versions, :count).by(1)
end
it "should assign the version into the `versions_association_name`" do
expect(widget.version).to be_nil
widget.destroy
expect(widget.version).not_to be_nil
expect(widget.version).to eq(widget.versions.last)
end
end
describe :after_rollback do
let(:rolled_back_name) { 'Big Moo' }
before do
begin
widget.transaction do
widget.update_attributes!(:name => rolled_back_name)
widget.update_attributes!(:name => Widget::EXCLUDED_NAME)
end
rescue ActiveRecord::RecordInvalid
widget.reload
widget.name = nil
widget.save
end
end
it 'does not create an event for changes that did not happen' do
widget.versions.map(&:changeset).each do |changeset|
expect(changeset.fetch('name', [])).to_not include(rolled_back_name)
end
end
end
end
describe "Association", :versioning => true do
describe "sort order" do
it "should sort by the timestamp order from the `VersionConcern`" do
expect(widget.versions.to_sql).to eq(
widget.versions.reorder(PaperTrail::Version.timestamp_sort_order).to_sql)
end
end
end
describe "Methods" do
describe "Instance", :versioning => true do
describe '#paper_trail_originator' do
it { is_expected.to respond_to(:paper_trail_originator) }
describe "return value" do
let(:orig_name) { FFaker::Name.name }
let(:new_name) { FFaker::Name.name }
before { PaperTrail.whodunnit = orig_name }
context "accessed from live model instance" do
specify { expect(widget).to be_live }
it "should return the originator for the model at a given state" do
expect(widget.paper_trail_originator).to eq(orig_name)
widget.whodunnit(new_name) { |w| w.update_attributes(:name => 'Elizabeth') }
expect(widget.paper_trail_originator).to eq(new_name)
end
end
context "accessed from a reified model instance" do
before do
widget.update_attributes(:name => 'Andy')
PaperTrail.whodunnit = new_name
widget.update_attributes(:name => 'Elizabeth')
end
context "default behavior (no `options[:dup]` option passed in)" do
let(:reified_widget) { widget.versions[1].reify }
it "should return the appropriate originator" do
expect(reified_widget.paper_trail_originator).to eq(orig_name)
end
it "should not create a new model instance" do
expect(reified_widget).not_to be_new_record
end
end
context "creating a new instance (`options[:dup] == true`)" do
let(:reified_widget) { widget.versions[1].reify(:dup => true) }
it "should return the appropriate originator" do
expect(reified_widget.paper_trail_originator).to eq(orig_name)
end
it "should not create a new model instance" do
expect(reified_widget).to be_new_record
end
end
end
end
end
describe "#originator" do
subject { widget }
it { is_expected.to respond_to(:originator) }
it 'should set the invoke `paper_trail_originator`' do
allow(::ActiveSupport::Deprecation).to receive(:warn)
is_expected.to receive(:paper_trail_originator)
subject.originator
end
it 'should display a deprecation warning' do
expect(::ActiveSupport::Deprecation).to receive(:warn).
with(/Use paper_trail_originator instead of originator/)
subject.originator
end
end
describe '#version_at' do
it { is_expected.to respond_to(:version_at) }
context "Timestamp argument is AFTER object has been destroyed" do
before do
widget.update_attribute(:name, 'foobar')
widget.destroy
end
it "should return `nil`" do
expect(widget.version_at(Time.now)).to be_nil
end
end
end
describe '#whodunnit' do
it { is_expected.to respond_to(:whodunnit) }
context "no block given" do
it "should raise an error" do
expect { widget.whodunnit('Ben') }.to raise_error(ArgumentError, 'expected to receive a block')
end
end
context "block given" do
let(:orig_name) { FFaker::Name.name }
let(:new_name) { FFaker::Name.name }
before do
PaperTrail.whodunnit = orig_name
expect(widget.versions.last.whodunnit).to eq(orig_name) # persist `widget`
end
it "should modify value of `PaperTrail.whodunnit` while executing the block" do
widget.whodunnit(new_name) do
expect(PaperTrail.whodunnit).to eq(new_name)
widget.update_attributes(:name => 'Elizabeth')
end
expect(widget.versions.last.whodunnit).to eq(new_name)
end
it "should revert the value of `PaperTrail.whodunnit` to it's previous value after executing the block" do
widget.whodunnit(new_name) { |w| w.update_attributes(:name => 'Elizabeth') }
expect(PaperTrail.whodunnit).to eq(orig_name)
end
context "error within block" do
it "should ensure that the whodunnit value still reverts to it's previous value" do
expect {
widget.whodunnit(new_name) { raise }
}.to raise_error(RuntimeError)
expect(PaperTrail.whodunnit).to eq(orig_name)
end
end
end
end
describe '#touch_with_version' do
it { is_expected.to respond_to(:touch_with_version) }
it "creates a version" do
count = widget.versions.size
# Travel 1 second because MySQL lacks sub-second resolution
Timecop.travel(1) do
widget.touch_with_version
end
expect(widget.versions.size).to eq(count + 1)
end
it "increments the `:updated_at` timestamp" do
time_was = widget.updated_at
# Travel 1 second because MySQL lacks sub-second resolution
Timecop.travel(1) do
widget.touch_with_version
end
expect(widget.updated_at).to be > time_was
end
end
end
describe "Class" do
subject { Widget }
describe "#paper_trail_enabled_for_model?" do
it { is_expected.to respond_to(:paper_trail_enabled_for_model?) }
it { expect(subject.paper_trail_enabled_for_model?).to be true }
end
describe '#paper_trail_off!' do
it { is_expected.to respond_to(:paper_trail_off!) }
it 'should set the `paper_trail_enabled_for_model?` to `false`' do
expect(subject.paper_trail_enabled_for_model?).to be true
subject.paper_trail_off!
expect(subject.paper_trail_enabled_for_model?).to be false
end
end
describe '#paper_trail_on!' do
before { subject.paper_trail_off! }
it { is_expected.to respond_to(:paper_trail_on!) }
it 'should set the `paper_trail_enabled_for_model?` to `true`' do
expect(subject.paper_trail_enabled_for_model?).to be false
subject.paper_trail_on!
expect(subject.paper_trail_enabled_for_model?).to be true
end
end
end
end
end