class method
self.add
Ruby on Rails 8.0.4
Since v3.0.20Signature
self.add(key, &block)
Adds a new renderer to call within controller actions. A renderer is invoked by passing its name as an option to AbstractController::Rendering#render. To create a renderer pass it a name and a block. The block takes two arguments, the first is the value paired with its key and the second is the remaining hash of options passed to render.
Create a csv renderer:
ActionController::Renderers.add :csv do |obj, options| filename = options[:filename] || 'data' str = obj.respond_to?(:to_csv) ? obj.to_csv : obj.to_s send_data str, type: Mime[:csv], disposition: "attachment; filename=#{filename}.csv" end
Note that we used Mime for the csv mime type as it comes with Rails. For a custom renderer, you’ll need to register a mime type with Mime::Type.register.
To use the csv renderer in a controller action:
def show @csvable = Csvable.find(params[:id]) respond_to do |format| format.html format.csv { render csv: @csvable, filename: @csvable.name } end end
Parameters
-
keyreq -
blockblock
Source
# File actionpack/lib/action_controller/metal/renderers.rb, line 73
def self.add(key, &block)
define_method(_render_with_renderer_method_name(key), &block)
RENDERERS << key.to_sym
end
Defined in actionpack/lib/action_controller/metal/renderers.rb line 73
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActionController::Renderers