Module: Loofah

Defined in:
lib/loofah.rb,
lib/loofah/helpers.rb,
lib/loofah/elements.rb,
lib/loofah/scrubber.rb,
lib/loofah/scrubbers.rb,
lib/loofah/html5/scrub.rb,
lib/loofah/metahelpers.rb,
lib/loofah/xml/document.rb,
lib/loofah/html/document.rb,
lib/loofah/html5/whitelist.rb,
lib/loofah/instance_methods.rb,
lib/loofah/xml/document_fragment.rb,
lib/loofah/html/document_fragment.rb

Overview

Strings and IO Objects as Input

Loofah.document and Loofah.fragment accept any IO object in addition to accepting a string. That IO object could be a file, or a socket, or a StringIO, or anything that responds to read and close. Which makes it particularly easy to sanitize mass quantities of docs.

Defined Under Namespace

Modules: DocumentDecorator, Elements, HTML, HTML5, Helpers, MetaHelpers, ScrubBehavior, Scrubbers, TextBehavior, XML Classes: Scrubber, ScrubberNotFound

Constant Summary collapse

VERSION =

The version of Loofah you are using

'2.2.0'

Class Method Summary collapse

Class Method Details

.document(*args, &block) ⇒ Object

Shortcut for Loofah::HTML::Document.parse This method accepts the same parameters as Nokogiri::HTML::Document.parse


35
36
37
# File 'lib/loofah.rb', line 35

def document(*args, &block)
  Loofah::HTML::Document.parse(*args, &block)
end

.fragment(*args, &block) ⇒ Object

Shortcut for Loofah::HTML::DocumentFragment.parse This method accepts the same parameters as Nokogiri::HTML::DocumentFragment.parse


41
42
43
# File 'lib/loofah.rb', line 41

def fragment(*args, &block)
  Loofah::HTML::DocumentFragment.parse(*args, &block)
end

.remove_extraneous_whitespace(string) ⇒ Object

A helper to remove extraneous whitespace from text-ified HTML


78
79
80
# File 'lib/loofah.rb', line 78

def remove_extraneous_whitespace(string)
  string.gsub(/\n\s*\n\s*\n/,"\n\n")
end

.scrub_document(string_or_io, method) ⇒ Object

Shortcut for Loofah.document(string_or_io).scrub!(method)


51
52
53
# File 'lib/loofah.rb', line 51

def scrub_document(string_or_io, method)
  Loofah.document(string_or_io).scrub!(method)
end

.scrub_fragment(string_or_io, method) ⇒ Object

Shortcut for Loofah.fragment(string_or_io).scrub!(method)


46
47
48
# File 'lib/loofah.rb', line 46

def scrub_fragment(string_or_io, method)
  Loofah.fragment(string_or_io).scrub!(method)
end

.scrub_xml_document(string_or_io, method) ⇒ Object

Shortcut for Loofah.xml_document(string_or_io).scrub!(method)


73
74
75
# File 'lib/loofah.rb', line 73

def scrub_xml_document(string_or_io, method)
  Loofah.xml_document(string_or_io).scrub!(method)
end

.scrub_xml_fragment(string_or_io, method) ⇒ Object

Shortcut for Loofah.xml_fragment(string_or_io).scrub!(method)


68
69
70
# File 'lib/loofah.rb', line 68

def scrub_xml_fragment(string_or_io, method)
  Loofah.xml_fragment(string_or_io).scrub!(method)
end

.xml_document(*args, &block) ⇒ Object

Shortcut for Loofah::XML::Document.parse This method accepts the same parameters as Nokogiri::XML::Document.parse


57
58
59
# File 'lib/loofah.rb', line 57

def xml_document(*args, &block)
  Loofah::XML::Document.parse(*args, &block)
end

.xml_fragment(*args, &block) ⇒ Object

Shortcut for Loofah::XML::DocumentFragment.parse This method accepts the same parameters as Nokogiri::XML::DocumentFragment.parse


63
64
65
# File 'lib/loofah.rb', line 63

def xml_fragment(*args, &block)
  Loofah::XML::DocumentFragment.parse(*args, &block)
end