Spec-Zone.ru › Ruby 2.7

класс BasicObject

Родитель:

BasicObject является родительским классом для всех классов в Ruby. Это явный пустой класс.

BasicObject может использоваться для создания иерархий объектов, независимых от иерархии объектов Ruby, таких как прокси-объекты, как класс Delegator, или в других случаях, где необходимо избежать загрязнения пространства имён методами и классами Ruby.

Чтобы избежать загрязнения BasicObject для других пользователей, вместо непосредственного изменения BasicObject следует создать соответствующий подкласс BasicObject:

class MyObjectSystem < BasicObject
end

BasicObject не включает Kernel (для методов, таких как puts) и BasicObject находится вне пространства имён стандартной библиотеки, поэтому общие классы не будут найдены без использования полного пути к классу.

Для предоставления полезных частей стандартной библиотеки подклассам BasicObject можно использовать различные стратегии. Подкласс может include Kernel для получения puts, exit, и т.д. Можно создать и включить модуль, похожий на Kernel, или использовать делегирование через method_missing:

class MyObjectSystem < BasicObject
  DELEGATE = [:puts, :p]

  def method_missing(name, *args, &block)
    return super unless DELEGATE.include? name
    ::Kernel.send(name, *args, &block)
  end

  def respond_to_missing?(name, include_private = false)
    DELEGATE.include?(name) or super
  end
end

Доступ к классам и модулям из стандартной библиотеки Ruby можно получить в подклассе BasicObject, ссылаясь на необходимую константу с корня, например, ::File или ::Enumerator. Как и method_missing, можно использовать const_missing для делегирования поиска констант Object:

class MyObjectSystem < BasicObject
  def self.const_missing(name)
    ::Object.const_get(name)
  end
end

Методы публичного класса

new() Показать исходный код
static VALUE
rb_obj_dummy0(VALUE _)
{
    return rb_obj_dummy();
}

Методы публичного экземпляра

!obj → true или false Показать исходный код
MJIT_FUNC_EXPORTED VALUE
rb_obj_not(VALUE obj)
{
    return RTEST(obj) ? Qfalse : Qtrue;
}

Логическое отрицание.

obj != other → true или false Показать исходный код
MJIT_FUNC_EXPORTED VALUE
rb_obj_not_equal(VALUE obj1, VALUE obj2)
{
    VALUE result = rb_funcall(obj1, id_eq, 1, obj2);
    return RTEST(result) ? Qfalse : Qtrue;
}

Возвращает true, если два объекта не равны, иначе false.

obj == other → true или false Показать исходный код
MJIT_FUNC_EXPORTED VALUE
rb_obj_equal(VALUE obj1, VALUE obj2)
{
    if (obj1 == obj2) return Qtrue;
    return Qfalse;
}

Равенство — На уровне Object, #== возвращает true только если obj и other являются одним и тем же объектом. Обычно этот метод переопределяется в дочерних классах, чтобы задать специфическое для класса значение.

В отличие от #==, метод equal? никогда не должен переопределяться подклассами, так как он используется для определения тождества объекта (то есть, a.equal?(b) тогда и только тогда, когда a является тем же объектом, что и b):

obj = "a"
other = obj.dup

obj == other      #=> true
obj.equal? other  #=> false
obj.equal? obj    #=> true

Метод eql? возвращает true если obj и other ссылаются на один и тот же ключ хэша. Это используется в Hash для проверки равенства элементов. Для любой пары объектов, где eql? возвращает true, значения хэша обоих объектов должны быть равны. Поэтому любой подкласс, переопределяющий eql?, должен также соответствующим образом переопределить хэш.

Для объектов класса Object, eql? является синонимом #==. Подклассы обычно продолжают эту традицию, алиасируя eql? на свой переопределённый метод #==, но есть исключения. Numeric типы, например, выполняют преобразование типов через #==, но не через eql?, поэтому:

