Innate::Helper::Render

Public Class Methods

included(into) click to toggle source

Enables you to simply call:

@example of added functionality

YourController.render_partial(:foo, :x => 42)
# File lib/innate/helper/render.rb, line 8
def self.included(into)
  into.extend(self)
end

Public Instance Methods

render_custom(action_name, variables = {}) click to toggle source

@api internal @author manveru

# File lib/innate/helper/render.rb, line 139
def render_custom(action_name, variables = {})
  unless action = resolve(action_name.to_s, :needs_method => false)
    raise(ArgumentError, "No Action %p on #{self}" % [action_name])
  end

  action.sync_variables(self.action)
  action.instance = action.node.new
  action.variables = action.variables.merge(variables)

  yield(action) if block_given?

  valid_action = action.view || action.method
  Log.warn("Empty action: %p" % [action]) unless valid_action
  action.render
end
render_file(filename, variables = {}) click to toggle source

Use the given file as a template and render it in the same scope as the current action. The filename may be an absolute path or relative to the process working directory.

@example usage

path = '/home/manveru/example/app/todo/view/index.xhtml'
render_file(path)
render_file(path, :title => :foo)

Ramaze will emit a warning if you try to render an Action without a method or view template, but will still try to render it. The usual {Action#valid?} doesn’t apply here, as sometimes you just cannot have a method associated with a template.

@api external @see render_custom @author manveru

# File lib/innate/helper/render.rb, line 121
def render_file(filename, variables = {})
  action = Action.create(:view => filename)
  action.sync_variables(self.action)

  action.node      = self.class
  action.engine    = self.action.engine
  action.instance  = action.node.new
  action.variables.merge!(variables)

  yield(action) if block_given?

  valid_action = action.view || action.method
  Log.warn("Empty action: %p" % [action]) unless valid_action
  action.render
end
render_full(path, query = {}) click to toggle source

Renders the full action in the way a real request would.

Please be aware that, if this is the first request from a client, you will not have access to the session in the action being rendered, as no actual session has been put into place yet.

It should work as expected on any subsequent requests.

As usual, patches welcome.

@example usage

render_full('/blog/article/1')
render_full('/blog/article/1', :lang => :de)

Please note that you have to give the full path in the same way you’d do in a direct request with curl or a browser.

@api external @see Mock.session @author manveru

# File lib/innate/helper/render.rb, line 33
def render_full(path, query = {})
  uri       = URI(path.to_s)
  uri.query = Rack::Utils.build_query(query)
  saved     = request, response, session, actions

  if cookie = request.env['HTTP_COOKIE']
    Mock.session do |mock|
      mock.cookie = cookie
      return mock.get(uri.to_s).body
    end
  else
    Mock.get(uri.to_s).body
  end
ensure
  self.request, self.response, self.session, self.actions = saved
end
render_partial(action_name, variables = {}) click to toggle source

Renders an action without any layout. You can further tweak the action to be rendered by passing a block.

@example usage

render_partial(:index)
render_partial(:index, :title => :foo)

Please note that you only have to supply the action name, if your action requires arguments then you have to pass a name suitable for that.

@example usage with action that requires arguments

# requires two arguments
def foo(a, b)
end

# pass two suitable arguments
render_partial('foo/1/2')

@api external @see render_custom @author manveru

# File lib/innate/helper/render.rb, line 74
def render_partial(action_name, variables = {})
  render_custom(action_name, variables) do |action|
    action.layout = nil
    yield(action) if block_given?
  end
end
render_view(action_name, variables = {}) click to toggle source

Renders an action view and does not execute any methods. The rendered view will not be wrapped in a layout and instead will use the layout of the current action. You can further tweak the action to be rendered by passing a block.

@example usage

render_view(:index)
render_view(:index, :title => :foo)

@api external @see render_custom @author manveru

# File lib/innate/helper/render.rb, line 94
def render_view(action_name, variables = {})
  render_custom(action_name, variables) do |action|
    action.layout = nil
    action.method = nil
    yield(action) if block_given?
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.