effective_cpd 0.6.8 → 1.1.0

data/app/models/concerns/effective_cpd_audit.rb

@@ -0,0 +1,594 @@
+# frozen_string_literal: true
+
+# EffectiveCpdAudit
+#
+# Mark your owner model with effective_cpd_audit to get all the includes
+
+module EffectiveCpdAudit
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_cpd_audit
+      include ::EffectiveCpdAudit
+    end
+  end
+
+  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
+    acts_as_email_form
+    acts_as_tokened
+    acts_as_reportable if respond_to?(:acts_as_reportable)
+    log_changes(except: [:wizard_steps, :cpd_audit_reviews]) if respond_to?(:log_changes)
+
+    acts_as_statused(
+      :opened,                # Just Opened
+      :started,               # First screen clicked
+      :conflicted,            # Auditee has declared a conflict of interest
+      :conflicted_resolved,   # The conflict of interest has been resolved
+      :exemption_requested,   # Auditee has requested an exemption
+      :exemption_granted,     # Exemption granted -> Audit is cancelled. Exit state.
+      :exemption_denied,      # Exemption denied
+      :extension_requested,   # Audittee has requested an extension
+      :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.
+    )
+
+    acts_as_wizard(
+      start: 'Start',
+      information: 'Information',
+      instructions: 'Instructions',
+
+      # These 4 steps are determined by audit_level settings
+      conflict: 'Conflict of Interest',
+      exemption: 'Request Exemption',
+      extension: 'Request Extension',
+      waiting: 'Waiting',
+      cpd: 'CPD',
+
+      questionnaire: 'Questionnaire',
+      # ... There will be one step per cpd_audit_level_sections here
+      files: 'Upload Resume',
+
+      submit: 'Submit',
+      submitted: 'Submitted'
+    )
+
+    attr_accessor :current_user
+    attr_accessor :current_step
+    attr_accessor :admin_process_request
+
+    # App scoped
+    belongs_to :cpd_audit_level, polymorphic: true
+    belongs_to :user, polymorphic: true  # The user being audited
+
+    has_many :cpd_audit_reviews, -> { order(:id) }, inverse_of: :cpd_audit, dependent: :destroy
+    accepts_nested_attributes_for :cpd_audit_reviews, allow_destroy: true
+
+    # Effective Scoped
+    has_many :cpd_audit_responses, -> { Effective::CpdAuditResponse.sorted }, class_name: 'Effective::CpdAuditResponse', inverse_of: :cpd_audit, dependent: :destroy
+    accepts_nested_attributes_for :cpd_audit_responses
+
+    has_many_attached :files
+
+    effective_resource do
+      due_date                 :date, permitted: false     # Computed due date based on notification and extension date
+
+      # Additional Info. Not really used.
+      notes                    :text, permitted: false
+
+      # Anonymous Name Mode
+      anonymous_name           :string, permitted: false   # Required when cpd_audit_level.anonymous?
+      anonymous_number         :integer, permitted: false  # A unique value
+
+      # Missing Info
+      missing_info_at        :datetime
+      missing_info_reason    :text
+
+      # Important dates
+      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, permitted: false
+
+      # Override Deadlines
+      ignore_deadlines         :boolean, permitted: false
+
+      # Auditee response
+      conflict_of_interest          :boolean
+      conflict_of_interest_reason   :text
+
+      exemption_request             :boolean
+      exemption_request_reason      :text
+
+      extension_request             :boolean
+      extension_request_date        :date
+      extension_request_reason      :text
+
+      # acts_as_statused
+      status                  :string, permitted: false
+      status_steps            :text
+
+      # Status dates
+      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 tokyyened
+      token                   :string, permitted: false
+
+      # Acts as Wizard
+      wizard_steps            :text, permitted: false
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:cpd_audit_level, user: [:cpd_statements], cpd_audit_reviews: [:cpd_audit_level, :user, :cpd_audit_review_items]) }
+    scope :sorted, -> { order(:id) }
+
+    scope :draft, -> { where(submitted_at: nil) }
+
+    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, done: nil, waiting_on_admin: nil, waiting_on_auditee: nil, waiting_on_reviewers: nil }
+    end
+
+    before_validation(if: -> { new_record? }) do
+      self.notification_date ||= Time.zone.now
+      self.due_date ||= deadline_to_submit()
+    end
+
+    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? }
+
+    validates :conflict_of_interest_reason, presence: true, if: -> { conflict_of_interest? }
+    validates :exemption_request_reason, presence: true, if: -> { exemption_request? }
+    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
+    end
+
+    validate(if: -> { current_step == :exemption && exemption_request? && !ignore_deadlines? }) do
+      deadline = deadline_to_exemption()
+      self.errors.add(:base, 'deadline to request exemption has already passed') if deadline && deadline < Time.zone.now
+    end
+
+    validate(if: -> { current_step == :extension && extension_request? && !ignore_deadlines? }) do
+      deadline = deadline_to_extension()
+      self.errors.add(:base, 'deadline to request extension has already passed') if deadline && deadline < Time.zone.now
+    end
+
+    validate(if: -> { determination.present? }) do
+      unless cpd_audit_level.determinations.include?(determination)
+        self.errors.add(:determination, 'must exist in this audit level')
+      end
+    end
+
+    # If we're submitted. Check if we can go into reviewed?
+    before_save(if: -> { submitted? }) { try_complete! }
+    before_save(if: -> { completed? }) { try_review! }
+
+    after_commit(on: :create) do
+      send_email(:cpd_audit_opened)
+    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 wizard_step_title(step)
+      self.class::WIZARD_STEPS[step] || dynamic_wizard_steps.fetch(step)
+    end
+
+    def required_steps
+      steps = [:start, :information, :instructions]
+
+      steps << :conflict if cpd_audit_level.conflict_of_interest?
+
+      steps << :exemption if cpd_audit_level.can_request_exemption?
+
+      unless exemption_requested?
+        steps << :extension if cpd_audit_level.can_request_extension?
+      end
+
+      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
+
+    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
+
+  def to_s
+    persisted? ? "#{cpd_audit_level} Audit of #{name}" : 'audit'
+  end
+
+  def name
+    anonymous_name.presence || user.to_s
+  end
+
+  def anonymous?
+    cpd_audit_level&.anonymous?
+  end
+
+  def deadline_date
+    (extension_date || notification_date)
+  end
+
+  def draft?
+    !was_submitted?
+  end
+
+  def in_progress?
+    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)
+    position = (wizard_step.to_s.split('section').last.to_i rescue false)
+    cpd_audit_level.cpd_audit_level_sections.find { |section| (section.position + 1) == position }
+  end
+
+  # Find or build
+  def cpd_audit_response(cpd_audit_level_question)
+    cpd_audit_response = cpd_audit_responses.find { |r| r.cpd_audit_level_question_id == cpd_audit_level_question.id }
+    cpd_audit_response ||= cpd_audit_responses.build(cpd_audit: self, cpd_audit_level_question: cpd_audit_level_question)
+  end
+
+  # Auditee wizard action
+  def start!
+    started!
+  end
+
+  # Admin action
+  def resolve_conflict!
+    wizard_steps[:conflict] = nil   # Have them complete the conflict step again.
+
+    assign_attributes(conflict_of_interest: false, conflict_of_interest_reason: nil)
+    conflicted_resolved!
+    submitted!
+
+    send_email(:cpd_audit_conflict_resolved)
+    true
+  end
+
+  # Auditee wizard action
+  def exemption!
+    return started! unless exemption_request?
+
+    update!(status: :exemption_requested)
+    send_email(:cpd_audit_exemption_request)
+  end
+
+  # Admin action
+  def process_exemption!
+    case admin_process_request
+    when 'Granted' then grant_exemption!
+    when 'Denied' then deny_exemption!
+    else
+      self.errors.add(:admin_process_request, "can't be blank"); save!
+    end
+  end
+
+  def grant_exemption!
+    wizard_steps[:submit] ||= Time.zone.now
+    submitted! && exemption_granted!
+    send_email(:cpd_audit_exemption_granted)
+  end
+
+  def deny_exemption!
+    assign_attributes(exemption_request: false)
+    exemption_denied!
+    send_email(:cpd_audit_exemption_denied)
+  end
+
+  # Auditee wizard action
+  def extension!
+    return started! unless extension_request?
+
+    update!(status: :extension_requested)
+    send_email(:cpd_audit_extension_request)
+  end
+
+  # Admin action
+  def process_extension!
+    case admin_process_request
+    when 'Granted' then grant_extension!
+    when 'Denied' then deny_extension!
+    else
+      self.errors.add(:admin_process_request, "can't be blank"); save!
+    end
+  end
+
+  def grant_extension!
+    self.extension_date = extension_request_date
+    self.due_date = deadline_to_submit()
+
+    cpd_audit_reviews.each { |cpd_audit_review| cpd_audit_review.extension_granted! }
+    extension_granted!
+    send_email(:cpd_audit_extension_granted)
+  end
+
+  def deny_extension!
+    assign_attributes(extension_request: false)
+    extension_denied!
+    send_email(:cpd_audit_extension_denied)
+  end
+
+  # Require CPD step
+  def user_cpd_required?
+    return false unless user.cpd_audit_cpd_required?
+    required_cpd_cycle.present?
+  end
+
+  def user_cpd_completed?
+    return true if required_cpd_cycle.blank?
+    user.cpd_statements.any? { |s| s.completed? && s.cpd_cycle_id == required_cpd_cycle.id }
+  end
+
+  def required_cpd_cycle
+    @required_cpd_cycle ||= begin
+      last_year = ((notification_date || created_at || Time.zone.now) - 1.year).all_year
+      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!
+      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!
+    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)
+  end
+
+  # Admin action
+  def close!
+    closed!
+    send_email(:cpd_audit_closed)
+  end
+
+  def email_form_defaults(action)
+    { from: EffectiveCpd.mailer_sender }
+  end
+
+  def send_email(email)
+    EffectiveCpd.send_email(email, self, email_form_params) unless email_form_skip?
+    true
+  end
+
+  def deadline_to_conflict_of_interest
+    return nil unless cpd_audit_level&.conflict_of_interest?
+    return nil unless cpd_audit_level.days_to_declare_conflict.present?
+
+    date = (notification_date || created_at || Time.zone.now)
+    EffectiveResources.advance_date(date, business_days: cpd_audit_level.days_to_declare_conflict)
+  end
+
+  def deadline_to_exemption
+    return nil unless cpd_audit_level&.can_request_exemption?
+    return nil unless cpd_audit_level.days_to_request_exemption.present?
+
+    date = (notification_date || created_at || Time.zone.now)
+    EffectiveResources.advance_date(date, business_days: cpd_audit_level.days_to_request_exemption)
+  end
+
+  def deadline_to_extension
+    return nil unless cpd_audit_level&.can_request_extension?
+    return nil unless cpd_audit_level.days_to_request_extension.present?
+
+    date = (notification_date || created_at || Time.zone.now)
+    EffectiveResources.advance_date(date, business_days: cpd_audit_level.days_to_request_extension)
+  end
+
+  def deadline_to_submit
+    return nil unless cpd_audit_level&.days_to_submit.present?
+
+    date = (extension_date || notification_date || created_at || Time.zone.now)
+    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

