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 



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

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 



690
691
692
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 690

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 



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

def applicant_course_areas_collection
  Effective::ApplicantCourseArea.deep.sorted
end

#applicant_course_names_collection(applicant_course_area:) ⇒ Object 



681
682
683
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 681

def applicant_course_names_collection(applicant_course_area:)
  applicant_course_area.applicant_course_names
end

#applicant_courses_sum ⇒ Object 



694
695
696
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 694

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

#applicant_endorsements_required? ⇒ Boolean

Returns:

  • (Boolean) 


717
718
719
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 717

def applicant_endorsements_required?
  min_applicant_endorsements > 0
end

#applicant_references_required? ⇒ Boolean

Returns:

  • (Boolean) 


708
709
710
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 708

def applicant_references_required?
  min_applicant_references > 0
end

#applicant_review(reviewer:) ⇒ Object

Find



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

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) 


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

def applicant_reviews_required?
  min_applicant_reviews > 0
end

#apply_to_join? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#approve! ⇒ Object

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



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 893

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,
      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 reinstatement?
    # No status
    EffectiveMemberships.Registrar.reinstate!(
      owner,
      to: to_category,
      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
    )
  else
    raise('unsupported approval applicant_type')
  end

  save!

  after_commit { send_email(:applicant_approved) }
  true
end

#approve_email_templates ⇒ Object 



879
880
881
882
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 879

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



843
844
845
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 843

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

#build_organization(params = {}) ⇒ Object 



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

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

#can_apply_applicant_types_collection ⇒ Object

Used by the select step



628
629
630
631
632
633
634
635
636
637
638
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 628

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



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 641

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 = Array(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 



793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 793

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.



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 774

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

  if all_steps.include?(:transcripts) || transcripts_required?
    requirements['Transcripts'] = ('Not Required' unless transcripts_required?) || transcripts_received?
  end

  if all_steps.include?(:ensorsements) || applicant_endorsements_required?
    requirements['Endorsements'] = ('Not Required' unless applicant_endorsements_required?) || (applicant_endorsements.count(&:completed?) >= min_applicant_endorsements)
  end

  if all_steps.include?(:references) || applicant_references_required?
    requirements['References'] = ('Not Required' unless applicant_references_required?) || (applicant_references.count(&:completed?) >= min_applicant_references)
  end

  requirements
end

#cpd_completed_cpd_cycles ⇒ Object 



749
750
751
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 749

def cpd_completed_cpd_cycles
  cpd_required_cpd_cycles.select { |cpd_cycle| user&.cpd_statement(cpd_cycle: cpd_cycle)&.completed? }
end

#cpd_required_cpd_cycles ⇒ Object 



740
741
742
743
744
745
746
747
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 740

def cpd_required_cpd_cycles
  date = submitted_at || Time.zone.now

  [
    (EffectiveCpd.previous_cpd_cycle(date: date) if cpd_requirement.to_s.include?('previous')),
    (EffectiveCpd.current_cpd_cycle(date: date) if cpd_requirement.to_s.include?('current'))
  ].compact
end

#cpd_requirement ⇒ Object

CPD Step



736
737
738
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 736

def cpd_requirement
  (category&.applicant_cpd_step_requirement.presence || EffectiveMemberships.Category.cpd_step_requirements.first)
end

#cpd_uncompleted_cpd_cycles ⇒ Object 



753
754
755
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 753

def cpd_uncompleted_cpd_cycles
  cpd_required_cpd_cycles.reject { |cpd_cycle| user&.cpd_statement(cpd_cycle: cpd_cycle)&.completed? }
end

#decline! ⇒ Object

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



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 941

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) 


585
586
587
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 585

def done?
  approved? || declined?
end

#in_progress? ⇒ Boolean

Returns:

  • (Boolean) 


581
582
583
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 581

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

#individual? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#min_applicant_courses ⇒ Object

Courses Amounts step



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

def min_applicant_courses
  category&.min_applicant_courses.to_i
end

#min_applicant_educations ⇒ Object

Educations Step



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

def min_applicant_educations
  category&.min_applicant_educations.to_i
end

#min_applicant_endorsements ⇒ Object

Endorsements Step



713
714
715
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 713

def min_applicant_endorsements
  category&.min_applicant_endorsements.to_i
end

#min_applicant_equivalences ⇒ Object

Equivalences Step



722
723
724
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 722

def min_applicant_equivalences
  category&.min_applicant_equivalences.to_i
end

#min_applicant_experiences_months ⇒ Object

Work Experiences Step



699
700
701
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 699

def min_applicant_experiences_months
  category&.min_applicant_experiences_months.to_i
end

#min_applicant_files ⇒ Object

Files Step



758
759
760
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 758

def min_applicant_files
  category&.min_applicant_files.to_i
end

#min_applicant_references ⇒ Object

References Step



704
705
706
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 704

def min_applicant_references
  category&.min_applicant_references.to_i
end

#min_applicant_reviews ⇒ Object 



833
834
835
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 833

def min_applicant_reviews
  category&.min_applicant_reviews.to_i
end

#missing! ⇒ Object 



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

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) 


577
578
579
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 577

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

#owner ⇒ Object 



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

def owner
  organization || user
end

#owner_symbol ⇒ Object 



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

def owner_symbol
  organization? ? :organization : :user
end

#reclassification? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#reinstatement? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#resubmit! ⇒ Object 



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

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 



872
873
874
875
876
877
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 872

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) 


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

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.



849
850
851
852
853
854
855
856
857
858
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 849

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

  if EffectiveMemberships.applicant_reviews?
    requirements['Reviews'] = ('Not Required' unless applicant_reviews_required?) || (applicant_reviews.count(&:completed?) >= min_applicant_reviews)
  end

  requirements
end

#select! ⇒ Object 



657
658
659
660
661
662
663
664
665
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 657

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



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

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 



589
590
591
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 589

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

#summary ⇒ Object 



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 593

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 do |item, done|
      done = (done ? 'Complete' : 'Incomplete') unless done.is_a?(String) || done.is_a?(Symbol)
      "<li>#{item}: #{done}</li>"
    end.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 



884
885
886
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 884

def to_category
  category
end

#to_s ⇒ Object

Instance Methods



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

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

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

#to_status ⇒ Object 



888
889
890
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 888

def to_status
  nil
end

#transcripts_received? ⇒ Boolean

Transcripts Step

Returns:

  • (Boolean) 


727
728
729
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 727

def transcripts_received?
  transcripts_received_on_was.present?
end

#transcripts_required? ⇒ Boolean

Returns:

  • (Boolean) 


731
732
733
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 731

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

#try_completed! ⇒ Object

Called when an applicant is submitted



861
862
863
864
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 861

def try_completed!
  return false unless submitted? && completed_requirements.values.all?
  complete!
end

#try_reviewed! ⇒ Object

Called when an applicant_review was submitted



867
868
869
870
 
# File 'app/models/concerns/effective_memberships_applicant.rb', line 867

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