Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schpet/cool_id
generate ids for your rails records that have a prefix indicating what model they belong to, followed by a nanoid
https://github.com/schpet/cool_id
gem graphql nanoid rails
Last synced: 10 days ago
JSON representation
generate ids for your rails records that have a prefix indicating what model they belong to, followed by a nanoid
- Host: GitHub
- URL: https://github.com/schpet/cool_id
- Owner: schpet
- License: isc
- Created: 2024-08-16T14:56:44.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-09-08T15:13:09.000Z (13 days ago)
- Last Synced: 2024-09-09T16:36:04.081Z (12 days ago)
- Topics: gem, graphql, nanoid, rails
- Language: Ruby
- Homepage: https://coolid.schpet.com
- Size: 52.7 KB
- Stars: 43
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cool id
gem for rails apps to generate string ids with a prefix, followed by a [nanoid](https://zelark.github.io/nano-id-cc/). similar to the ids you see in stripe's api. also able to lookup any record by id, similar to rails' globalid. there's an [introductory blog post](https://schpet.com/note/cool-id) explaining why i made this.
## usage
### basic id generation
```ruby
class User < ActiveRecord::Base
include CoolId::Model
cool_id prefix: "usr"
end
User.create!(name: "...").id
# => "usr_vktd1b5v84lr"
```
### locate records
```ruby
CoolId.locate("usr_vktd1b5v84lr")
# => #
```
### generate ids
e.g. for batch inserts or upserts
```ruby
User.generate_cool_id
# => "usr_vktd1b5v84lr"
```
### parsing ids
```ruby
parsed = CoolId.parse("usr_vktd1b5v84lr")
# => #
parsed.model_class
# => User
```
### configuration options
it takes parameters to change the alphabet or length
```ruby
class Customer < ActiveRecord::Base
include CoolId::Model
cool_id prefix: "cus", alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ", length: 8
end
Customer.create!(name: "...").id
# => "cus_UHNYBINU"
```
and these can be configured globally
```ruby
CoolId.configure do |config|
config.separator = "-"
config.alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
config.length = 8
end
```
#### using a different id field
you can use cool_id with a separate field, keeping the default primary key:
```ruby
class Product < ActiveRecord::Base
include CoolId::Model
cool_id prefix: "prd", id_field: :public_id
end
product = Product.create!(name: "Cool Product")
product.id # => 1 (or a uuid or whatever primary key you like)
product.public_id # => "prd_vktd1b5v84lr"
# locate will find this
CoolId.locate("prd_vktd1b5v84lr") # => #
```
this approach allows you to avoid exposing your primary keys, read David Bryant Copeland's [Create public-facing unique keys alongside your primary keys](https://naildrivin5.com/blog/2024/08/26/create-public-facing-unique-keys-alongside-your-primary-keys.html) to learn why you might want to do this. it also allows you to adopt cool_id more easily in a project that already has some data.
## installation
add cool_id to your Gemfile:
```bash
bundle add cool_id
```
```ruby
gem "cool_id"
```
don't want to deal with a dependency? copy it into your project:
```
mkdir -p app/lib
curl https://raw.githubusercontent.com/schpet/cool_id/main/lib/cool_id.rb -o app/lib/cool_id.rb
```
### adding cool_id to a single model
use string ids when creating a table
```ruby
create_table :users, id: :string do |t|
t.string :name
end
```
include the `CoolId::Model` concern in the active record model and set up a prefix
```ruby
class User < ActiveRecord::Base
include CoolId::Model
cool_id prefix: "usr"
end
```
note: if you prefer more traditional primary keys (like bigints or uuids) you can use the `id_field` on a different column.
### using cool_id on all models
you have drank the coolaid. setup rails to use string ids on all new generated migrations
```ruby
# config/initializers/generators.rb
Rails.application.config.generators do |g|
g.orm :active_record, primary_key_type: :string
end
```
then setup `ApplicationRecord` to include cool id and ensure it's setup in classes that inherit from it
```ruby
# app/models/application_record.rb
class ApplicationRecord < ActiveRecord::Base
include CoolId::Model
primary_abstract_class
enforce_cool_id_for_descendants
end
```
### graphql
if you use the graphql ruby node interface, you can implement [object identification](https://graphql-ruby.org/schema/object_identification)
```ruby
# app/graphql/app_schema.rb
class AppSchema < GraphQL::Schema
def self.id_from_object(object, type_definition, query_ctx)
object.id
end
def self.object_from_id(id, query_ctx)
CoolId.locate(id)
end
end
```