stealth_dom_id

stealth_dom_id extends Rails' dom_id helper to generate DOM IDs using an alternative attribute instead of database primary keys. This helps prevent exposing internal database IDs

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add stealth_dom_id

If bundler is not being used to manage dependencies, install the gem by executing:

gem install stealth_dom_id

Usage

This gem extends Rails' dom_id helper to use an alternative attribute instead of exposing database IDs in your HTML elements.

Instead of:

<%= dom_id(@user) %>
# => "user_1"

You can use:

<%= dom_id(@user, attribute: :public_id) %>
# => "user_a1b2c3"

attribute is optional, it defaults to the primary_key. Just like with Rails' dom_id, the prefix attribute is also supported.

<%= dom_id(@user, :admin, attribute: :public_id) %>
# => "admin_user_a1b2c3"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

License

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