https://github.com/rails-designer/stealth_dom_id

Extends Rails `dom_id` helper to support custom attribute-based identifiers
https://github.com/rails-designer/stealth_dom_id

gem rails ruby

Last synced: 17 days ago
JSON representation

Extends Rails `dom_id` helper to support custom attribute-based identifiers

• Host: GitHub
• URL: https://github.com/rails-designer/stealth_dom_id
• Owner: Rails-Designer
• License: mit
• Created: 2024-11-04T09:42:45.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-30T11:30:50.000Z (2 months ago)
• Last Synced: 2025-01-19T16:04:22.917Z (18 days ago)
• Topics: gem, rails, ruby
• Language: Ruby
• Homepage:
• Size: 28.3 KB
• Stars: 22
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# stealth_dom_id

stealth_dom_id extends Rails' [`dom_id`](https://github.com/rails/rails/blob/main/actionview/lib/action_view/record_identifier.rb) 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:

```bash

bundle add stealth_dom_id

```

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

```bash

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:

```erb

<%= dom_id(@user) %>

# => "user_1"

```

You can use:

```erb

<%= 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.

```erb

<%= 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](https://opensource.org/licenses/MIT).