Skip to content

Commit

Permalink
minor doc additions
Browse files Browse the repository at this point in the history
  • Loading branch information
rtomayko committed Oct 22, 2008
1 parent eb352fc commit 5632876
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
3 changes: 2 additions & 1 deletion TODO
Expand Up @@ -27,6 +27,7 @@

- BUG: meta store hits but entity misses
- BUG: HEAD request on invalid entry caches zero-length response
- BUG: Response body written to cache each time validation succeeds
- Are we doing HEAD properly?
- liberal, conservative, sane caching configs
- Sample app
Expand All @@ -36,7 +37,7 @@
- sorts params by key, then value
- urlencodes /[^ A-Za-z0-9_.-]/ host, path, and param key/value
- Support server-specific X-Sendfile (or similar) for delivering cached
bodies.
bodies (file entity stores only).
- Sqlite3 (meta store)
- Cache invalidation on PUT, POST, DELETE.
- Invalidate at the request URI; or, anything that's "near" the request URI.
Expand Down
10 changes: 7 additions & 3 deletions doc/configuration.markdown
Expand Up @@ -152,8 +152,13 @@ When an event is triggered, the blocks associated with the event are executed in
reverse/FILO order (i.e., the block declared last runs first) until a
_transitioning statement_ is encountered. Transitioning statements are suffixed
with a bang character (e.g, `pass!`, `store!`, `error!`) and cause the current
event to halt and the machine to transition to the subsequent event; control
is not returned to the original event.
event to halt and the machine to transition to the subsequent event; control is
not returned to the original event. The [default configuration](#default)
includes documentation on available transitions for each event.

The `next` statement can be used to exit an event block without transitioning
to another event. Subsequent event blocks are executed until a transitioning
statement is encountered:

on :fetch do
next if response.freshness_information?
Expand All @@ -164,7 +169,6 @@ is not returned to the original event.
end
end


<a id='import'></a>

Importing Configuration
Expand Down
2 changes: 1 addition & 1 deletion doc/index.markdown
Expand Up @@ -106,4 +106,4 @@ License

__Rack::Cache__ is Copyright &copy; 2008
by [Ryan Tomayko](http://tomayko.com/about)
and is provided under [the MIT license](./license.html)
and is provided under [the MIT license](./license)

0 comments on commit 5632876

Please sign in to comment.