effective_cpd 0.0.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96dbf47b702128c10b5b8f1ee07f9fb4798efdd77220b506b75124737e55e8ec
-  data.tar.gz: a5e0a5a658c43ffef382a8becb65b7a84b61a24a01f701dbb7daaecf63aa391f
+  metadata.gz: 3f74220d92f6cb570ae692fae9610f7aa3c16435f025381cda0f1d76d37eb462
+  data.tar.gz: 5370d91a541e895acccdfe6249e7fab92083bd2e7a39138a5f1c37fe0f6141f1
 SHA512:
-  metadata.gz: 3ee41586315d02240cbdaa075b91aec80122db0c6820db8f5c79595af3e45a617fcabbe5284d67ef149209bd998870dd9684bf3d3bce0c88ddfec836e7e82e6b
-  data.tar.gz: ab8a10bd1aed88b3971d596a22bae191a6e9d77c20ba1f7343bc8888d9930feb57ab8d57cc2cb3aded11b938d5c83e8689ed2c54f85bd28cdd76291921c7fc7e
+  metadata.gz: 62863f2ebce7908df8170c7e981c026e2e16eff493376a2c21c00bfdeaeee1a2dd394713bfa5be6d1986452cd519ac6d94000f15c38ec8d5c3e561c4dd8eb297
+  data.tar.gz: f039df8345571dc4812372211026330d2fb69bc20eb398110cb8e0a5831273c4940132770dfdcb85212867e8b1beb5c7761b81ea52ae6b803f4579d65c48e4f3

data/README.md

@@ -43,19 +43,66 @@ Then migrate the database:
 rake db:migrate
 ```
 
-Render the "available statements for current_user" datatable on your user dashboard:
+Please add the following to your User model:
+
+```
+has_many :cpd_statements, -> { Effective::CpdStatement.sorted }, class_name: 'Effective::CpdStatement'
+```
+
+Use the following datatables to display to your user their statements and audits and audit reviews:
 
 ```haml
 %h2 Continuing Professional Development
 
-%p Please submit a CPD statement for the following available #{cpd_cycles_label}:
-= render_datatable(EffectiveCpdDatatable.new, simple: true)
+- # Auditee datatables (4)
+- auditing = EffectiveCpdAvailableAuditsDatatable.new(self)
+- if auditing.present?
+  .mt-4
+    %p You have been selected for audit:
+    = render_datatable(auditing, simple: true)
+
+- audited = EffectiveCpdCompletedAuditsDatatable.new(self)
+- if audited.present?
+  .mt-4
+    %p You have completed these past audits:
+    = render_datatable(audited, simple: true)
+
+- available = EffectiveCpdAvailableCyclesDatatable.new(self)
+- if available.present?
+  .mt-4
+    %p Please submit a CPD statement for the following available #{cpd_cycles_label}:
+    = render_datatable(available, simple: true)
+
+- completed = EffectiveCpdCompletedStatementsDatatable.new(self)
+- if completed.present?
+  .mt-4
+    %p You have completed these past statements:
+    = render_datatable(completed, simple: true)
 
-- datatable = EffectiveCpdStatementsDatatable.new(self)
-- if datatable.present?
+- # Auditor / Audit reviewer datatables (2)
+- reviewing = EffectiveCpdAvailableAuditReviewsDatatable.new(self)
+- if reviewing.present?
   .mt-4
-    %p You completed these statements:
-    = render_datatable(datatable, simple: true)
+    %p You have been selected to review the following audits:
+    = render_datatable(reviewing, simple: true)
+
+- reviewed = EffectiveCpdCompletedAuditReviewsDatatable.new(self)
+- if reviewed.present?
+  .mt-4
+    %p You have completed these past audit reviews:
+    = render_datatable(reviewed, simple: true)
+```
+
+On the Admin::Users#edit, you can use the following datatables as well:
+
+```haml
+%h2 CPD Statements
+- datatable = Admin::EffectiveCpdStatementsDatatable.new(user_id: user.id, user_type: user.class.name)
+= render_datatable(datatable, inline: true)
+
+%h2 CPD Audits
+- datatable = Admin::EffectiveCpdAuditsDatatable.new(user_id: user.id, user_type: user.class.name)
+= render_datatable(datatable)
 
 ```
 
@@ -63,9 +110,61 @@ Add a link to the admin menu:
 
 ```haml
 - if can? :admin, :effective_cpd
