effective_cpd 1.0.0 → 1.1.0

data/app/models/concerns/effective_cpd_audit.rb

@@ -15,6 +15,27 @@ module EffectiveCpdAudit
 
   module ClassMethods
     def effective_cpd_audit?; true; end
+
+    def admin_process_request_options
+      ['Granted', 'Denied']
+    end
+
+    def done_states
+      [:exemption_granted, :closed]
+    end
+
+    def waiting_on_admin_states
+      [:conflicted, :exemption_requested, :extension_requested, :submitted, :reviewed]
+    end
+
+    def waiting_on_reviewers_states
+      [:completed]
+    end
+
+    def waiting_on_auditee_states
+      [:opened, :started, :conflicted_resolved, :exemption_denied, :extension_granted, :extension_denied]
+    end
+
   end
 
   included do
@@ -35,6 +56,8 @@ module EffectiveCpdAudit
       :extension_granted,     # Extension granted
       :extension_denied,      # Extension denied
       :submitted,             # Audittee has completed questionnaire submitted. Audittee is done.
+      :missing_info,          # Admin has indicated information is missing. The audittee can edit applicant and add info
+      :completed,             # Admin has received all deliverables. The audit is complete and ready for review.
       :reviewed,              # All audit reviews completed. Ready for a determination.
       :closed                 # Determination made by admin and/or audit committee. Exit state. All done.
     )
@@ -55,8 +78,8 @@ module EffectiveCpdAudit
       # ... There will be one step per cpd_audit_level_sections here
       files: 'Upload Resume',
 
-      submit: 'Confirm & Submit',
-      complete: 'Complete'
+      submit: 'Submit',
+      submitted: 'Submitted'
     )
 
     attr_accessor :current_user
@@ -76,31 +99,29 @@ module EffectiveCpdAudit
 
     has_many_attached :files
 
-    ADMIN_PROCESS_REQUEST_OPTIONS = ['Granted', 'Denied']
-    COMPLETED_STATES = [:exemption_granted, :closed]
-    WAITING_ON_ADMIN_STATES = [:conflicted, :exemption_requested, :extension_requested, :reviewed]
-    WAITING_ON_REVIEWERS_STATES = [:submitted]
-    WAITING_ON_AUDITEE_STATES = [:opened, :started, :conflicted_resolved, :exemption_denied, :extension_granted, :extension_denied]
-
     effective_resource do
-      due_date                 :date     # Computed due date based on notification and extension date
+      due_date                 :date, permitted: false     # Computed due date based on notification and extension date
+
+      # Additional Info. Not really used.
+      notes                    :text, permitted: false
 
-      selection                :string
-      region                   :string
-      notes                    :text
+      # Anonymous Name Mode
+      anonymous_name           :string, permitted: false   # Required when cpd_audit_level.anonymous?
+      anonymous_number         :integer, permitted: false  # A unique value
 
-      # Anonymous Name
-      anonymous_name           :string   # Required when cpd_audit_level.anonymous?
+      # Missing Info
+      missing_info_at        :datetime
+      missing_info_reason    :text
 
       # Important dates
-      notification_date        :date     # Can be set on CpdAudits#new, but basically created_at
-      extension_date           :date     # set by admin if extension if granted
+      notification_date        :date, permitted: false     # Can be set on CpdAudits#new, but basically created_at
+      extension_date           :date, permitted: false     # set by admin if extension if granted
 
       # Final determination
-      determination            :string
+      determination            :string, permitted: false
 
       # Override Deadlines
-      ignore_deadlines         :boolean
+      ignore_deadlines         :boolean, permitted: false
 
       # Auditee response
       conflict_of_interest          :boolean
@@ -114,20 +135,21 @@ module EffectiveCpdAudit
       extension_request_reason      :text
 
       # acts_as_statused
-      status                  :string
+      status                  :string, permitted: false
       status_steps            :text
 
       # Status dates
-      started_at              :datetime
-      submitted_at            :datetime
-      reviewed_at             :datetime
-      closed_at               :datetime
+      started_at              :datetime, permitted: false
+      submitted_at            :datetime, permitted: false
+      completed_at            :datetime, permitted: false
+      reviewed_at             :datetime, permitted: false
+      closed_at               :datetime, permitted: false
 
-      # Acts as tokened
-      token                   :string
+      # Acts as tokyyened
+      token                   :string, permitted: false
 
       # Acts as Wizard
-      wizard_steps            :text
+      wizard_steps            :text, permitted: false
 
       timestamps
     end
