🧩 ConcernsOnRails

🇻🇳 Note: Hoàng Sa and Trường Sa belong to Việt Nam.

A simple collection of reusable Rails concerns to keep your models clean and DRY.

• ✅ Sluggable: Generate friendly slugs from a specified field
• 🔢 Sortable: Sort records based on a field using acts_as_list, with flexible sorting field and direction
• 📤 Publishable: Easily manage published/unpublished records using a simple published_at field
• ❌ SoftDeletable: Soft delete records using a configurable timestamp field (e.g., deleted_at) with automatic scoping

Add this line to your application's Gemfile:

gem 'concerns_on_rails', github: 'VSN2015/concerns_on_rails'

Then execute:

bundle install

Add slugs based on a specified attribute.

class Post < ApplicationRecord
  include ConcernsOnRails::Sluggable

  sluggable_by :title
end

post = Post.create!(title: "Hello World")
post.slug # => "hello-world"

If the slug source is changed, the slug will auto-update.

Use for models that need ordering.

class Task < ApplicationRecord
  include ConcernsOnRails::Sortable

  sortable_by :position
end

Task.create!(name: "B")
Task.create!(name: "A")
Task.first.name # => "B" (sorted by position ASC)

You can customize the sort field and direction:

class PriorityTask < ApplicationRecord
  include ConcernsOnRails::Sortable

  sortable_by priority: :desc
end

Additional features:

• 📌 Automatically sets acts_as_list on the configured column
• 📋 Adds default sorting scope to your model
• ↕️ Supports custom direction: :asc or :desc
• 🔍 Validates that the sortable field exists in the table schema
• 🧠 Compatible with scopes and ActiveRecord queries
• 🔄 Can be reconfigured dynamically within the model using sortable_by

Manage published/unpublished records using a published_at field.

class Article < ApplicationRecord
  include ConcernsOnRails::Publishable
end

Article.published   # => returns only published articles
Article.unpublished # => returns only unpublished articles

article = Article.create!(title: "Draft")
article.published? # => false

article.publish!
article.published? # => true

article.unpublish!
article.published? # => false

Additional features:

• ✅ published? returns true if published_at is present and in the past
• 🕒 publish! sets published_at to current time
• 🚫 unpublish! sets published_at to nil
• 🔎 Add scopes: .published, .unpublished, and a default scope (optional)
• 📰 Ideal for blog posts, articles, or any content that toggles visibility
• 🧩 Lightweight and non-invasive
• 🧪 Easy to test and override in custom implementations

Soft delete records using a timestamp field (default: deleted_at).

class User < ApplicationRecord
  include ConcernsOnRails::SoftDeletable

  # Optional: customize field and touch behavior
  soft_deletable_by :deleted_at, touch: true
end

User.without_deleted   # => returns only active users
User.soft_deleted      # => returns soft-deleted users
User.active            # => same as without_deleted
User.all               # => returns only non-deleted by default (default_scope applied)

user.soft_delete!      # Soft delete the user (sets deleted_at)
user.deleted?          # => true
user.soft_deleted?     # => true (alias)
user.is_soft_deleted?  # => true (alias)

user.restore!          # Restore the user (sets deleted_at to nil)
user.deleted?          # => false

user.really_delete!    # Hard delete the record from DB

User.destroy_all           # Soft delete all users (sets deleted_at)
User.really_destroy_all    # Hard delete ALL users (removes from DB)

You can use the following hooks to run logic before/after soft delete or restore:

class User < ApplicationRecord
  include ConcernsOnRails::SoftDeletable

  def before_soft_delete
    # Code to run before soft delete
  end

  def after_soft_delete
    # Code to run after soft delete
  end

  def before_restore
    # Code to run before restore
  end

  def after_restore
    # Code to run after restore
  end
end

• Default field is deleted_at, can be changed with soft_deletable_by :your_field
• touch: false to skip updating updated_at when soft deleting/restoring
• Aliases for deleted?: soft_deleted?, is_soft_deleted?
• All scopes and methods work seamlessly with ActiveRecord

To build the gem:

gem build concerns_on_rails.gemspec

To install locally:

gem install ./concerns_on_rails-1.0.0.gem

Bug reports and pull requests are welcome!

This project is licensed under the MIT License.

🇻🇳 Hoàng Sa and Trường Sa belong to Việt Nam.

The source code is available on GitHub:

👉 https://github.com/VSN2015/concerns_on_rails

Feel free to star ⭐️, fork 🍴, or contribute with issues and PRs.