Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Initial commit
- Loading branch information
0 parents
commit a577b0b
Showing
15 changed files
with
2,105 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
Barista is a simple URL router for nodejs. | ||
|
||
Getting Barista | ||
=============== | ||
|
||
Install via npm, thusly: | ||
|
||
```javascript | ||
npm install barista | ||
``` | ||
|
||
Using Barista | ||
------------- | ||
|
||
```javascript | ||
var Router = require('barista').Router; | ||
|
||
var router = new Router; | ||
``` | ||
|
||
|
||
### Adding routes | ||
```javascript | ||
// a basic example | ||
router.match( '/products', 'GET' ) | ||
.to( 'products.index' ) | ||
|
||
// Rails-style variables | ||
router.match( '/products/:id', 'GET' ) | ||
.to( 'products.show' ) | ||
|
||
// optional parts | ||
router.match( '/products/:id(.:format)', 'GET' ) | ||
.to( 'products.show' ) | ||
|
||
// convenience methods | ||
router.get( '/products/:id(.:format)' ) | ||
.to( 'products.show' ) | ||
|
||
router.put( '/products/:id(.:format)' ) | ||
.to( 'products.update' ) | ||
|
||
router.post( '/products' ) | ||
.to( 'products.create' ) | ||
|
||
router.delete( '/products' ) | ||
.to( 'products.destroy' ) | ||
``` | ||
### REST Resources | ||
|
||
```javascript | ||
router.resource( 'products' ) | ||
``` | ||
|
||
is equivalent to: | ||
|
||
```javascript | ||
router.get( '/products(.:format)' ) | ||
.to( 'products.index' ) | ||
|
||
router.get( '/products/add(.:format)' ) | ||
.to( 'products.add' ) | ||
|
||
router.get( '/products/:id(.:format)' ) | ||
.to('products.show' ) | ||
|
||
router.get('/products/:id/edit(.:format)' ) | ||
.to( 'products.edit' ) | ||
|
||
router.post('/products(.:format)' ) | ||
.to( 'products.create' ) | ||
|
||
router.put('/products/:id(.:format)' ) | ||
.to( 'products.update' ) | ||
|
||
router.delete('/products/:id(.:format)' ) | ||
.to( 'products.destroy' ) | ||
``` | ||
|
||
Resolution & dispatching | ||
------------------------ | ||
|
||
The `router.all( url, method [, callback] )` method can be used in two ways: | ||
|
||
```javascript | ||
var params = router.first( '/products/15', 'GET' ) | ||
``` | ||
OR | ||
```javascript | ||
router.first( '/products/15', 'GET', function( params ){ | ||
// dispatch the request or something | ||
}) | ||
``` | ||
|
||
You can get all the matching routes like so: | ||
```javascript | ||
var params = router.all( '/products/15', 'GET' ) | ||
|
||
//=> [params, params, params....] | ||
``` | ||
|
||
Route generation | ||
---------------- | ||
|
||
Pass in a params hash, get back a tasty string: | ||
```javascript | ||
router.url( { | ||
controller: 'products', | ||
action: 'show', | ||
id: 5 | ||
} ) | ||
//=> '/products/5' | ||
|
||
router.url( { | ||
controller: 'products', | ||
action: 'show', | ||
id: 5, | ||
format: 'json' | ||
} ) | ||
//=> '/products/5.json' | ||
``` | ||
Set the optional second parameter to `true` if you want | ||
extra params appended as a query string: | ||
```javascript | ||
router.url({ | ||
controller: 'products', | ||
action: 'show', | ||
id: 5, | ||
format: 'json', | ||
love: 'cheese' | ||
}, true ) | ||
//=> '/products/5.json?love=cheese' | ||
``` | ||
|
||
Things I forgot... | ||
------------------ | ||
...might be in the `/docs` folder... | ||
|
||
...or might not exist at all. | ||
|
||
|
||
It's broken! | ||
------------ | ||
Shit happens. | ||
|
||
Write a test that fails and add it to the tests folder, | ||
then create an issue! | ||
|
||
Patches welcome :-) | ||
|
||
|
||
Who are you? | ||
------------ | ||
I'm [Kieran Huggins](mailto:kieran@refactory.ca), partner at [Refactory](http://refactory.ca) in Toronto, Canada. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,186 @@ | ||
/*--------------------- Layout and Typography ----------------------------*/ | ||
body { | ||
font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif; | ||
font-size: 15px; | ||
line-height: 22px; | ||
color: #252519; | ||
margin: 0; padding: 0; | ||
} | ||
a { | ||
color: #261a3b; | ||
} | ||
a:visited { | ||
color: #261a3b; | ||
} | ||
p { | ||
margin: 0 0 15px 0; | ||
} | ||
h1, h2, h3, h4, h5, h6 { | ||
margin: 0px 0 15px 0; | ||
} | ||
h1 { | ||
margin-top: 40px; | ||
} | ||
#container { | ||
position: relative; | ||
} | ||
#background { | ||
position: fixed; | ||
top: 0; left: 525px; right: 0; bottom: 0; | ||
background: #f5f5ff; | ||
border-left: 1px solid #e5e5ee; | ||
z-index: -1; | ||
} | ||
#jump_to, #jump_page { | ||
background: white; | ||
-webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777; | ||
-webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px; | ||
font: 10px Arial; | ||
text-transform: uppercase; | ||
cursor: pointer; | ||
text-align: right; | ||
} | ||
#jump_to, #jump_wrapper { | ||
position: fixed; | ||
right: 0; top: 0; | ||
padding: 5px 10px; | ||
} | ||
#jump_wrapper { | ||
padding: 0; | ||
display: none; | ||
} | ||
#jump_to:hover #jump_wrapper { | ||
display: block; | ||
} | ||
#jump_page { | ||
padding: 5px 0 3px; | ||
margin: 0 0 25px 25px; | ||
} | ||
#jump_page .source { | ||
display: block; | ||
padding: 5px 10px; | ||
text-decoration: none; | ||
border-top: 1px solid #eee; | ||
} | ||
#jump_page .source:hover { | ||
background: #f5f5ff; | ||
} | ||
#jump_page .source:first-child { | ||
} | ||
table td { | ||
border: 0; | ||
outline: 0; | ||
} | ||
td.docs, th.docs { | ||
max-width: 450px; | ||
min-width: 450px; | ||
min-height: 5px; | ||
padding: 10px 25px 1px 50px; | ||
overflow-x: hidden; | ||
vertical-align: top; | ||
text-align: left; | ||
} | ||
.docs pre { | ||
margin: 15px 0 15px; | ||
padding-left: 15px; | ||
} | ||
.docs p tt, .docs p code { | ||
background: #f8f8ff; | ||
border: 1px solid #dedede; | ||
font-size: 12px; | ||
padding: 0 0.2em; | ||
} | ||
.pilwrap { | ||
position: relative; | ||
} | ||
.pilcrow { | ||
font: 12px Arial; | ||
text-decoration: none; | ||
color: #454545; | ||
position: absolute; | ||
top: 3px; left: -20px; | ||
padding: 1px 2px; | ||
opacity: 0; | ||
-webkit-transition: opacity 0.2s linear; | ||
} | ||
td.docs:hover .pilcrow { | ||
opacity: 1; | ||
} | ||
td.code, th.code { | ||
padding: 14px 15px 16px 25px; | ||
width: 100%; | ||
vertical-align: top; | ||
background: #f5f5ff; | ||
border-left: 1px solid #e5e5ee; | ||
} | ||
pre, tt, code { | ||
font-size: 12px; line-height: 18px; | ||
font-family: Monaco, Consolas, "Lucida Console", monospace; | ||
margin: 0; padding: 0; | ||
} | ||
|
||
|
||
/*---------------------- Syntax Highlighting -----------------------------*/ | ||
td.linenos { background-color: #f0f0f0; padding-right: 10px; } | ||
span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; } | ||
body .hll { background-color: #ffffcc } | ||
body .c { color: #408080; font-style: italic } /* Comment */ | ||
body .err { border: 1px solid #FF0000 } /* Error */ | ||
body .k { color: #954121 } /* Keyword */ | ||
body .o { color: #666666 } /* Operator */ | ||
body .cm { color: #408080; font-style: italic } /* Comment.Multiline */ | ||
body .cp { color: #BC7A00 } /* Comment.Preproc */ | ||
body .c1 { color: #408080; font-style: italic } /* Comment.Single */ | ||
body .cs { color: #408080; font-style: italic } /* Comment.Special */ | ||
body .gd { color: #A00000 } /* Generic.Deleted */ | ||
body .ge { font-style: italic } /* Generic.Emph */ | ||
body .gr { color: #FF0000 } /* Generic.Error */ | ||
body .gh { color: #000080; font-weight: bold } /* Generic.Heading */ | ||
body .gi { color: #00A000 } /* Generic.Inserted */ | ||
body .go { color: #808080 } /* Generic.Output */ | ||
body .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ | ||
body .gs { font-weight: bold } /* Generic.Strong */ | ||
body .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ | ||
body .gt { color: #0040D0 } /* Generic.Traceback */ | ||
body .kc { color: #954121 } /* Keyword.Constant */ | ||
body .kd { color: #954121; font-weight: bold } /* Keyword.Declaration */ | ||
body .kn { color: #954121; font-weight: bold } /* Keyword.Namespace */ | ||
body .kp { color: #954121 } /* Keyword.Pseudo */ | ||
body .kr { color: #954121; font-weight: bold } /* Keyword.Reserved */ | ||
body .kt { color: #B00040 } /* Keyword.Type */ | ||
body .m { color: #666666 } /* Literal.Number */ | ||
body .s { color: #219161 } /* Literal.String */ | ||
body .na { color: #7D9029 } /* Name.Attribute */ | ||
body .nb { color: #954121 } /* Name.Builtin */ | ||
body .nc { color: #0000FF; font-weight: bold } /* Name.Class */ | ||
body .no { color: #880000 } /* Name.Constant */ | ||
body .nd { color: #AA22FF } /* Name.Decorator */ | ||
body .ni { color: #999999; font-weight: bold } /* Name.Entity */ | ||
body .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ | ||
body .nf { color: #0000FF } /* Name.Function */ | ||
body .nl { color: #A0A000 } /* Name.Label */ | ||
body .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ | ||
body .nt { color: #954121; font-weight: bold } /* Name.Tag */ | ||
body .nv { color: #19469D } /* Name.Variable */ | ||
body .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ | ||
body .w { color: #bbbbbb } /* Text.Whitespace */ | ||
body .mf { color: #666666 } /* Literal.Number.Float */ | ||
body .mh { color: #666666 } /* Literal.Number.Hex */ | ||
body .mi { color: #666666 } /* Literal.Number.Integer */ | ||
body .mo { color: #666666 } /* Literal.Number.Oct */ | ||
body .sb { color: #219161 } /* Literal.String.Backtick */ | ||
body .sc { color: #219161 } /* Literal.String.Char */ | ||
body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */ | ||
body .s2 { color: #219161 } /* Literal.String.Double */ | ||
body .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ | ||
body .sh { color: #219161 } /* Literal.String.Heredoc */ | ||
body .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ | ||
body .sx { color: #954121 } /* Literal.String.Other */ | ||
body .sr { color: #BB6688 } /* Literal.String.Regex */ | ||
body .s1 { color: #219161 } /* Literal.String.Single */ | ||
body .ss { color: #19469D } /* Literal.String.Symbol */ | ||
body .bp { color: #954121 } /* Name.Builtin.Pseudo */ | ||
body .vc { color: #19469D } /* Name.Variable.Class */ | ||
body .vg { color: #19469D } /* Name.Variable.Global */ | ||
body .vi { color: #19469D } /* Name.Variable.Instance */ | ||
body .il { color: #666666 } /* Literal.Number.Integer.Long */ |
Oops, something went wrong.