Checks if the object has a value at key and that the value is not empty

convenience method to join as many arguments as you want by the first argument - useful for making paths

Returns an array of keys for this object. If attributes_only is true will not return keys that map to a function()

Shortcut to Sammy.log

Renders a simple HTML version of this Objects attributes. Does not render functions. For example. Given this Sammy.Object:

Returns a copy of the object with Functions removed.

Returns a string representation of this object. if include_functions is true, it will also toString() the methods of this object. By default only prints the attributes.

Generates a unique identifing string. Used for application namespaceing.

bind the proxy events to the current app.

get the current location from the hash.

set the current location to new_location

unbind the proxy events from the current app

returns a jQuery object of the Applications bound element.

A shortcut for binding a callback to be run after a route is executed. After callbacks have no guarunteed order.

Adds an around filter to the application. around filters are functions that take a single argument callback which is the entire route execution path wrapped up in a closure. This means you can decide whether or not to proceed with execution by not invoking callback or, more usefuly wrapping callback inside the result of an asynchronous execution.

Example

The most common use case for around() is calling a possibly async function and executing the route within the functions callback:

Takes a single callback that is pushed on to a stack. Before any route is run, the callbacks are evaluated in order within the current Sammy.EventContext

If any of the callbacks explicitly return false, execution of any further callbacks and the route itself is halted.

You can also provide a set of options that will define when to run this before based on the route it proceeds.

Example

See contextMatchesOptions() for a full list of supported options

Works just like jQuery.fn.bind() with a couple noteable differences.

• It binds all events to the application element
• All events are bound within the eventNamespace()
• Events are not actually bound until the application is started with run()
• callbacks are evaluated within the context of a Sammy.EventContext

See code.quirkey.com/sammy/docs/events.html for more info.

Will bind a single callback function to every event that is already being listened to in the app. This includes all the APP_EVENTS as well as any custom events defined with bind().

Used internally for debug logging.

Matches an object of options against an EventContext like object that contains path and verb attributes. Internally Sammy uses this for matching before() filters against specific options. You can set the object to only match certain paths or verbs, or match all paths or verbs except those that match the options.

Example

The base error handler takes a string message and an Error object. If raise_errors is set to true on the app level, this will re-throw the error to the browser. Otherwise it will send the error to log(). Override this method to provide custom error handling e.g logging to a server side component or displaying some feedback to the user.

A unique event namespace defined per application. All events bound with bind() are automatically bound within this space.

Delegates to the location_proxy to get the current location. See Sammy.HashLocationProxy for more info on location proxies.

Helper extends the event context just like helpers() but does it a single method at a time. This is especially useful for dynamically named helpers

Example

Arguments

Helpers extends the EventContext prototype specific to this app. This allows you to define app specific helper functions that can be used whenever you’re inside of an event context (templates, routes, bind).

Example

Arguments

Returns a boolean of weather the current application is running.

Given a verb and a String path, will return either a route object or false if a matching route can be found within the current defined set.

mapRoutes takes an array of arrays, each array being passed to route() as arguments, this allows for mass definition of routes. Another benefit is this makes it possible/easier to load routes via remote JSON.

Example

This thows a ‘404 Not Found’ error by invoking error(). Override this method or error() to provide custom 404 behavior (i.e redirecting to / or showing a warning)

Reruns the current route

Returns a copy of the given path with any query string after the hash removed.

route() is the main method for defining routes within an application. For great detail on routes, check out: code.quirkey.com/sammy/doc/routes.html

This method also has aliases for each of the different verbs (eg. get(), post(), etc.)

Arguments

Actually starts the application’s lifecycle. run() should be invoked within a document.ready block to ensure the DOM exists before binding events, etc.

Example

Arguments

First, invokes lookupRoute() and if a route is found, parses the possible URL params and then invokes the route’s callback within a new Sammy.EventContext. If the route can not be found, it calls notFound(). If raise_errors is set to true and the error() has not been overriden, it will throw an actual JS error.

You probably will never have to call this directly.

Arguments

Returns

Either returns the value returned by the route callback or raises a 404 Not Found error.

Delegates to the location_proxy to set the current location. See Sammy.HashLocationProxy for more info on location proxies.

Arguments

Swaps the content of $element() with content You can override this method to provide an alternate swap behavior for EventContext.partial().

Example

//=> Sammy.Application: body

Triggers custom events defined with bind()

Arguments

The opposite of run(), un-binds all event listeners and intervals run() Automaticaly binds a onunload event to run this when the document is closed.

use() is the entry point for including Sammy plugins. The first argument to use should be a function() that is evaluated in the context of the current application, just like the app_function argument to the Sammy.Application constructor.

Any additional arguments are passed to the app function sequentially.

For much more detail about plugins, check out: code.quirkey.com/sammy/doc/plugins.html

Example

Split interpolated strings into an array of literals and code fragments.

Parse the attribute block using a state machine

A shortcut to the app’s $element()

A shortcut to app’s eventNamespace()

Raises a possible notFound() error for the current path.

Used for rendering remote templates or documents within the current application/DOM. By default Sammy and partial() know nothing about how your templates should be interpeted/rendered. This is easy to change, though. partial() looks for a method in EventContext that matches the extension of the file you’re fetching (e.g. ‘myfile.template’ will look for a template() method, ‘myfile.haml’ => haml(), etc.) If no matching render method is found it just takes the file contents as is.

If you’re templates have different (or no) extensions, and you want to render them all through the same engine, you can set the default/fallback template engine on the app level by setting app.template_engine to the name of the engine or a function() {}

Caching

If you use the Sammy.Cache plugin, remote requests will be automatically cached unless you explicitly set cache_partials to false

Example

There are a couple different ways to use partial():

Iteration/Arrays

If the data object passed to partial() is an Array, partial() will itterate over each element in data calling the callback with the results of interpolation and the index of the element in the array.

Changes the location of the current window. If to begins with ’#’ it only changes the document’s hash. If passed more than 1 argument redirect will join them together with forward slashes.

Example

A shortcut to app’s swap()

//=> Sammy.EventContext: get #/ {}

Triggers events on app within the current context.

by @langalex, support for arrays of strings

json is a polymorphic function that translates objects aback and forth from JSON to JS. If given a string, it will parse into JS, if given a JS object it will stringify into JSON.

Example

Removes the value at key from the current store

Clears all the values for the current store.

Checks for the existance of key in the current store. Returns a boolean.

Returns the value at key if set, otherwise, runs the callback and sets the value to the value returned in the callback.

Example

Returns the set value at key, parsing with JSON.parse and turning into an object if possible

Checks for the availability of the current storage type in the current browser/config.

Returns the all the keys set for the current store as an array. Internally Sammy.Store keeps this array in a ‘meta_key’ for easy access.

loads the response of a request to path into key.

Example

In /mytemplate.tpl:

In app.js:

Sets the value of key<tt> with <tt>value. If value<tt> is an object, it is turned to and stored as a string with <tt>JSON.stringify. It also tries to conform to the KVO pattern triggering jQuery events on the element that the store is bound to.

Example