NeatIds

Generate neat, Stripe-style prefixed IDs for your models with Sqids. Works with numeric OR UUID-esque primary keys!

Heavily inspired by prefixed_ids

How to use my plugin.

Add this line to your application's Gemfile:

gem "neat_ids"

And then execute:

$ bundle

Or install it yourself as:

$ gem install neat_ids

Add has_neat_id :my_prefix to your models (before you define any associations!!) to autogenerate Neat IDs.

class User < ApplicationRecord
  has_neat_id :user
end

By default, Neat IDs overrides to_param in the model to use Neat IDs.

To get the Neat ID for a record:

@user.to_param
#=> "user_12345abcd"

If to_param override is disabled:

@user.neat_id
#=> "user_12345abcd"

By default, neat_ids overrides find and to_param to seamlessly URLs automatically.

User.first.to_param
#=> "user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe"

User.find("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe")
#=> #<User>

You can also use find_by_neat_id or find_by_neat_id! when the find override is disabled:

User.find_by_neat_id("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe") # Returns a User or nil
User.find_by_neat_id!("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe") # Raises an exception if not found

To disable find and to_param overrides, pass the following options:

class User < ApplicationRecord
  has_neat_id :user, override_find: false, override_param: false
end

Imagine you have a Neat ID but you don't know which model it belongs to:

NeatIds.find("user_5vJjbzXq9KrLEMm3")
#=> #<User>

NeatIds.find("acct_2iAnOP0xGDYk6dpe")
#=> #<Account>

This works similarly to GlobalIDs.

You can customize the prefix, length, and attribute name for NeatIds.

class Account < ApplicationRecord
  has_neat_id :acct, minimum_length: 32, override_find: false, override_param: false, fallback: false
end

By default, find will accept both Neat IDs and regular IDs. Setting fallback: false will disable finding by regular IDs and will only allow Neat IDs.

Bug reports and pull requests are welcome on GitHub at https://github.com/braddoeswebdev/neat_ids.

Contributors are expected to adhere to the code of conduct.

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