12. Разни. alias, freeze, taint. RDoc

29 ноември 2011

Днес

Синоними на методи
Замразяване и зацапване на обекти
Инструменти за генериране на документация
Различни дреболии в Ruby, които все още не сме споменавали

Преди това...

По темата с captchas...

Относно пета задача...

Проверена е
Получавате максимум 8 точки, вместо 6
Още не сме приключили с наказателните точки (за лоша идентация, нечетим код и прочее)
Не сме приключили и с бонус-точките :)
Ако имате коментари, смислени възражения или критика, пишете ни

Кодировки на source-файловете ви в Ruby

Пазете файловете си в UTF-8
Указвате това на Ruby-интерпретатора с: # encoding: UTF-8
Горното е коментар в началото на вашия something.rb-файл
Например, вместо това:

# encoding: ISO-8859-1
#използвам и този encoding и в тестовете иначе ми дава грешка

По-добре е така:

# encoding: UTF-8

Синоними на методи в Ruby

Можете да дефинирате синоними на методи в Ruby, посредством:
Ключовата дума alias
Методът Module#alias_method
И двете правят достъпно копие на тялото на даден метод под друго име
Използват се много във вградените в Ruby-методи, например String#size и String#length
Удобни са в някои ситуации, в които super не помага

Синтаксис за синоними на методи

С ключовата дума alias: alias :new_method :old_method
Или: alias new_method old_method (забележете, че това не са символи или низове, a идентификатори)
С метода от стандартната библиотека Module#alias_method:
alias_method :new_method, :old_method
Или: alias_method 'new_method', 'old_method'

Семантика на синоними на методи

Alias-ите не са обикновени синоними, symlink-ове, указатели и прочее
Това, което се случва при "alias"-ване на методи, е приблизително еквивалентно на копиране на тялото на оригиналния метод
Ако модифицирате тялото на оригиналния метод след като сте го "alias"-нали, alias-ът ще запази старото тяло

Синоними на методи

Например:

def to_s
  to_html
end

По-добре да се запише така:

alias_method :to_html, :to_s

Или така:

alias to_html to_s

Разлики между alias и alias_method

На първо място, alias е ключова дума, докато alias_method е обикновен метод от Module
От горното следват и повечето разлики между двете:
При alias може да подавате като аргументи направо идентификатори на методи, например:
alias original_to_s to_s ще направи нов синоним на to_s под името original_to_s
alias_method original_to_s to_s ще интерпретира original_to_s и to_s като имена на променливи
Зад тези имена трябва да стои низ или символ, указващ име на метод
По този начин може да правите синоними на методи динамично, докато с alias това не става

Разлики между alias и alias_method

създаване на синоними по време на изпълнение

class TranslationsController
  LOCALES = [:en, :de, :fr, :es, :ja]

  def completed_translations
    @current_locale = $1 if current_action_name =~ /_(\w{2})$/
  end

  LOCALES.each do |locale|
    alias_method "completed_translations_in_{locale}", completed_translations
  end
end

Забележки относно синоними на методи

Ползвайте super когато можете и избягвайте alias_* когато е възможно
Не забравяйте, че super работи и за методи, които са дошли от include-ване на модули във вашия клас
Някои инструменти, които генерират документация от вашия код, имат проблеми с тази техника
Тъй като alias е ключова дума и подлежи на статичен синтактичен анализ, такива инструменти разпознават тези синоними
За разлика от това, Module#alias_method обикновено не се разпознава в тези случаи, понеже не може да ползвате статичен синтактичен анализ за целта

Достъп до полета на класа

Не забравяйте за attr_reader/attr_accessor
Например:

def inspect
  @text
end

Може и така:

attr_reader :text
alias_method :inspect, :text

Замразяване на обекти в Ruby

Реално превръща mutable-обекти в immutable
Замразяването става с Object#freeze
Можете да проверите дали обект е замразен с Object#frozen?
Веднъж замразен, даден обект не може да бъде размразен
Не можете да променяте вече замразени обекти
Възможно е да доведе до ускоряване на вашия код
Често се ползва, когато присволявате mutable-типове на константи

Замразяване на обекти

module Entities
  ENTITIES = {
    '&' => '&amp;',
    '"' => '&quot;',
    '<' => '&lt;',
    '>' => '&gt;',
  }.freeze

  ENTITY_PATTERN = /#{ENTITIES.keys.join('|')}/.freeze

  def escape(text)
    text.gsub ENTITY_PATTERN, ENTITIES
  end
end

Оцапани обекти в Ruby

Object#taint - маркира даден обект като "зацапан", т.е. потенциално опасен
Object#tainted? ще ви върне true, ако обект е маркиран като замърсен
Ако конструирате нов обект, на база на "зацапан" такъв, новият обект също ще е "зацапан"
Всички данни, влизащи във вашата програма "отвън", се маркират като "зацапани"
Идва от Perl и навремето се е ползвало много активно при писане на CGI-скриптове като някаква форма на защитна мярка

Документация в Ruby

Пишете ли документация? Как? Къде?
Както повечето други езици и платформи, и в Ruby има инструменти за автоматично генериране на документация
RDoc — Ruby documentation
Seattle.rb проект; дефакто стандарт
YARD — инструмент, разширяващ RDoc-стандарта

RDoc

YARD

Други - Rails API документацията

Други - API Dock

RDoc

Анализира статично вашата файлова структура, класове, модули, методи
Извлича коментарите над методи, класове и прочее и ги обработва
Дори да нямате коментари, пак ще генерира смислена и донякъде полезна документация
Във въпросните коментари може да използвате специален синтаксис

Подробно относно RDoc

Официална документация относно позволения маркъп (малко трудна за откриване):
http://docs.seattlerb.org/rdoc/RDoc/Markup.html
Обща документация на RDoc:
http://docs.seattlerb.org/rdoc/index.html

12. Разни. alias, freeze, taint. RDoc

29 ноември 2011

Днес

Преди това...

По темата с captchas...

Относно пета задача...

Кодировки на source-файловете ви в Ruby

Синоними на методи в Ruby

Синтаксис за синоними на методи

Семантика на синоними на методи

Синоними на методи

Разлики между alias и alias_method

Разлики между alias и alias_method

създаване на синоними по време на изпълнение

Забележки относно синоними на методи

Достъп до полета на класа

Замразяване на обекти в Ruby

Замразяване на обекти

Оцапани обекти в Ruby

Документация в Ruby

RDoc

YARD

Други - Rails API документацията

Други - API Dock

RDoc

Подробно относно RDoc

Въпроси