effective_cpd 0.0.1 → 0.1

data/app/models/effective/cpd_audit_level_question.rb

@@ -0,0 +1,91 @@
+module Effective
+  class CpdAuditLevelQuestion < ActiveRecord::Base
+    belongs_to :cpd_audit_level
+    belongs_to :cpd_audit_level_section
+
+    has_many :cpd_audit_level_question_options, -> { CpdAuditLevelQuestionOption.sorted }, inverse_of: :cpd_audit_level_question, dependent: :delete_all
+    accepts_nested_attributes_for :cpd_audit_level_question_options, reject_if: :all_blank, allow_destroy: true
+
+    has_many :cpd_audit_responses
+
+    has_one_attached :upload_file
+    has_rich_text :body
+
+    if respond_to?(:log_changes)
+      log_changes(to: :cpd_audit_level, except: [:cpd_audit_responses])
+    end
+
+    CATEGORIES = [
+      'Choose one',   # Radios
+      'Select all that apply', # Checks
+      'Select up to 1',
+      'Select up to 2',
+      'Select up to 3',
+      'Select up to 4',
+      'Select up to 5',
+      'Date',         # Date Field
+      'Email',        # Email Field
+      'Number',       # Numeric Field
+      'Long Answer',  # Text Area
+      'Short Answer', # Text Field
+      'Upload File'   # File field
+    ]
+
+    WITH_OPTIONS_CATEGORIES = [
+      'Choose one',   # Radios
+      'Select all that apply', # Checks
+      'Select up to 1',
+      'Select up to 2',
+      'Select up to 3',
+      'Select up to 4',
+      'Select up to 5'
+    ]
+
+    effective_resource do
+      title         :text
+      category      :string
+      required      :boolean
+
+      position  :integer
+
+      timestamps
+    end
+
+    scope :deep, -> { with_rich_text_body.includes(:cpd_audit_level_section, :cpd_audit_level_question_options) }
+    scope :sorted, -> { order(:position) }
+
+    before_validation(if: -> { cpd_audit_level_section.present? }) do
+      self.cpd_audit_level = cpd_audit_level_section.cpd_audit_level
+      self.position ||= (cpd_audit_level_section.cpd_audit_level_questions.map(&:position).compact.max || -1) + 1
+    end
+
+    validates :title, presence: true
+    validates :category, presence: true, inclusion: { in: CATEGORIES }
+    validates :position, presence: true
+    validates :cpd_audit_level_question_options, presence: true, if: -> { question_option? }
+
+    before_destroy do
+      if (count = cpd_audit_responses.length) > 0
+        raise("#{count} audit responses belong to this question")
+      end
+    end
+
+    # Create choose_one? and select_all_that_apply? methods for each category
+    CATEGORIES.each do |category|
+      define_method(category.parameterize.underscore + '?') { self.category == category }
+    end
+
+    def question_option?
+      WITH_OPTIONS_CATEGORIES.include?(category)
+    end
+
+    def category_partial
+      category.to_s.parameterize.underscore
+    end
+
+    def to_s
+      title.presence || 'audit question'
+    end
+
+  end
+end

data/app/models/effective/cpd_audit_level_question_option.rb

@@ -0,0 +1,34 @@
+module Effective
+  class CpdAuditLevelQuestionOption < ActiveRecord::Base
+    belongs_to :cpd_audit_level_question
+
+    has_many :cpd_audit_response_options
+
+    effective_resource do
+      title         :text
+      position      :integer
+
+      timestamps
+    end
+
+    before_validation(if: -> { cpd_audit_level_question.present? }) do
+      self.position ||= (cpd_audit_level_question.cpd_audit_level_question_options.map { |obj| obj.position }.compact.max || -1) + 1
+    end
+
+    scope :sorted, -> { order(:position) }
+
+    validates :title, presence: true
+    validates :position, presence: true
+
+    before_destroy do
+      if (count = cpd_audit_response_options.length) > 0
+        raise("#{count} audit response options belong to this question option")
+      end
+    end
+
+    def to_s
+      title.presence || 'New Audit Question Option'
+    end
+
+  end
+end

data/app/models/effective/cpd_audit_level_section.rb

