<p> JavascriptRoutes converts your Rails routes into JavaScript. You can then access (generate) them in the browser (or any other JS environment). It supports both normal and named routes, and creates helper functions for the latter. </p> <h3>Installing</h3> Download from "Github":https://github.com/toretore/javascript_routes/tree and put in @vendor/plugins@. <h3>Using</h3> <p> The plugin will generate _public/javascripts/routes.js_ when the application starts. The file will vary in size depending on how many routes you have in routes.rb. The "required" parts are around 3kb. To use it, simply include it like any other JavaScript file in your layout: </p> [html] <script type="text/javascript" src="/javascripts/routes.js"></script> [/html] <p> The file will define two objects that will be available to the browser. A @Route@ encapsulates a single route, while @Routes@ contain all routes (it's an array). @Routes.named@ contains all the named routes. To generate a route, call @Routes.generate@: </p> [javascript] Routes.generate({controller:'foo', action:'foo'}) Routes.generate({controller:'bar', action:'baz', baz:'quux'}, {host:'example.com'}) [/javascript] <p> If no routes are found to match the parameters, it will return false. The generate function takes an object (hash) with name/value mappings and an optional @options@ object. The available options are: </p> <dl> <dt>onlyPath</dt> <dd>Don't include the domain</dd> <dt>includeSlash</dt> <dd>Include the last slash in the path</dd> <dt>escape</dt> <dd>Set to false to prevent the escaping of special characters</dd> <dt>protocol</dt> <dd>Protocol other than 'http://' to use</dd> <dt>host</dt> <dd>Hostname</dd> <dt>port</dt> <dd>Port number</dd> <dt>noDefaults</dt> <dd>Don't use <code>Routes.defaultParams</code> when generating URL</dd> </dl> <p> If you want to use a named route, it will have defined a convenience method on the @Routes@ object: </p> [javascript] Routes.home() Routes.articles() Routes.article(1) Routes.article({id:1, foo:'bar'}) [/javascript] <p> These functions can, like their Rails equivalents, take either a hash with name/value mappings, or all required arguments in the correct order. They also take an optional second (or last) argument @options@. </p> <h3>Default parameters and options</h3> <p> The @Routes@ object has two properties, @defaultParams@ and @defaultOptions@, that can be filled with default values for the @params@ and @options@ arguments passed when generating URLs. You could, for example, set a default controller name: </p> [javascript] Routes.defaultParams.controller = 'articles'; Routes.generate({action:'show', id:1}); // => "/articles/1" (if RESTful) //You can set any parameter you want Routes.defaultParams.foo = 'bar'; Routes.generate({controller:'users', :action:'index'}); // => "/users?foo=bar" Routes.generate({controller:'users', :action:'index', foo:'rab'}); // => "/users?foo=rab" delete Routes.defaultParams.foo; Routes.defaultParams.id = 1; Routes.user(); //=> "/users/1" Routes.user(2); //=> "/users/2" [/javascript] <p> @Routes.defaultParams.action@ is already set to "index", which is the default action for any controller. You can @delete@ this if that's not what you want of course. Parameters passed to the generate method or default parameters from a named route will overwrite parameters from @defaultParams@. </p> <p> @Routes.defaultOptions@ contains the default values passed as the @options@ (second) argument when generating URLs. Some values, like @host@ and @port@ will already have been set to the current host name and port number. </p> [javascript] Routes.defaultOptions.host = 'example.com'; Routes.generate({controller:'users'}); //=> "http://example.com/users" Routes.defaultOptions.onlyPath = true; Routes.generate({controller:'users'}); //=> "/users" Routes.defaultParams.foo = 'bar'; Routes.generate({controller:'users'}); //=> "/users?foo=bar" Routes.defaultParams.noDefaults = true; Routes.generate({controller:'users'}); //=> "/users" [/javascript] <p> As with @defaultParams@, values in @defaultOptions@ will be overwritten by options passed in at generation time. </p> 2007-06-29T16:38:40-04:00 18 true javascript_routes

2008-04-17T10:08:37-04:00