https://github.com/altmetric/decontaminator

Ruby HTML sanitizer based on a lightweight Oga parser.
https://github.com/altmetric/decontaminator

Last synced: 2 days ago
JSON representation

Ruby HTML sanitizer based on a lightweight Oga parser.

• Host: GitHub
• URL: https://github.com/altmetric/decontaminator
• Owner: altmetric
• License: mit
• Created: 2015-08-13T13:55:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-20T16:10:18.000Z (over 6 years ago)
• Last Synced: 2024-10-31T13:18:38.241Z (13 days ago)
• Language: Ruby
• Homepage:
• Size: 15.6 KB
• Stars: 39
• Watchers: 14
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Decontaminator [![Build Status](https://travis-ci.org/altmetric/decontaminator.svg?branch=master)](https://travis-ci.org/altmetric/decontaminator)

Ruby HTML sanitizer based on a lightweight Oga parser.

**Current version:** 1.0.2

**Supported Ruby versions:** 1.9.3, 2.0, 2.1, 2.2, JRuby 1.7, and Rubinius 2.5

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'decontaminator'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install decontaminator

## Usage

```ruby

require 'decontaminator'

input = '
Heading
Lorem ipsum...
alert(1)'

fragment = Decontaminator::Fragment.new(input)

puts fragment.decontaminate.inspect

" Heading  Lorem ipsum... "

```


## Contributing

1. Fork it ( https://github.com/altmetric/decontaminator/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## License

Copyright © 2015-2018 Altmetric LLP

Distributed under the [MIT license](https://github.com/altmetric/decontaminator/blob/master/LICENSE.txt).