@@ -0,0 +1,50 @@
+module Effective
+  class CpdAuditLevelSection < ActiveRecord::Base
+    belongs_to :cpd_audit_level
+
+    has_rich_text :top_content
+    has_rich_text :bottom_content
+
+    has_many :cpd_audit_level_questions, -> { CpdAuditLevelQuestion.sorted }, inverse_of: :cpd_audit_level_section, dependent: :destroy
+    accepts_nested_attributes_for :cpd_audit_level_questions, allow_destroy: true
+
+    has_many :cpd_audit_responses
+
+    if respond_to?(:log_changes)
+      log_changes(to: :cpd_audit_level, except: [:cpd_audit_responses])
+    end
+
+    effective_resource do
+      title     :string
+      position  :integer
+
+      timestamps
+    end
+
+    scope :deep, -> {
+      with_rich_text_top_content
+      .with_rich_text_bottom_content
+      .includes(cpd_audit_level_questions: [:rich_text_body])
+    }
+
+    scope :sorted, -> { order(:position) }
+
+    before_validation(if: -> { cpd_audit_level.present? }) do
+      self.position ||= (cpd_audit_level.cpd_audit_level_sections.map(&:position).compact.max || -1) + 1
+    end
+
+    validates :title, presence: true
+    validates :position, presence: true
+
+    before_destroy do
+      if (count = cpd_audit_responses.length) > 0
+        raise("#{count} audit responses belong to this section")
+      end
+    end
+
+    def to_s
+      title.presence || 'audit section'
+    end
+
+  end
+end

data/app/models/effective/cpd_audit_response.rb

@@ -0,0 +1,86 @@
+module Effective
+  class CpdAuditResponse < ActiveRecord::Base
+    belongs_to :cpd_audit
+    belongs_to :cpd_audit_level_section
+    belongs_to :cpd_audit_level_question
+
+    has_many :cpd_audit_response_options, dependent: :delete_all
+    has_many :cpd_audit_level_question_options, through: :cpd_audit_response_options
+
+    has_one_attached :upload_file
+
+    if respond_to?(:log_changes)
+      log_changes(to: :cpd_audit)
+    end
+
+    effective_resource do
+      # The response
+      date            :date
+      email           :string
+      number          :integer
+      long_answer     :text
+      short_answer    :text
+
+      timestamps
+    end
+
+    scope :submitted, -> { where(cpd_audit: Effective::CpdAudit.where.not(submitted_at: nil)) }
+    scope :deep, -> { includes(:cpd_audit, :cpd_audit_level_question) }
+
+    before_validation(if: -> { cpd_audit_level_question.present? }) do
+      self.cpd_audit_level_section = cpd_audit_level_question.cpd_audit_level_section
+    end
+
+    validates :date, presence: true, if: -> { cpd_audit_level_question&.required? && cpd_audit_level_question.date? }
+    validates :email, presence: true, email: true, if: -> { cpd_audit_level_question&.required? && cpd_audit_level_question.email? }
+    validates :number, presence: true, if: -> { cpd_audit_level_question&.required? && cpd_audit_level_question.number? }
+    validates :long_answer, presence: true, if: -> { cpd_audit_level_question&.required? && cpd_audit_level_question.long_answer? }
+    validates :short_answer, presence: true, if: -> { cpd_audit_level_question&.required? && cpd_audit_level_question.short_answer? }
+    validates :upload_file, presence: true, if: -> { cpd_audit_level_question&.required? && cpd_audit_level_question.upload_file? }
+    validates :cpd_audit_level_question_option_ids, presence: true, if: -> { cpd_audit_level_question&.required? && cpd_audit_level_question.question_option? }
+
+    validates :cpd_audit_level_question_option_ids, if: -> { cpd_audit_level_question&.choose_one? },
+      length: { maximum: 1, message: 'please choose 1 option only' }
+
+    validates :cpd_audit_level_question_option_ids, if: -> { cpd_audit_level_question&.select_up_to_1? },
+      length: { maximum: 1, message: 'please select 1 option or fewer' }
+
+    validates :cpd_audit_level_question_option_ids, if: -> { cpd_audit_level_question&.select_up_to_2? },
+      length: { maximum: 2, message: 'please select 2 options or fewer' }
+
+    validates :cpd_audit_level_question_option_ids, if: -> { cpd_audit_level_question&.select_up_to_3? },
+      length: { maximum: 3, message: 'please select 3 options or fewer' }
+
+    validates :cpd_audit_level_question_option_ids, if: -> { cpd_audit_level_question&.select_up_to_4? },
+      length: { maximum: 4, message: 'please select 4 options or fewer' }
+
+    validates :cpd_audit_level_question_option_ids, if: -> { cpd_audit_level_question&.select_up_to_5? },
+      length: { maximum: 5, message: 'please select 5 options or fewer' }
+
+    def to_s
+      'audit response'
+    end
+
+    def response
+      return nil unless cpd_audit_level_question.present?
+
+      return date if cpd_audit_level_question.date?
+      return email if cpd_audit_level_question.email?
+      return number if cpd_audit_level_question.number?
+      return long_answer if cpd_audit_level_question.long_answer?
+      return short_answer if cpd_audit_level_question.short_answer?
+      return upload_file if cpd_audit_level_question.upload_file?
+
+      return cpd_audit_level_question_options.first if cpd_audit_level_question.choose_one?
+      return cpd_audit_level_question_options.first if cpd_audit_level_question.select_up_to_1?
+      return cpd_audit_level_question_options if cpd_audit_level_question.question_option?
+
+      raise('unknown response for unexpected cpd audit question category')
+    end
+
+    def category_partial
+      cpd_audit_level_question&.category_partial
+    end
+
+  end
+end

