Ruby -API für Quecksilber -DVCs. Powers Mercurial auf beantalkapp.com
Weitere Informationen finden Sie in der Yard -Dokumentation hier:
rubydoc.info/gemes/mercurial-ruby/file/readme.rdoc
GitHub unterstützt keine Yard-spezifische Syntax, sodass diese Readme kaputt aussehen kann.
Edelstein installieren Mercurial - Ruby
Getestet mit Quecksilberversionen 1.9, 1.9.1, 2.1, 2.5.2; Ruby -Versionen 1.8.7, 1.9.3 und 2.0.0.
Es gibt mehrere Einstellungen, die Sie konfigurieren können:
Quecksilber . Konfigurieren Sie do | conf | Conf. HG_BINY_PATH = "/usr/bin/hg" Ende
Weitere Informationen finden Sie unter {Mercurial :: Konfigurationskonfiguration} Klasse.
Alle Aktionen werden über {mercurial :: repository repository} -Objekt ausgeführt. Bevor Sie also anfangen, alles zu tun, müssen Sie eine initialisieren. Entweder durch Erstellen eines neuen Repositorys:
repository = mercurial :: repository . create ( "/path/to/new_repository" ))
oder ein vorhandenes Öffnen:
repository = mercurial :: repository . Öffnen ( "/path/to/vorhanden_repository" )
Fühlen Sie sich nun frei, verschiedene Methoden aufzurufen, um Änderungen, Zweige, Knoten usw. zu erhalten:
repository.commits.by_hash_ids ('291a498f04e9', '63f70b2314ed')
repository.branches.all
repository.hooks.by_name ('Commit')
...Eine vollständige Liste von Entitäten und deren Methoden finden Sie in den Features Abschnitt unten.
{Mercurial :: repository repository}
{Mercurial :: configfile .hgrc} - Hooks und verschiedene Einstellungen
{Mercurial :: Commit Commits}
{Mercurial :: Knotenknoten} - Dateien und Verzeichnisse
{Mercurial :: Zweigzweige}
{Mercurial :: Tags -Tags}
{Mercurial :: diff diffs}
{Mercurial :: schulde beschreiben}
{Mercurial :: Manifest}
{Mercurial :: FileIndex Dateiindex}}
Sie können {Mercurial :: Shell-Shell} -Klasse verwenden, um benutzerdefinierte Shell-Befehle auszuführen, die dem Edelstein noch nicht als erstklassige Bürger hinzugefügt wurden.
Es gibt einen einfachen Caching -Mechanismus in das Edelstein. Wenn Sie Schienen Cachestore-kompatibler Caching-Speicher an den Konfigurationsblock übergeben, kann Mercurial-Ruby die Ausgabe aller von ihm ausgeführten HG-Befehle zwischengespeichert. Wenn Sie dann die gleiche Methode erneut ausführen und dieselbe Befehl ausführt, gibt das Edelstein die Ausgabe vom Cache zurück.
So konfigurieren Sie es:
Quecksilber . Konfigurieren Sie do | conf | Conf. Cache_Store = Rails . Cache Ende
Das Edelstein verwendet eine einzelne Methode des Cachestore namens fetch . Der Cache läuft automatisch ab, wenn sich die MTIME von Repository ändert, und es ist Ihre Aufgabe, es zu aktualisieren.
Sie können eine Auszeit für so ziemlich jeden Befehl angeben, den Sie ausführen. Mach es so:
Repository . sich verpflichtet . All ( : Timeout => 5 )
Copyright © 2013 Ilya Sabanin. Weitere Informationen finden Sie unter Lizenz.txt.