has_markup

has_markup is an ActiveRecord plugin that integrates Tidy, Markdown, Textile and sanitize helper method into a single plugin.

Installation

Install the plugin with

script/plugin install git://github.com/fnando/has_markup.git

Install the markup language you want to use. For Markdown, install it using

sudo gem install rdiscount

If you prefer Textile, install it using

sudo gem install RedCloth

To have Tidy support, download the source at http://sourceforge.net/projects/tidy and compile it using

tar xvf tidy4aug00.tgz
cd tidy4aug00
make
sudo make install

There are also binaries for different systems, so find out what's the best one for you!

Usage

All you need to do is call the method has_markup from your model.

class Post < ActiveRecord::Base
  has_markup :content,
    :format       => :markdown,
    :tidy         => true,
    :tags         => %w(p a em strong ul li),
    :attributes   => %w(href)
end

The example above expects the table posts to have two columns: content and formatted_content. This example is also filtering the allowed tags and attributes. If you don't want to limit what will be saved, just go with something like this

class Post < ActiveRecord::Base
  has_markup :content,
    :format       => :textile,
    :tidy         => true
end

To save normalized HTML, if you don't want to use Markdown or Textile, set :format to :html

class Post < ActiveRecord::Base
  has_markup :content,
    :format       => :html,
    :tidy         => true
end

If you don't want the content to be sanitized at all, you can set :sanitize to false. This is specially useful if you're the editor or something like that.

class Post < ActiveRecord::Base
  has_markup :content,
    :format       => :html,
    :sanitize     => false
end

You can instantiate a markup object any time:

markup = Markup.new(:markdown, 'some text')
markup = Markup.new(:textile,  'some text')
puts markup.to_html

To sanitize a given HTML, use the html method:

Sanitize.html('<script>alert(document.cookie)</script>')

Sanitize.html('<script>alert(document.cookie)</script>',
	:tags => %w(p a em strong img ul li ol)
)

Sanitize.html('<script>alert(document.cookie)</script>',
	:attributes => %w(href title alt)
)

To remove all tags, use the strip_tags method:

Sanitize.strip_tags('<strong>PWNED</strong>')

If you want to normalize HTML, you can use

Sanitize.tidy('some text', options)

where options is a hash with all possible tidy arguments. You can check the list here: http://tidy.sourceforge.net/docs/tidy_man.html. Remember to replace - by _.

TIDY NOTES

has_markup will try to discovery where the tidy library is located. You can set it anytime by declaring the constant TIDY_PATH.

When Sanitize.html is called, Tidy is executed twice: before the sanitization process and after the text has been filtered.

Maintainer

Nando Vieira (http://simplesideias.com.br)

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.