ruby-mine

Syntax-Sonntag, verspätet. Ich hatte bis eben noch Urlaub. Heute geht es, wie versprochen, um

Fancy Strings

Ja, von sowas träumen Java- und Pascal-Programmierer nachts: Nützliche kleine syntaktische Zuckerwürfel, die einem Ruby-Programmierer das Leben erleichtern. Außerdem würde Obfuscation ohne Fancy Strings nur halbsoviel Spaß machen.

Kostproben:

%q(Es gibt 4 verschiedene Anführungszeichen: "'`´.)
%r{ [A-Z] \\w{5} \\b }x
plugin_paths += %W( #{VENDOR}/html_plugins ) unless XHTML
%Q'Instanzvariablen können #@eingebaut werden,\\
  #@@klassen_variablen\\n und #$globale auch.'
%r\\VERY STRANGE!\\x
%%%%%%%.empty?

Syntax

Grundsätzlich sieht ein Fancy String so aus:

• Ein %-Zeichen dort, wo kein Operator erwartet wird (sonst wird das Zeichen als %-Methode erkannt.)
• Dann eines der Fancy-String-Typzeichen: q, w, s, r, x, Q oder W.
• Lässt man dieses Zeichen aus, wird Q angenommen: %.toll, was?.
• Dann folgt ein fast beliebiger Begrenzer: Alles außer Buchstaben und Zahlen ist erlaubt, sogar Whitespace, also %."!# und sogar \ und \n.
• Ausnahme: Wenn man kein Typzeichen angegeben hat, sind alphanumerische Zeichen nicht erlaubt, also /[A-Z0-9]/.
  Der Grund hierfür ist einfach, dass in Zukunft weitere Typzeichen eingeführt werden könnten.
• Dann folgt beliebiger Inhalt, der alles enthalten kann, auch Zeilenwechsel.
  Das erwartete Schlusszeichen kann mit \ maskiert werden.
• Das Schlusszeichen beendet den String.

Typen

%(...) (wird interpretiert)

%Q*ark daz* (wird interpretiert)

Das entspricht den doppelten Anführungszeichen (Quoted):
%Q(abc\d), %(abc\d) und "abc\d" liefern alle denselben String.

%q.:. (wird nicht interpretiert)

Das ist ein uninterpretierter String in einfachen Anführungszeichen, also genau dasselbe wie ':'.

%r-/\*.*?\*/-m (wird interpretiert)

Das erzeugt dieselbe Regexp wie /\/\*.*?\*\//m, nur kann man sie ein wenig besser lesen. (Oder?)
Modifier werden wie gewohnt angegeben; diese Regexp frisst übrigends C-Kommentare.

%x<ruby -e "p 2 ** `ls *.* | wc -l`"> (wird interpretiert)

Das ist ein Systemstring, der genau wie `rm -rf ~` einfach ausgeführt (eXecuted) wird.

%w]John James Sean\ Paul] (wird nicht interpretiert)

Dieser wohl bekannteste Typ erzeugt String-Arrays. Die Zeichenkette wird an jedem Leerzeichen getrennt; maskierte Leerzeichen werden ignoriert. Das Beispiel erzeugt ["John", "James", "Sean Paul"].
Besonders gerne benutze ich diese String mehrzeilig, als Ersatz für Datenfelder:

PREDEFINED_CONSTANTS = %w[
  nil true false self
  DATA ARGV ARGF __FILE__ __LINE__
]

Oder, in Rails:

inflect.uncountable %w( elvis\\ presley chaos penner )

Man erkennt, warum matz diesen Buchstaben gewählt hat: %w erzeugt Wortlisten.

%W~Wolf#$$ Tiger#{Time.now.sec}~ (wird interpretiert)

Dasselbe, diesmal wird jedes Wort noch einzeln interpretiert. Die Analogie ist klar: Q und W sind die interpretierenden Varianten von q und w.
Das Beispiel erzeugt bei mir ["Wolf3356", "Tiger49"], und bei euch sicher etwas anderes ($$ ist die aktuelle Prozessnummer.)

%s=Also, ich mag keine Tiger...= (wird interpretiert)

Symbole, beliebig lang, mit beliebigen Zeichen. Ja, solche Symbole gibt es.
Als bekanntere Alternative könnte man hier :"diese Variante" benutzen; Allerdings kennt Rdoc die Syntax nicht und gibt Fehler aus (':' not followed by identified or operator). Die uninterpretierte Variante mit einfachen Anführungszeichen mag Rdoc ebensowenig: :'Das ist mir egal!'

Die Tabelle für Technokraten

Typ	erzeugt	interpr.	Besonderheiten
	String	ja	keine alphanumerischen Zeichen als Begrenzer erlaubt
Q	String	ja
q	String	nein
w	String-Array	nein	Leerzeichen müssen maskiert werden
W	String-Array	ja	dito
s	Symbol	ja
x	Ergebnis des Systemaufrufs als String	ja
r	Regexp	ja	Modifier können angehängt werden

Spezielle Begrenzer

Relativ einfach ist zu erkennen, wie Ruby mit Klammern umgeht:

%r[irgendwie logisch]
%q(Klammern (sowas hier: ()) kann man schachteln.)
%s>Achtung! Hier wartet Ruby nicht auf < sondern auf >

Verwirrender ist allerdings, dass Zeilenwechsel als Begrenzer dienen dürfen:

p %q
test

#-> "test"

Und ganz komisch wird es, wenn man Zeichen verwendet, die Ruby normalerweise interpretiert. Hier gibt Ruby dem Begrenzer immer den Vorrang.

%Q#Jetzt kann ich keinen \\#{Inline-Code} mehr benutzen!#
%\\Sieht aus wie eine Regexp im Spiegel.\\

Obfuscation

Als Beispiel für Code, den keiner lesen kann, benutze ich das folgende Ornament:

%%%%%%%

Hierbei handelt es sich um zwei Fancy Strings, die mit dem Operator % verknüpft werden; beide Fancy Strings sind simple Q-Strings, die als Begrenzer verwirrenderweise das Prozentzeichen verwenden. Also: %%% == "", so einfach. Und "" % "" ergibt wieder einen leeren String.

Woher weiß ich, dass Ruby nicht noch mehr Fancy Strings kennt, die murphy mir nicht verraten will?

(0..255).map do |c|
  type = c.chr
  #next unless type[/[a-z]/i]
  type if `ruby -ce 'p %#{type}(ls)'`['Syntax OK']
end.display

Liefert bei mir exakt den String " ')=QWqrswx". Die Erklärung der 4 ersten Zeichen bleibt dem Leser als Übungsaufgabe überlassen.

Viel Spaß mit Ruby!