Class: User

Inherits:
ApplicationRecord show all
Includes:
Awardee, Disabling, Mumuki::Domain::Helpers::User, Mumuki::Domain::Syncable, WithDiscussionCreation, WithNotifications, WithPreferences, WithProfile, WithReminders, WithTermsAcceptance, WithUserNavigation
Defined in:
app/models/user.rb

Constant Summary collapse

PLACEHOLDER_IMAGE_URL = 
'user_shape.png'.freeze

Instance Method Summary collapse

Methods included from WithUserNavigation

#navigable_name, #navigation_end?

Methods included from WithReminders

#build_reminder, #remind!, #should_remind?, #try_remind_with_lock!

Methods included from WithPgLock

#with_pg_lock

Methods included from WithNotifications

#read_notification!, #unread_messages, #unread_notifications

Methods included from Awardee

#acquired_medals, #unacquired_medals

Methods included from Disabling

#disable!, #disabled?, #enabled?, #ensure_enabled!

Methods included from WithTermsAcceptance

#accept_forum_terms!, #accept_profile_terms!, #forum_terms, #has_accepted?, #has_forum_terms_to_accept?, #has_profile_terms_to_accept?, #has_role_terms_to_accept?, #profile_terms, #role_specific_terms

Methods included from Mumuki::Domain::Helpers::User

#any_granted_organizations, #discusser_of?, #full_name, #has_immersive_main_organization?, #has_role?, #has_student_granted_organizations?, #immersive_organization_at, #immersive_organization_with_content_at, #immersive_organizations_at, #immersive_organizations_with_content_at, #main_organization, #merge_permissions!, #platform_class_name, #profile_completed?, #to_param

Methods included from Mumuki::Domain::Syncable

#platform_class_name, #sync_key

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_changes!, serialize_symbolized_hash_array, teaser_on, #update_and_notify!, update_or_create!, whitelist_attributes, with_pg_retry, with_temporary_token

Instance Method Details

#abbreviated_name ⇒ Object 



216
217
218
 
# File 'app/models/user.rb', line 216

def abbreviated_name
  "#{first_name} #{last_name.first.capitalize + '.' if last_name.present?}".strip
end

#accept_invitation!(invitation) ⇒ Object 



107
108
109
 
# File 'app/models/user.rb', line 107

def accept_invitation!(invitation)
  make_student_of! invitation.course_slug
end

#age ⇒ Object 



252
253
254
255
256
 
# File 'app/models/user.rb', line 252

def age
  if birthdate.present?
    @age ||= Time.now.round_years_since(birthdate.to_time)
  end
end

#attach!(role, course) ⇒ Object 



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

def attach!(role, course)
  add_permission! role, course.slug
  save_and_notify!
end

#build_assignment(exercise, organization) ⇒ Object 



224
225
226
 
# File 'app/models/user.rb', line 224

def build_assignment(exercise, organization)
  Assignment.build_for(self, exercise, organization)
end

#bury! ⇒ Object 



172
173
174
175
 
# File 'app/models/user.rb', line 172

def bury!
  # TODO change avatar
  update! self.class.buried_profile.merge(accepts_reminders: false, gender: nil, birthdate: nil)
end

#can_access_teacher_info_in?(organization) ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
 
# File 'app/models/user.rb', line 208

def can_access_teacher_info_in?(organization)
  teacher_of?(organization) || organization.teacher_training?
end

#can_discuss_here? ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
 
# File 'app/models/user.rb', line 204

def can_discuss_here?
  can_discuss_in? Organization.current
end

#can_discuss_in?(organization) ⇒ Boolean

Tells if the given user can discuss in an organization

This is true only when this organization has the forum enabled and the user has the discusser pseudo-permission and the discusser is trusted

Returns:

  • (Boolean) 


196
197
198
 
# File 'app/models/user.rb', line 196

def can_discuss_in?(organization)
  organization.forum_enabled? && discusser_of?(organization) && trusted_as_discusser_in?(organization) && !banned_from_forum?
end

#certificate_in(certificate_program, certificate_h) ⇒ Object 



311
312
313
314
315
 
# File 'app/models/user.rb', line 311

def certificate_in(certificate_program, certificate_h)
  return if certificated_in?(certificate_program)
  certificate = certificates.create certificate_h.merge(certificate_program: certificate_program)
  UserMailer.certificate(certificate).deliver_later
end

#certificated_in?(certificate_program) ⇒ Boolean

Returns:

  • (Boolean) 


307
308
309
 
# File 'app/models/user.rb', line 307

def certificated_in?(certificate_program)
  certificates.where(certificate_program: certificate_program).exists?
end

#certificates_in_organization(organization = Organization.current) ⇒ Object 



303
304
305
 
# File 'app/models/user.rb', line 303