@@ -136,16 +158,19 @@ module EffectiveCpdAudit
     scope :sorted, -> { order(:id) }
 
     scope :draft, -> { where(submitted_at: nil) }
-    scope :available, -> { where.not(status: COMPLETED_STATES) }
-    scope :completed, -> { where(status: COMPLETED_STATES) }
 
-    scope :waiting_on_admin, -> { where(status: WAITING_ON_ADMIN_STATES) }
-    scope :waiting_on_auditee, -> { where(status: WAITING_ON_AUDITEE_STATES) }
-    scope :waiting_on_reviewers, -> { where(status: WAITING_ON_REVIEWERS_STATES) }
+    scope :available, -> { where.not(status: done_states) }
+    scope :in_progress, -> { where.not(status: done_states) }
+
+    scope :done, -> { where(status: done_states) }
+
+    scope :waiting_on_admin, -> { where(status: waiting_on_admin_states) }
+    scope :waiting_on_auditee, -> { where(status: waiting_on_auditee_states) }
+    scope :waiting_on_reviewers, -> { where(status: waiting_on_reviewers_states) }
 
     # effective_reports
     def reportable_scopes
-      { draft: nil, available: nil, completed: nil, waiting_on_admin: nil, waiting_on_auditee: nil, waiting_on_reviewers: nil }
+      { draft: nil, available: nil, done: nil, waiting_on_admin: nil, waiting_on_auditee: nil, waiting_on_reviewers: nil }
     end
 
     before_validation(if: -> { new_record? }) do
@@ -153,7 +178,12 @@ module EffectiveCpdAudit
       self.due_date ||= deadline_to_submit()
     end
 
-    validates :anonymous_name, presence: true, if: -> { cpd_audit_level&.anonymous? }
+    with_options(if: -> { cpd_audit_level&.anonymous? }) do
+      before_validation { assign_anonymous_name_and_number }
+
+      validates :anonymous_name, presence: true
+      validates :anonymous_number, presence: true
+    end
 
     validates :notification_date, presence: true
     validates :determination, presence: true, if: -> { closed? }
@@ -163,6 +193,9 @@ module EffectiveCpdAudit
     validates :extension_request_date, presence: true, if: -> { extension_request? }
     validates :extension_request_reason, presence: true, if: -> { extension_request? }
 
+    # Admin Missing Info
+    validates :missing_info_reason, presence: true, if: -> { missing_info? }
+
     validate(if: -> { current_step == :conflict && conflict_of_interest? && !ignore_deadlines? }) do
       deadline = deadline_to_conflict_of_interest()
       self.errors.add(:base, 'deadline to declare conflict of interest has already passed') if deadline && deadline < Time.zone.now
@@ -185,62 +218,130 @@ module EffectiveCpdAudit
     end
 
     # If we're submitted. Check if we can go into reviewed?
-    before_save(if: -> { submitted? }) { review! }
+    before_save(if: -> { submitted? }) { try_complete! }
+    before_save(if: -> { completed? }) { try_review! }
 
     after_commit(on: :create) do
       send_email(:cpd_audit_opened)
     end
-  end
 
-  def to_s
-    persisted? ? "#{cpd_audit_level} Audit of #{user}" : 'audit'
-  end
+    def dynamic_wizard_steps
+      cpd_audit_level.cpd_audit_level_sections.each_with_object({}) do |section, h|
+        h["section#{section.position+1}".to_sym] = section.title
+      end
+    end
 
-  def dynamic_wizard_steps
-    cpd_audit_level.cpd_audit_level_sections.each_with_object({}) do |section, h|
-      h["section#{section.position+1}".to_sym] = section.title
+    def wizard_step_title(step)
+      self.class::WIZARD_STEPS[step] || dynamic_wizard_steps.fetch(step)
     end
-  end
 
-  def can_visit_step?(step)
-    return (step == :complete) if was_submitted?  # Can only view complete step once submitted
-    can_revisit_completed_steps(step)
-  end
+    def required_steps
+      steps = [:start, :information, :instructions]
 
-  def required_steps
-    steps = [:start, :information, :instructions]
+      steps << :conflict if cpd_audit_level.conflict_of_interest?
 
-    steps << :conflict if cpd_audit_level.conflict_of_interest?
+      steps << :exemption if cpd_audit_level.can_request_exemption?
 
-    steps << :exemption if cpd_audit_level.can_request_exemption?
+      unless exemption_requested?
+        steps << :extension if cpd_audit_level.can_request_extension?
+      end
 
