PublicActivity

If no view template is found, the gem falls back to I18n translations. You can render pure I18n strings by passing {display: :i18n} to the render methods. Define translations in your locale .yml files using the activity key structure.

activity:
  article:
    create: 'Article has been created'
    update: 'Someone has edited the article'
    destroy: 'Some user removed an article!'

To test with RSpec, you can disable public_activity in rails_helper.rb and use PublicActivity.with_tracking or PublicActivity.without_tracking blocks to control tracking during tests.

# rails_helper.rb
require 'public_activity/testing'
PublicActivity.enabled = false

# file_spec.rb
PublicActivity.with_tracking do
  # your test code goes here
end

To enable activity tracking, include PublicActivity::Model and call the tracked method within your model class.

# ActiveRecord
class Article < ActiveRecord::Base
  include PublicActivity::Model
  tracked
end

# Mongoid
class Article
  include Mongoid::Document
  include PublicActivity::Model
  tracked
end

# MongoMapper
class Article
  include MongoMapper::Document
  include PublicActivity::Model
  tracked
end

If you are using ActiveRecord, you must generate and run the migration for the activities table.

rails g public_activity:migration
rake db:migrate

By default, public_activity uses ActiveRecord. To use Mongoid or MongoMapper, create an initializer file at config/initializers/public_activity.rb and set the ORM.

# For Mongoid
PublicActivity::Config.set do
  orm :mongoid
end

# For MongoMapper
PublicActivity::Config.set do
  orm :mongo_mapper
end

You can manually trigger custom activities on a tracked model using the create_activity method. You can specify a key and an owner.

@article.create_activity key: 'article.commented_on', owner: current_user

Use PublicActivity::Config.set with a block to configure the ORM, activity tracking status, and the activity table name. This is typically used in a Rails initializer (e.g., config/initializers/public_activity.rb).

PublicActivity::Config.set do
  orm :mongo_mapper
  enabled false
  table_name "activities"
end