1 == 1.0     #=> true
1.eql? 1.0   #=> false
__id__ → целое число Показать исходный код
object_id → целое число
VALUE
rb_obj_id(VALUE obj)
{
    /*
     *                32-bit VALUE space
     *          MSB ------------------------ LSB
     *  false   00000000000000000000000000000000
     *  true    00000000000000000000000000000010
     *  nil     00000000000000000000000000000100
     *  undef   00000000000000000000000000000110
     *  symbol  ssssssssssssssssssssssss00001110
     *  object  oooooooooooooooooooooooooooooo00        = 0 (mod sizeof(RVALUE))
     *  fixnum  fffffffffffffffffffffffffffffff1
     *
     *                    object_id space
     *                                       LSB
     *  false   00000000000000000000000000000000
     *  true    00000000000000000000000000000010
     *  nil     00000000000000000000000000000100
     *  undef   00000000000000000000000000000110
     *  symbol   000SSSSSSSSSSSSSSSSSSSSSSSSSSS0        S...S % A = 4 (S...S = s...s * A + 4)
     *  object   oooooooooooooooooooooooooooooo0        o...o % A = 0
     *  fixnum  fffffffffffffffffffffffffffffff1        bignum if required
     *
     *  where A = sizeof(RVALUE)/4
     *
     *  sizeof(RVALUE) is
     *  20 if 32-bit, double is 4-byte aligned
     *  24 if 32-bit, double is 8-byte aligned
     *  40 if 64-bit
     */

    return rb_find_object_id(obj, cached_object_id);
}

Возвращает целое числовой идентификатор для obj.

Одно и то же число будет возвращено при всех вызовах object_id для данного объекта, и любые два активных объекта не будут иметь одинаковый идентификатор.

Примечание: некоторые объекты встроенных классов повторно используются для оптимизации. Это относится к непосредственным значениям и замороженным строковым литералам.

BasicObject реализует +__id__+, Kernel реализует object_id.

Непосредственные значения не передаются по ссылке, а передаются по значению: nil, true, false, Fixnums, Symbols и некоторые Floats.

Object.new.object_id  == Object.new.object_id  # => false
(21 * 2).object_id    == (21 * 2).object_id    # => true
"hello".object_id     == "hello".object_id     # => false
"hi".freeze.object_id == "hi".freeze.object_id # => true
send(символ [, args...]) → obj Показать исходный код
__send__(символ [, args...]) → obj
send(строка [, args...]) → obj
__send__(строка [, args...]) → obj
VALUE
rb_f_send(int argc, VALUE *argv, VALUE recv)
{
    return send_internal_kw(argc, argv, recv, CALL_FCALL);
}

Вызывает метод, идентифицированный символом symbol, передавая ему любые указанные аргументы. Можно использовать __send__, если имя send конфликтует с существующим методом в obj. При идентификации метода строкой, строка преобразуется в символ.

BasicObject реализует +__send__+, Kernel реализует send.

class Klass
  def hello(*args)
    "Hello " + args.join(' ')
  end
end
k = Klass.new
k.send :hello, "gentle", "readers"   #=> "Hello gentle readers"
equal?(other) → true или false Показать исходный код
MJIT_FUNC_EXPORTED VALUE
rb_obj_equal(VALUE obj1, VALUE obj2)
{
    if (obj1 == obj2) return Qtrue;
    return Qfalse;
}

Равенство — На уровне Object, #== возвращает true только если obj и other являются одним и тем же объектом. Обычно этот метод переопределяется в дочерних классах, чтобы задать специфическое для класса значение.

В отличие от #==, метод equal? никогда не должен переопределяться подклассами, так как он используется для определения тождества объекта (то есть, a.equal?(b) тогда и только тогда, когда a является тем же объектом, что и b):

obj = "a"
other = obj.dup

obj == other      #=> true
obj.equal? other  #=> false
obj.equal? obj    #=> true

Метод eql? возвращает true если obj и other ссылаются на один и тот же ключ хэша. Это используется в Hash для проверки равенства элементов. Для любой пары объектов, где eql? возвращает true, значения хэша обоих объектов должны быть равны. Поэтому любой подкласс, переопределяющий eql?, должен также соответствующим образом переопределить хэш.

Для объектов класса Object, eql? является синонимом #==. Подклассы обычно продолжают эту традицию, алиасируя eql? на свой переопределённый метод #==, но есть исключения. Numeric типы, например, выполняют преобразование типов через #==, но не через eql?, поэтому:

1 == 1.0     #=> true
1.eql? 1.0   #=> false
instance_eval(строка [, имя_файла [, номер_строки]] ) → obj Показать исходный код
instance_eval {|obj| блок } → obj
static VALUE
rb_obj_instance_eval_internal(int argc, const VALUE *argv, VALUE self)
{
    VALUE klass = singleton_class_for_eval(self);
    return specific_eval(argc, argv, klass, self, RB_PASS_CALLED_KEYWORDS);
}