-    unless exemption_requested?
-      steps << :extension if cpd_audit_level.can_request_extension?
+      if exemption_requested? || extension_requested?
+        steps += [:waiting]
+      end
+
+      if user_cpd_required?
+        steps += [:cpd]
+      end
+
+      steps += [:questionnaire] + dynamic_wizard_steps.keys + [:files, :submit, :submitted]
+
+      steps
     end
 
-    if exemption_requested? || extension_requested?
-      steps += [:waiting]
+    def can_visit_step?(step)
+      return [:start].exclude?(step) if missing_info? # Can revisit whole audit if missing info
+      return (step == :submitted) if was_submitted?  # Can only view complete step once submitted
+
+      can_revisit_completed_steps(step)
     end
+  end
 
-    steps += [:cpd, :questionnaire] + dynamic_wizard_steps.keys + [:files, :submit, :complete]
+  def to_s
+    persisted? ? "#{cpd_audit_level} Audit of #{name}" : 'audit'
+  end
 
-    steps
+  def name
+    anonymous_name.presence || user.to_s
   end
 
-  def wizard_step_title(step)
-    WIZARD_STEPS[step] || dynamic_wizard_steps.fetch(step)
+  def anonymous?
+    cpd_audit_level&.anonymous?
   end
 
   def deadline_date
     (extension_date || notification_date)
   end
 
-  def completed?
-    COMPLETED_STATES.include?(status.to_sym)
+  def draft?
+    !was_submitted?
   end
 
   def in_progress?
-    COMPLETED_STATES.include?(status.to_sym) == false
+    self.class.done_states.include?(status.to_sym) == false
+  end
+
+  def done?
+    self.class.done_states.include?(status.to_sym)
+  end
+
+  def ready_to_review?
+    was_completed?
+  end
+
+  def status_label
+    (status_was || status).to_s.gsub('_', ' ')
+  end
+
+  def summary
+    case status_was
+    when 'opened'
+      "The audit has been opened. The auditee and audit reviewers have been notified. Waiting for the auditee to submit their audit questionnaire."
+    when 'started'
+      "The auditee has begun their audit questionnaire. Waiting for the auditee to submit their audit questionnaire."
+    when 'conflicted'
+      "The auditee has declared a conflict of interest. A new reviewer will be assigned."
+    when 'conflicted_resolved'
+      "The auditee had declared a conflict of interest. This has been resolved. Waiting for the auditee to submit their audit questionnaire."
+    when 'exemption_requested'
+      "The auditee has requested an exemption. Waiting for request to be granted or denied."
+    when 'exemption_granted'
+      "The exemption request has been granted. This audit may now be closed."
+    when 'exemption_denied'
+      "The exemption request has been denied. The audit will continue. Waiting for the auditee to submit their audit questionnaire."
+    when 'extension_requested'
+      "The auditee has requested an extension. Waiting for request to be granted or denied."
+    when 'extension_granted'
+      "The extension request has been granted. There is a new deadline. Waiting for the auditee to submit their audit questionnaire."
+    when 'extension_denied'
+      "The extension request has been denied. The deadline remains. Waiting for the auditee to submit their audit questionnaire."
+    when 'submitted'
+      summary = "Auditee has submitted their audit wizard."
+      tasks = "The following tasks remain before it can be completed:"
+      approval = "Waiting on complete, review and determination."
+      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'
+      "All required materials have been provided. This audit will transition to 'reviewed' after all reviewers have finished."
+    when 'missing_info'
+      "Missing the following information: <ul><li>#{missing_info_reason}</li></ul>"
+    when 'reviewed'
+      "The audit has been reviewed and is ready for the final determination to be made."
+    when 'closed'
+      "This audit has been closed with a final determination #{determination}. All done."
+    else
+      raise("unexpected status #{status}")
+    end.html_safe
   end
 
   def cpd_audit_level_section(wizard_step)
@@ -348,29 +449,79 @@ module EffectiveCpdAudit
   def required_cpd_cycle
     @required_cpd_cycle ||= begin
       last_year = ((notification_date || created_at || Time.zone.now) - 1.year).all_year
-      EffectiveCpd.CpdCycle.available.where(start_at: last_year).first
+      Effective::CpdCycle.available.where(start_at: last_year).first
     end
   end
 
   # Auditee wizard action
   def submit!
+    # Complete the very last step too
+    wizard_steps[:submitted] = Time.zone.now
+
     if conflict_of_interest?
       conflicted!
       send_email(:cpd_audit_conflicted)
     else
       submitted!
-
-      cpd_audit_reviews.each { |cpd_audit_review| cpd_audit_review.ready! }
       send_email(:cpd_audit_submitted)
     end
 
     true
   end
 
