o Ruby

Ostatnimi czasy cicho w polskiej blogosferze programistów Rubiego. Mój blog też nie jest wyjątkiem. Zdaje się czas jest sporym problemem, bo o czym pisać to jest... No nieważne :). Dzisiaj krótko, ale że kiedyś obiecałem sobie pisać nie tylko długo i treściwie...

monkey-patching wcieleniem zła?

Monkey-patching to technika, w której pozwalamy sobie na wprowadzanie zmiany w cudzym kodzie, na przykład podmianę istniejącej metody, dodanie nowej. W społeczności Rubiego ta technika jest stosunkowo popularna, z kolei Pythonistas jej nie lubią. Tym razem nie będę zagłębiać się w szczegóły i rozstrzygał czy ta technika jest dobra, zła, niebezpieczna (być może kiedyś). Chciałbym pokazać prosty sposób na nieinwazyjne ulepszanie istniejących klas/metod.

W moim kodzie chciałem użyć metody Array#index. Metoda zwraca index w tablicy podanego obiektu lub nil jeśli elementu nie znaleziono.

a = [3, 7, 2, 10]
puts a.index(7) # => 1

Jednak jak się okazało metoda ta nie obsługuje bloków, zatem poniższy kod nie zadziała.

a = [4, 8, 10, 7, 1]
puts a.index {|e| e % 2 == 1 } # szukamy indeksu pierwszej nieparzystej liczby

monkey-patching na ratunek

W prosty sposób możemy tą dziurę załatać. Należy jednak dobrze przemyśleć strategię. Najważniejsze jest to, żeby nie zepsuć aktualnej wersji.

class Array
  alias_method :__old_index__, :index

  def index(obj = nil)
    if obj.nil?
      self.each_with_index do |e, i|
        return i if yield(e)
      end
      return nil
    else
      return __old_index__(obj)
    end
  end
end

a = [4, 8, 10, 7, 1]
puts a.index {|e| e % 2 == 1 } # szukamy indeksu pierwszej nieparzystej liczby

Myślę, że kod jest prosty w zrozumieniu, jednakże dla tych mniej wprawnych programistów Rubiego pozwolę sobie na mały opis. Poprzez alias_method tworzymy alias do metody index, tak by móc do niej się potem odwołać. Następnie nadpisujemy metodę index, zauważ, że parametr jest opcjonalny (obj = nil). Jest to przygotowanie do wersji z blokiem. W ciele metody sprawdzamy czy parametr został podany. Jeśli nie (obj.nil? == true) to wykona się kod obsługujący blok, w przeciwnym wypadku odpalamy starą wersję metody index poprzez jej alias.

W Rubym 1.8.7 (już niedługo oficjalne wydanie) i 1.9 poprawiono wiele metod w tym i Array#index by obsługiwały blok. Można zatem dodać kod sprawdzający obsługę bloku i nie dodawać tej metody w takim wypadku.

class Array
  begin
    [1].index {|e| e == 1}
  rescue ArgumentError
    puts "(monkey-)patching Array#index (RUBY_VERSION = #{RUBY_VERSION})"
    alias_method :__old_index__, :index

    def index(obj = nil)
      if obj.nil?
        self.each_with_index do |e, i|
          return i if yield(e)
        end
        return nil
      else
        return __old_index__(obj)
      end
    end
  end

end

a = [4, 8, 10, 7, 1]
puts a.index {|e| e % 2 == 1 } # szukamy indeksu pierwszej nieparzystej liczby