Module: Assert::Assertions

Included in:
Context
Defined in:
lib/assert/assertions.rb

Defined Under Namespace

Classes: CheckException, NoRaisedException, RaisedException

Constant Summary collapse

IGNORED_ASSERTION_HELPERS = 
[
  :assert_throws,     :assert_nothing_thrown,
  :assert_operator,   :refute_operator,
  :assert_in_epsilon, :refute_in_epsilon,
  :assert_in_delta,   :refute_in_delta,
  :assert_send
]

Instance Method Summary collapse

Instance Method Details

#assert_block(desc = nil) ⇒ Object 



14
15
16
 
# File 'lib/assert/assertions.rb', line 14

def assert_block(desc = nil)
  assert(yield, desc){ "Expected block to return a true value." }
end

#assert_changes(ruby_string_to_eval, desc: nil, from: Assert::ActualValue.not_given, to: Assert::ActualValue.not_given, &block) ⇒ Object 



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
 
# File 'lib/assert/assertions.rb', line 201

def assert_changes(
      ruby_string_to_eval,
      desc: nil,
      from: Assert::ActualValue.not_given,
      to: Assert::ActualValue.not_given,
      &block
    )
  desc_msg = desc ? "#{desc}\n" : ""
  from_eval = instance_eval(ruby_string_to_eval)
  if Assert::ActualValue.given?(from)
    assert_equal(
      from,
      from_eval,
      "#{desc_msg}Expected `#{ruby_string_to_eval}` to change from `#{from.inspect}`."
    )
  end

  block.call

  to_eval = instance_eval(ruby_string_to_eval)
  if Assert::ActualValue.given?(to)
    assert_equal(
      to,
      to_eval,
      "#{desc_msg}Expected `#{ruby_string_to_eval}` to change to `#{to.inspect}`."
    )
  end

  if (
    Assert::ActualValue.not_given?(from) &&
    Assert::ActualValue.not_given?(to)
  )
    assert_not_equal(
      from_eval,
      to_eval,
      "#{desc_msg}Expected `#{ruby_string_to_eval}` to change; "\
      "it was `#{from_eval.inspect}` and didn't change."
    )
  end
end

#assert_empty(collection, desc = nil) ⇒ Object 



23
24
25
26
27
 
# File 'lib/assert/assertions.rb', line 23

def assert_empty(collection, desc = nil)
  assert(collection.empty?, desc) do
    "Expected #{Assert::U.show(collection, __assert_config__)} to be empty."
  end
end

#assert_equal(exp, act, desc = nil) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/assert/assertions.rb', line 36

def assert_equal(exp, act, desc = nil)
  assert(act == exp, desc) do
    c = __assert_config__
    exp_show = Assert::U.show_for_diff(exp, c)
    act_show = Assert::U.show_for_diff(act, c)

    if c.use_diff_proc.call(exp_show, act_show)
      "Expected does not equal actual, diff:\n"\
      "#{c.run_diff_proc.call(exp_show, act_show)}"
    else
      "Expected #{Assert::U.show(act, c)} to be equal to #{Assert::U.show(exp, c)}."
    end
  end
end

#assert_false(object, desc = nil) ⇒ Object 



172
173
174
175
176
 
# File 'lib/assert/assertions.rb', line 172

def assert_false(object, desc = nil)
  assert(object == false, desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} to be false."
  end
end

#assert_file_exists(file_path, desc = nil) ⇒ Object 



67
68
69
70
71
 
# File 'lib/assert/assertions.rb', line 67

def assert_file_exists(file_path, desc = nil)
  assert(File.exists?(File.expand_path(file_path)), desc) do
    "Expected #{Assert::U.show(file_path, __assert_config__)} to exist."
  end
end

#assert_includes(object, collection, desc = nil) ⇒ Object Also known as: assert_included 



80
81
82
83
84
85
 
# File 'lib/assert/assertions.rb', line 80

def assert_includes(object, collection, desc = nil)
  assert(collection.include?(object), desc) do
    "Expected #{Assert::U.show(collection, __assert_config__)}"\
    " to include #{Assert::U.show(object, __assert_config__)}."
  end
end

#assert_instance_of(klass, instance, desc = nil) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/assert/assertions.rb', line 98

def assert_instance_of(klass, instance, desc = nil)
  assert(instance.instance_of?(klass), desc) do
    "Expected #{Assert::U.show(instance, __assert_config__)} (#{instance.class})"\
    " to be an instance of #{klass}."
  end
end

#assert_kind_of(klass, instance, desc = nil) ⇒ Object 



113
114
115
116
117
118
 
# File 'lib/assert/assertions.rb', line 113

def assert_kind_of(klass, instance, desc = nil)
  assert(instance.kind_of?(klass), desc) do
    "Expected #{Assert::U.show(instance, __assert_config__)} (#{instance.class})"\
    " to be a kind of #{klass}."
  end
end

#assert_match(exp, act, desc = nil) ⇒ Object 



128
129
130
131
132
133
134
 
