Class: SpreeCmCommissioner::Guest

Inherits:
Base
  • Object
show all
Includes:
KycBitwise, PhoneNumberSanitizer
Defined in:
app/models/spree_cm_commissioner/guest.rb

Overview

rubocop:disable Metrics/ClassLength

Constant Summary

Constants included from KycBitwise

KycBitwise::BIT_FIELDS, KycBitwise::ORDERED_BIT_FIELDS

Class Method Summary collapse

Instance Method Summary collapse

Methods included from KycBitwise

#available_social_contact_platforms, #kyc?, #kyc_fields, #kyc_value_enabled?, #unordered_kyc_fields

Class Method Details

.csv_importable_columnsObject



67
68
69
70
71
72
73
# File 'app/models/spree_cm_commissioner/guest.rb', line 67

def self.csv_importable_columns
  %i[
    first_name last_name phone_number age dob gender address other_occupation
    entry_type nationality_id other_organization expectation emergency_contact bib_number
    preferred_telegram_user_id seat_number country_code contact
  ]
end

Instance Method Details

#all_required_dynamic_fields_completed?(stage) ⇒ Boolean

Returns:

  • (Boolean)


233
234
235
# File 'app/models/spree_cm_commissioner/guest.rb', line 233

def all_required_dynamic_fields_completed?(stage)
  missing_dynamic_fields_for_stage(stage).blank?
end

#allowed_checkout?Boolean

no validation for each field as we allow user to save data to model partially.

Returns:

  • (Boolean)


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

def allowed_checkout?
  kyc_fields.all? { |field| allowed_checkout_for?(field) }
end

#allowed_checkout_for?(field) ⇒ Boolean

rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity

Returns:

  • (Boolean)


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'app/models/spree_cm_commissioner/guest.rb', line 80

def allowed_checkout_for?(field) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
  return first_name.present? && last_name.present? if field == :guest_name
  return gender.present? if field == :guest_gender
  return dob.present? if field == :guest_dob
  return occupation.present? || other_occupation.present? if field == :guest_occupation
  return nationality.present? if field == :guest_nationality
  return age.present? if field == :guest_age
  return emergency_contact.present? if field == :guest_emergency_contact
  return other_organization.present? if field == :guest_organization
  return expectation.present? if field == :guest_expectation
  return social_contact_platform.present? && social_contact.present? if field == :guest_social_contact
  return upload_later? || (id_card.present? && id_card.allowed_checkout?) if field == :guest_id_card
  return address.present? if field == :guest_address
  return phone_number.present? if field == :guest_phone_number
  return country_code.present? if field == :guest_country_code
  return contact.present? if field == :guest_contact

  false
end

#assign_seat_numberObject



143
144
145
146
147
# File 'app/models/spree_cm_commissioner/guest.rb', line 143

def assign_seat_number
  return if seat_number.present? # avoid reassign seat to guest

  assign_seat_number!
end

#assign_seat_number!Object



149
150
151
152
153
154
# File 'app/models/spree_cm_commissioner/guest.rb', line 149

def assign_seat_number!
  index = bib_number - 1
  positions = line_item.variant.seat_number_positions || []

  self.seat_number = (positions[index] if index >= 0 && index < positions.size)
end

#bib_display_prefix?Boolean

Returns:

  • (Boolean)


202
203
204
# File 'app/models/spree_cm_commissioner/guest.rb', line 202

def bib_display_prefix?
  line_item.variant.bib_display_prefix?
end

#bib_required?Boolean

Returns:

  • (Boolean)


198
199
200
# File 'app/models/spree_cm_commissioner/guest.rb', line 198

def bib_required?
  line_item.variant.bib_prefix.present?
end

#check_in_completed?Boolean

Returns:

  • (Boolean)


258
259
260
261
262
# File 'app/models/spree_cm_commissioner/guest.rb', line 258

def check_in_completed?
  return true unless line_item.product.dynamic_fields.during_check_in.any?

  check_in_fields_completed?
end

#current_ageObject



192
193
194
195
196
# File 'app/models/spree_cm_commissioner/guest.rb', line 192

def current_age
  return nil if dob.nil?

  ((Time.zone.now - dob.to_time) / 1.year.seconds).floor
end

#current_collection_phaseObject



264
265
266
267
268
269
270
271
272
# File 'app/models/spree_cm_commissioner/guest.rb', line 264

def current_collection_phase
  if check_in.present?
    :during_check_in
  elsif line_item.order.completed?
    :post_registration
  else
    :pre_registration
  end
end

#formatted_bib_numberObject

bib_number: 345, bib_prefix: 5KM, bib_zerofill: 5 => return 5KM00345 bib_number: 345, bib_prefix: 5KM, bib_zerofill: 2 => return 5KM345



284
285
286
287
288
289
290
291
292
293
294
295
# File 'app/models/spree_cm_commissioner/guest.rb', line 284

def formatted_bib_number
  return nil if bib_prefix.blank?
  return nil if bib_number.blank?

  filled_bib_number = bib_number.to_s.rjust(line_item.variant.bib_zerofill.to_i, '0')

  if bib_display_prefix?
    "#{bib_prefix}#{filled_bib_number}"
  else
    filled_bib_number
  end
end

#full_nameObject



156
157
158
# File 'app/models/spree_cm_commissioner/guest.rb', line 156

