Use the EmailMunger gem in your Rails app to encode displayed email addresses on web pages so that they are much less likely to be harvested by bots and bombarded with spam, yet still visible in web browsers. Each character in an email address is converted into its HTML5 UTF-8 character code. Additionally, the '@' and '.' characters are presented in italics. For example, the address
abcdefghijklmnopqrstuvwxyz0123456789@example.com
becomes abcdefghijklmnopqrstuvwxyz0123456789<i>@</i>example<i>.</i>com
Add this line to your application's Gemfile:
gem 'email_munger'
And then execute:
$ bundle
Or install it yourself as:
$ gem install email_munger
To encode the email address abcdefghijklmnopqrstuvwxyz0123456789@example.com in a Ruby environment, enter the following command:
EmailMunger.encode('abcdefghijklmnopqrstuvwxyz0123456789@example.com')
The result is:
abcdefghijklmnopqrstuvwxyz0123456789<i>@</i>example<i>.</i>com
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/email_munger. 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.
The gem is available as open source under the terms of the MIT License.
After you download this source code, enter sh gem_test.sh
to set up and test this gem.
Enter sh code_test.sh
to test the quality of this gem's source code.
Enter sh gem_console.sh
.
Enter sh gem_install.sh
.
Enter sh all.sh
to run the gem_test.sh, code_test.sh, and gem_install.sh scripts.