class LoggableActivity::Activity

Returns a list of activities for a given actor.

# File lib/loggable_activity/activity.rb, line 214
def self.activities_for_actor(actor, limit = 20, params = { offset: 0 })
  LoggableActivity::Activity.latest(limit, params).where(actor:)
end

Returns the last activity.

# File lib/loggable_activity/activity.rb, line 230
def self.last(limit = 1)
  return latest(1).first if limit == 1

  latest(limit)
end

Returns a list of activities ordered by creation date.

# File lib/loggable_activity/activity.rb, line 219
def self.latest(limit = 20, params = { offset: 0 })
  offset = params[:offset] || 0
  LoggableActivity::Activity
    .all
    .order(created_at: :desc)
    .includes(:payloads)
    .offset(offset)
    .limit(limit)
end

Returns the display name for a actor. what method to use if defined in ‘/config/loggable_activity.yaml’

Example:

@activity.actor_display_name

Returns:

"Elvis Presley"

# File lib/loggable_activity/activity.rb, line 207
def actor_display_name
  return I18n.t('loggable.activity.deleted') if encrypted_actor_display_name.nil?

  LoggableActivity::Encryption.decrypt(encrypted_actor_display_name, actor_key)
end

Returns a list of attributes of the activity includig the indliced relations. The included relations are devined in the ‘config/loggable_activity.yaml’ file. The attributes are packed in a way that they can be used to display the activity in the UI.

Example:

@activity.attrs

Returns:

 [
   {
     record_class: "User",
     payload_type: "primary_payload",
     attrs: {
       "first_name" => "David",
       "last_name" => "Bowie",
       "age" => "69",
       "email" => "david@example.com",
       "user_type" => "Patient"
     }
   },
   {
     record_class: "Demo::UserProfile",
     payload_type: "current_association",
     attrs: {
       "sex" => "Male",
       "religion" => "Agnostic"
     }
   },
   {
     record_class: "Demo::Address",
     payload_type: "current_association",
     attrs: {
       "street" => "Eiffel Tower",
       "city" => "Paris",
       "country" => "France",
       "postal_code" => "75007"
     }
   },
   {
     record_class: "Demo::Club",
     payload_type: "current_association",
     attrs: {
       "name" => "Mystic Fusion Lounge"
     }
   }
]

# File lib/loggable_activity/activity.rb, line 68
def attrs
  ordered_payloads.map do |payload|
    {
      record_class: payload.record_type,
      payload_type: payload.payload_type,
      attrs: payload.attrs
    }
  end
end

Returns the attributes for the primary payload, without the relations.

Example:

@activity.primary_payload_attrs

Returns:

{
    "first_name" => "David",
    "last_name" => "Bowie",
          "age" => "69",
        "email" => "david@example.com",
    "user_type" => "Patient"
}

# File lib/loggable_activity/activity.rb, line 154
def primary_payload_attrs
  primary_payload ? primary_payload.attrs : {}
end

Returns the display name for a record. what method to use if defined in ‘/config/loggable_activity.yaml’

Example:

@activity.record_display_name

Returns:

"David Bowie"

# File lib/loggable_activity/activity.rb, line 192
def record_display_name
  return I18n.t('loggable.activity.deleted') if encrypted_record_display_name.nil?

  LoggableActivity::Encryption.decrypt(encrypted_record_display_name, record_key)
end

Returns the attributes for the relations.

Example:

@activity.relations_attrs

Returns:

[
  {
    record_class: "Demo::Address",
    # Current association payload type
    payload_type: "current_association",
    # Current attributes for Demo::Address
    attrs: {
      "street" => "The Palace of Versailles",
      "city" => "Versailles",
      "country" => "France",
      "postal_code" => "78000"
    }
  }
]

# File lib/loggable_activity/activity.rb, line 179
def relations_attrs
  attrs.filter { |p| p[:payload_type] == 'current_association' }
end

Returns the attributes of an upddate activity.

Example:

@activity.update_activity_attrs

Returns:

{
  # Update attributes for Demo::Club
  update_attrs: {
    record_class: "Demo::Club",
    attrs: [
      {
        "name" => {
          # Previous name
          from: "Electric Oasis Club",
          # New name
          to: "Electric Oasis Club nr 5"
        }
      }
    ]
  },
  # Updated relations attributes
  updated_relations_attrs: [
    {
      record_class: "Demo::Address",
      previous_attrs: {
        # Record class
        record_class: "Demo::Address",
        # Previous association payload type
        payload_type: "previous_association",
        # Previous attributes for Demo::Address
        attrs: {
          "street" => "Ice Hotel, Marknadsvägen 63",
          "city" => "Jukkasjärvi",
          "country" => "Sweden",
          "postal_code" => "981 91"
        }
      },
      current_attrs: {
        record_class: "Demo::Address",
        # Current association payload type
        payload_type: "current_association",
        # Current attributes for Demo::Address
        attrs: {
          "street" => "The Palace of Versailles",
          "city" => "Versailles",
          "country" => "France",
          "postal_code" => "78000"
        }
      }
    }
  ]
}

# File lib/loggable_activity/activity.rb, line 132
def update_activity_attrs
  {
    update_attrs:,
    updated_relations_attrs:
  }
end