Jak stworzyć pomocnika w Railsach?

Hej tam! Jestem częścią dostawcy Railsów i chętnie podzielę się z Tobą tym, jak stworzyć pomocnika w Railsach. To sprytne narzędzie, które może sprawić, że rozwój Railsów stanie się o wiele łatwiejszy i wydajniejszy. Zatem zanurzmy się od razu!

Kim są pomocnicy Railsów?

Na początek przyjrzyjmy się, czym są pomocnicy Railsów. Krótko mówiąc, pomocnicy w Railsach umożliwiają współdzielenie kodu w różnych częściach aplikacji. Przypominają małe funkcje narzędziowe, których można używać w widokach, kontrolerach, a nawet innych pomocnikach. Pomyśl o nich jak o swoich zaufanych pomocnikach, którzy pomogą Ci zachować SUCHY kod (nie powtarzaj się).

Załóżmy na przykład, że masz kilka widoków, w których musi być wyświetlana sformatowana data. Zamiast wpisywać kod formatowania daty w każdym widoku, możesz utworzyć metodę pomocniczą, która zrobi to za Ciebie. Następnie możesz po prostu wywołać tę metodę w swoich widokach, ilekroć chcesz wyświetlić sformatowaną datę.

Tworzenie pierwszego pomocnika

OK, więc jak właściwie stworzyć pomocnika w Railsach? To całkiem proste. Railsy mają wbudowany generator, który sprawia, że jest to dziecinnie proste.

Otwórz terminal i przejdź do katalogu aplikacji Rails. Następnie uruchom następujące polecenie:

szyny generują pomocnika MyHelper

To polecenie utworzy nowy plik pomocniczy w formacieaplikacja/pomocnicykatalog o nazwiemój_pomocnik.rb. Otwórz ten plik w swoim ulubionym edytorze tekstu, a zobaczysz coś takiego:

moduł MyHelper # Dodaj metody pomocnicze tutaj

To jest podstawowa struktura pomocnika Railsów. To po prostu moduł Ruby z metodami, które możesz zdefiniować. Dodajmy do naszego pomocnika prostą metodę. Załóżmy, że chcemy utworzyć metodę zwracającą wiadomość powitalną.

module MyHelper def Welcome_message "Witamy w naszej wspaniałej aplikacji Railsowej!" koniec koniec

To wszystko! Stworzyliśmy naszą pierwszą metodę pomocniczą. A teraz, jak go używamy?

Korzystanie z pomocnika w widokach

Używanie metody pomocniczej w widoku jest bardzo łatwe. Załóżmy, że mamy plik widokuapp/views/welcome/index.html.erb. W tym pliku możemy wywołać naszwiadomość_powitaniametoda taka:

<h1><%= wiadomość_powitalna %></h1>

Po wyrenderowaniu tego widoku zostanie wyświetlony komunikat powitalny, który zdefiniowaliśmy w naszej metodzie pomocniczej.

Metody pomocnicze do formatowania

Pomocnicy doskonale nadają się również do formatowania danych. Załóżmy, że pracujemy z niektórymi dostarczanymi przez nas produktami szynowymi, takimi jakSzyna 49E2. Możemy chcieć wyświetlić nazwę produktu w ładny, sformatowany sposób.

Stwórzmy do tego metodę pomocniczą.

moduł ProductHelper def format_nazwa_produktu(nazwa_produktu) nazwa_produktu.upcase.gsub("_", " ") end end

Teraz, naszym zdaniem, tam, gdzie wyświetlamy informacje o produkcie, możemy zastosować tę metodę.

<p><%= format_product_name("49E2_Rail") %></p>

Spowoduje to wyświetlenie nazwy produktu wielkimi literami z podkreśleniami zastąpionymi spacjami.

Praca z wieloma pomocnikami

W aplikacji Railsowej możesz mieć wielu pomocników i możesz ich używać w różnych częściach aplikacji. Na przykład możesz miećPomocnik użytkownikado obsługi formatowania związanego z użytkownikiem i aPomocnik Produktudo wykonywania zadań związanych z produktem.