+  # When an audit is submitted, these must be done to go to completed.
+  # An Admin can override this and just set them to completed.
+  def completed_requirements
+    {}
+  end
+
+  # called by a before_save when submitted
+  def try_complete!
+    false # Nothing to do. Admin completes audits.
+  end
+
+  def complete!
+    raise('audit must have been submitted to complete!') unless was_submitted?
+
+    assign_attributes(missing_info_reason: nil)
+    completed!
+
+    # Each of these sends a cpd_audit_review_ready email
+    cpd_audit_reviews.each { |cpd_audit_review| cpd_audit_review.ready! }
+
+    true
+  end
+
+  def missing!
+    raise('audit must have been submitted to missing!') unless was_submitted?
+
+    missing_info!
+    send_email(:cpd_audit_missing_info)
+  end
+
+  def resubmit!
+    raise('audit must have been submitted and missing info to resubmit!') unless was_submitted? && was_missing_info?
+    raise('already submitted') if submitted?
+
+    assign_attributes(skip_to_step: :submitted, submitted_at: Time.zone.now)
+
+    submitted!
+    send_email(:cpd_audit_submitted)
+  end
+
+  def try_review!
+    return false unless was_submitted?
+    return false unless completed?
+    return false unless cpd_audit_reviews.present? && cpd_audit_reviews.all?(&:completed?)
+
+    review!
+  end
+
   # Called in a before_save. Intended for applicant_review to call in its submit! method
   def review!
-    return false unless submitted?
-    return false unless cpd_audit_reviews.present? && cpd_audit_reviews.all?(&:completed?)
+    raise('already reviewed') if was_reviewed?
+    raise('audit must have been submitted to review!') unless was_submitted?
+    raise('audit must have been completed to review!') unless was_completed?
 
     reviewed!
     send_email(:cpd_audit_reviewed)
@@ -422,4 +573,22 @@ module EffectiveCpdAudit
     EffectiveResources.advance_date(date, business_days: cpd_audit_level.days_to_submit)
   end
 
+  # The name pattern is A23XXX where XXX is an autoincrement
+  # The name pattern is A23XXX where XXX is an autoincrement
+  def assign_anonymous_name_and_number
+    return if anonymous_name.present? || anonymous_number.present?
+    return if cpd_audit_level.blank?
+
+    prefix = cpd_audit_level.anonymous_audits_prefix
+    raise('expected cpd audit level to have an anonymous prefix') unless prefix.present?
+
+    # Where starts with prefix
+    number = (self.class.all.where('anonymous_name LIKE ?', "#{prefix}%").maximum('anonymous_number') || 0) + 1 # The next number
+
+    # Apply prefix and pad number to 3 digits
+    name = prefix + number.to_s.rjust(3, '0')
+
+    assign_attributes(anonymous_number: number, anonymous_name: name)
+  end
+
 end

data/app/models/concerns/effective_cpd_audit_level.rb

@@ -29,7 +29,7 @@ module EffectiveCpdAuditLevel
     # App scoped
     has_many :cpd_audits
 
-    has_many :cpd_audit_reviews, -> { EffectiveCpd.CpdAuditReview.sorted }, inverse_of: :cpd_audit_level, dependent: :destroy
+    has_many :cpd_audit_reviews, -> { order(:id) }, inverse_of: :cpd_audit_level, dependent: :destroy
     accepts_nested_attributes_for :cpd_audit_reviews, allow_destroy: true
 
     # Effective Scoped
@@ -46,6 +46,8 @@ module EffectiveCpdAuditLevel
       title                         :string
 
       anonymous                     :boolean
+      anonymous_audits_prefix        :string
+      anonymous_audit_reviews_prefix :string
 
       determinations                :text     # Final determination by auditor
       recommendations               :text     # Recommendations by audit reviewers
@@ -86,10 +88,11 @@ module EffectiveCpdAuditLevel
     validates :days_to_request_extension, presence: true, if: -> { can_request_extension? }
     validates :days_to_request_extension, numericality: { greater_than: 0, allow_nil: true }
 
+    validates :anonymous_audits_prefix, presence: true, if: -> { anonymous? }
+    validates :anonymous_audit_reviews_prefix, presence: true, if: -> { anonymous? }
+
     before_destroy do
-      if (count = cpd_audits.length) > 0
-        raise("#{count} audits belong to this audit level")
-      end
+      raise("can't destroy audit level with existing audits") if cpd_audits.length > 0
     end
   end