effective_cpd 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13796b4516c32b7fd046c28fdaa1f034446e31e244c3012e9d6a0e1018feadac
-  data.tar.gz: 0a6b9cefe19dc6b61194037bfd2856f90dc74d09033b78a3edcbb508cbd92239
+  metadata.gz: 1b7b747aec6776c9ea09dc1e36517084133694dca965f7d32ec8a20d66a9596d
+  data.tar.gz: c21e47933d6026f612f79f0f63b52895d7319b2db744eb53b68e7881c280f497
 SHA512:
-  metadata.gz: ceaa617e8d6f772d12dd08009b00df480098c268ff65dc03e5ee11da3a556353cd4ae507324497c8a1b1610810a9cc4ac811803c7c02b6d28749f3715a19fe45
-  data.tar.gz: 6bae554b970a8edb702b57fb18a401191fc7da6ff5acddaf21db76c1d6a4ab452a7f53e8c72178d7ed451a94ed72f155d2f7e5f5a4e6d0abdfb794eeab7e8cf1
+  metadata.gz: ec38bd12ba35145518b3285534b32e006a86fa6e29ed39da8fae6d6554ac554b0ffb676aaa32fc592920a3d4c2e8181c9138c9a5338edcfabd789d612af930be
+  data.tar.gz: 6859e61d222b1fdcea05e91188f0b783de4ed76dd4f10dc8ce50dc0773ae4b4f5f39c90d2bb5ff188928bf2401ad7cd1e40b3ec4f1a2a2a7efd8e05063d0adb6

data/app/controllers/admin/cpd_audits_controller.rb

@@ -43,6 +43,13 @@ module Admin
       ].compact.join(' ')
     }
 
