Ruby

Veröffentlicht von Jens am 02. September 2008

A few years ago, I came across the Ruby programming language, and I fell in love. Somehow, it just seemed to work the way my brain works—I can express myself in Ruby more naturally and with less intervening fluff than in any other language I know. [...] And now, for the first time, I can seriously say that Ruby is ready for the enterprise. The language is stable, the libraries are great, and there is a growing pool of talented and enthusiastic Ruby developers, all rising to the challenge. Dave Thomas (Schmidt 2006, Foreword)

 

Ruby ist eine Programmiersprache, die 1995 von dem Japaner Yukihiro Matsumoto veröffentlicht wurde. Sie wurde durch die Sprachen Perl, Eiffel, Ada, Smalltalk und Lisp inspiriert. Die herausragenden Eigenschaften von Ruby sind:

  • Vollständige Objektorientierung. Es existieren keine einfachen Datentypen.
  • Die durch Lisp inspirierten Closures erlauben mächtige Operationen.
  • Ruby Mixins, die eine elegante Art der Mehrfachvererbung darstellen.
  • Das dynamische Typsystem, das große Flexibilität ermöglicht.
  • Die Ausbalancierung zwischen funktionaler und imperativer Programmierung.

Ruby on Rails

Veröffentlicht von Jens am 16. Juli 2008

Since it first appeared in July 2004, Ruby on Rails has revolutionized the process of developing web applications. It has enabled web developers to become much faster and more efficient, al lowing for quicker application development a critical advantage in these days of web time.
(Orsini 2007, S.1)

 

Ruby on Rails ist ein in Ruby programmiertes Framework für die Entwicklung von Webapplikationen. Es wurde von David Heinemeier Hansson entwickelt und 2004 der Öffentlichkeit vorgestellt. Das Framework folgt dem Model-View-Controller Architekturmuster, bei dem das Softwaresystem in Datenhaltungsschicht (Model), Präsentationsschicht (View) und Programmsteuerung (Controller) aufgeteilt wird.

Ruby on Rails macht von der Möglichkeit der Metaprogrammierung gebrauch um Methoden zu definieren, die wie Erweiterungen der Ruby Syntax wirken. Es folgt dem Prinzip Don’t Repeat Yourself und stellt Konvention über Konfiguration.

Besonders hervorzuheben ist das Modul Active Record, das eine objektrelationale Abbildung der Datenbank nach dem von Martin Fowler, in Patterns of Enterprise Application Architecture, vorgestellten Active Record Designpattern bereitstellt. In Agile Web Development with Rails wird Ruby on Rails in allen Details beschrieben.

Aussagekräftige Html-Titel 1

Veröffentlicht von Jens am 02. Juli 2008

Jede Html-Datei muss einen Titel enthalten. Der im Html-Kopf notiert ist und für folgende Dinge verwendet wird:

  • Der Titel wird bei der Darstellung der Datei im Web-Browser in der Titelzeile des Browserfensters und in Karteireitern angezeigt.
  • Der Titel wird von Webbrowsern beim Speichern von Lesezeichen verwendet.
  • Der Titel wird im Verlauf der besuchten Seiten in Webbrowsern angezeigt.
  • Der Titel wird bei der Indizierung von Webseiten durch Suchmaschinen als wichtiges Merkmal verwendet.

Somit sollte der Titel möglichst exakt dem Inhalt der Seite entsprechen. Das wirkt sich positiv auf die Usability der Seitennavigation und beim Setzen von Lesezeichen im Webbrowser aus.

Ein Html-Titel muss im Html-Kopf einer Datei definiert werden. Der Html-Kopf sollte aus Gründen der Wartbarkeit nur an einer Stelle im Projekt notiert werden und alle Dateien sollten diesen zentral gehaltenen Html-Kopf inkludieren. Da Titel einer Html-Datei möglichst dem Inhalt der Seite entsprechen sollte, muss dieser im Idealfall für jede einzelne Seite angepasst werden. Den Html-Kopf in einzelne Seiten der Darstellungschicht zu kopieren würde jedoch dem DRY-Prinzip widersprechen.

