chaps-io/public_activity

View on GitHub
lib/public_activity/orm/active_record/activist.rb

Summary

Maintainability
A
0 mins
Test Coverage
module PublicActivity
  module ORM
    module ActiveRecord
      # Module extending classes that serve as owners
      module Activist
        # Adds ActiveRecord associations to model to simplify fetching
        # so you can list activities performed by the owner.
        # It is completely optional. Any model can be an owner to an activity
        # even without being an explicit activist.
        #
        # == Usage:
        # In model:
        #
        #   class User < ActiveRecord::Base
        #     include PublicActivity::Model
        #     activist
        #   end
        #
        # In controller:
        #   User.first.activities_as_owner
        # or
        #   User.first.activities_as_recipient
        #
        def activist
          has_many :activities_as_owner,
            :class_name => "::PublicActivity::Activity",
            :as => :owner
          has_many :activities_as_recipient,
            :class_name => "::PublicActivity::Activity",
            :as => :recipient
        end
      end
    end
  end
end