Jeśli chcesz użyć konkretnego pomocnika w kontrolerze, możesz dołączyć go w ten sposób:

class ProductsController < Pomocnik ApplicationController ProductHelper def indeks # Logika kontrolera tutaj end end

Spowoduje to, że wszystkie metody w plikuPomocnik Produktudostępne w widokach powiązanych z plikiemKontroler produktów.

Metody pomocnicze dla renderowania warunkowego

Pomocnicy są również przydatni do renderowania warunkowego. Załóżmy, że chcemy wyświetlić różne komunikaty w zależności od tego, czy produkt jest w magazynie, czy nie.

moduł StockHelper def stock_message(in_stock) if in_stock "Ten produkt jest w magazynie i jest gotowy do wysyłki!" else „Przepraszamy, ten produkt jest niedostępny.” koniec koniec koniec

Naszym zdaniem możemy użyć tej metody w następujący sposób:

<p><%= stock_message(@product.in_stock) %></p>

Tutaj,@produkt.in_stockto wartość logiczna wskazująca, czy produkt znajduje się w magazynie, czy nie.

Używanie pomocników w formularzach Railsowych

Pomocników można także używać do upraszczania pracy z formularzami Railsowymi. Załóżmy na przykład, że tworzymy formularz, aby dodać nowySzyny do dźwigów kolejowych CR175do naszego inwentarza.

49E2 Rail CR175 Railway Crane Rails

Możemy stworzyć metodę pomocniczą, która wygeneruje etykietę dla pola formularza.

moduł FormHelper def custom_label(formularz, pole) form.label pole, klasa: "custom - label" end end

W naszym widoku formularza możemy użyć tej metody pomocniczej w następujący sposób:

<%= formularz_dla @produktu do |f| %> <%= etykieta_niestandardowa(f, :nazwa) %> <%= f.pole_tekstowe :nazwa %> <!-- Inne pola formularza --> <% end %>

Spowoduje to wygenerowanie etykiety z niestandardową klasą dla naszego pola formularza.

Testowanie swoich pomocników

Ważne jest, aby przetestować metody pomocnicze, aby upewnić się, że działają zgodnie z oczekiwaniami. Railsy domyślnie używają frameworku MiniTest do testowania.

Aby przetestować naszewiadomość_powitaniametoda wMój pomocnik, możemy utworzyć plik testowy w formacietest/pomocnicykatalog o nazwiemy_helper_test.rb.

wymagaj klasy „test_helper” MyHelperTest < ActionView::TestCase test „wiadomość powitalna powinna zwrócić poprawny ciąg znaków” do Assert_equal „Witamy w naszej niesamowitej aplikacji Railsowej!”, Welcome_message end end

Uruchom testy za pomocąpróba szynpolecenie w terminalu, a zobaczysz, czy Twoja metoda pomocnicza pomyślnie przejdzie test.

Wniosek

Tworzenie i używanie pomocników w Railsach to skuteczny sposób na uporządkowanie kodu i umożliwienie jego ponownego użycia. Niezależnie od tego, czy zajmujesz się formatowaniem, renderowaniem warunkowym czy obsługą formularzy, pomocnicy mogą znacznie ułatwić Ci życie.

Jako dostawca Railsów widzieliśmy na własne oczy, jak użycie pomocników może usprawnić proces programowania i uczynić go bardziej wydajnym. Jeśli jesteś zainteresowany zakupem naszych wysokiej jakości szyn, takich jakSzyna 49E2,Szyny do dźwigów kolejowych CR175, LubSzyna ASCE 60LB, chętnie z Tobą porozmawiamy. Skontaktuj się z nami, aby rozpocząć dyskusję dotyczącą zakupów i zobaczyć, jak nasze produkty mogą pasować do Twojego projektu.

Referencje

Przewodniki po Railsach: Oficjalna dokumentacja Railsów jest doskonałym źródłem wiedzy o pomocnikach Rails i innych aspektach rozwoju Railsów.
Zwinne tworzenie stron internetowych za pomocą Railsów: obszerna książka, która szczegółowo opisuje rozwój Railsów.