* Rename banned and comment_banned roles * Add data update script to rename roles containing 'ban' * Add named error for Suspended users * Update unidiomatic method names * Rename misc banned to suspended * Apply suggestions from code review Co-authored-by: Michael Kohl <me@citizen428.net> * Add unit tests for suspended methods This commit also adds TODO comments for removing banned and comment_banned from the codebase after data update scripts have successfully run on all of our Forems. Co-authored-by: Michael Kohl <me@citizen428.net>
172 lines
5.7 KiB
Ruby
172 lines
5.7 KiB
Ruby
class Organization < ApplicationRecord
|
|
include CloudinaryHelper
|
|
|
|
COLOR_HEX_REGEXP = /\A#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})\z/.freeze
|
|
INTEGER_REGEXP = /\A\d+\z/.freeze
|
|
SLUG_REGEXP = /\A[a-zA-Z0-9\-_]+\z/.freeze
|
|
MESSAGES = {
|
|
integer_only: "Integer only. No sign allowed.",
|
|
reserved_word: "%<value>s is a reserved word. Contact site admins for help registering your organization."
|
|
}.freeze
|
|
|
|
acts_as_followable
|
|
|
|
before_validation :downcase_slug
|
|
before_validation :check_for_slug_change
|
|
before_validation :evaluate_markdown
|
|
before_save :update_articles
|
|
before_save :remove_at_from_usernames
|
|
before_save :generate_secret
|
|
# You have to put before_destroy callback BEFORE the dependent: :nullify
|
|
# to ensure they execute before the records are updated
|
|
# https://guides.rubyonrails.org/active_record_callbacks.html#destroying-an-object
|
|
before_destroy :cache_article_ids
|
|
|
|
has_many :articles, dependent: :nullify
|
|
has_many :collections, dependent: :nullify
|
|
has_many :credits, dependent: :restrict_with_error
|
|
has_many :display_ads, dependent: :destroy
|
|
has_many :listings, dependent: :destroy
|
|
has_many :notifications, dependent: :delete_all
|
|
has_many :organization_memberships, dependent: :delete_all
|
|
has_many :profile_pins, as: :profile, inverse_of: :profile, dependent: :destroy
|
|
has_many :sponsorships, dependent: :destroy
|
|
has_many :unspent_credits, -> { where spent: false }, class_name: "Credit", inverse_of: :organization
|
|
has_many :users, through: :organization_memberships
|
|
|
|
validates :articles_count, presence: true
|
|
validates :bg_color_hex, format: COLOR_HEX_REGEXP, allow_blank: true
|
|
validates :company_size, format: { with: INTEGER_REGEXP, message: MESSAGES[:integer_only], allow_blank: true }
|
|
validates :company_size, length: { maximum: 7 }, allow_nil: true
|
|
validates :credits_count, presence: true
|
|
validates :cta_body_markdown, length: { maximum: 256 }
|
|
validates :cta_button_text, length: { maximum: 20 }
|
|
validates :cta_button_url, length: { maximum: 150 }, url: { allow_blank: true, no_local: true }
|
|
validates :github_username, length: { maximum: 50 }
|
|
validates :location, :email, length: { maximum: 64 }
|
|
validates :name, :summary, :url, :profile_image, presence: true
|
|
validates :name, length: { maximum: 50 }
|
|
validates :proof, length: { maximum: 1500 }
|
|
validates :secret, length: { is: 100 }, allow_nil: true
|
|
validates :secret, uniqueness: true
|
|
validates :slug, exclusion: { in: ReservedWords.all, message: MESSAGES[:reserved_word] }
|
|
validates :slug, format: { with: SLUG_REGEXP }, length: { in: 2..18 }
|
|
validates :slug, presence: true, uniqueness: { case_sensitive: false }
|
|
validates :spent_credits_count, presence: true
|
|
validates :summary, length: { maximum: 250 }
|
|
validates :tag_line, length: { maximum: 60 }
|
|
validates :tech_stack, :story, length: { maximum: 640 }
|
|
validates :text_color_hex, format: COLOR_HEX_REGEXP, allow_blank: true
|
|
validates :twitter_username, length: { maximum: 15 }
|
|
validates :unspent_credits_count, presence: true
|
|
validates :url, length: { maximum: 200 }, url: { allow_blank: true, no_local: true }
|
|
|
|
validate :unique_slug_including_users_and_podcasts, if: :slug_changed?
|
|
|
|
after_save :bust_cache
|
|
|
|
after_commit :sync_related_elasticsearch_docs, on: :update
|
|
after_commit :bust_cache, :article_sync, on: :destroy
|
|
|
|
mount_uploader :profile_image, ProfileImageUploader
|
|
mount_uploader :nav_image, ProfileImageUploader
|
|
mount_uploader :dark_nav_image, ProfileImageUploader
|
|
|
|
alias_attribute :username, :slug
|
|
alias_attribute :old_username, :old_slug
|
|
alias_attribute :old_old_username, :old_old_slug
|
|
alias_attribute :website_url, :url
|
|
|
|
attr_accessor :cached_article_ids
|
|
|
|
def cache_article_ids
|
|
self.cached_article_ids = articles.ids
|
|
end
|
|
|
|
def check_for_slug_change
|
|
return unless slug_changed?
|
|
|
|
self.old_old_slug = old_slug
|
|
self.old_slug = slug_was
|
|
Organizations::UpdateOrganizationArticlesPathsWorker.perform_async(id, slug_was, slug)
|
|
end
|
|
|
|
def path
|
|
"/#{slug}"
|
|
end
|
|
|
|
def generate_secret
|
|
self.secret = generated_random_secret if secret.blank?
|
|
end
|
|
|
|
def generated_random_secret
|
|
SecureRandom.hex(50)
|
|
end
|
|
|
|
def approved_and_filled_out_cta?
|
|
cta_processed_html?
|
|
end
|
|
|
|
def profile_image_90
|
|
Images::Profile.call(profile_image_url, length: 90)
|
|
end
|
|
|
|
def enough_credits?(num_credits_needed)
|
|
credits.unspent.size >= num_credits_needed
|
|
end
|
|
|
|
def suspended?
|
|
# Hacky, yuck!
|
|
# TODO: [@jacobherrington] Remove this method
|
|
false
|
|
end
|
|
|
|
def destroyable?
|
|
organization_memberships.count == 1 && articles.count.zero?
|
|
end
|
|
|
|
private
|
|
|
|
def evaluate_markdown
|
|
self.cta_processed_html = MarkdownProcessor::Parser.new(cta_body_markdown).evaluate_limited_markdown
|
|
end
|
|
|
|
def remove_at_from_usernames
|
|
self.twitter_username = twitter_username.delete("@") if twitter_username
|
|
self.github_username = github_username.delete("@") if github_username
|
|
end
|
|
|
|
def downcase_slug
|
|
self.slug = slug&.downcase
|
|
end
|
|
|
|
def update_articles
|
|
return unless saved_change_to_slug || saved_change_to_name || saved_change_to_profile_image
|
|
|
|
articles.update(cached_organization: Articles::CachedEntity.from_object(self))
|
|
end
|
|
|
|
def bust_cache
|
|
Organizations::BustCacheWorker.perform_async(id, slug)
|
|
end
|
|
|
|
def unique_slug_including_users_and_podcasts
|
|
slug_taken = (
|
|
User.exists?(username: slug) ||
|
|
Podcast.exists?(slug: slug) ||
|
|
Page.exists?(slug: slug) ||
|
|
slug&.include?("sitemap-")
|
|
)
|
|
|
|
errors.add(:slug, "is taken.") if slug_taken
|
|
end
|
|
|
|
def sync_related_elasticsearch_docs
|
|
DataSync::Elasticsearch::Organization.new(self).call
|
|
end
|
|
|
|
def article_sync
|
|
# Syncs article cached organization and updates Elasticsearch docs
|
|
Article.where(id: cached_article_ids).find_each(&:save)
|
|
end
|
|
end
|