1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/doc/symbol/casecmp.rdoc
Burdette Lamar b21026cb1a
Enhanced RDoc for Symbol (#5795)
Treats:

    #==
    #inspect
    #name
    #to_s
    #to_sym
    #to_proc
    #succ
    #<=>
    #casecmp
    #casecmp?
    #=~
    #match
    #match?
2022-04-12 17:27:18 -05:00

27 lines
727 B
Text

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.