модуль Comparable

Миксин Comparable используется классами, объекты которых можно упорядочить. Класс должен определить оператор <=>, который сравнивает получатель с другим объектом, возвращая -1, 0 или +1 в зависимости от того, меньше ли получатель, равен ли он или больше другого объекта. Если другой объект не может быть сравнен, то оператор <=> должен вернуть nil. Comparable использует <=> для реализации обычных операторов сравнения (<, <=, ==, >=, и >) и метод between?.

class SizeMatters
  include Comparable
  attr :str
  def <=>(anOther)
    str.size <=> anOther.str.size
  end
  def initialize(str)
    @str = str
  end
  def inspect
    @str
  end
end

s1 = SizeMatters.new("Z")
s2 = SizeMatters.new("YY")
s3 = SizeMatters.new("XXX")
s4 = SizeMatters.new("WWWW")
s5 = SizeMatters.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]

Открытые методы экземпляра

obj < other → true или false Показать исходный код

static VALUE
cmp_lt(VALUE x, VALUE y)
{
    VALUE c = rb_funcall(x, cmp, 1, y);

    if (rb_cmpint(c, x, y) < 0) return Qtrue;
    return Qfalse;
}

Сравнивает два объекта на основе метода получателя <=>, возвращая true, если он возвращает -1.

obj <= other → true или false Показать исходный код

static VALUE
cmp_le(VALUE x, VALUE y)
{
    VALUE c = rb_funcall(x, cmp, 1, y);

    if (rb_cmpint(c, x, y) <= 0) return Qtrue;
    return Qfalse;
}

Сравнивает два объекта на основе метода получателя <=>, возвращая true, если он возвращает -1 или 0.

obj == other → true или false Показать исходный код

static VALUE
cmp_equal(VALUE x, VALUE y)
{
    VALUE a[2];

    if (x == y) return Qtrue;

    a[0] = x; a[1] = y;
    return rb_rescue(cmp_eq, (VALUE)a, cmp_failed, 0);
}

Сравнивает два объекта на основе метода получателя <=>, возвращая true, если он возвращает 0. Также возвращает true, если obj и other — один и тот же объект.

Даже если obj <=> other вызвал исключение, исключение игнорируется, и возвращается false.

obj > other → true или false Показать исходный код

static VALUE
cmp_gt(VALUE x, VALUE y)
{
    VALUE c = rb_funcall(x, cmp, 1, y);

    if (rb_cmpint(c, x, y) > 0) return Qtrue;
    return Qfalse;
}

Сравнивает два объекта на основе метода получателя <=>, возвращая true, если он возвращает 1.

obj >= other → true или false Показать исходный код

static VALUE
cmp_ge(VALUE x, VALUE y)
{
    VALUE c = rb_funcall(x, cmp, 1, y);

    if (rb_cmpint(c, x, y) >= 0) return Qtrue;
    return Qfalse;
}

Сравнивает два объекта на основе метода получателя <=>, возвращая true, если он возвращает 0 или 1.

between?(min, max) → true или false Показать исходный код

static VALUE
cmp_between(VALUE x, VALUE min, VALUE max)
{
    if (RTEST(cmp_lt(x, min))) return Qfalse;
    if (RTEST(cmp_gt(x, max))) return Qfalse;
    return Qtrue;
}

Возвращает false, если obj <=> min меньше нуля или если объект <=> max больше нуля, true в противном случае.

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

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.