Class Webby::Renderer
In: lib/webby/renderer.rb
Parent: Object

The Webby::Renderer is used to filter and layout the text found in the resource page files in the content directory.

A page is filtered based on the settings of the ‘filter’ option in the page‘s meta-data information. For example, if ‘textile’ is specified as a filter, then the page will be run through the RedCloth markup filter. More than one filter can be used on a page; they will be run in the order specified in the meta-data.

A page is rendered into a layout specified by the ‘layout’ option in the page‘s meta-data information.

Methods

Included Modules

ERB::Util

Attributes

logger  [R] 

Public Class methods

Create a new renderer for the given page. The renderer will apply the desired filters to the page (from the page‘s meta-data) and then render the filtered page into the desired layout.

Render the given page and write the resulting output to the page‘s destination. If the page uses pagination, then multiple destination files will be created — one for each paginated data set in the page.

Public Instance methods

Returns the binding in the scope of this Renderer object.

Configure local variables in the scope of the current binding returned by the get_binding method. The locals should be given as a hash of name / value pairs.

Attempts to locate a partial by name. If only the partial name is given, then the current directory of the page being rendered is searched for the partial. If a full path is given, then the partial is searched for in that directory.

Raises a Webby::Error if the partial could not be found.

This method will put filter guards around the given input string. This will protect the string from being processed by any remaining filters (specifically the textile filter).

The string is returned unchanged if there are no remaining filters to guard against.

Apply the desired filters to the page and then render the filtered page into the desired layout. The filters to apply to the page are determined from the page‘s meta-data. The layout to use is also determined from the page‘s meta-data.

Returns true if there is a next page to render. Returns false if there is no next page or if pagination has not been configured for the current page.

Render the layout for the given resource. If the resource does not have a layout, then this method returns immediately.

Apply the desired filters to the page. The filters to apply are determined from the page‘s meta-data.

Render the given partial into the current page. The :locals are a hash of key / value pairs that will be set as local variables in the scope of the partial when it is rendered.

Keep track of the page rendering for the given path. The block is where the the page will be rendered.

This method keeps a stack of the current pages being rendeered. It looks for duplicates in the stack — an indication of a rendering loop. When a rendering loop is detected, an error is raised.

This method returns whatever is returned from the block.

Returns the current binding for the renderer.

Iterate the given block for each item selected from the items array using the given number of items per_page. The first time the page is rendered, the items passed to the block are selected using the range (0...per_page). The next rendering selects (per_page...2*per_page). This continues until all items have been paginated.

Calling this method creates a @pager object that can be accessed from the page. The @pager contains information about the next page, the current page number, the previous page, and the number of items in the current page.

Render the given resource (a page or a partial) and return the results as a string. If a resource is not given, then the options hash should contain the name of a partial to render (:partial => ‘name’).

When a partial name is given, the partial is found by looking in the directory of the current page being rendered. Otherwise, the full path to the partial can be given.

If a :guard option is given as true, then the resulting string will be protected from processing by subsequent filters. Currently this only protects against the textile filter.

When rendering partials, local variables can be passed to the partial by setting them in hash passed as the :locals option.

Options

:partial<String>:The partial to render
:locals<Hash>:Locals values to define when rendering a partial
:guard<Boolean>:Prevents the resulting string from being processed by subsequent filters (only textile for now)

Returns

A string that is the rendered page or partial.

Examples

   # render the partial "foo" using the given local variables
   render( :partial => "foo", :locals => {:bar => "value for bar"} )

   # find another page and render it into this page and protect the
   # resulting contents from further filters
   page = @pages.find( :title => "Chicken Coop" )
   render( page, :guard => true )

   # find a partial and render it using the given local variables
   partial = @partials.find( :filename => "foo", :in_directory => "/path" )
   render( partial, :locals => {:baz => "baztastic"} )

This method is being deprecated. It is being made internal to the framework and really shouldn‘t be used anymore.

This method is being deprecated. Please use the render method instead.

[Validate]