Project / February 12, 2009

auto_html plugin

By Dejan Simic/1836 Views/2 Comments

If you don't want to bother visitors with rich HTML editor or markup code, but you still want to allow them to embed youtube video, images, links and stuff like that on your site, purely by pasting URL, check out auto_html Rails plugin. See the live demo.

script/plugin install git://github.com/dejan/auto_html.git

Let's say you have model Comment with attribute body. Create another column in database called body_html. Now have something like this:

class Comment < ActiveRecord::Base
  auto_html_for(:body) do
    html_escape
    youtube(:width => 400, :height => 250)
    image
    link(:target => "_blank", :rel => "nofollow")
    simple_format
  end
end

... and you'll have this behaviour:

Comment.create(:body => 'Hey check out this cool video: http://www.youtube.com/watch?v=WdsGihou8J4')  
=> #<Comment id: 123, body: 'Hey check out this cool video: http://www.youtube.com/watch?v=WdsGihou8J4', body_html: '<p>Hey check out this cool video: <object height="250" width="400"><param name="movie" value="http://www.youtube.com/v/WdsGihou8J4" /><param name="wmode" value="transparent" /><embed src="http://www.youtube.com/v/WdsGihou8J4" type="application/x-shockwave-flash" height="250" wmode="transparent" width="400"></embed></object></p>'>

Note that order of invoking filters is important, ie. you want html_escape as first and link amongst last, so that it doesn't transform youtube URL to plain link.

Now all you have to do is to display it in template without escaping, since plugin took care of that.

<% for comment in @comments %>
   <li><%= comment.body_html %></li>
<% end %>

If you need to display preview, no problem. Have something like this as action in your controller:

  def preview
    comment = Comment.new(params[:comment])
    comment.auto_html_prepare
    render :text => comment.body_html
  end

Plugin is highly customizable, and you can easily create new filters that will transform user input any way you like. For instance, this is the filter for youtube that comes bundled with plugin:

AutoHtml.add_filter(:youtube).with(:width => 390, :height => 250) do |text, options|
  text.gsub(/http:\/\/www.youtube\.com\/watch\?v=([^&\n]+)/) do
    youtube_id = $1
    %{<object height="#{options[:height]}" width="#{options[:width]}"><param name="movie" value="http://www.youtube.com/v/#{youtube_id}" /><param name="wmode" value="transparent" /><embed src="http://www.youtube.com/v/#{youtube_id}" type="application/x-shockwave-flash" height="#{options[:height]}" wmode="transparent" width="#{options[:width]}"></embed></object>}
  end
end

If you want to contribute new filters or enhance existing ones, you can do that on github.

Comments

Posted by nacho on 11 months ago5b06e0980b0ecc3c2388f9ec7c2cc6f1?s=30

great idea, i'm going to test it now
thanks

Posted by Matt Hooks on 10 months agoCacb3e93b8acde0219ad4eb099205a82?s=30

Diggin' this.

Add a Comment