https://github.com/altmetric/decontaminator
Ruby HTML sanitizer based on a lightweight Oga parser.
https://github.com/altmetric/decontaminator
Last synced: 3 months 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 (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-11-29T17:11:41.000Z (7 months ago)
- Last Synced: 2025-03-30T12:07:43.591Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 18.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
Ruby HTML sanitizer based on a lightweight Oga parser.
**Current version:** 1.0.2
**Supported Ruby versions:** >= 2.7
## 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-2024 Altmetric LLP
Distributed under the [MIT license](https://github.com/altmetric/decontaminator/blob/master/LICENSE.txt).