# File 'lib/assert/assertions.rb', line 128

def assert_match(exp, act, desc = nil)
  exp_regex = String === exp && String === act ? /#{Regexp.escape(exp)}/ : exp
  assert(act =~ exp_regex, desc) do
    "Expected #{Assert::U.show(act, __assert_config__)}"\
    " to match #{Assert::U.show(exp, __assert_config__)}."
  end
end

#assert_nil(object, desc = nil) ⇒ Object 



146
147
148
149
150
 
# File 'lib/assert/assertions.rb', line 146

def assert_nil(object, desc = nil)
  assert(object.nil?, desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} to be nil."
  end
end

#assert_not_block(desc = nil) ⇒ Object Also known as: refute_block 



18
19
20
 
# File 'lib/assert/assertions.rb', line 18

def assert_not_block(desc = nil)
  assert(!yield, desc){ "Expected block to not return a true value." }
end

#assert_not_changes(ruby_string_to_eval, desc: nil, from: Assert::ActualValue.not_given, &block) ⇒ Object Also known as: refute_changes 



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
 
# File 'lib/assert/assertions.rb', line 242

def assert_not_changes(
      ruby_string_to_eval,
      desc: nil,
      from: Assert::ActualValue.not_given,
      &block
    )
  desc_msg = desc ? "#{desc}\n" : ""
  from_eval = instance_eval(ruby_string_to_eval)
  if Assert::ActualValue.given?(from)
    assert_equal(
      from,
      from_eval,
      "#{desc_msg}Expected `#{ruby_string_to_eval}` to not change from `#{from.inspect}`."
    )
  end

  block.call

  to_eval = instance_eval(ruby_string_to_eval)
  assert_equal(
    from_eval,
    to_eval,
    "#{desc_msg}Expected `#{ruby_string_to_eval}` to not change; "\
    "it was `#{from_eval.inspect}` and changed to `#{to_eval.inspect}`."
  )
end

#assert_not_empty(collection, desc = nil) ⇒ Object Also known as: refute_empty 



29
30
31
32
33
 
# File 'lib/assert/assertions.rb', line 29

def assert_not_empty(collection, desc = nil)
  assert(!collection.empty?, desc) do
    "Expected #{Assert::U.show(collection, __assert_config__)} to not be empty."
  end
end

#assert_not_equal(exp, act, desc = nil) ⇒ Object Also known as: refute_equal 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/assert/assertions.rb', line 51

def assert_not_equal(exp, act, desc = nil)
  assert(act != exp, desc) do
    c = __assert_config__
    exp_show = Assert::U.show_for_diff(exp, c)
    act_show = Assert::U.show_for_diff(act, c)

    if c.use_diff_proc.call(exp_show, act_show)
      "Expected equals actual, diff:\n"\
      "#{c.run_diff_proc.call(exp_show, act_show)}"
    else
      "Expected #{Assert::U.show(act, c)} to not be equal to #{Assert::U.show(exp, c)}."
    end
  end
end

#assert_not_false(object, desc = nil) ⇒ Object Also known as: refute_false 



178
179
180
181
182
 
# File 'lib/assert/assertions.rb', line 178

def assert_not_false(object, desc = nil)
  assert(object != false, desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} to not be false."
  end
end

#assert_not_file_exists(file_path, desc = nil) ⇒ Object Also known as: refute_file_exists 



73
74
75
76
77
 
# File 'lib/assert/assertions.rb', line 73

def assert_not_file_exists(file_path, desc = nil)
  assert(!File.exists?(File.expand_path(file_path)), desc) do
    "Expected #{Assert::U.show(file_path, __assert_config__)} to not exist."
  end
end

#assert_not_includes(object, collection, desc = nil) ⇒ Object Also known as: assert_not_included, refute_includes, refute_included 



88
89
90
91
92
93
 
# File 'lib/assert/assertions.rb', line 88

def assert_not_includes(object, collection, desc = nil)
  assert(!collection.include?(object), desc) do
    "Expected #{Assert::U.show(collection, __assert_config__)}"\
    " to not include #{Assert::U.show(object, __assert_config__)}."
  end
end

#assert_not_instance_of(klass, instance, desc = nil) ⇒ Object Also known as: refute_instance_of 



105
106
107
108
109
110
 
# File 'lib/assert/assertions.rb', line 105

def assert_not_instance_of(klass, instance, desc = nil)
  assert(!instance.instance_of?(klass), desc) do
    "Expected #{Assert::U.show(instance, __assert_config__)} (#{instance.class})"\
    " to not be an instance of #{klass}."
  end
end

#assert_not_kind_of(klass, instance, desc = nil) ⇒ Object Also known as: refute_kind_of 



120
121
122
123
124
125
 
# File 'lib/assert/assertions.rb', line 120

def assert_not_kind_of(klass, instance, desc = nil)
  assert(!instance.kind_of?(klass), desc) do
    "Expected #{Assert::U.show(instance, __assert_config__)} (#{instance.class})"\
    " to not be a kind of #{klass}."
  end
