render_radiant 0.0.1

data/README.md

@@ -0,0 +1,63 @@
+= RenderRadiant
+
+== SYNOPSIS
+
+RenderRadiant adds a :radiant option to ActionController::Base's render method, giving actions in your extension controller the ability to use Radiant for rendering pages. The page's context is set based on instance variables you define in the action. "flash", "params" and locals you pass in using the :locals option are also available from the page's context.globals to be used by your Radius tags.
+
+The page to render is deduced from the requested URL or the passed in :action option.
+
+== INSTALL
+
+    gem install render_radiant
+
+Require 'render_radiant' in your Radiant extension's extension_config.
+
+== USAGE
+
+In your extension's controller, use the render :radiant command:
+
+    EventsController < ActionController::Base
+
+      def index
+        @events = Event.all
+        render :radiant
+      end
+
+      def show
+        @event = Event.find(params[:id])
+        render :radiant, :locals => { :cool_event => @event.cool? }
+      end
+
+    end
+
+Page attributes can be overridden and/or set by passing in the page hash:
+
+   render :radiant, :page => { :title => @event.name }
+
+By default all instance variables declared in the action are assigned to the Radiant page's context to be called from your Radius tags.
+
+The url matching the controller and action name is used for rendering.
+
+To use a different url for rendering, pass in the :action option:
+
+    render :radiant, :action => 'myaction'
+
+You will want to create a page tree in Radiant with slugs that match the actions in your controller that will be rendered. If a corresponding Radiant page is not found, the 404 page is rendered.
+
+=== Controller to Radiant Page Mapping
+
+render_radiant assumes the Radiant page used for rendering will match the URL of the request. So, for example, in an EventsController, the "index" action will use Page.find_by_url('/events') to fetch the index page for that request.
+
+=== Loading Context
+
+render_radiant loads instance variables defined in the action, locals passed in via the :locals option hash, and values from the "flash" and "params" methods into the page's context.globals to be called from your Radius tags.
+
+So if you define the variable @events in your EventsController's "index" action, the data will be available to radius in tag.locals.events during rendering.
+
+=== Overriding Default Page Values
+
+Currently render_radiant will override the page's title by passing in the :title option.
+
+== RAILS 3 POSSIBILITIES
+
+Currently only Rails 2.3.8 (which is used by the current version of Radiant) is used. However, once Radiant adopts Rails 3, a custom Radiant renderer can be built, therefore making monkey-patching ActionController::Base unnecessary: http://www.engineyard.com/blog/2010/render-options-in-rails-3/

data/lib/render_radiant.rb

@@ -0,0 +1,136 @@
+module RenderRadiant
+
+  RADIANT_DEFAULT_METHOD_ASSIGNS = [:flash, :params]
+
+  # Override the default render method to render for Radiant
+  def self.included(kls)
+    kls.send(:alias_method_chain, :render, :render_radiant)
+  end
+
+  # Use Radiant to render the page matching the passed in URL.
+  #
+  # Usage:
+  #
+  #   EventsController < ActionController::Base
+  #
+  #     def index
+  #       @events = Event.all
+  #       render :radiant
+  #     end
+  #
+  #     def show
+  #       @event = Event.find(params[:id])
+  #       render :radiant, :locals => { :cool_event => @event.cool? }
+  #     end
+  #
+  #   end
+  #
+  # Page attributes can be overridden and/or set by passing in through the
+  # :radiant options hash:
+  #
+  #   render :radiant => { :title => @event.name }
+  #
+  # By default all instance variables declared in the action are assigned
+  # to the Radiant page's context to be called from your Radius tags.
+  #
+  # The url matching the controller and action name is used for rendering.
+  #
+  # To use a different url for rendering, pass in the :action option:
+  #
+  #   render :radiant, :action => 'myaction'
+  #
+  # Of course you will need to create a page tree in Radiant that matches
+  # the url of the page you are wanting to render.
+  #
+  def render_with_render_radiant(options = nil, extra_options = {}, &block)
+    if options &&
+       ( (options.is_a?(Symbol) && options == :radiant) ||
+         (options.is_a?(Hash) && options.keys.first == :radiant) )
+
+      # Bringing this in from original render
+      raise DoubleRenderError, "Can only render or redirect once per action" if performed?
+      validate_render_arguments(options, extra_options, block_given?)
+
+      options = options[:radiant]
+
+      # Retrieve the action and controller to form a URL
+      split_action = extra_options[:action].split('/') if extra_options[:action]
+      if split_action
+        action, controller = split_action
+      else
+        action, controller = params[:action], params[:controller]
+      end
+
+      # Assume the URL will be formatted like /controller_name/action_name or
+      # /controller_name if calling the index action
+      url = "/#{controller}"
+      url << "/#{action}" if action != 'index'
+
+      page = Page.find_by_url(url)
+
+      # Collect page overrides
+      # Set cache to false by default
+      page_overrides = {
+        :cache => false
+      }
+
+      page_overrides.merge!(options) if options
+
+      # Override the page instance with any passed in customizations
+      page_overrides.each do |k,v|
+        blk = proc { v }
+        kls = (class << page; self; end)
+        kls.send(:define_method, k, blk)
+      end
+
+      render_for_radiant(page, extra_options[:locals])
+    else
+      render_without_render_radiant(options, extra_options, &block)
+    end
+  end
+
+  def render_for_radiant(page, local_assigns)
+
+    # Collect values to assign
+    values = {}
+
+    # Collect values returned from methods
+    RADIANT_DEFAULT_METHOD_ASSIGNS.each do |m|
+      values[m] = self.send(m)
+    end
+
+    # Collect values assigned via the locals option
+    local_assigns ||= {}
+    local_assigns.each do |name, value|
+      values[name] = value
+    end
+
+    # Collect ivars from the action
+    ivars = self.instance_variable_names
+    ivars -= self.protected_instance_variables
+    ivars.each do |name|
+      values[name.gsub(/@/,'')] = self.instance_variable_get(name)
+    end
+
+    # Assign each value to the page context
+    page.send(:lazy_initialize_parser_and_context)
+    context = page.instance_variable_get(:@context)
+    values.each do |k,v|
+      context.globals.send "#{k}=", v
+    end
+
+    # WillPaginate loves this
+    page.instance_variable_set(
+      :@url,
+      ActionController::UrlRewriter.new(request, params.clone)
+    )
+
+    # Let ActionController know we're rendering the page
+    @performed_render = true
+
+    page.process(request, response)
+  end
+
+end
+
+ActionController::Base.send(:include, RenderRadiant)

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: render_radiant
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chase James
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+description: RenderRadiant allows you to send variables and other settings declared in your action to be rendered in Radiant.
+email: nx@nu-ex.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/render_radiant.rb
+has_rdoc: true
+homepage: http://github.com/nuex/render_radiant
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: render_radiant
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActionController overrides for using Radiant for rendering
+test_files: []
+