loofah-activerecord¶ ↑

Description¶ ↑

loofah-activerecord extends loofah‘s HTML sanitization into Rails ActiveRecord models.

See more about loofah at: github.com/flavorjones/loofah

Features¶ ↑

There are two ActiveRecord extensions included with loofah-activerecord:

Loofah::ActiveRecordExtension is an opt-in sanitizer. You must explicitly declare attributes to be sanitized.
Loofah::XssFoliate, a drop-in replacement for XssTerminate, is an opt-out sanitizer. By default all models and attributes are sanitized.

ActiveRecord Extension #1: Opt-In¶ ↑

See Loofah::ActiveRecordExtension for full documentation. The class methods mixed into ActiveRecord are:

html_document
html_fragment

which are used to declare how specific string and text attributes should be scrubbed during before_validation.

# app/model/post.rb
class Post < ActiveRecord::Base
  html_fragment :body, :scrub => :prune  # scrubs `body` using the :prune scrubber
end

ActiveRecord Extension #2: Opt-Out¶ ↑

See Loofah::XssFoliate::ClassMethods for more documentation. The class methods mixed into ActiveRecord are:

xss_foliate
xss_foliated?

which are used to declare how specific string and text attributes should be scrubbed during before_validation.

Attributes are scrubbed with the :strip scrubber by default, unless another scrubber is specified or the attribute is present in an :except clause.

Requirements¶ ↑

Loofah >= 1.0.0
Rails 3.2, 3.1, 3.0, 2.3, 2.2, 2.1, 2.0 or 1.2 (pow!)

Installation¶ ↑

Unsurprisingly:

gem install loofah-activerecord

Support¶ ↑

The bug tracker is available here:

github.com/flavorjones/loofah-activerecord/issues

And the mailing list is on librelist (the general Loofah mailing list):

[email protected] / librelist.com

And the IRC channel is #loofah on freenode.

Loofah: github.com/flavorjones/loofah
XssTerminate: github.com/look/xss_terminate/tree/master

Authors¶ ↑

Mike Dalessio (@flavorjones)

Featuring code contributed by:

Josh Nichols
Damon P. Cortesi

Historical Note¶ ↑

This library was split out of the Loofah project for version 1.0.0.

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.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

yesmeck / loofah-activerecord Goto Github PK