-  = link_to 'CPD Categories', effective_cpd.admin_cpd_categories_path
-  = link_to 'CPD Cycles', effective_cpd.admin_cpd_cycles_path
-  = link_to 'CPD Statements', effective_cpd.admin_cpd_statements_path
+  - if can? :index, Effective::CpdCategory
+    = nav_link_to 'CPD Categories', effective_cpd.admin_cpd_categories_path
+
+  - if can? :index, Effective::CpdCycle
+    = nav_link_to 'CPD Cycles', effective_cpd.admin_cpd_cycles_path
+
+  - if can? :index, Effective::CpdAuditLevel
+    = nav_link_to 'CPD Audit Levels', effective_cpd.admin_cpd_audit_levels_path
+
+  = nav_divider
+
+  - if can? :index, Effective::CpdStatement
+    = nav_link_to 'CPD Statements', effective_cpd.admin_cpd_statements_path
+
+  - if can? :index, Effective::CpdAudit
+    = nav_link_to 'CPD Audits', effective_cpd.admin_cpd_audits_path
+```
+
+## Configuration
+
+As an admin, visit the CPD Categories, then CPD Cycles, and CPD Audit levels.
+
+Once all these 3 areas have been configured, users can submit statements and audits can be performed.
+
+## Required Score
+
+You can specify the required score in the CPD Cycle.
+
+You can also programatically do it. Add the following to your user class.
+
+```
+# This is an ActiveRecord concern to add the has_many :cpd_statements
+effective_cpd_user
+
+# We require 100 points in the last 3 years.
+def cpd_statement_required_score(cpd_statement)
+  # We always consider the 3 year window, of the passed cpd_statement and the last two statements
+  last_two_statements = cpd_statements.select do |statement|
+    statement.completed? && statement.cpd_cycle_id < cpd_statement.cpd_cycle_id
+  end.last(2)
+
+  # They can submit 0 0 100
+  return 0 if last_two_statements.length < 2
+
+  # 100 points in the last 3 years.
+  required_score = 100
+
+  # Score so far
+  existing_score = last_two_statements.sum { |statement| statement.score }
+  raise('expected existing_score to be >= 0') if existing_score < 0
+
+  # Required score minus previous
+  return 0 if existing_score >= required_score
+  (required_score - existing_score)
+end
 ```
 
 ## Authorization
@@ -83,6 +182,12 @@ if user.persisted?
   can [:index, :show, :update], Effective::CpdStatement, user_id: user.id
   can [:index, :show], Effective::CpdCycle
   can([:create, :update, :destroy], Effective::CpdStatementActivity) { |sa| sa.cpd_statement.user_id == user.id }
+  can [:index, :show, :update], Effective::CpdAudit, user_id: user.id
+end
+
+if user.reviewer?
+  can [:index], Effective::CpdAudit
+  can [:index, :show, :update], Effective::CpdAuditReview, user_id: user.id
 end
 
 if user.admin?
@@ -91,7 +196,14 @@ if user.admin?
   can :manage, Effective::CpdCategory
   can :manage, Effective::CpdCycle
   can :manage, Effective::CpdRule
+
+  can :manage, Effective::CpdAuditLevel
+  can :manage, Effective::CpdAuditLevelSection
+  can :manage, Effective::CpdAuditLevelQuestion
+
   can :manage, Effective::CpdStatement
+  can :manage, Effective::CpdAudit
+  can :manage, Effective::CpdAuditReview
 end
 ```
 

data/app/assets/javascripts/effective_cpd/activities.js

@@ -44,6 +44,12 @@ $(document).on('click', '[data-cpd-edit-activity]', function(event) {
   $activity.children('.statement-activity-form').show()
 });
 
