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_columns ⇒ Object 



70
71
72
73
74
75
76
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 70

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) 


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

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) 


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

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) 


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

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_number ⇒ Object 



146
147
148
149
150
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 146

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

  assign_seat_number!
end

#assign_seat_number! ⇒ Object 



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

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) 


205
206
207
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 205

def bib_display_prefix?
  line_item.variant.bib_display_prefix?
end

#bib_required? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#check_in_completed? ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
264
265
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 261

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

  check_in_fields_completed?
end

#current_age ⇒ Object 



195
196
197
198
199
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 195

def current_age
  return nil if dob.nil?

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

#current_collection_phase ⇒ Object 



267
268
269
270
271
272
273
274
275
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 267

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_number ⇒ Object

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



287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 287

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_name ⇒ Object 



159
160
161
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 159

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

#generate_bib ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 209

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 



224
225
226
227
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 224

def generate_bib!
  generate_bib
  save!
end

#generate_png_qr(size = 120) ⇒ Object 



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

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_qr ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 163

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 



229
230
231
232
233
234
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 229

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_status ⇒ Object 



277
278
279
280
281
282
283
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 277

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) 


255
256
257
258
259
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 255

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) 


249
250
251
252
253
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 249

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

  pre_registration_fields_completed?
end

#preload_order_block_ids ⇒ Object 



314
315
316
317
318
319
320
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 314

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_data ⇒ Object 



191
192
193
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 191

def qr_data
  token
end

#require_kyc_field? ⇒ Boolean

rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength

Returns:

  • (Boolean) 


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
138
139
140
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 103

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_id ⇒ Object 



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

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

#should_validate_block? ⇒ Boolean

validate only if block_id is present AND (new record OR block_id is changing) goal: don’t bother re-validating when block_id stays the same

Returns:

  • (Boolean) 


302
303
304
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 302

def should_validate_block?
  block_id.present? && (new_record? || will_save_change_to_block_id?)
end

#validate_block ⇒ Object 



306
307
308
309
310
311
312
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 306

def validate_block
  return if block_id.blank?
  return if line_item.blank? || line_item.variant.blank?
  return if line_item.variant.variant_blocks.exists?(block_id: block_id)

  errors.add(:block, "does not exist in variant #{line_item.variant_id}")
end

#validate_dynamic_fields_for_phase(phase) ⇒ Object 



240
241
242
243
244
245
246
247
 
# File 'app/models/spree_cm_commissioner/guest.rb', line 240

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