+    submit :complete, 'Ready to Review', success: -> {
+      [
+        "Successfully completed #{resource}",
+        ("and sent reviewers an audit ready notification" unless resource.email_form_skip)
+      ].compact.join(' ')
+    }
+
     submit :missing, 'Missing Info', success: -> {
       [
         "Successfully marked #{resource} as missing info",

data/app/datatables/admin/effective_cpd_audit_reviews_datatable.rb

@@ -26,7 +26,7 @@ module Admin
       col :submitted_at, as: :date, label: 'Submitted'
       col :conflict_of_interest
       col :recommendation
-      col :comments
+      col :comments, label: 'Reviewer notes'
 
       actions_col(edit: false)
     end

data/app/helpers/effective_cpd_audits_helper.rb

@@ -12,5 +12,23 @@ module EffectiveCpdAuditsHelper
     [['Yes, I would like to request an extension', true], ['No extension request', false]]
   end
 
+  def cpd_audit_new_reviewer_collection(cpd_audit = nil)
+    cpd_audit ||= EffectiveCpd.CpdAudit.new
+    raise('expected a cpd audit') unless cpd_audit.class.respond_to?(:effective_cpd_audit?)
+
+    cpd_audit.current_user = current_user
+    users = cpd_audit.suggested_cpd_audit_reviewers()
+
+    users.map do |user|
+      in_progress = content_tag(:span, class: 'badge badge-info') do
+        reviews = user.cpd_audit_reviews.count { |review| review.in_progress? }
+        "#{pluralize(reviews, 'review')} in progress"
+      end
+
+      html = content_tag(:div, "#{user} #{in_progress}")
+
+      [user.to_s, user.to_param, { 'data-html': html }]
+    end
+  end
 
 end

data/app/models/concerns/effective_cpd_audit.rb

@@ -352,11 +352,11 @@ module EffectiveCpdAudit
     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."
+      approval = "Waiting on completeness check, 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."
+      "All required materials have been provided. Ready to review. 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'
@@ -508,11 +508,13 @@ module EffectiveCpdAudit
   def complete!
     raise('audit must have been submitted to complete!') unless was_submitted?
 
+    existing = cpd_audit_reviews.select { |cpd_audit_review| cpd_audit_review.persisted? }
+
     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! }
+    existing.each { |cpd_audit_review| cpd_audit_review.ready! }
 
     true
   end
@@ -616,4 +618,8 @@ module EffectiveCpdAudit
     assign_attributes(anonymous_number: number, anonymous_name: name)
   end
 
+  def suggested_cpd_audit_reviewers
+    (current_user || user).class.send(EffectiveCpd.audit_reviewer_user_scope).sorted_by_in_progress_cpd_audit_reviews
+  end
+
 end

data/app/models/concerns/effective_cpd_audit_review.rb

@@ -125,7 +125,10 @@ module EffectiveCpdAuditReview
       validates :anonymous_number, presence: true
     end
 
-    after_commit(on: :create) { send_email(:cpd_audit_review_opened) }
+    after_commit(on: :create) {
+      send_email(cpd_audit.was_completed? ? :cpd_audit_review_ready : :cpd_audit_review_opened)
+    }
+
     after_commit(on: :destroy) { cpd_audit.try_review! }
 
     def dynamic_wizard_statement_steps

data/app/models/concerns/effective_cpd_user.rb

@@ -26,6 +26,16 @@ module EffectiveCpdUser
 
     scope :cpd_audit_auditees, -> { without_role(:cpd_audit_reviewer).without_role(:admin) }
     scope :cpd_audit_reviewers, -> { with_role(:cpd_audit_reviewer) }
+
+    scope :sorted_by_in_progress_cpd_audit_reviews, -> {
+      left_joins(:cpd_audit_reviews)
+        .where(cpd_audit_reviews: { submitted_at: nil})
+        .includes(:cpd_audit_reviews)
+        .group(:id)
+        .order('COUNT(cpd_audit_reviews.id) ASC')
+        .order('MAX(cpd_audit_reviews.created_at) ASC')
+        .order('id ASC')
+    }
   end
 
   # This one will actually be enforced or displayed first

data/app/models/effective/cpd_audit_response_option.rb

@@ -2,5 +2,10 @@ module Effective
   class CpdAuditResponseOption < ActiveRecord::Base
     belongs_to :cpd_audit_response
     belongs_to :cpd_audit_level_question_option
+
+    def to_s
+      cpd_audit_level_question_option.to_s
+    end
+
   end
 end

data/app/views/admin/cpd_audit_reviews/_form.html.haml

@@ -11,6 +11,9 @@
   = render('admin/cpd_audits/audit_reviewer_fields', f: f)
 
   %p Send email
-  = email_form_fields(f, :cpd_audit_review_opened)
+  - if cpd_audit_review.cpd_audit&.was_completed?
+    = email_form_fields(f, :cpd_audit_review_ready)
+  - else
+    = email_form_fields(f, :cpd_audit_review_opened)
 
   = effective_submit(f)

data/app/views/admin/cpd_audits/_audit_reviewer_fields.html.haml

@@ -1,2 +1,2 @@
-- collection = current_user.class.send(EffectiveCpd.audit_reviewer_user_scope)
-= f.select :user, { 'Audit Reviewers' => collection }, label: 'Audit Reviewer', polymorphic: true
+= f.hidden_field :user_type, value: current_user.class.name
+= f.select :user_id, cpd_audit_new_reviewer_collection(f.object.cpd_audit), label: 'Audit Reviewer'

data/app/views/admin/cpd_audits/_form_close.html.haml

@@ -1,6 +1,6 @@
 = card('Determination') do
   = effective_form_with(model: [:admin, cpd_audit], engine: true) do |f|
-    %p This action will close this audit with the following determination:
+    %p This action will <strong>close</strong> this audit with the following determination:
 
     = f.select :determination, cpd_audit.cpd_audit_level.determinations
 

data/app/views/admin/cpd_audits/_form_complete.html.haml

@@ -1,17 +1,33 @@
 = effective_form_with(model: [:admin, cpd_audit], engine: true) do |f|
   = f.hidden_field :id
 
-  %p The #{cpd_audit} will be marked <strong>completed</strong>. All deliverables have been received and all requirements completed.
+  %p This audit will be marked as <strong>completed information</strong> and <strong>ready for review</strong>.
 
-  %p The audit reviewer(s) will be notified that this audit is ready to review.
+  - reviewers = cpd_audit.cpd_audit_reviews
 
-  %h3 Email to send
-  %p
+  - if reviewers.present?
+    %h3 Email to send
+    %p
+      - email = Effective::EmailTemplate.where(template_name: :cpd_audit_review_ready).first!
 
-    An
-    - email = Effective::EmailTemplate.where(template_name: :cpd_audit_review_ready).first!
-    = link_to('cpd_audit_review_ready email', effective_email_templates.edit_admin_email_template_path(email))
+      The existing
+      = link_to(pluralize(reviewers.length, 'assigned reviewer'), '#audit-reviews', 'data-click-tab': true)
+      will be sent an
+      = link_to('cpd_audit_review_ready email', effective_email_templates.edit_admin_email_template_path(email))
+      email.
 
-    email will be sent to each reviewer.
+  - if reviewers.blank?
+    %p Please assign one or more reviewers:
 
-  = f.submit 'Complete Audit', border: false, center: true, 'data-confirm': "Complete #{f.object}?"
+    - # Pre-select the first reviewer if present
+    - if f.object.cpd_audit_reviews.blank?
+      - f.object.cpd_audit_reviews.build(user: cpd_audit.suggested_cpd_audit_reviewers.first)
+
+    = f.has_many :cpd_audit_reviews, class: 'tight' do |fr|
+      = card('Reviewer') do
+        = render('admin/cpd_audits/audit_reviewer_fields', form: fr, f: fr)
+
+        %p Send email
+        = email_form_fields(fr, :cpd_audit_review_ready)
+
+  = f.submit 'Ready to Review', border: false, center: true, 'data-confirm': "Complete #{f.object}?"

data/app/views/admin/cpd_audits/_form_deadlines.html.haml

@@ -2,9 +2,9 @@
   %p The audittee has the following deadlines:
 
   %ul
-    %li To declare conflict of interest: #{f.object.deadline_to_conflict_of_interest}
-    %li To request exemption: #{f.object.deadline_to_exemption}
-    %li To request extension: #{f.object.deadline_to_extension}
+    %li To declare conflict of interest: #{f.object.deadline_to_conflict_of_interest.presence || 'None'}
+    %li To request exemption: #{f.object.deadline_to_exemption.presence || 'None'}
+    %li To request extension: #{f.object.deadline_to_extension.presence || 'None'}
 
   = f.check_box :ignore_deadlines, label: 'Yes, ignore audittee deadlines and allow these actions to be performed'
 

data/app/views/admin/cpd_audits/_form_new.html.haml

@@ -8,6 +8,8 @@
   = f.date_field :notification_date, label: 'Date of notification', required: false,
     hint: "the starting date for any deadline calculations. leave blank for today's date"
 
+  = render('admin/cpd_audits/form_new_fields', form: f, f: f)
+
   %h2 Auditee
   = card('Auditee') do
     %p.text-muted The auditee is the person being audited

data/app/views/admin/cpd_audits/_form_new_fields.html.haml

@@ -0,0 +1 @@
+-# Intentionally blank

data/app/views/admin/cpd_audits/_form_process.html.haml

@@ -6,7 +6,7 @@
 
 = accordion do
   - if EffectiveResources.authorized?(self, :complete, cpd_audit)
-    = collapse 'Complete this Audit' do
+    = collapse 'Ready for Review' do
       = render('admin/cpd_audits/form_complete', cpd_audit: cpd_audit)
 
   - if EffectiveResources.authorized?(self, :missing, cpd_audit)
@@ -14,5 +14,5 @@
       = render('admin/cpd_audits/form_missing_info', cpd_audit: cpd_audit)
 
   - if EffectiveResources.authorized?(self, :close, cpd_audit)
-    = collapse 'Close Audit with Determination' do
+    = collapse 'Close with Determination' do
       = render('admin/cpd_audits/form_close', cpd_audit: cpd_audit)

data/app/views/admin/cpd_audits/_status.html.haml

@@ -98,7 +98,7 @@
     - # Waiting to Complete
     - unless cpd_audit.was_completed?
       %tr
-        %td Waiting to Complete
+        %td Ready Check
         %td= cpd_audit.submitted_at&.strftime('%F') || '-'
         %td
           - cpd_audit.completed_requirements.each do |requirement, completed|
@@ -108,7 +108,7 @@
 
         %td
           - if cpd_audit.submitted?
-            = link_to 'Complete Audit', '#process', 'data-click-tab': true, class: 'btn btn-sm btn-primary'
+            = link_to 'Process: Ready or Missing Info', '#process', 'data-click-tab': true, class: 'btn btn-sm btn-primary'
 
     - # Missing Information
     %tr
@@ -120,10 +120,15 @@
         - if cpd_audit.was_missing_info? && cpd_audit.missing_info_reason.blank?
           = icon('check', class: 'small-1')
           Done
+
+        - if cpd_audit.was_completed? && !cpd_audit.was_missing_info?
+          = icon('check', class: 'small-1')
+          No Missing Info
+
       %td
 
     %tr
-      %td Complete
+      %td Ready for Review
       %td= cpd_audit.completed_at&.strftime('%F') || '-'
       %td
         - if cpd_audit.was_completed?

data/app/views/effective/cpd_audit_review_items/_fields.html.haml

@@ -8,4 +8,4 @@
 - else
   = f.radios :recommendation, recommendations, inline: true
 
-= f.text_area :comments
+= f.text_area :comments, label: 'Notes'

data/app/views/effective/cpd_audit_reviews/_summary.html.haml

@@ -70,5 +70,9 @@
         %td= cpd_audit_review.recommendation.presence || '-'
 
       %tr
-        %th Reviewer Comments
-        %td= cpd_audit_review.comments.presence || 'No comments'
+        %th Reviewer Notes
+        %td
+          - if cpd_audit_review.comments.present?
+            = simple_format(cpd_audit_review.comments)
+          - else
+            None

data/app/views/effective/cpd_audit_reviews/conflict.html.haml

@@ -20,6 +20,6 @@
       = f.text_area :conflict_of_interest_reason, required: true
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/cpd_audit_level_section.html.haml

@@ -38,6 +38,6 @@
       .mb-2= cpd_audit_level_section.bottom_content.to_s
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/cpd_statement.html.haml

@@ -30,6 +30,6 @@
                 = render('/effective/cpd_audit_review_items/fields', f: fi, cpd_audit_review: resource)
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/feedback.html.haml

@@ -3,7 +3,7 @@
     = collapse('Show audit...', card_class: '') do
       .mt-4= render('effective/cpd_audits/cpd_audit', cpd_audit: resource.cpd_audit)
 
-  %p Please provide any feedback for #{resource.cpd_audit.name}:
+  %p Please provide any final feedback for #{resource.cpd_audit.name}:
 
   = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
     = f.hidden_field :current_step
@@ -11,6 +11,6 @@
     = f.text_area :feedback, label: 'Feedback for the auditee'
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/files.html.haml

@@ -12,6 +12,6 @@
         %li= link_to(file.filename, url_for(file), target: '_blank')
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/instructions.html.haml

@@ -4,7 +4,7 @@
 
     %hr
 
-    %p The following rolling comments will be displayed for your use on each step.
-    = f.text_area :comments, label: 'Reviewer comments'
+    %p The following rolling notes will be displayed for your use on each step.
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/questionnaire.html.haml

@@ -3,6 +3,6 @@
     = f.hidden_field :current_step
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/recommendation.html.haml

@@ -18,6 +18,6 @@
       = f.radios :recommendation, recommendations, inline: true
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/statements.html.haml

@@ -23,6 +23,6 @@
     = f.hidden_field :current_step
 
     %hr
-    = f.text_area :comments, label: 'Reviewer comments'
+    = f.text_area :comments, label: 'Reviewer notes', hint: 'Not displayed to the auditee'
 
     = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_audit_reviews/submit.html.haml

@@ -11,4 +11,4 @@
   = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
     = f.hidden_field :current_step
 
-    = f.submit 'Submit Audit Review', center: true
+    = f.submit 'Submit Audit Review', center: true, 'data-confirm': "Really Submit Audit Review?"

data/app/views/effective/cpd_audits/_missing_info.html.haml

@@ -5,7 +5,7 @@
 
 %p
   Please revisit each wizard step and
-  = link_to 'Complete all missing information', wizard_path(:information), class: 'btn btn-primary'
+  = link_to 'Complete all missing information', wizard_path(:instructions), class: 'btn btn-primary'
   for this audit.
 
 %p

data/app/views/effective/cpd_audits/_summary.html.haml

@@ -40,6 +40,8 @@
                 %br
                 %small= mail_to cpd_audit_review.user.email
 
+      = render('effective/cpd_audits/summary_fields', cpd_audit: cpd_audit)
+
       %tr
         %th Date of notification
         %td= cpd_audit.notification_date.strftime('%F')

data/app/views/effective/cpd_audits/_summary_fields.html.haml

@@ -0,0 +1 @@
+- # Intentionally blank

data/app/views/effective/cpd_audits/submit.html.haml

@@ -13,6 +13,6 @@
     = f.hidden_field :current_step
 
     - if EffectiveResources.authorized?(self, :resubmit, resource)
-      = f.submit 'Resubmit Audit', center: true
+      = f.submit 'Resubmit Audit', center: true, 'data-confirm': "Really Resubmit Audit?"
     - else
-      = f.submit 'Submit Audit', center: true
+      = f.submit 'Submit Audit', center: true, 'data-confirm': "Really Submit Audit?"

data/lib/effective_cpd/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_cpd
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -311,6 +311,7 @@ files:
 - app/views/admin/cpd_audits/_form_files.html.haml
 - app/views/admin/cpd_audits/_form_missing_info.html.haml
 - app/views/admin/cpd_audits/_form_new.html.haml
+- app/views/admin/cpd_audits/_form_new_fields.html.haml
 - app/views/admin/cpd_audits/_form_process.html.haml
 - app/views/admin/cpd_audits/_status.html.haml
 - app/views/admin/cpd_bulk_audits/_form.html.haml
@@ -393,6 +394,7 @@ files:
 - app/views/effective/cpd_audits/_layout.html.haml
 - app/views/effective/cpd_audits/_missing_info.html.haml
 - app/views/effective/cpd_audits/_summary.html.haml
+- app/views/effective/cpd_audits/_summary_fields.html.haml
 - app/views/effective/cpd_audits/_waiting.html.haml
 - app/views/effective/cpd_audits/chat.html.haml
 - app/views/effective/cpd_audits/conflict.html.haml