-
-
Notifications
You must be signed in to change notification settings - Fork 912
/
have_db_column_matcher.rb
286 lines (253 loc) · 8.32 KB
/
have_db_column_matcher.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
module Shoulda
module Matchers
module ActiveRecord
# The `have_db_column` matcher tests that the table that backs your model
# has a specific column.
#
# class CreatePhones < ActiveRecord::Migration
# def change
# create_table :phones do |t|
# t.string :supported_ios_version
# end
# end
# end
#
# # RSpec
# RSpec.describe Phone, type: :model do
# it { should have_db_column(:supported_ios_version) }
# end
#
# # Minitest (Shoulda)
# class PhoneTest < ActiveSupport::TestCase
# should have_db_column(:supported_ios_version)
# end
#
# #### Qualifiers
#
# ##### of_type
#
# Use `of_type` to assert that a column is defined as a certain type.
#
# class CreatePhones < ActiveRecord::Migration
# def change
# create_table :phones do |t|
# t.decimal :camera_aperture
# end
# end
# end
#
# # RSpec
# RSpec.describe Phone, type: :model do
# it do
# should have_db_column(:camera_aperture).of_type(:decimal)
# end
# end
#
# # Minitest (Shoulda)
# class PhoneTest < ActiveSupport::TestCase
# should have_db_column(:camera_aperture).of_type(:decimal)
# end
#
# ##### with_options
#
# Use `with_options` to assert that a column has been defined with
# certain options (`:precision`, `:limit`, `:default`, `:null`, `:scale`,
# or `:primary`).
#
# class CreatePhones < ActiveRecord::Migration
# def change
# create_table :phones do |t|
# t.decimal :camera_aperture, precision: 1, null: false
# end
# end
# end
#
# # RSpec
# RSpec.describe Phone, type: :model do
# it do
# should have_db_column(:camera_aperture).
# with_options(precision: 1, null: false)
# end
# end
#
# # Minitest (Shoulda)
# class PhoneTest < ActiveSupport::TestCase
# should have_db_column(:camera_aperture).
# with_options(precision: 1, null: false)
# end
#
# @return [HaveDbColumnMatcher]
#
def have_db_column(column)
HaveDbColumnMatcher.new(column)
end
# @private
class HaveDbColumnMatcher
def initialize(column)
@column = column
@options = {}
end
def of_type(column_type)
@options[:column_type] = column_type
self
end
def with_options(opts = {})
%w(precision limit default null scale primary).each do |attribute|
if opts.key?(attribute.to_sym)
@options[attribute.to_sym] = opts[attribute.to_sym]
end
end
self
end
def matches?(subject)
@subject = subject
column_exists? &&
correct_column_type? &&
correct_precision? &&
correct_limit? &&
correct_default? &&
correct_null? &&
correct_scale? &&
correct_primary?
end
def failure_message
"Expected #{expectation} (#{@missing})"
end
def failure_message_when_negated
"Did not expect #{expectation}"
end
def description
desc = "have db column named #{@column}"
desc << " of type #{@options[:column_type]}" if @options.key?(:column_type)
desc << " of precision #{@options[:precision]}" if @options.key?(:precision)
desc << " of limit #{@options[:limit]}" if @options.key?(:limit)
desc << " of default #{@options[:default]}" if @options.key?(:default)
desc << " of null #{@options[:null]}" if @options.key?(:null)
desc << " of primary #{@options[:primary]}" if @options.key?(:primary)
desc << " of scale #{@options[:scale]}" if @options.key?(:scale)
desc
end
protected
def column_exists?
if model_class.column_names.include?(@column.to_s)
true
else
@missing = "#{model_class} does not have a db column named #{@column}."
false
end
end
def correct_column_type?
return true unless @options.key?(:column_type)
if matched_column.type.to_s == @options[:column_type].to_s
true
else
@missing = "#{model_class} has a db column named #{@column} " <<
"of type #{matched_column.type}, not #{@options[:column_type]}."
false
end
end
def correct_precision?
return true unless @options.key?(:precision)
if matched_column.precision.to_s == @options[:precision].to_s
true
else
@missing = "#{model_class} has a db column named #{@column} " <<
"of precision #{matched_column.precision}, " <<
"not #{@options[:precision]}."
false
end
end
def correct_limit?
return true unless @options.key?(:limit)
if matched_column.limit.to_s == @options[:limit].to_s
true
else
@missing = "#{model_class} has a db column named #{@column} " <<
"of limit #{matched_column.limit}, " <<
"not #{@options[:limit]}."
false
end
end
def correct_default?
return true unless @options.key?(:default)
if matched_column.type_cast_default.to_s == @options[:default].to_s
true
else
@missing = "#{model_class} has a db column named #{@column} " <<
"of default #{matched_column.type_cast_default}, " <<
"not #{@options[:default]}."
false
end
end
def correct_null?
return true unless @options.key?(:null)
if matched_column.null.to_s == @options[:null].to_s
true
else
@missing = "#{model_class} has a db column named #{@column} " <<
"of null #{matched_column.null}, " <<
"not #{@options[:null]}."
false
end
end
def correct_scale?
return true unless @options.key?(:scale)
if actual_scale.to_s == @options[:scale].to_s
true
else
@missing = "#{model_class} has a db column named #{@column} "
@missing << "of scale #{actual_scale}, not #{@options[:scale]}."
false
end
end
def correct_primary?
return true unless @options.key?(:primary)
if matched_column.primary? == @options[:primary]
true
else
@missing = "#{model_class} has a db column named #{@column} "
if @options[:primary]
@missing << 'that is not primary, but should be'
else
@missing << 'that is primary, but should not be'
end
false
end
end
def matched_column
@_matched_column ||= begin
column = model_class.columns.detect { |each| each.name == @column.to_s }
DecoratedColumn.new(model_class, column)
end
end
def model_class
@subject.class
end
def actual_scale
matched_column.scale
end
def actual_primary?
model_class.primary_key == matched_column.name
end
def expectation
"#{model_class.name} to #{description}"
end
# @private
class DecoratedColumn < SimpleDelegator
def initialize(model, column)
@model = model
super(column)
end
def type_cast_default
model.column_defaults[name]
end
def primary?
model.primary_key == name
end
protected
attr_reader :model
end
end
end
end
end