summaryrefslogtreecommitdiff
path: root/doc/symbol/casecmp.rdoc
blob: 9c286070b7ab04dc935c3ca490ee6fa1a0bb7f01 (plain)
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
Like Symbol#<=>, but case-insensitive;
equivalent to <tt>self.to_s.casecmp(object.to_s)</tt>:

  lower = :abc
  upper = :ABC
  upper.casecmp(lower) # => 0
  lower.casecmp(lower) # => 0
  lower.casecmp(upper) # => 0

Returns nil if +self+ and +object+ have incompatible encodings,
or if +object+ is not a symbol:

  sym = 'äöü'.encode("ISO-8859-1").to_sym
  other_sym = 'ÄÖÜ'
  sym.casecmp(other_sym) # => nil
  :foo.casecmp(2)        # => nil

Unlike Symbol#casecmp?,
case-insensitivity does not work for characters outside of 'A'..'Z' and 'a'..'z':

  lower = :äöü
  upper = :ÄÖÜ
  upper.casecmp(lower) # => -1
  lower.casecmp(lower) # => 0
  lower.casecmp(upper) # => 1

Related: Symbol#casecmp?, String#casecmp.