Module: EffectiveMembershipsApplicant

Extended by:
ActiveSupport::Concern
Defined in:
app/models/concerns/effective_memberships_applicant.rb

Overview

EffectiveMembershipsApplicant

Mark your owner model with effective_memberships_applicant to get all the includes

Defined Under Namespace

Modules: Base, ClassMethods

Instance Method Summary collapse

Instance Method Details

#applicant_course(applicant_course_name: nil) ⇒ Object 



664
665
666
667
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 664

def applicant_course(applicant_course_name: nil)
  applicant_courses.find { |ac| ac.applicant_course_name_id == applicant_course_name.id } ||
  applicant_courses.build(applicant_course_name: applicant_course_name, applicant_course_area: applicant_course_name.applicant_course_area)
end

#applicant_course_area_sum(applicant_course_area:) ⇒ Object 



669
670
671
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 669

def applicant_course_area_sum(applicant_course_area:)
  applicant_courses.select { |ac| ac.applicant_course_area_id == applicant_course_area.id }.sum { |ac| ac.amount.to_i }
end

#applicant_course_areas_collection ⇒ Object 



656
657
658
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 656

def applicant_course_areas_collection
  Effective::ApplicantCourseArea.deep.sorted
end

#applicant_course_names_collection(applicant_course_area:) ⇒ Object 



660
661
662
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 660

def applicant_course_names_collection(applicant_course_area:)
  applicant_course_area.applicant_course_names
end

#applicant_courses_sum ⇒ Object 



673
674
675
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 673

def applicant_courses_sum
  applicant_courses.sum { |ac| ac.amount.to_i }
end

#applicant_endorsements_required? ⇒ Boolean

Returns:

  • (Boolean) 


696
697
698
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 696

def applicant_endorsements_required?
  required_steps.include?(:endorsements) && min_applicant_endorsements > 0
end

#applicant_references_required? ⇒ Boolean

Returns:

  • (Boolean) 


687
688
689
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 687

def applicant_references_required?
  required_steps.include?(:references) && min_applicant_references > 0
end

#applicant_review(reviewer:) ⇒ Object

Find



795
796
797
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 795

def applicant_review(reviewer:)
  applicant_reviews.find { |ar| ar.reviewer_id == reviewer.id && ar.reviewer_type == reviewer.class.name }
end

#applicant_reviews_required? ⇒ Boolean

Returns:

  • (Boolean) 


786
787
788
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 786

def applicant_reviews_required?
  (min_applicant_reviews > 0 || applicant_reviews.present?)
end

#apply_to_join? ⇒ Boolean

Returns:

  • (Boolean) 


545
546
547
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 545

def apply_to_join?
  applicant_type == 'Apply to Join'
end

#approve! ⇒ Object

Admin approves an applicant. Registers the owner. Sends an email.



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 844

def approve!
  raise('already approved') if was_approved?
  raise('applicant must have been submitted to approve!') unless was_submitted?

  # Complete the wizard step. Just incase this is run out of order.
  wizard_steps[:checkout] ||= Time.zone.now
  wizard_steps[:submitted] ||= Time.zone.now
  assign_attributes(missing_info_reason: nil)

  approved!

  EffectiveMemberships.Registrar.delete_fees!(owner)

  if apply_to_join?
    EffectiveMemberships.Registrar.register!(
      owner,
      to: to_category,
      status: to_status,
      date: approved_membership_date.presence,       # Set by the Admin Process form, or nil
      number: approved_membership_number.presence    # Set by the Admin Process form, or nil
    )
  elsif reclassification?
    EffectiveMemberships.Registrar.reclassify!(owner, to: to_category, status: to_status)
  elsif reinstatement?
    EffectiveMemberships.Registrar.reinstate!(owner, to: to_category)
  else
    raise('unsupported approval applicant_type')
  end

  save!

  after_commit { send_email(:applicant_approved) }
  true
end

#approve_email_templates ⇒ Object 



830
831
832
833
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 830

def approve_email_templates
  raise('expected EffectiveEmailTemplates') unless defined?(EffectiveEmailTemplates)
  Effective::EmailTemplate.where('template_name ILIKE ?', 'applicant_approve%').order(:template_name)
end

#build_applicant_review(reviewer:) ⇒ Object

Find or build



800
801
802
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 800

def build_applicant_review(reviewer:)
  applicant_review(reviewer: reviewer) || applicant_reviews.build(reviewer: reviewer)
end

#build_organization(params = {}) ⇒ Object 



541
542
543
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 541

def build_organization(params = {})
  self.organization = EffectiveMemberships.Organization.new(params)
end

#can_apply_applicant_types_collection ⇒ Object

Used by the select step



607
608
609
610
611
612
613
614
615
616
617
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 607