data/app/models/effective/cpd_audit_response_option.rb

@@ -0,0 +1,6 @@
+module Effective
+  class CpdAuditResponseOption < ActiveRecord::Base
+    belongs_to :cpd_audit_response
+    belongs_to :cpd_audit_level_question_option
+  end
+end

data/app/models/effective/cpd_audit_review.rb

@@ -0,0 +1,222 @@
+module Effective
+  class CpdAuditReview < ActiveRecord::Base
+    attr_accessor :current_user
+    attr_accessor :current_step
+
+    belongs_to :cpd_audit
+    belongs_to :cpd_audit_level
+    belongs_to :user, polymorphic: true    # Auditor
+
+    has_many :cpd_audit_review_items, -> { CpdAuditReviewItem.sorted }, inverse_of: :cpd_audit_review
+    accepts_nested_attributes_for :cpd_audit_review_items, reject_if: :all_blank, allow_destroy: true
+
+    if respond_to?(:log_changes)
+      log_changes(to: :cpd_audit, except: :wizard_steps)
+    end
+
+    acts_as_email_form
+    acts_as_tokened
+
+    acts_as_wizard(
+      start: 'Start',
+      information: 'Information',
+      instructions: 'Instructions',
+
+      # Optional based on cpd_audit_level options
+      conflict: 'Conflict of Interest',
+
+      waiting: 'Waiting on Auditee Submission',
+
+      statements: 'Review CPD Statements',
+      # ... There will be one step per cpd_statement here. "statement1"
+
+      questionnaire: 'Review Questionnaire Responses',
+      # ... There will be one step per cpd_audit_level_sections here
+
+      recommendation: 'Recommendation',
+      submit: 'Confirm & Submit',
+      complete: 'Complete'
+    )
+
+    effective_resource do
+      token                     :string
+      due_date                  :date
+
+      # Auditor response
+      conflict_of_interest          :boolean
+      conflict_of_interest_reason   :text
+
+      # Rolling comments
+      comments                  :text
+
+      # Recommendation Step
+      recommendation            :string
+
+      # Status Dates
+      submitted_at              :datetime
+
+      # acts_as_statused
+      # I'm not using acts_as_statused yet, but I probably will later
+      status                  :string
+      status_steps            :text
+
+      # Wizard Progress
+      wizard_steps              :text
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:cpd_audit, :cpd_audit_level, :user) }
+    scope :sorted, -> { order(:id) }
+
+    scope :available, -> { where(submitted_at: nil) }
+    scope :completed, -> { where.not(submitted_at: nil) }
+
+    before_validation(if: -> { new_record? }) do
+      self.cpd_audit_level ||= cpd_audit&.cpd_audit_level
+      self.due_date ||= deadline_to_review()
+    end
+
+    validate(if: -> { recommendation.present? }) do
+      unless cpd_audit_level.recommendations.include?(recommendation)
+        self.errors.add(:recommendation, 'must exist in this audit level')
+      end
+    end
+
+    after_commit(on: :create) { send_email(:cpd_audit_review_opened) }
+    after_commit(on: :destroy) { cpd_audit.review! }
+
+    def to_s
+      'audit review'
+    end
+
+    def to_s
+      persisted? ? "#{cpd_audit_level} Audit Review by #{user}" : 'audit review'
+    end
+
+    # Find or build
+    def cpd_audit_review_item(item)
+      unless item.kind_of?(CpdAuditResponse) || item.kind_of?(CpdStatementActivity)
+        raise("expected a cpd_audit_response or cpd_statement_activity")
+      end
+
+      cpd_audit_review_item = cpd_audit_review_items.find { |cari| cari.item == item }
+      cpd_audit_review_item ||= cpd_audit_review_items.build(item: item)
+    end
+
+    # The dynamic CPD Statement review steps
+    def auditee_cpd_statements
+      cpd_audit.user.cpd_statements.select do |cpd_statement|
+        cpd_statement.completed? && (submitted_at.blank? || cpd_statement.submitted_at < submitted_at)
+      end
+    end
+
+    def cpd_statement(wizard_step)
+      cpd_cycle_id = (wizard_step.to_s.split('statement').last.to_i rescue false)
+      auditee_cpd_statements.find { |cpd_statement| cpd_statement.cpd_cycle_id == cpd_cycle_id }
+    end
+
+    def dynamic_wizard_statement_steps
+      @statement_steps ||= auditee_cpd_statements.each_with_object({}) do |cpd_statement, h|
+        h["statement#{cpd_statement.cpd_cycle_id}".to_sym] = "#{cpd_statement.cpd_cycle.to_s} Activities"
+      end
+    end
+
+    # The dynamic CPD Audit Level Sections steps
+    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
+
+    def dynamic_wizard_questionnaire_steps
+      @questionnaire_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
+      dynamic_wizard_statement_steps.merge(dynamic_wizard_questionnaire_steps)
+    end
+
+    def can_visit_step?(step)
+      return (step == :complete) if completed?  # Can only view complete step once submitted
+      can_revisit_completed_steps(step)
+    end
+
+    def required_steps
+      steps = [:start, :information, :instructions]
+
+      steps << :conflict if cpd_audit_level.conflict_of_interest?
+
+      if conflict_of_interest?
+        return steps + [:submit, :complete]
+      end
+
+      steps += [:waiting] unless ready?
+
+      steps += [:statements] + dynamic_wizard_statement_steps.keys
+      steps += [:questionnaire] + dynamic_wizard_questionnaire_steps.keys
+      steps += [:recommendation, :submit, :complete]
+
+      steps
+    end
+
+    def wizard_step_title(step)
+      WIZARD_STEPS[step] || dynamic_wizard_steps.fetch(step)
+    end
+
+    # Called by CpdAudit.extension_granted
+    def extension_granted!
+      self.due_date = deadline_to_review()
+    end
+
+    # Called by CpdAudit.submit!
+    def ready!
+      send_email(:cpd_audit_review_ready)
+    end
+
+    # Called by review wizard submit step
+    def submit!
+      update!(submitted_at: Time.zone.now)
+      cpd_audit.review! # maybe go from submitted->removed
+
+      send_email(:cpd_audit_review_submitted)
+    end
+
+    # When ready, the applicant review wizard hides the waiting step
+    def ready?
+      cpd_audit&.was_submitted?
+    end
+
+    def in_progress?
+      submitted_at.blank?
+    end
+
+    def completed?
+      submitted_at.present?
+    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
+      cpd_audit.deadline_to_conflict_of_interest
+    end
+
+    def deadline_to_review
+      return nil unless cpd_audit_level&.days_to_review.present?
+
+      date = cpd_audit.deadline_to_submit
+      return nil unless date.present?
+
+      EffectiveResources.advance_date(date, business_days: cpd_audit_level.days_to_review)
+    end
+
+  end
+end