@@ -0,0 +1,111 @@
+# EffectiveCpdUser
+#
+# Mark your user model with effective_cpd_user to get a few helpers
+# And user specific point required scores
+
+module EffectiveCpdAuditLevel
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_cpd_audit_level
+      include ::EffectiveCpdAuditLevel
+    end
+  end
+
+  module ClassMethods
+    def effective_cpd_audit_level?; true; end
+  end
+
+  included do
+    has_many_rich_texts
+
+    # For each cpd audit and cpd audit review wizard step
+    # rich_text_all_steps_audit_content
+    # rich_text_step_audit_content
+
+    # rich_text_all_steps_audit_review_content
+    # rich_text_step_audit_review_content
+
+    # App scoped
+    has_many :cpd_audits
+
+    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
+    has_many :cpd_audit_level_sections, -> { Effective::CpdAuditLevelSection.sorted }, class_name: 'Effective::CpdAuditLevelSection', inverse_of: :cpd_audit_level, dependent: :destroy
+    accepts_nested_attributes_for :cpd_audit_level_sections, allow_destroy: true
+
+    has_many :cpd_audit_level_questions, -> { Effective::CpdAuditLevelQuestion.sorted }, class_name: 'Effective::CpdAuditLevelQuestion', through: :cpd_audit_level_sections
+
+    if respond_to?(:log_changes)
+      log_changes(except: [:cpd_audits, :cpd_audit_reviews, :cpd_audit_level_sections, :cpd_audit_level_questions])
+    end
+
+    effective_resource do
+      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
+
+      days_to_submit                :integer  # For auditee to submit statement
+      days_to_review                :integer  # For auditor/audit_review to be completed
+
+      conflict_of_interest          :boolean      # Feature flags
+      can_request_exemption         :boolean
+      can_request_extension         :boolean
+
+      days_to_declare_conflict      :integer
+      days_to_request_exemption     :integer
+      days_to_request_extension     :integer
+
+      timestamps
+    end
+
+    serialize :determinations, Array
+    serialize :recommendations, Array
+
+    scope :deep, -> { all }
+    scope :sorted, -> { order(:title) }
+
+    validates :title, presence: true
+    validates :determinations, presence: true
+    validates :recommendations, presence: true
+
+    validates :days_to_submit, numericality: { greater_than: 0, allow_nil: true }
+    validates :days_to_review, numericality: { greater_than: 0, allow_nil: true }
+
+    validates :days_to_declare_conflict, presence: true, if: -> { conflict_of_interest? }
+    validates :days_to_declare_conflict, numericality: { greater_than: 0, allow_nil: true }
+
+    validates :days_to_request_exemption, presence: true, if: -> { can_request_exemption? }
+    validates :days_to_request_exemption, numericality: { greater_than: 0, allow_nil: true }
+
+    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
+      raise("can't destroy audit level with existing audits") if cpd_audits.length > 0
+    end
+  end
+
+  def to_s
+    title.presence || 'audit level'
+  end
+
+  def determinations
+    Array(self[:determinations]) - [nil, '']
+  end
+
+  def recommendations
+    Array(self[:recommendations]) - [nil, '']
+  end
+
+end