def full_name
  [first_name, last_name].compact_blank.join(' ')
end

#generate_bibObject



206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'app/models/spree_cm_commissioner/guest.rb', line 206

def generate_bib
  return if bib_prefix.present?
  return unless bib_required?
  return if event_id.blank?

  self.bib_prefix = line_item.variant.bib_prefix

  last_bib_number = event.guests
                         .where(bib_prefix: bib_prefix)
                         .maximum(:bib_number) || 0

  self.bib_number = last_bib_number + 1
  self.bib_index = "#{event_id}-#{bib_prefix}-#{bib_number}"
end

#generate_bib!Object



221
222
223
224
# File 'app/models/spree_cm_commissioner/guest.rb', line 221

def generate_bib!
  generate_bib
  save!
end

#generate_png_qr(size = 120) ⇒ Object



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'app/models/spree_cm_commissioner/guest.rb', line 172

def generate_png_qr(size = 120)
  qrcode = RQRCode::QRCode.new(qr_data)
  qrcode.as_png(
    bit_depth: 1,
    border_modules: 1,
    color_mode: ChunkyPNG::COLOR_GRAYSCALE,
    color: 'black',
    file: nil,
    fill: 'white',
    module_px_size: 4,
    resize_exactly_to: false,
    resize_gte_to: false,
    size: size
  )
end

#generate_svg_qrObject



160
161
162
163
164
165
166
167
168
169
170
# File 'app/models/spree_cm_commissioner/guest.rb', line 160

def generate_svg_qr
  qrcode = RQRCode::QRCode.new(qr_data)
  qrcode.as_svg(
    color: '000',
    shape_rendering: 'crispEdges',
    module_size: 5,
    standalone: true,
    use_path: true,
    viewbox: '0 0 20 10'
  )
end

#missing_dynamic_fields_for_stage(stage) ⇒ Object



226
227
228
229
230
231
# File 'app/models/spree_cm_commissioner/guest.rb', line 226

def missing_dynamic_fields_for_stage(stage)
  required_fields = line_item.product.dynamic_fields.where(data_fill_stage: stage)
  filled_ids = guest_dynamic_fields.map(&:dynamic_field_id)

  required_fields.reject { |field| filled_ids.include?(field.id) }
end

#phase_completion_statusObject



274
275
276
277
278
279
280
# File 'app/models/spree_cm_commissioner/guest.rb', line 274

def phase_completion_status
  {
    pre_registration: pre_registration_completed?,
    post_registration: post_registration_completed?,
    during_check_in: check_in_completed?
  }
end

#post_registration_completed?Boolean

Returns:

  • (Boolean)


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

def post_registration_completed?
  return true unless line_item.product.dynamic_fields.post_registration.any?

  post_registration_fields_completed?
end

#pre_registration_completed?Boolean

Returns:

  • (Boolean)


246
247
248
249
250
# File 'app/models/spree_cm_commissioner/guest.rb', line 246

def pre_registration_completed?
  return true unless line_item.product.dynamic_fields.pre_registration.any?

  pre_registration_fields_completed?
end

#preload_order_block_idsObject



297
298
299
300
301
302
303
# File 'app/models/spree_cm_commissioner/guest.rb', line 297

def preload_order_block_ids
  return if line_item.blank?
  return if line_item.order.blank?

  block_ids = line_item.order.blocks.pluck(:id)
  line_item.order.update(preload_block_ids: block_ids)
end

#qr_dataObject



188
189
190
# File 'app/models/spree_cm_commissioner/guest.rb', line 188

def qr_data
  token
end

#require_kyc_field?Boolean

rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength

Returns:

  • (Boolean)


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'app/models/spree_cm_commissioner/guest.rb', line 100

def require_kyc_field? # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
  kyc_fields.any? do |field|
    case field
    when :guest_name
      first_name.blank? || last_name.blank?
    when :guest_gender
      gender.blank?
    when :guest_dob
      dob.blank?
    when :guest_age
      age.blank?
    when :guest_occupation
      occupation.blank? && other_occupation.blank?
    when :guest_nationality
      nationality.blank?
    when :guest_emergency_contact
      emergency_contact.blank?
    when :guest_organization
      other_organization.blank?
    when :guest_expectation
      expectation.blank?
    when :guest_social_contact
      social_contact_platform.blank? || social_contact.blank?
    when :guest_id_card
      id_card.blank?
    when :guest_address
      address.blank?
    when :guest_phone_number
      phone_number.blank?
    when :guest_country_code
      country_code.blank?
    when :guest_contact
      contact.blank?
    else
      false
    end
  end
end

#set_event_idObject



139
140
141
# File 'app/models/spree_cm_commissioner/guest.rb', line 139

def set_event_id
  self.event_id ||= line_item&.event_id
end

#validate_dynamic_fields_for_phase(phase) ⇒ Object



237
238
239
240
241
242
243
244
# File 'app/models/spree_cm_commissioner/guest.rb', line 237

def validate_dynamic_fields_for_phase(phase)
  required_fields = line_item.product.dynamic_fields.where(data_fill_stage: phase)
  filled_ids = guest_dynamic_fields.map(&:dynamic_field_id)

  required_fields.each do |field|
    errors.add(:base, "#{field.label} is required for #{phase} phase") unless filled_ids.include?(field.id)
  end
end