Entsprechende DSL-Syntax

Question

Ich versuche mein eigenes DSL für Dateimanipulation zu programmieren, nur um zu lernen.

Mein Ziel ist es verständlich und einfach zu programmieren.

Hier gibt es 3 Alternativen für einen String in einen database.yml anhängt:

1. append("windows").to("database.yml") 

2. append(string: "windows").to(file: "database.yml") 

3. append_string("windows").to_file("database.yml") 

4. append_string "windows", to_file: "database.yml" 

5. append string: "windows", to_file: "database.yml" 

Im ein wenig in all diesen Alternativen verloren.

Könnte jemand mit Erfahrung in DSL mir eine Anleitung geben und erklären, was das Für und Wider mit jedem ist?

Jeder wird gleich gelesen, aber ich möchte wissen, welche Best Practice für DRY und gute Codierung Standard folgt.

EDIT: Ich denke, es wird gut sein, wenn ich einige optionale Parameter angeben könnte z.

So betrachtet, denke ich, dass ich die Methodenaufrufe verwenden muss. Denn wenn ich Alternativen 4-5 verwende, kann ich bei Angabe von force => true nicht wissen, ob es sich um die Zeichenkette oder die Datei handelt.

Answer 1

Für mich scheint jede Option in Ordnung.

Wenn Sie (oder Benutzer) immer auf "database.yml" schreiben, aber anhängende Inhalte sind unterschiedlich, folgende möglicherweise besser.

on "database.yml" { 
    append "windows" 
    append "ubuntsu" 
    append "Leopard" 

    remove_if "bsd" do |..| 
     ....#if condition satisfied, "bsd" will be removed 
    end 
    .. 
} 

Wenn Sie (oder Benutzer) wollen „Fenster“ immer für verschiedene Datenbankdateien, folgende kann in Ordnung sein anhängen.(Vielleicht seltenen Fall ,,)

append "windows".to { 
    to "database.yml" 
    to "database2.yml" 
    to "database3.xml", :force=>true 
} 

Wie dem auch sei, ich denke, die bessere Wahl, es selbst zu nutzen oder fragen Sie Ihren Benutzernamen und anschließend verfeinern.

Answer 2

Das beste DSL, das ich kenne, kümmert sich normalerweise um den Typ für Sie. Also würde ich den Typ des angehängten Wertes nicht angeben. Dies würde alle Alternativen ausschließen, die das Wort "string" enthalten, und möglicherweise auch alle Alternativen, die das Wort "file" enthalten.

Ich persönlich wie diese hier:

append("windows").to("database.yml") 
append("windows").to("database.yml", :force => true) 

append "windows", :to => "database.yml" 
append "windows", :to => "database.yml", :force => true 

append "windows", :to_file => "database.yml" # if you really want "to_file" 
append "windows", :to_file => "database.yml", :force => true # if you really want "to_file" 

wenn ich Alternativen verwenden 4-5 dann, wenn ich angeben : force => true, kann ich nicht wissen, ob es für die Zeichenfolge ist oder die Datei.

Ich sehe es nicht als ein Problem, die optionalen Parameter zielen in der Regel auf die Aktion. Sie sind weder für die Zeichenfolge noch für die Datei spezifisch. Wenn Sie Folgendes festlegen: force => true, erzwingen Sie das Anhängen.

Answer 3

Ich denke, es hängt alles davon ab, wie Sie Ihr DSL verwenden möchten. Es scheint sinnvoll, dass man mehrere Optionen auf einer einzigen Datei in einem Lauf durchführen möchte, so könnten Sie vielleicht so etwas wie

on 'database.yaml' do 
    append 'windows' 

    line 16 do 
    indent 2.spaces 
    end 

    lines 3,6,7 do 
    delete 
    end 
end 

Bedeutung der Ansicht, dass zuerst definieren Sie einen Bereich (eine Datei, eine Linie, eine Reihe von Zeilen, ein Block usw.) und dann eine Reihe von Operationen, die darauf ausgeführt werden sollen. Aber andererseits sind wir Programmierer, vielleicht möchte "durchschnittlicher Benutzer" etwas, das einer natürlichen Sprache ähnelt, wie Sie begonnen haben.

Answer 4

ich einen Blog-Post auf DSL gestern schreiben, ist es nicht das Dateisystem-spezifische DSL Frage beantworten, aber es sollte Ihnen genügend Informationen bieten eine Entscheidung

Slick code with simple DSLs thanks to Ruby

Answer 5

einige Ideen zu machen:

with file('database.yaml') do |f| 
    f.append file('additions.yaml') 
    f.append 'somekey: true' 
    f.move_to dir('/some/where') 
    cpy = f.copy_to dir('some/where/else') 
    f.delete 
end