Вычисляет строку, содержащую код Ruby, или данный блок, в контексте получателя (obj). Для установки контекста переменная self устанавливается в obj во время выполнения кода, предоставляя коду доступ к переменным экземпляра и приватным методам obj.

Если instance_eval получает блок, obj также передаётся как единственный аргумент блока.

Если instance_eval получает строку, необязательные второй и третий параметры предоставляют имя файла и начальный номер строки, которые используются при сообщении об ошибках компиляции.

class KlassWithSecret
  def initialize
    @secret = 99
  end
  private
  def the_secret
    "Ssssh! The secret is #{@secret}."
  end
end
k = KlassWithSecret.new
k.instance_eval { @secret }          #=> 99
k.instance_eval { the_secret }       #=> "Ssssh! The secret is 99."
k.instance_eval {|obj| obj == self } #=> true
instance_exec(arg...) {|var...| блок } → obj Показать исходный код
static VALUE
rb_obj_instance_exec_internal(int argc, const VALUE *argv, VALUE self)
{
    VALUE klass = singleton_class_for_eval(self);
    return yield_under(klass, self, argc, argv, RB_PASS_CALLED_KEYWORDS);
}

Выполняет заданный блок в контексте получателя (obj). Для установки контекста переменная self устанавливается в obj во время выполнения кода, предоставляя коду доступ к переменным экземпляра. Аргументы передаются как параметры блока.

class KlassWithSecret
  def initialize
    @secret = 99
  end
end
k = KlassWithSecret.new
k.instance_exec(5) {|x| @secret+x }   #=> 104

Приватные методы экземпляра

method_missing(символ [, *args] ) → результат Показать исходный код
static VALUE
rb_method_missing(int argc, const VALUE *argv, VALUE obj)
{
    rb_execution_context_t *ec = GET_EC();
    raise_method_missing(ec, argc, argv, obj, ec->method_missing_reason);
    UNREACHABLE_RETURN(Qnil);
}

Вызывается Ruby, когда obj получает сообщение, которое он не может обработать. символ — символ вызываемого метода, а args — любые переданные ему аргументы. По умолчанию интерпретатор генерирует ошибку при вызове этого метода. Однако возможно переопределить метод, чтобы обеспечить более динамичное поведение. Если принято решение, что определённый метод не должен обрабатываться, то следует вызвать super, чтобы предки могли обработать отсутствующий метод. Пример ниже создаёт класс Roman, который отвечает на методы с именами, состоящими из римских цифр, возвращая соответствующие значения целых чисел.

class Roman
  def roman_to_int(str)
    # ...
  end

  def method_missing(symbol, *args)
    str = symbol.id2name
    begin
      roman_to_int(str)
    rescue
      super(symbol, *args)
    end
  end
end

r = Roman.new
r.iv      #=> 4
r.xxiii   #=> 23
r.mm      #=> 2000
r.foo     #=> NoMethodError
singleton_method_added(символ) Показать исходный код
static VALUE
rb_obj_dummy1(VALUE _x, VALUE _y)
{
    return rb_obj_dummy();
}

Вызывается в качестве обратного вызова всякий раз, когда к получателю добавляется метод экземпляра.

module Chatty
  def Chatty.singleton_method_added(id)
    puts "Adding #{id.id2name}"
  end
  def self.one()     end
  def two()          end
  def Chatty.three() end
end

вывод:

Adding singleton_method_added
Adding one
Adding three
singleton_method_removed(символ) Показать исходный код
static VALUE
rb_obj_dummy1(VALUE _x, VALUE _y)
{
    return rb_obj_dummy();
}

Вызывается в качестве обратного вызова всякий раз, когда метод экземпляра удаляется из получателя.

module Chatty
  def Chatty.singleton_method_removed(id)
    puts "Removing #{id.id2name}"
  end
  def self.one()     end
  def two()          end
  def Chatty.three() end
  class << self
    remove_method :three
    remove_method :one
  end
end

вывод:

Removing three
Removing one
singleton_method_undefined(символ) Показать исходный код
static VALUE
rb_obj_dummy1(VALUE _x, VALUE _y)
{
    return rb_obj_dummy();
}

Вызывается в качестве обратного вызова всякий раз, когда метод экземпляра не определён в получателе.

module Chatty
  def Chatty.singleton_method_undefined(id)
    puts "Undefining #{id.id2name}"
  end
  def Chatty.one()   end
  class << self
     undef_method(:one)
  end
end

вывод:

Undefining one

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API