end

#assert_not_match(exp, act, desc = nil) ⇒ Object Also known as: refute_match, assert_no_match 



136
137
138
139
140
141
142
 
# File 'lib/assert/assertions.rb', line 136

def assert_not_match(exp, act, desc = nil)
  exp = String === exp && String === act ? /#{Regexp.escape(exp)}/ : exp
  assert(act !~ exp, desc) do
    "Expected #{Assert::U.show(act, __assert_config__)}"\
    " to not match #{Assert::U.show(exp, __assert_config__)}."
  end
end

#assert_not_nil(object, desc = nil) ⇒ Object Also known as: refute_nil 



152
153
154
155
156
 
# File 'lib/assert/assertions.rb', line 152

def assert_not_nil(object, desc = nil)
  assert(!object.nil?, desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} to not be nil."
  end
end

#assert_not_respond_to(method, object, desc = nil) ⇒ Object Also known as: assert_not_responds_to, refute_respond_to, refute_responds_to 



278
279
280
281
282
283
 
# File 'lib/assert/assertions.rb', line 278

def assert_not_respond_to(method, object, desc = nil)
  assert(!object.respond_to?(method), desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} (#{object.class})"\
    " to not respond to `#{method}`."
  end
end

#assert_not_same(exp, act, desc = nil) ⇒ Object Also known as: refute_same 



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/assert/assertions.rb', line 306

def assert_not_same(exp, act, desc = nil)
  assert(!act.equal?(exp), desc) do
    c = __assert_config__
    exp_show = Assert::U.show_for_diff(exp, c)
    act_show = Assert::U.show_for_diff(act, c)
    exp_id = "#<#{exp.class}:#{"0x0%x" % (exp.object_id << 1)}>"
    act_id = "#<#{act.class}:#{"0x0%x" % (act.object_id << 1)}>"

    if c.use_diff_proc.call(exp_show, act_show)
      "Expected #{act_id} to not be the same as #{exp_id}, diff:\n"\
      "#{c.run_diff_proc.call(exp_show, act_show)}"
    else
      "Expected #{Assert::U.show(act, c)} (#{act_id}) to not be the same as"\
      " #{Assert::U.show(exp, c)} (#{exp_id})."
    end
  end
end

#assert_not_true(object, desc = nil) ⇒ Object Also known as: refute_true 



165
166
167
168
169
 
# File 'lib/assert/assertions.rb', line 165

def assert_not_true(object, desc = nil)
  assert(object != true, desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} to not be true."
  end
end

#assert_nothing_raised(*exceptions, &block) ⇒ Object Also known as: assert_not_raises, assert_not_raise 



193
194
195
196
197
 
# File 'lib/assert/assertions.rb', line 193

def assert_nothing_raised(*exceptions, &block)
  desc = exceptions.last.kind_of?(String) ? exceptions.pop : nil
  err = NoRaisedException.new(exceptions, &block)
  assert(!err.raised?, desc){ err.msg }
end

#assert_raises(*exceptions, &block) ⇒ Object Also known as: assert_raise 



185
186
187
188
189
190
 
# File 'lib/assert/assertions.rb', line 185

def assert_raises(*exceptions, &block)
  desc = exceptions.last.kind_of?(String) ? exceptions.pop : nil
  err = RaisedException.new(exceptions, &block)
  assert(err.raised?, desc){ err.msg }
  err.exception
end

#assert_respond_to(method, object, desc = nil) ⇒ Object Also known as: assert_responds_to 



270
271
272
273
274
275
 
# File 'lib/assert/assertions.rb', line 270

def assert_respond_to(method, object, desc = nil)
  assert(object.respond_to?(method), desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} (#{object.class})"\
    " to respond to `#{method}`."
  end
end

#assert_same(exp, act, desc = nil) ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/assert/assertions.rb', line 288

def assert_same(exp, act, desc = nil)
  assert(act.equal?(exp), desc) do
    c = __assert_config__
    exp_show = Assert::U.show_for_diff(exp, c)
    act_show = Assert::U.show_for_diff(act, c)
    exp_id = "#<#{exp.class}:#{"0x0%x" % (exp.object_id << 1)}>"
    act_id = "#<#{act.class}:#{"0x0%x" % (act.object_id << 1)}>"

    if c.use_diff_proc.call(exp_show, act_show)
      "Expected #{act_id} to be the same as #{exp_id}, diff:\n"\
      "#{c.run_diff_proc.call(exp_show, act_show)}"
    else
      "Expected #{Assert::U.show(act, c)} (#{act_id}) to be the same as"\
      " #{Assert::U.show(exp, c)} (#{exp_id})."
    end
  end
end

#assert_true(object, desc = nil) ⇒ Object 



159
160
161
162
163
 
# File 'lib/assert/assertions.rb', line 159

def assert_true(object, desc = nil)
  assert(object == true, desc) do
    "Expected #{Assert::U.show(object, __assert_config__)} to be true."
  end
end