gitcoinco/code_fund_ads

View on GitHub
app/models/comment.rb

Summary

Maintainability
A
0 mins
Test Coverage
# == Schema Information
#
# Table name: comments
#
#  id               :bigint           not null, primary key
#  body             :text
#  commentable_type :string
#  lft              :bigint
#  rgt              :bigint
#  subject          :string
#  title            :string
#  created_at       :datetime         not null
#  updated_at       :datetime         not null
#  commentable_id   :bigint
#  parent_id        :bigint
#  user_id          :bigint           not null
#
# Indexes
#
#  index_comments_on_commentable_id_and_commentable_type  (commentable_id,commentable_type)
#  index_comments_on_user_id                              (user_id)
#

class Comment < ActiveRecord::Base
  # extends ...................................................................
  # class methods .............................................................
  # includes ..................................................................

  # relationships .............................................................
  belongs_to :commentable, polymorphic: true
  belongs_to :user

  # validations ...............................................................
  validates :body, presence: true
  validates :user, presence: true

  # callbacks .................................................................

  # scopes ....................................................................

  # Helper class method to lookup all comments assigned
  # to all commentable types for a given user.
  scope :find_comments_by_user, ->(user) { where(user_id: user.id).order("created_at DESC") }

  # Helper class method to look up all comments for
  # commentable class name and commentable id.
  scope :find_comments_for_commentable, ->(commentable_str, commentable_id) do
    where(commentable_type: commentable_str.to_s, commentable_id: commentable_id).order("created_at DESC")
  end

  # additional config (i.e. accepts_nested_attribute_for etc...) ..............
  acts_as_nested_set scope: [:commentable_id, :commentable_type]
  has_rich_text :content

  # class methods .............................................................
  class << self
    alias by_user find_comments_by_user
    alias for_commentable find_comments_for_commentable

    # Helper class method that allows you to build a comment
    # by passing a commentable object, a user_id, and ActionText content
    # example in readme
    def build_from(obj, user_id, content)
      new \
        commentable: obj,
        body: "#",
        content: content,
        user_id: user_id
    end

    # Helper class method to look up a commentable object
    # given the commentable class name and id
    def find_commentable(commentable_str, commentable_id)
      commentable_str.constantize.find(commentable_id)
    end
  end

  # public instance methods ...................................................

  # helper method to check if a comment has children
  def has_children?
    children.any?
  end

  # protected instance methods ................................................
  # private instance methods ..................................................
end