b4um Generator installieren

Der b4um Generator ist eine Sammlung wiederverwendbarer Generatoren für Ruby on Rails. Er nimmt uns wiederkehrende Arbeiten bei der Entwicklung einer Rails-Anwendung ab und kann benötigte Dateien und Grundstrukturen automatisch erstellen.

Installation und erster Start

In dieser Tutorial-Serie lernen wir den b4um Generator Schritt für Schritt kennen. Wir beginnen mit der Installation und einfachen statischen Seiten. Anschließend beschäftigen wir uns unter anderem mit Header und Footer und steigen später in umfangreichere Funktionen ein.

In diesem ersten Teil installieren wir den b4um Generator 0.1.0 und überprüfen anschließend, ob Rails die Generatoren erkannt hat.

Voraussetzungen

Für den b4um Generator 0.1.0 benötigen wir:

eine bestehende Ruby-on-Rails-Anwendung
Ruby ab Version 3.1.0
Bundler zur Verwaltung der Gems unserer Anwendung

Welche Ruby-Version aktuell verwendet wird, können wir im Terminal überprüfen:

ruby -v

Die verwendete Rails-Version erhalten wir mit:

rails -v

Alle folgenden Befehle führen wir im Hauptverzeichnis unserer Rails-Anwendung aus.

Falls wir uns noch nicht dort befinden, wechseln wir zunächst in das Projektverzeichnis:

cd meine_app

Der b4um Generator auf RubyGems

Der b4um Generator wird als Ruby Gem unter dem Namen

b4um_generators

veröffentlicht.

Die in diesem Tutorial verwendete Version ist:

0.1.0

Auf der RubyGems-Seite finden wir neben der aktuellen Version auch die Installationsbefehle und die benötigte Ruby-Version.

Der b4um Generator 0.1.0 steht als b4um_generators auf RubyGems zur Verfügung.

Möglichkeit 1: Das Gem direkt installieren

Ruby Gems können direkt über den Befehl gem install installiert werden.

Für den b4um Generator lautet der Befehl:

gem install b4um_generators

RubyGems lädt daraufhin das Gem herunter und installiert es in der aktuell verwendeten Ruby-Umgebung.

Nach der Installation können wir überprüfen, ob das Gem vorhanden ist:

gem list b4um_generators

Bei erfolgreicher Installation sollte in der Ausgabe unter anderem die Version erscheinen:

b4um_generators (0.1.0)

Möglichkeit 2: Installation über die Gemfile

Wenn wir den b4um Generator in einem konkreten Rails-Projekt verwenden möchten, sollten wir ihn als Abhängigkeit der Anwendung in die Gemfile aufnehmen.

Dazu öffnen wir im Hauptverzeichnis unserer Rails-Anwendung die Datei:

Gemfile

und ergänzen:

gem "b4um_generators"

Möchten wir ausdrücklich die Version verwenden, die in diesem Tutorial eingesetzt wird, können wir die Version auch festlegen:

gem "b4um_generators", "~> 0.1.0"

~> 0.1.0 erlaubt kompatible Aktualisierungen innerhalb dieser Versionsreihe, verhindert aber einen automatischen Wechsel auf eine zukünftige inkompatible Haupt- oder Nebenversionsreihe.

Für den Einstieg können wir einfach verwenden:

gem "b4um_generators"

Anschließend speichern wir die Gemfile.

Über die Gemfile nehmen wir b4um_generators dauerhaft in die Abhängigkeiten unserer Rails-Anwendung auf.

Abhängigkeiten mit Bundler installieren

Nachdem wir die Gemfile geändert haben, führen wir im Hauptverzeichnis unserer Rails-Anwendung aus:

bundle install

Bundler liest die Gemfile, löst die benötigten Abhängigkeiten auf und installiert die erforderlichen Gems.

Gleichzeitig wird die Datei

Gemfile.lock

aktualisiert.

Die Gemfile.lock hält die tatsächlich verwendeten Versionen der Abhängigkeiten fest. Dadurch kann dieselbe Rails-Anwendung später auf einem anderen Entwicklungsrechner oder Server mit den passenden Gem-Versionen eingerichtet werden.

Welche der beiden Installationsmöglichkeiten sollten wir verwenden?

Mit

gem install b4um_generators

installieren wir das Gem grundsätzlich in unserer aktuellen Ruby-Umgebung.

Für die Verwendung innerhalb eines Rails-Projekts ist der Eintrag in der Gemfile jedoch besonders wichtig:

gem "b4um_generators"

mit anschließendem:

bundle install

Dadurch ist dokumentiert, dass unsere Anwendung den b4um Generator benötigt.

Wer das Projekt später beispielsweise über Git auf einen anderen Rechner überträgt, muss nicht mehr wissen, welche Gems irgendwann manuell installiert wurden. Bundler kann die Abhängigkeiten des Projekts anhand von Gemfile und Gemfile.lock wiederherstellen.

Prüfen, ob Rails den b4um Generator erkannt hat

Jetzt überprüfen wir, ob die Installation funktioniert hat.

Dazu lassen wir uns die in unserer Rails-Anwendung verfügbaren Generatoren anzeigen:

bin/rails generate

Rails gibt daraufhin eine Liste der verfügbaren Generatoren aus.

Nach erfolgreicher Installation sollten dort auch die Generatoren von b4um erscheinen.

Nach der Installation stehen die Generatoren von b4um direkt über das Rails-Generator-System zur Verfügung.

Warum verwenden wir bin/rails?

In den Beispielen verwenden wir:

bin/rails generate

und nicht einfach:

rails generate

bin/rails verwendet das Rails-Binstub der aktuellen Anwendung. Der Befehl wird damit im Kontext unseres Projekts und der dort definierten Abhängigkeiten ausgeführt.

Gerade wenn auf einem Entwicklungsrechner mehrere Rails-Anwendungen mit unterschiedlichen Gem-Versionen vorhanden sind, ist das hilfreich.

Die Installation ist abgeschlossen

Damit ist der b4um Generator eingerichtet.

Wir kennen jetzt zwei Möglichkeiten zur Installation.

Direkt über RubyGems:

gem install b4um_generators

oder als Abhängigkeit unserer Rails-Anwendung über die Gemfile:

gem "b4um_generators"

gefolgt von:

bundle install

Mit

bin/rails generate

können wir anschließend überprüfen, ob Rails die zusätzlichen Generatoren erkannt hat.

Damit sind die Vorbereitungen abgeschlossen.

Im nächsten Tutorial verwenden wir den b4um Generator zum ersten Mal praktisch und erstellen eine statische Seite. Dabei schauen wir uns Schritt für Schritt an, welchen Befehl wir benötigen, welche Dateien erzeugt werden und wie wir die neue Seite anschließend im Browser aufrufen und bearbeiten.

Meld dich an und schreibe ein Kommentar