RailsHtmlValidator

This gem adds the capability of validating HTML to ActiveRecord and ActiveModel.

Installation

Add this line to your application's Gemfile:

gem 'rails_html_validator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rails_html_validator

Usage

class Blog < ActiveRecord::Base
  # standard validation
  validates :body, html: true

  # with exclude tags
  validates :body, html: { exclude_tags: %w(head script style) }
end

With ActiveModel

class Blog
  include ActiveModel::Validations

  attr_accessor :body

  # with legacy syntax (the syntax above works also)
  validates_url :body, html: true
end

Rspec Matcher

RSpec.describe Blog, type: :model do
  it { is_expected.to exclude_html_tag_of :body, tag: :script }
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jiraffeinc/rails_html_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the RailsHtmlValidator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.