+// When we click any x button
+$(document).on('click', '[data-cpd-collapse]', function(event) {
+  event.preventDefault()
+  collapse_effective_cpd_activities()
+});
+
 // Initializers
 $(document).ready(function() { initialize_effective_cpd_activities() });
 $(document).on('turbolinks:load', function() { initialize_effective_cpd_activities() });

data/app/controllers/admin/cpd_audit_level_questions_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdAuditLevelQuestionsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_audit_level_question).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_audit_levels_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdAuditLevelsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_audit_level).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_audit_reviews_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdAuditReviewsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_audit_review).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_audits_controller.rb

@@ -0,0 +1,41 @@
+module Admin
+  class CpdAuditsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    submit :resolve_conflict, 'Resolve Conflict of Interest', success: -> {
+      [
+        "Successfully resolved #{resource}",
+        ("and sent #{resource.user.email} a notification" unless resource.email_form_skip?)
+      ].compact.join(' ')
+    }
+
+    submit :close, 'Close Audit', success: -> {
+      [
+        "Successfully closed #{resource}",
+        ("and sent #{resource.user.email} a notification" unless resource.email_form_skip?)
+      ].compact.join(' ')
+    }
+
+    submit :process_exemption, 'Process Exemption Request', success: -> {
+      [
+        "Successfully #{resource.status.gsub('_', ' ')} #{resource}",
+        ("and sent #{resource.user.email} a notification" unless resource.email_form_skip?)
+      ].compact.join(' ')
+    }
+
+    submit :process_extension, 'Process Extension Request', success: -> {
+      [
+        "Successfully #{resource.status.gsub('_', ' ')} #{resource}",
+        ("and sent #{resource.user.email} a notification" unless resource.email_form_skip?)
+      ].compact.join(' ')
+    }
+
+    def permitted_params
+      params.require(:effective_cpd_audit).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_special_rules_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdSpecialRulesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_special_rule).permit!
+    end
+
+  end
+end

data/app/controllers/effective/cpd_audit_reviews_controller.rb

@@ -0,0 +1,60 @@
+module Effective
+  class CpdAuditReviewsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::WizardController
+
+    resource_scope do
+      Effective::CpdAuditReview.deep.where(user: current_user)
+    end
+
+    # Reuse the same view for all cpd_audit_level_section steps
+    # https://github.com/zombocom/wicked/blob/v1.3.4/lib/wicked/controller/concerns/render_redirect.rb#L32
+    def render_step(the_step, options = {}, params = {})
+      if resource.dynamic_wizard_statement_steps.keys.include?(the_step)
+        render('cpd_statement', options)
+      elsif resource.dynamic_wizard_questionnaire_steps.keys.include?(the_step)
+        render('cpd_audit_level_section', options)
+      else
+        super
+      end
+    end
+
+    def permitted_params
+      case step
+      when :start
+        params.require(:effective_cpd_audit_review).permit(:current_step, :comments)
+      when :information
+        params.require(:effective_cpd_audit_review).permit(:current_step, :comments)
+      when :instructions
+        params.require(:effective_cpd_audit_review).permit(:current_step, :comments)
+      when :conflict
+        params.require(:effective_cpd_audit_review)
+          .permit(:current_step, :comments, :conflict_of_interest, :conflict_of_interest_reason)
+      when :statements
+        params.require(:effective_cpd_audit_review).permit(:current_step, :comments)
+      when :questionnaire
+        params.require(:effective_cpd_audit_review).permit(:current_step, :comments)
+      when :recommendation
+        params.require(:effective_cpd_audit_review).permit(:current_step, :comments, :recommendation)
+      when :submit
+        params.require(:effective_cpd_audit_review).permit(:current_step)
+      when :complete
+        raise('unexpected post to complete')
+      else
+        if step.to_s.start_with?('statement')
+          params.require(:effective_cpd_audit_review).permit(:current_step, :comments,
+            cpd_audit_review_items_attributes: [:id, :item_id, :item_type, :recommendation, :comments]
+          )
+        elsif step.to_s.start_with?('section')
+          params.require(:effective_cpd_audit_review).permit(:current_step, :comments,
+            cpd_audit_review_items_attributes: [:id, :item_id, :item_type, :recommendation, :comments]
+          )
+        else
+          raise('unexpected step')
+        end
+      end
+    end
+
+  end
+end