Ein Ausweg besteht darin, im zentral gehaltenen Html-Kopf eine Funktion zu definieren, die das Titel-Element generiert und dessen Inhalte als Parameter von jeder Seite der Darstellungschicht übergeben werden. In der Darstellungschicht kann dieser Methodenaufruf gleichzeitig als Html-Überschrift verwendet werden die bei den meisten Seiten dem Html-Titel entspricht.

Patrick Crowley hat mit Headliner ein Rails Plugin geschrieben das genau das macht. Es ist wirklich einfach zu benutzen.

Nach der Installation über:

script/plugin install http://the.railsi.st/svn/repo/plugins/headliner/

Muss eine zentrale Konfiguration des Plugins in der Layout Datei vorgenommen werden:

<head>
<%= title :site => "journizer.com", :separator => "-",
:lowercase => true, :reverse => true %>
</head>

In den einzelnen Views kann der Html-Titel jetzt mit:

<h1><%=t "My page title" %></h1>

gesetzt werden.

Suchmaschinenoptimierung für Rails Anwendungen

Veröffentlicht von Jens am 25. April 2008

Ich bin im Moment dabei mir Gedanken darüber zu machen wie man eine Ruby on Rails Anwendung für Suchmaschinen optimieren kann. Ich plane darüber eine kleine Serie von Artikeln zu schreiben.

Folgende Teile habe ich geplant:

Teil 1 von 4: Aussagekräftige HTML-Titel

Teil 2 von 4: Sinnvolle HTML-Meta Angaben

Teil 3 von 4: Menschenlesbare Urls

Teil 4 von 4: Sitemap.xml

Styleguide for Rails Projects 1

Veröffentlicht von Jens am 11. April 2008

Principles

DRY - Don’t Repeat yourself.
http://www.jensjaeger.com/2008/04/das-dry-prinzip/ (german)
http://en.wikipedia.org/wiki/DRY

KISS - Keep it Simple Stupid
http://www.jensjaeger.com/2008/04/das-kiss-prinzip/ (german)
http://en.wikipedia.org/wiki/KISS_principle

General

General Ruby Styleguide
http://rubygarden.org/ruby/page/show/RubyStyleGuide

General Rails Styleguide:
http://wiki.rubyonrails.org/rails/pages/CodingStandards

Language

Everything in the source code must be written in english. Including comments, variable names and function names.

Encoding

All files must be encoded with UTF-8.

Methods

Every method should have a meaningful name.
For a procedure name use a strong verb.
Example:

Report.print

 

For a function name use a description of the return value
Example:

Report.publishing_date

 

Avoid meaningless or wishy-washy verbs.
Descripe everything the method does.
Make names of routines as long as necessary.
The average length of methods should be from 15 to 20 characters.

Variables

Every variable should have a meaningful name.
The most consideration in naming is that the name fully and accurately descripe the entity the variable represents.
The average length of a variable should be from 8 to 15 characters.
Use shorter name only for iterators in really short scopes.
Example:

reports.each do |r|
  r.print
end

 

The scope of a variable should be as short as possible.
Arrays should have a plural name.
Example:

reports = Report.find(:all)

 

Everything else should have a singular name.
Example:

report = Report.find_by_id(1)

Constants

Naming like variables.
There should be no numbers in the sourcecode. Every number should be a constant defined in environment.rb.
Example:

PAG_PAGES = 10 #items per page for pagination

Comments

Comment as much as possible.
You shouldn’t comment WHAT your code does (this would be hurt the DRY-Principle), you should comment WHY your code does something.

Stay DRY

If you are doing something more than once, extract it into a method. This is especially the case when it comes to conditional queries. So instead of writing:

@reports = Report.find(:all, :conditions => ["deleted = ", 1])

you should write a method:

class Report < AR::B
  def find_deleted
    find(:all, :conditions => ["deleted = ", 1])
  end
end

Paranthesis

Use paranthesis with “standard” method calls and no paranthesis for helper-style hash arguments. Example:

Report.find_by_id(1)
#instead of
Report.find_by_id 1

but

link_to "view", { :action => "view" }
#instead of
link_to("view", { :action => "view" })

Acknowledgments

Thanks to Florian Gilcher for the helpful comments.