Seaside et REST

Quand on écrit une application web avec Seaside, on se soucie en général peu des urls, et pour cause, celles-ci représentent l’état de l’application, et non le chemin pour accéder à une ressource.

Comment faire alors si l’on veut construire des urls bookmarkables?

Cette question est souvent posée sur la mailing-list, bien que la solution soit relativement connue, j’ai donc décidé d’écrire un article sur le sujet.

Il suffit pour cela de surcharger deux méthodes : #initialRequest: et #updateUrl: dans votre composant principal par exemple. WABrowser utilise cette technique, je vous conseille donc de regarder son fonctionnement.

Imaginons que l’on ait deux composants, MYMainComponent et MYSubComponent :

MYMainComponent>>initialRequest: aRequest
super initialRequest: aRequest.
aRequest fields at: 'contents' ifPresent: [ :contents | self setContents: contents]

MYSubComponent>>updateUrl: aUrl
super updateUrl: aUrl.
aUrl addParameter: 'contents' value: self uri

MYSubComponent>>uri
^'subcomponent'

Vous obtiendrez ainsi des urls du type :

http://foo.bar/maincomponent/?contents=subcomponent

Suivant le type d’url que vous recherchez, pouvez utiliser la methode #addToPath:.

MYSubComponent>>updateUrl: aUrl
super updateUrl: aUrl.
aUrl addToPAth: self uri

L’url obtenue ressemblera à ceci :

http://foo.bar/maincomponent/subcomponent

Noubliez pas d’adapter #initialRequest: à vos besoins.

Concernant le problème de la validité des liens après l’expiration de la session, je vous recommande cet article de Ken Treis.

Découpler des composants Seaside

Lorsque l’on écrit des composants Seaside, il arrive souvent que l’on veuille qu’ils communiquent ou interagissent entre eux. On peut alors se demander comment procéder pour éviter de les coupler explicitement, et qu’ils restent réutilisables.

Il existe une solution pratique et élégante à ce problème : les annonces. Plusieurs implémentations existent en Squeak, j’ai choisi d’utiliser celle fournie avec OmniBrowser, pour sa simplicité.

L’idée est simple : créer un annonceur dans la session, un composant peut déclencher l’annonce, et un autre y répondre.

WASession subclass: #MySession
instanceVariableNames: 'announcer'
classVariableNames: ''
poolDictionaries: ''
category: 'Announcement-Demo'

MySession>>announcer
^announcer ifNil: [announcer := OBAnnouncer new]

Il ne faut pas oublier d’initialiser correctement le composant principal de l’application :

MyMainComponent class>>initialize
(self registerAsApplication: 'Announcement-Demo')
preferenceAt: #sessionClass put: MySession

Il faut ensuite créer une annonce, sous-classe de OBAnnouncement :

OBAnnouncement subclass: #MyAnnouncement
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'Announcement-Demo'

Tout composant intéressé par cette annonce peut alors le spécifier lors de son initialisation, et prévoir une action à effectuer lors de son annonce :

MyFirstComponent>>initialize
super initialize.
self session announcer observe: MyAnnouncement send: #action to: self

MyFirstComponent>>action
"Do something when MyAnnouncement is announced."

Et un autre composant peut l’annoncer :

MySecondComponent>>renderContentOn: html
html anchor callback: [self announceAction]; with: 'do something'

MySecondComponent>>announceAction
self session announcer announce: MyAnnouncement

Vous pouvez donc très facilement faire interagir plusieurs composants de cette manière, avec différentes annonces, et ainsi garder des composants réutilisables.

Tamaris, un puissant outil de développement

Quel Squeaker ne s’est jamais retrouvé submergé par une multitude de workspaces et browsers ? C’était souvent mon cas, avant que je ne découvre Tamaris, un outil de développement Squeak particulièrement utile.

Tamaris est un explorateur d’objets très complet qui permet de naviguer et de les classer suivant des taxomonies (vues en arbres d’objets). Si son utilisation paraît complexe et peu intuitive au premier abord, elle se révèle par la suite très efficace. Outre l’intégration des outils habituels (browsers, workspace et transcript, …), Tamaris offre de nombreuses possibilités :

• multiples classifications;
• fenêtres splittables horizontalement et verticalement;
• gestion de l’historique, possibilités de recherches;
• liste des objets récents et gestion des marque-pages;
• bien d’autres choses encore !

L’installation est très simple : ouvrez SqueakMap Package Loader (menu world>>open…>>SqueakMap Package Loader) et installez Tamaris ou Tamaris for Squeak 3.9 suivant l’image que vous utilisez. Les utilisateurs qui utilisent déjà la version 3.10 devront installer la dernière version de Tamaris depuis SqueakSource.

Notons qu’une documentation[1] au format PDF (en anglais) est télechargée automatiquement lors de cette installation.

Un screenshot pour la route :

[1] Quoique claire, la documentation mériterait d’être plus détaillée.