data/app/controllers/effective/cpd_audits_controller.rb

@@ -0,0 +1,55 @@
+module Effective
+  class CpdAuditsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::WizardController
+
+    resource_scope do
+      Effective::CpdAudit.deep.where(user: current_user)
+    end
+
+    # Reuse the same view for all cpd_audit_level_section steps
+    # https://github.com/zombocom/wicked/blob/v1.3.4/lib/wicked/controller/concerns/render_redirect.rb#L32
+    def render_step(the_step, options = {}, params = {})
+      return super unless resource.dynamic_wizard_steps.keys.include?(the_step)
+      render('cpd_audit_level_section', options)
+    end
+
+    def permitted_params
+      case step
+      when :start
+        params.require(:effective_cpd_audit).permit(:current_step)
+      when :information
+        params.require(:effective_cpd_audit).permit(:current_step)
+      when :instructions
+        params.require(:effective_cpd_audit).permit(:current_step)
+      when :conflict
+        params.require(:effective_cpd_audit)
+          .permit(:current_step, :conflict_of_interest, :conflict_of_interest_reason)
+      when :exemption
+        params.require(:effective_cpd_audit)
+          .permit(:current_step, :exemption_request, :exemption_request_reason)
+      when :extension
+        params.require(:effective_cpd_audit)
+          .permit(:current_step, :extension_request, :extension_request_date, :extension_request_reason)
+      when :questionnaire
+        params.require(:effective_cpd_audit).permit(:current_step)
+      when :files
+        params.require(:effective_cpd_audit).permit(:current_step, files: [])
+      when :submit
+        params.require(:effective_cpd_audit).permit(:current_step)
+      when :complete
+        raise('unexpected post to complete')
+      else
+        raise('unexpected step') unless step.to_s.start_with?('section')
+
+        params.require(:effective_cpd_audit).permit(:current_step,
+          cpd_audit_responses_attributes: [
+            :id, :cpd_audit_id, :cpd_audit_level_question_id, :date, :email, :number, :long_answer, :short_answer, :upload_file, cpd_audit_level_question_option_ids: []
+          ]
+        )
+      end
+    end
+
+  end
+end

data/app/controllers/effective/cpd_cycles_controller.rb

@@ -2,6 +2,7 @@ module Effective
   class CpdCyclesController < ApplicationController
     before_action(:authenticate_user!) if defined?(Devise)
 
+    # If they visit /cpd_cycles/1, redirect to their statement for that cycle
     def show
       cycle = Effective::CpdCycle.find(params[:id])
       EffectiveResources.authorize!(self, :show, cycle)

data/app/controllers/effective/cpd_statements_controller.rb

@@ -57,9 +57,7 @@ module Effective
           :current_step, :confirm_read, :confirm_factual, files: []
         )
       when :submit
-        params.require(:effective_cpd_statement).permit(
-          :current_step, :confirm_readonly
-        )
+        params.require(:effective_cpd_statement).permit(:current_step, :confirm_readonly)
       when :complete
         raise('unexpected post to complete')
       else

data/app/datatables/admin/effective_cpd_audit_level_questions_datatable.rb

@@ -0,0 +1,30 @@
+module Admin
+  class EffectiveCpdAuditLevelQuestionsDatatable < Effective::Datatable
+    datatable do
+      reorder :position
+
+      col :created_at, visible: false
+      col :updated_at, visible: false
+      col :id, visible: false
+
+      col :cpd_audit_level_section
+
+      col :position do |cpd_audit_level_question|
+        cpd_audit_level_question.position.to_i + 1
+      end
+
+      col :title
+      col :body
+      col :required
+
+      col :category, label: 'Type'
+      col :cpd_audit_level_question_options, label: 'Options'
+
+      actions_col
+    end
+
+    collection do
+      Effective::CpdAuditLevelQuestion.all.deep
+    end
+  end
+end