ApplicationRecord (model) debug_id method

application_record.rb

class ApplicationRecord < ActiveRecord::Base
  self.abstract_class = true

  # Returns a string to be used in log messages.
  # Concats the object's class name w/ it's id, so we can easely
  # identify and search for the object in log messages.
  #
  # Example:
  #
  # user = User.new(id: 25)
  # logger.info "Failed to save #{user.debug_id}"
  # => "Failed to save User#25"
  def debug_id
    object_id = self.persisted? ? self.id : 'new'

    "#{self.class.name}##{object_id}"
  end
end

This method is specially useful for displaying the object's id in log
messages.

It will return the object's class name w/ its id.

It makes the object easily identifiable and searchable, without having
to always manually log what object we are logging.

Usage example:

user = User.new(id: 25)
logger.info "Failed to save #{user.debug_id}"
=> "Failed to save User#25"