view roundup/web/NOTES.md @ 4905:6e313bdf6b69 routing

routing: Add new roundup.web namespace with router component This branch is to untangle hardcoded Roundup URL scheme, make it more readable and customizable with extensions. Right now it doesn't seem possible to write extension that renders static HTML page at /about without modifying Roundup DB, and this web component should not depend on DB schema.
author anatoly techtonik <techtonik@gmail.com>
date Tue, 15 Jul 2014 13:33:43 +0300
parents
children b860ede03056
line wrap: on
line source


Engineering notes for Roundup components for web.


### Logical structure of web components

An attempt to see what components are present in
web request processing.

    +-----------+
    |           |
    | Router    |
    └─----------+                     (pure logic)
    ----------------------------------------------
    +-----------+    
    |           |    
    | Login     |    
    └-----------+   (logic + templates + messages)
    ----------------------------------------------
    +-----------+
    ¦           ¦
    ¦ User DB   ¦
    └-----------+                       (messages)


Every component consists of messages (data), logic
(code) and representation (templates). Message
definition (data) also takes into account actions
that make component work. Templates are mostly
needed for human readability. 


### Router

Status for Roundup URL map check:

    [ ] urlmap component

    /_file/(.*) 
      StaticFileHandler
       [ ] /_file
       [ ] /_file/
       [ ] /_file/name
    /@@file/(.*)
      StaticFileHandler
       [ ] /@@file
       [ ] /@@file/
       [ ] /@@file/name

Roundup Issue Tracker: http://roundup-tracker.org/