def can_apply_applicant_types_collection
  if owner.blank?
    ['Apply to Join']
  elsif owner.membership_removed? && owner.reinstatement_membership_history.present?
    ['Apply for Reinstatement', 'Apply to Join']
  elsif owner.membership.blank? || owner.membership.categories.blank?
    ['Apply to Join']
  else
    ['Apply to Reclassify']
  end
end

#can_apply_categories_collection ⇒ Object

Used by the select step



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 620

def can_apply_categories_collection
  categories = EffectiveMemberships.Category.sorted.can_apply

  if user.blank? || !user.is?(:member)
    return categories.where(can_apply_new: true)
  end

  category_ids = user.membership.category_ids.map(&:to_s) - [nil, '']

  categories.select do |category|
    category.can_apply_new? ||
    category.can_apply_existing? ||
    (category.can_apply_restricted? && (category_ids & category.can_apply_restricted_ids.map(&:to_s)).present?)
  end
end

#complete! ⇒ Object 



750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 750

def complete!
  raise('applicant must have been submitted to complete!') unless was_submitted?

  # Let an admin ignore these requirements if need be
  # return false unless submitted? && completed_requirements.values.all?

  assign_attributes(missing_info_reason: nil)
  completed!

  after_commit { send_email(:applicant_completed) }
  true
end

#completed_requirements ⇒ Object

When an application is submitted, these must be done to go to completed. An Admin can override this and just set them to completed.



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 731

def completed_requirements
  requirements = {}
  return requirements unless category.present?

  if applicant_endorsements_required?
    requirements['Applicant Endorsements'] = (applicant_endorsements.count(&:completed?) >= min_applicant_endorsements)
  end

  if applicant_references_required?
    requirements['Applicant References'] = (applicant_references.count(&:completed?) >= min_applicant_references)
  end

  if transcripts_required?
    requirements['Applicant Transcripts'] = transcripts_received?
  end

  requirements
end

#decline! ⇒ Object

Admin approves an applicant. Registers the owner. Sends an email.



880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 880

def decline!
  raise('already declined') if was_declined?
  raise('previously approved') if was_approved?
  raise('applicant must have been submitted to decline!') unless was_submitted?

  # Complete the wizard step. Just incase this is run out of order.
  wizard_steps[:checkout] ||= Time.zone.now
  wizard_steps[:submitted] ||= Time.zone.now
  declined!

  save!

  after_commit { send_email(:applicant_declined) }
  true
end

#done? ⇒ Boolean

Returns:

  • (Boolean) 


569
570
571
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 569

def done?
  approved? || declined?
end

#in_progress? ⇒ Boolean

Returns:

  • (Boolean) 


565
566
567
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 565

def in_progress?
  !approved? && !declined?
end

#individual? ⇒ Boolean

Returns:

  • (Boolean) 


557
558
559
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 557

def individual?
  !(owner.kind_of?(EffectiveMemberships.Organization) && category&.organization?)
end

#min_applicant_courses ⇒ Object

Courses Amounts step



652
653
654
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 652

def min_applicant_courses
  category&.min_applicant_courses.to_i
end

#min_applicant_educations ⇒ Object

Educations Step



647
648
649
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 647

def min_applicant_educations
  category&.min_applicant_educations.to_i
end

#min_applicant_endorsements ⇒ Object

Endorsements Step



692
693
694
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 692

def min_applicant_endorsements
  category&.min_applicant_endorsements.to_i
end

#min_applicant_equivalences ⇒ Object

Equivalences Step



701
702
703
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 701

def min_applicant_equivalences
  category&.min_applicant_equivalences.to_i
end

#min_applicant_experiences_months ⇒ Object

Work Experiences Step



678
679
680
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 678

def min_applicant_experiences_months
  category&.min_applicant_experiences_months.to_i
end

#min_applicant_files ⇒ Object

Files Step



715
716
717
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 715

def min_applicant_files
  category&.min_applicant_files.to_i
end

#min_applicant_references ⇒ Object

References Step



683
684
685
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 683

def min_applicant_references
  category&.min_applicant_references.to_i
end

#min_applicant_reviews ⇒ Object 



790
791
792
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 790

def min_applicant_reviews
  category&.min_applicant_reviews.to_i
end

#missing! ⇒ Object 



763
764
765
766
767
768
769
770
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 763

def missing!
  raise('applicant must have been submitted to missing!') unless was_submitted?

  missing_info!

  after_commit { send_email(:applicant_missing_info) }
  true
end

#organization? ⇒ Boolean

Returns:

  • (Boolean) 


561
562
563
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 561

def organization?
  owner.kind_of?(EffectiveMemberships.Organization) && category&.organization?
end

#owner ⇒ Object 



533
534
535
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 533

def owner
  organization || user
end

#owner_symbol ⇒ Object 



537
538
539
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 537