def certificates_in_organization(organization = Organization.current)
  certificates.where certificate_program: CertificateProgram.where(organization: organization)
end

#clear_progress! ⇒ Object 



100
101
102
103
104
105
 
# File 'app/models/user.rb', line 100

def clear_progress!
  transaction do
    update! last_submission_date: nil, last_exercise: nil
    assignments.destroy_all
  end
end

#clear_progress_for!(organization) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
 
# File 'app/models/user.rb', line 317

def clear_progress_for!(organization)
  location = { organization: organization }.compact

  target_assignments = assignments.where(location)

  messages.where(assignment: target_assignments).delete_all

  target_assignments.delete_all
  indicators.where(location).delete_all
  user_stats.where(location).delete_all
end

#completed_containers(sequence, organization) ⇒ Object

Takes a didactic - ordered - sequence of content containers and returns those that have been completed



179
180
181
 
# File 'app/models/user.rb', line 179

def completed_containers(sequence, organization)
  sequence.take_while { |it| it.content.completed_for?(self, organization) }
end

#completed_containers_with_lookahead(sequence, organization, lookahead: 1) ⇒ Object

Like ‘completed_containers`, returns a slice of the completed containers in the sequence, but adding a configurable number of trailing, non-completed contaienrs



185
186
187
188
189
190
 
# File 'app/models/user.rb', line 185

def completed_containers_with_lookahead(sequence, organization, lookahead: 1)
  raise 'invalid lookahead' if lookahead < 1

  count = completed_containers(sequence, organization).size
  sequence[0..count + lookahead - 1]
end

#current_audience ⇒ Object 



244
245
246
 
# File 'app/models/user.rb', line 244

def current_audience
  current_organic_context&.target_audience
end

#current_immersive_context_and_content_at(path_item) ⇒ Object 



285
286
287
288
289
 
# File 'app/models/user.rb', line 285

def current_immersive_context_and_content_at(path_item)
  immersive_organization_with_content_at(path_item).tap do |orga, _|
    return [Organization.current, path_item] unless orga.present?
  end
end

#current_immersive_context_at(path_item) ⇒ Object 



262
263
264
265
266
267
268
 
# File 'app/models/user.rb', line 262

def current_immersive_context_at(path_item)
  if Organization.current?
    immersive_organization_at(path_item) || Organization.current
  else
    main_organization
  end
end

#current_organic_context ⇒ Object 



258
259
260
 
# File 'app/models/user.rb', line 258

def current_organic_context
  Organization.current? ?  Organization.current : main_organization
end

#currently_in_exam? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'app/models/user.rb', line 160

def currently_in_exam?
  exams.any? { |e| e.in_progress_for? self }
end

#custom_profile_picture ⇒ Object 



164
165
166
 
# File 'app/models/user.rb', line 164

def custom_profile_picture
  avatar&.image_url || image_url
end

#detach!(role, course) ⇒ Object 



147
148
149
150
 
# File 'app/models/user.rb', line 147

def detach!(role, course)
  remove_permission! role, course.slug
  save_and_notify!
end

#formal_first_name ⇒ Object 



291
292
293
 
# File 'app/models/user.rb', line 291

def formal_first_name
  verified_first_name.presence || first_name
end

#formal_full_name ⇒ Object 



299
300
301
 
# File 'app/models/user.rb', line 299

def formal_full_name
  "#{formal_first_name} #{formal_last_name}"
end

#formal_last_name ⇒ Object 



295
296
297
 
# File 'app/models/user.rb', line 295

def formal_last_name
  verified_last_name.presence || last_name
end

#import_from_resource_h!(json) ⇒ Object 



123
124
125
 
# File 'app/models/user.rb', line 123

def import_from_resource_h!(json)
  update! self.class.slice_resource_h json
end

#incognito? ⇒ Boolean

Returns:

  • (Boolean) 


240
241
242
 
# File 'app/models/user.rb', line 240

def incognito?
  false
end

#interpolations ⇒ Object 



152
153
154
155
156
157
158
 
# File 'app/models/user.rb', line 152

def interpolations
  {
      'user_email' => email,
      'user_first_name' => first_name,
      'user_last_name' => last_name
  }
end

#last_lesson ⇒ Object 



56
57
58
 
# File 'app/models/user.rb', line 56

def last_lesson
  last_guide.try(:lesson)
end

#messages_in_organization(organization = Organization.current) ⇒ Object 



60
61
62
 
# File 'app/models/user.rb', line 60

def messages_in_organization(organization = Organization.current)
  messages.where('assignments.organization': organization)
end

#name_initials ⇒ Object 



212
213
214
 
# File 'app/models/user.rb', line 212

def name_initials
  name.split.map(&:first).map(&:capitalize).join(' ')
end

#never_submitted? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'app/models/user.rb', line 96

def never_submitted?
  last_submission_date.nil?
end

#next_exercise_at(guide) ⇒ Object 



232
233
234
 
# File 'app/models/user.rb', line 232

def next_exercise_at(guide)
  guide.pending_exercises(self).order('exercises.number asc').first
end

#notify_permissions_changed! ⇒ Object 



270
271
272
273
274
275
276
277
 
# File 'app/models/user.rb', line 270

def notify_permissions_changed!
  return if permissions_before_last_save == permissions
  Mumukit::Nuntius.notify! 'user-permissions-changed', user: {
    uid: uid,
    old_permissions: permissions_before_last_save.as_json,
    new_permissions: permissions.as_json
  }
end

#passed_assignments ⇒ Object 



84
85
86
 
# File 'app/models/user.rb', line 84

def passed_assignments
  assignments.where(status: Mumuki::Domain::Status::Submission::Passed.to_i)
end

#passed_submissions_count ⇒ Object 



72
73
74
 
# File 'app/models/user.rb', line 72

def passed_submissions_count
  passed_assignments.count
end

#passed_submissions_count_in(organization) ⇒ Object 



64
65
66
 
# File 'app/models/user.rb', line 64

def passed_submissions_count_in(organization)
  assignments.where(top_submission_status: Mumuki::Domain::Status::Submission::Passed.to_i, organization: organization).count
end

#pending_siblings_at(content) ⇒ Object 



228
229
230
 
# File 'app/models/user.rb', line 228

def pending_siblings_at(content)
  content.pending_siblings_for(self)
end

#placeholder_image_url ⇒ Object 



248
249
250
 
# File 'app/models/user.rb', line 248

def placeholder_image_url
  PLACEHOLDER_IMAGE_URL
end

#profile_picture ⇒ Object 



168
169
170
 
# File 'app/models/user.rb', line 168

def profile_picture
  custom_profile_picture || placeholder_image_url
end

#progress_at(content, organization) ⇒ Object 



220
221
222
 
# File 'app/models/user.rb', line 220

def progress_at(content, organization)
  Indicator.find_or_initialize_by(user: self, organization: organization, content: content)
end

#run_submission!(submission, assignment, evaluation) ⇒ Object 



236
237
238
 
# File 'app/models/user.rb', line 236

def run_submission!(submission, assignment, evaluation)
  submission.run! assignment, evaluation
end

#save_and_notify! ⇒ Object 



279
280
281
282
283
 
# File 'app/models/user.rb', line 279

def save_and_notify!
  save!
  notify_permissions_changed!
  self
end

#solved_exercises_count ⇒ Object 



80
81
82
 
# File 'app/models/user.rb', line 80

def solved_exercises_count
  solved_exercises.count
end

#submissions_count ⇒ Object 



68
69
70
 
# File 'app/models/user.rb', line 68

def submissions_count
  assignments.pluck(:submissions_count).sum
end

#submitted_exercises_count ⇒ Object 



76
77
78
 
# File 'app/models/user.rb', line 76

def submitted_exercises_count
  submitted_exercises.count
end

#to_resource_h ⇒ Object 



127
128
129
 
# File 'app/models/user.rb', line 127

def to_resource_h
  super.merge(image_url: profile_picture)
end

#to_s ⇒ Object 



92
93
94
 
# File 'app/models/user.rb', line 92

def to_s
  "#{id}:#{name}:#{uid}"
end

#transfer_progress_to!(another) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
 
# File 'app/models/user.rb', line 111

def transfer_progress_to!(another)
  transaction do
    assignments.update_all(submitter_id: another.id)
    if another.never_submitted? || last_submission_date.try { |it| it > another.last_submission_date }
      another.update! last_submission_date: last_submission_date,
                      last_exercise: last_exercise,
                      last_organization: last_organization
    end
  end
  reload
end

#trusted_as_discusser_in?(organization) ⇒ Boolean

Returns:

  • (Boolean) 


200
201
202
 
# File 'app/models/user.rb', line 200

def trusted_as_discusser_in?(organization)
  trusted_for_forum? || !organization.forum_only_for_trusted?
end

#unsubscribe_from_reminders! ⇒ Object 



137
138
139
 
# File 'app/models/user.rb', line 137

def unsubscribe_from_reminders!
  update! accepts_reminders: false
end

#verify_name! ⇒ Object 



131
132
133
134
135
 
# File 'app/models/user.rb', line 131

def verify_name!
  self.verified_first_name ||= first_name
  self.verified_last_name ||= last_name
  save!
end

#visit!(organization) ⇒ Object 



88
89
90
 
# File 'app/models/user.rb', line 88

def visit!(organization)
  update!(last_organization: organization) if organization != last_organization
end