Class: Discussion

Inherits:
ApplicationRecord show all
Includes:
Contextualization, WithDiscussionStatus, WithResponsibleModerator, WithScopedQueries
Defined in:
app/models/discussion.rb

Constant Summary

Constants included from WithScopedQueries

WithScopedQueries::SCOPING_METHODS

Constants included from WithResponsibleModerator

WithResponsibleModerator::MODERATOR_MAX_RESPONSIBLE_TIME

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Contextualization

#affable_expectation_results, #affable_test_results, #affable_tips, #expectation_results_visible?, #failed_expectation_results, #feedback_html, #first_test_result, #first_test_result_html, #humanized_expectation_results, #iconize, #queries_with_results, #result_html, #results_body_hidden?, #sanitized_affable_test_results, #single_visible_test_result?, #single_visual_result?, #single_visual_result_html, #test_result_html, #visible_expectation_results, #visible_status

Methods included from WithResponsibleModerator

#any_responsible?, #can_toggle_responsible?, #current_responsible_visible_for?, #no_current_responsible?, #responsible?, #toggle_responsible!

Methods inherited from ApplicationRecord

active_between, aggregate_of, all_except, defaults, #delete, #destroy!, enum_prefixed_translations_for, numbered, organic_on, resource_fields, #save, #save_and_notify!, #save_and_notify_changes!, serialize_symbolized_hash_array, teaser_on, #update_and_notify!, update_or_create!, whitelist_attributes, with_pg_retry, with_temporary_token

Methods included from WithPgLock

#with_pg_lock

Class Method Details

.debatable_for(klazz, params) ⇒ Object 



181
182
183
184
 
# File 'app/models/discussion.rb', line 181

def self.debatable_for(klazz, params)
  debatable_id = params[:"#{klazz.underscore}_id"]
  klazz.constantize.find(debatable_id)
end

Instance Method Details

#authorized?(user) ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'app/models/discussion.rb', line 111

def authorized?(user)
  initiator?(user) || user.try(:moderator_here?)
end

#commentable_by?(user) ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'app/models/discussion.rb', line 67

def commentable_by?(user)
  user&.moderator_here? || (opened? && user.present?)
end

#extra_preview_html ⇒ Object 



166
167
168
169
170
 
# File 'app/models/discussion.rb', line 166

def extra_preview_html
  # FIXME this is buggy, because the extra
  # may have changed since the submission of this discussion
  exercise.assignment_for(initiator).extra_preview_html
end

#friendly ⇒ Object 



87
88
89
 
# File 'app/models/discussion.rb', line 87

def friendly
  initiator.abbreviated_name
end

#has_messages? ⇒ Boolean

Returns:

  • (Boolean) 


138
139
140
 
# File 'app/models/discussion.rb', line 138

def has_messages?
  visible_messages.exists? || description.present?
end

#has_responses? ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'app/models/discussion.rb', line 146

def has_responses?
  responses_count > 0
end

#has_submission? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'app/models/discussion.rb', line 75

def has_submission?
  submission.solution.present?
end

#has_validated_responses? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'app/models/discussion.rb', line 150

def has_validated_responses?
  validated_messages_count > 0
end

#initiator?(user) ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'app/models/discussion.rb', line 115

def initiator?(user)
  user.try(:uid) == initiator.uid
end

#last_message_date ⇒ Object 



83
84
85
 
# File 'app/models/discussion.rb', line 83

def last_message_date
  visible_messages.last&.created_at || created_at
end

#mark_subscriptions_as_unread!(user) ⇒ Object 



99
100
101
 
# File 'app/models/discussion.rb', line 99

def mark_subscriptions_as_unread!(user)
  subscriptions.where.not(user: user).each(&:unread!)
end

#navigable_content_in(_) ⇒ Object 



55
56
57
 
# File 'app/models/discussion.rb', line 55

def navigable_content_in(_)
  nil
end

#reachable_status_for?(user, status) ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'app/models/discussion.rb', line 124

def reachable_status_for?(user, status)
  reachable_statuses_for(user).include? status
end

#reachable_statuses_for(user) ⇒ Object 



119
120
121
122
 
# File 'app/models/discussion.rb', line 119

def reachable_statuses_for(user)
  return [] unless authorized?(user)
  status.reachable_statuses_for(user, self)
end

#read_by?(user) ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'app/models/discussion.rb', line 79

def read_by?(user)
  subscription_for(user).read
end

#requires_attention? ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
 
# File 'app/models/discussion.rb', line 158

def requires_attention?
  no_current_responsible? && status.requires_attention_for?(self)
end

#requires_attention_for?(user) ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
 
# File 'app/models/discussion.rb', line 154

def requires_attention_for?(user)
  user&.moderator_here? && requires_attention?
end

#responses_count ⇒ Object 



142
143
144
 
# File 'app/models/discussion.rb', line 142

def responses_count
  visible_messages.where.not(sender: initiator.uid).count
end

#subject ⇒ Object

TODO remove this once discussions generate notifications



187
188
189
 
# File 'app/models/discussion.rb', line 187

def subject
  'discussion'
end

#submit_message!(message, user) ⇒ Object 



103
104
105
106
107
108
109
 
# File 'app/models/discussion.rb', line 103

def submit_message!(message, user)
  message.merge!(sender: user.uid)
  messages.create(message)
  user.subscribe_to! self
  mark_subscriptions_as_unread!(user)
  no_responsible! if responsible?(user)
end

#subscribable? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'app/models/discussion.rb', line 71

def subscribable?
  opened? || solved?
end

#subscribe_initiator! ⇒ Object 



162
163
164
 
# File 'app/models/discussion.rb', line 162

def subscribe_initiator!
  initiator.subscribe_to! self
end

#subscription_for(user) ⇒ Object 



91
92
93
 
# File 'app/models/discussion.rb', line 91

def subscription_for(user)
  subscriptions.find_by(user: user)
end

#target ⇒ Object 



59
60
61
 
# File 'app/models/discussion.rb', line 59

def target
  self
end

#try_solve! ⇒ Object 



49
50
51
52
53
 
# File 'app/models/discussion.rb', line 49

def try_solve!
  if opened?
    update! status: reachable_statuses_for(initiator).first
  end
end

#update_counters! ⇒ Object 



172
173
174
175
176
177
178
179
 
# File 'app/models/discussion.rb', line 172

def update_counters!
  messages_query = messages_by_updated_at
  validated_messages = messages_query.select &:validated?
  has_moderator_response = messages_query.find { |it| it.validated? || it.question? }&.validated?
  update! messages_count: messages_query.count,
          validated_messages_count: validated_messages.count,
          requires_moderator_response: !has_moderator_response
end

#update_status!(status, user) ⇒ Object 



128
129
130
131
132
133
134
135
136
 
# File 'app/models/discussion.rb', line 128

def update_status!(status, user)
  if reachable_status_for?(user, status)
    update! status: status,
            status_updated_by: user,
            status_updated_at: Time.current

    no_responsible! if responsible?(user)
  end
end

#upvote_for(user) ⇒ Object 



95
96
97
 
# File 'app/models/discussion.rb', line 95

def upvote_for(user)
  upvotes.find_by(user: user)
end

#used_in?(organization) ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'app/models/discussion.rb', line 63

def used_in?(organization)
  organization == self.organization
end

#visible_messages ⇒ Object 



45
46
47
 
# File 'app/models/discussion.rb', line 45

def visible_messages
  messages.visible
end