Self или @ для атрибута класса?

Question

[MisterMK]

Доброго времени суток!
По текущему вопросы было прочитано куча статей и был перерыт весь гугл вкупе с Ruby Way, но конкретно я так и не понял - что к чему.
Вопрос в следующем:
Насколько будет правильным или же неправильным использование self в методе initialize для атрибутов класса?
И будет ли нарушением, если, скажем, мы будем ставить "@" перед атрибутами, а не self?
Судя по всему изученному и прочитанному, я делаю вывод, что ставить нужно self, ибо мы вызываем метод, а не обращаемся к самой переменной. Соответственно, "@" нужно ставить при обращении к переменной как к get'теру, а не как к set'теру.
Прошу рассудить.
Заранее, благодарю!

class Log_parse
  attr_accessor :dir, :input_filename, :output_filename, :result_filename,
                  :src_ip_final_table, :dst_ip_final_table, 
                  :proto_final_table, :service_port_final_table

  def initialize
    self.dir = ""                
    self.output_filename = []
    self.input_filename = 
    [
      '01_02_2019.txt', '05_02_2019.txt', 
      '07_02_2019.txt', '09_02_2019.txt', 
      '11_02_2019.txt', '13_02_2019.txt',
      '15_02_2019.txt', '18_02_2019.txt', 
      '20_02_2019.txt', '21_02_2019.txt', 
      '24_02_2019.txt', '26_02_2019.txt',
      '28_02_2019.txt'
    ]
    @input_filename.each_with_index do |filename, iterator|
      self.output_filename[iterator] = @dir + 'output_' + filename
    end

    self.src_ip_final_table = []
    self.dst_ip_final_table = []
    self.proto_final_table = []
    self.service_port_final_table = []
  end
# ...
end

Answer 1

[oh_shi]

Это одно и тоже. self.dir = вызывает dir=, который вы создали, когда указали attr_accessor :dir, выглядит это как-то так:

def dir=(str)
  @dir = str
end

Потому логично использовать напрямую @, еще и на 4 символа короче=)
Плюс @ что его можно использовать и без attr_accessor. Но если нужны геттер и сеттер, то лучше использовать attr_accessor, чем писать их самому, потому что ваш код будет на руби, а attr_accessor написан на С.

Comments

[MisterMK]

Спасибо за фидбэк!
А если, скажем, будет другой метод в этом классе, в котором будет определена переменная dir, которая, в свою очередь, будет являться уже локальной, если не приписывать ей "@" или self.?

class Log_parse
  def initialize
    # ...
  end

  def some_method
    dir = "some_str"
  end
# ...
end

В данном случае, у нас :dir будет иметь то значение, какое мы указали в initialize.
Также, насколько я понимаю, мы можем создать переменную экземпляра класса достаточно просто:

class Some_class
  def some_method
    @some_instance_var = ""
  end
end

Но только в данном случае, конечно же, доступ к этой переменной можно будет получить, насколько мне известно, только при помощи методов instance_variable_get/set.
Прошу поправить, если где-то просчитался))

[oh_shi]

MisterMK, В принципе да, но только не рекомендую называть локальные переменные такими же именами. Вот пример, когда self не нужен. И если где-то будет еще локальная переменная dir, то могут возникнуть проблемы.

class LogParse
  attr_accessor :dir

  def initialize
    @dir = 'test'
  end

  def some_method
    puts dir
  end
end

LogParse.new.some_method

=> test

[MisterMK]

oh_shi, с этим ясно, спасибо!
А по best practice каким образом лучше описывать атрибуты класса? Просто при помощи "@", даже если нет локальных переменных с тем же именем?

[oh_shi]

MisterMK, Да, лучше испрользовать @.

[MisterMK]

oh_shi, понял, спасибо за пояснение!

Answer 2

[Запорожченко Олег]

Ваш простой вопрос не так прост, как кажется.

Недостаток инстанс переменных в том, что по умолчанию они имеют значение nil и поэтому возможно пропустить опечатку. К этому многие приходят, потому что рано или поздно пишут код, в котором для инстанс переменной допустимо значение nil, а оно там всегда nil из-за опечатки. Инстанс переменные хороши для мемоизации, но их использование лучше сократить до минимума.

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

Т.е. в следующем коде

class Log_parse
  attr_accessor :dir

  def initialize
    self.dir = "" 
  end
end

руби не поймет, что вы из одного и того же класса вызываете сеттер. self считается объектом, а вызов через точку - вызовом публичного метода. Идеальный вариантом был бы случай, когда вы отдельно определяете отдельно публичные аксессоры, отдельно приватные и пользуетесь только аксессорами, но в руби так сделать нельзя (без костылей по крайней мере).

В итоге совет следующий:
В остальных методах класса использовать только аксессоры - публичные или приватные.
В конструкторе уже возможны варианты. Если вы считаете, что объявление публичных аксессоров никак не навредит классу, лучше использовать аксессоры. Иначе - инстанс переменные.

Comments

[MisterMK]

Спасибо за фидбэк!
Насколько я понял, Вы имеете в виду использование инстанс переменных более предпочтительным, нежели аксессоров из-за невозможности напрямую обратиться к геттеру?
Если это так, то ограничить доступ к инстанс переменным через инстанс класса можно при помощи метода private, иначе доступ можно получить при помощи методов instance_variable_get/set?

[Запорожченко Олег]

Только что проверил, мои знания о руби немного устарели.

Следующий код работает, так что лучше всегда использовать только аксессоры

class LogParse

  def initialize
    self.dir = "aa" 
  end
  
  private 
  
  attr_accessor :dir
end