def owner_symbol
  organization? ? :organization : :user
end

#reclassification? ⇒ Boolean

Returns:

  • (Boolean) 


549
550
551
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 549

def reclassification?
  applicant_type == 'Apply to Reclassify'
end

#reinstatement? ⇒ Boolean

Returns:

  • (Boolean) 


553
554
555
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 553

def reinstatement?
  applicant_type == 'Apply for Reinstatement'
end

#resubmit! ⇒ Object 



772
773
774
775
776
777
778
779
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 772

def resubmit!
  raise('applicant must have been submitted and missing info to resubmit!') unless was_submitted? && was_missing_info?
  raise('already submitted') if submitted?
  raise('expected a purchased order') unless submit_order&.purchased?

  assign_attributes(skip_to_step: :submitted, submitted_at: Time.zone.now)
  submitted!
end

#review! ⇒ Object 



823
824
825
826
827
828
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 823

def review!
  raise('applicant must have been submitted to review!') unless was_submitted?

  # Let an admin ignore these requirements if need be
  reviewed!
end

#reviewable? ⇒ Boolean

Completed -> Reviewed requirements

Returns:

  • (Boolean) 


782
783
784
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 782

def reviewable?
  completed?
end

#reviewed_requirements ⇒ Object

When an application is completed, these must be done to go to reviewed An Admin can override this and just set them to reviewed.



806
807
808
809
810
811
812
813
814
815
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 806

def reviewed_requirements
  requirements = {}
  return requirements unless category.present?

  if applicant_reviews_required?
    requirements['Applicant Reviews'] = (applicant_reviews.count(&:done?) >= min_applicant_reviews)
  end

  requirements
end

#select! ⇒ Object 



636
637
638
639
640
641
642
643
644
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 636

def select!
  raise('cannot select a submitted applicant') if was_submitted?
  raise('cannot select a purchased applicant') if orders.any? { |order| order.purchased? }

  # Reset the progress so far. They have to click through screens again.
  assign_attributes(wizard_steps: wizard_steps.slice(:start, :select))

  save!
end

#stamp ⇒ Object

Stamps step



720
721
722
723
724
725
726
727
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 720

def stamp
  stamps.first || stamps.build(
    owner: owner,
    name: owner.to_s,
    shipping_address: (owner.try(:shipping_address) || owner.try(:billing_address)),
    price: 0
  )
end

#status_label ⇒ Object 



573
574
575
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 573

def status_label
  (status_was || status).to_s.gsub('_', ' ')
end

#summary ⇒ Object 



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 577

def summary
  case status_was
  when 'draft'
    "Applicant has not yet completed the #{category} wizard steps or paid to submit this application. This application will transition to 'submitted' after payment has been collected."
  when 'submitted'
    summary = "Application has been purchased and submitted."
    tasks = "The following tasks remain before it can be completed:"
    approval = "Waiting on approval."
    items = completed_requirements.map { |item, done| "<li>#{item}: #{done ? 'Complete' : 'Incomplete'}</li>" }.join
    completed_requirements.present? ? "<p>#{summary} #{tasks}</p><ul>#{items}</ul>" : "#{summary} #{approval}"
  when 'completed'
    if applicant_reviews_required?
      "All required materials have been provided. This application will transition to 'reviewed' after all reviewers have voted."
    else
      "This application has been completed and is now ready for an admin to approve or decline it. If approved, prorated fees will be generated."
    end
  when 'missing_info'
    "Missing the following information: <ul><li>#{missing_info_reason}</li></ul>"
  when 'reviewed'
    "This application has been reviewed and is now ready for an admin to approve or decline it. If approved, prorated fees will be generated."
  when 'approved'
    "The application has been approved. All done."
  when 'declined'
    "This application has been declined."
  else
    raise("unexpected status #{status}")
  end.html_safe
end

#to_category ⇒ Object 



835
836
837
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 835

def to_category
  category
end

#to_s ⇒ Object

Instance Methods



527
528
529
530
531
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 527

def to_s
  return 'New Applicant' if applicant_type.blank? || category.blank? || owner.blank?

  "#{owner} - #{applicant_type} to #{category}"
end

#to_status ⇒ Object 



839
840
841
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 839

def to_status
  nil
end

#transcripts_received? ⇒ Boolean

Transcripts Step

Returns:

  • (Boolean) 


706
707
708
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 706

def transcripts_received?
  transcripts_received_on_was.present?
end

#transcripts_required? ⇒ Boolean

Returns:

  • (Boolean) 


710
711
712
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 710

def transcripts_required?
  required_steps.include?(:transcripts)
end

#try_reviewed! ⇒ Object

Called when an applicant_review was submitted



818
819
820
821
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 818

def try_reviewed!
  return false unless completed? && reviewed_requirements.values.all?
  reviewed!
end