How to use unread gem with multiple types of readers, like users and admins?

Define acts_as_reader on different models, such as User and Admin, and use polymorphic associations. The gem supports this via reader_type and readable_type columns in the read_marks table, allowing flexible tracking across models.

What's better for read tracking: unread gem or a simple boolean column?

Unread is better for scalability and performance with large datasets, as it uses efficient joins and avoids bloating records with user-specific columns. Boolean columns are simpler but can lead to table sprawl and slower queries as users grow.

How does unread handle concurrency when multiple users mark items as read?

It relies on ActiveRecord's transaction mechanisms and database constraints, but concurrent updates might cause race conditions. The README doesn't address this explicitly, so you may need to add database-level locks or retry logic for critical operations.

Can I integrate unread with Rails API-only applications?

Yes, it works with Rails API mode as it's model-based and doesn't depend on views. However, you'll need to handle the migrations and ensure your API endpoints use the provided scopes and methods appropriately.

How to implement read receipts for chat messages using unread?

Use the have_read and have_not_read scopes on user models to query who has read a message. Combine this with real-time updates via WebSockets or polling to sync read statuses, but note that unread itself doesn't provide real-time features.

What happens if I delete a record that has read_marks entries?

You need to handle cleanup manually, as the gem doesn't automatically cascade deletes. The README suggests using cleanup_read_marks! in a cron job, but for immediate cleanup, you should add dependent: :destroy or similar callbacks in your models.

Open-Awesome

Unread

MITRubyv0.14.0

A Ruby on Rails gem to manage read/unread status of ActiveRecord objects with high performance.

GitHub

741 stars120 forks0 contributors

What is Unread?

Unread is a Ruby gem that manages read and unread statuses for ActiveRecord objects in Ruby on Rails applications. It solves the problem of tracking which records (like messages, documents, or comments) a user has read, providing scopes and methods to query and update read states efficiently. The gem is designed for performance, using a single additional database table and optimized SQL queries.

Target Audience

Ruby on Rails developers building applications that need to track user read states, such as messaging systems, notification feeds, or content platforms where read/unread status is essential.

Value Proposition

Developers choose Unread for its high performance, simplicity, and scalability. It offers a clean API, minimal database overhead, and efficient queries, making it suitable for large datasets without the complexity of alternative solutions.

Overview

Handle unread records and mark them as read with Ruby on Rails

Use Cases

Best For

Tracking unread messages or notifications in a Rails app
Managing read status for user comments or documents
Building activity feeds with read/unread indicators
Implementing 'mark all as read' functionality efficiently
Handling read states in large-scale Rails applications
Adding read tracking to ActiveRecord models with minimal setup

Not Ideal For

Projects using non-ActiveRecord ORMs like Sequel or Mongoid
Applications requiring real-time read status updates without database queries
Simple apps where read tracking can be handled with session or cache storage
Systems with strict constraints against adding database tables

Pros & Cons

Pros

High Performance

Uses efficient LEFT JOIN queries and a single read_marks table, optimized for large datasets as shown in the README's SQL example.

Flexible Timestamp Control

Configurable 'on' option allows using fields like created_at or updated_at, preventing unwanted unread status changes on record updates.

Clean Scoped API

Provides intuitive scopes like unread_by and read_by, and methods like mark_as_read!, making integration into Rails models straightforward.

Scalable with Cleanup

Includes mark_as_read! :all for bulk operations and cleanup_read_marks! method to manage table growth, though it requires manual maintenance.

Cons

Manual Maintenance Required

The read_marks table can grow indefinitely without regular cleanup, requiring a cron job as admitted in the README, adding operational overhead.

ActiveRecord Lock-in

Only works with ActiveRecord in Rails, not compatible with other Ruby ORMs or frameworks, limiting its use in mixed-stack applications.

Setup Complexity

Requires generating and running a migration, adding database indexes on timestamp fields, and adhering to specific Ruby and Rails version requirements.

Frequently Asked Questions

Related Projects

PaperTrail

Track changes to your rails models

Stars7,024

Forks911

Last commit2 months ago

ActsAsTaggableOn

A tagging plugin for Rails applications that allows for custom tagging along dynamic contexts.

Stars4,992

Forks1,196

Last commit18 days ago

activerecord-import

A library for bulk insertion of data into your database using ActiveRecord.

Stars4,152

Forks618