Comparable 모듈

Comparable 믹스인은 순서 비교가 가능한 객체를 만드는 클래스에서 써요. 이 모듈을 쓰려면 클래스가 <=> 연산자를 정의해야 해요. <=>는 수신자(receiver)를 다른 객체와 비교해, 작으면 0보다 작은 값, 같으면 0, 크면 0보다 큰 값을 돌려줘요. 비교할 수 없는 객체가 오면 nil을 돌려줘야 하고요. Comparable은 이 <=> 하나로 우리가 익숙한 비교 연산자(<, <=, ==, >=, >)와 between? 메서드를 구현해 줘요.

출처: Ruby 4.0 API

본문

클래스는 반드시 <=> 연산자를 정의해야 해요. 이 연산자는 수신자를 다른 객체와 비교해, 수신자가 다른 객체보다 작으면 0보다 작은 값, 같으면 0, 크면 0보다 큰 값을 돌려줘요. 다른 객체가 비교 불가능하면 <=>는 nil을 돌려줘야 해요. Comparable은 <=>를 이용해 상용 비교 연산자(<, <=, ==, >=, >)와 between? 메서드를 구현해요.

class StringSorter
  include Comparable

  attr :str
  def <=>(other)
    str.size <=> other.str.size
  end

  def initialize(str)
    @str = str
  end

  def inspect
    @str
  end
end

s1 = StringSorter.new("Z")
s2 = StringSorter.new("YY")
s3 = StringSorter.new("XXX")
s4 = StringSorter.new("WWWW")
s5 = StringSorter.new("VVVVV")

s1 < s2                       #=> true
s4.between?(s1, s3)           #=> false
s4.between?(s3, s5)           #=> true
[ s3, s2, s5, s4, s1 ].sort   #=> [Z, YY, XXX, WWWW, VVVVV]

모듈이 제공하는 메서드

Comparable 모듈이 제공하는 메서드들은 모두 <=>를 이용해요.

<: self가 주어진 객체보다 작은지.
<=: self가 주어진 객체보다 작거나 같은지.
==: self가 주어진 객체와 같은지.
>: self가 주어진 객체보다 큰지.
>=: self가 주어진 객체보다 크거나 같은지.
between?: self가 두 주어진 객체 사이에 있으면 true.
clamp: 주어진 객체 min, max 또는 범위 (min..max)에 대해:
- (self <=> min) < 0이면 min.
- (self <=> max) > 0이면 max.
- 그 외에는 self.

Public Instance Methods

self < other → true or false

self가 other보다 "작은지"를 돌려줘요. (self <=> other) < 0과 같아요:

'foo' < 'foo'  # => false
'foo' < 'food' # => true

self <= other → true or false

self가 other보다 "작거나 같은지"를 돌려줘요. (self <=> other) <= 0과 같아요:

'foo' <= 'foo'  # => true
'foo' <= 'food' # => true
'food' <= 'foo' # => false

obj == other → true or false

수신자의 <=> 메서드로 두 객체를 비교해서 0이면 true를 돌려줘요. obj와 other가 같은 객체여도 true를 돌려줘요.

obj > other → true or false

수신자의 <=> 메서드로 두 객체를 비교해서 0보다 큰 값이면 true를 돌려줘요.

obj >= other → true or false

수신자의 <=> 메서드로 두 객체를 비교해서 0보다 크거나 같은 값이면 true를 돌려줘요.

between?(min, max) → true or false

obj <=> min이 0보다 작거나, obj <=> max가 0보다 크면 false, 그 외에는 true를 돌려줘요.

3.between?(1, 5)               #=> true
6.between?(1, 5)               #=> false
'cat'.between?('ant', 'dog')   #=> true
'gnu'.between?('ant', 'dog')   #=> false

clamp(min, max) → obj

clamp(range) → obj

(min, max) 형태에서는, obj <=> min이 0보다 작으면 min을, obj <=> max가 0보다 크면 max를, 그 외에는 obj를 돌려줘요.

12.clamp(0, 100)         #=> 12
523.clamp(0, 100)        #=> 100
-3.123.clamp(0, 100)     #=> 0

'd'.clamp('a', 'f')      #=> 'd'
'z'.clamp('a', 'f')      #=> 'f'

min이 nil이면 obj보다 작은 값으로 간주하고, max가 nil이면 obj보다 큰 값으로 간주해요.

-20.clamp(0, nil)           #=> 0
523.clamp(nil, 100)         #=> 100

(range) 형태에서는, obj <=> range.begin이 0보다 작으면 range.begin을, obj <=> range.end가 0보다 크면 range.end를, 그 외에는 obj를 돌려줘요.

12.clamp(0..100)         #=> 12
523.clamp(0..100)        #=> 100
-3.123.clamp(0..100)     #=> 0

'd'.clamp('a'..'f')      #=> 'd'
'z'.clamp('a'..'f')      #=> 'f'

range.begin이 nil이면 obj보다 작은 값으로, range.end가 nil이면 obj보다 큰 값으로 간주해요.

-20.clamp(0..)           #=> 0
523.clamp(..100)         #=> 100

range.end가 배제(excluded)되면서 nil이 아니면 예외가 발생해요.

100.clamp(0...100)       # ArgumentError