effective_cpd 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce8f5f1c83904eecbd1cc49e84720ec7ed6d51aa39773354666b0e07e9bda56a
-  data.tar.gz: 3a69c509409f5d33427f19c223a4803d8b1a8a49aa1d8e9addc03ee4f16cefce
+  metadata.gz: d431d1c016484d56c812b1e62e51203d8d6dcc9a626452e3e0275a194126f045
+  data.tar.gz: af7ef23916669b65010a86afe274c65cc123662a95b30d69c96cd6767eae41f6
 SHA512:
-  metadata.gz: 0dfbe56c0a27a8743663d3ae374a62c1f0c674d46b189a2636b144d8f3bfe12c1ccc19fd8163e63d0b92010aeedc8b62856a5f87558ce231842093279b2404d3
-  data.tar.gz: '0864c315be7007b31a19dc76b934618ffd6bf678f547a063d9e6bdd0c62b491b13fccf62b264a69dadb7652cd527bdc27e3a1832bc0aa6fd798a2105feef7bbf'
+  metadata.gz: 64768ebc20002cc568e939d0ed694edc7d293899a3470529a42a88100a3a94dfd27dbc379ed250cbf3a3439a4abef84b9cefa95f4d00edfba8fea9d9ecfbb9bc
+  data.tar.gz: 91b7b3f4853dfd810c98039949f3ac1d00fc4d0a6ba95aa51745809d683b142ff21fc74ab397659b473d8620b3de1097be27e2b93065720ba09ec3f28a18aa67

data/README.md

@@ -186,8 +186,8 @@ if user.persisted?
 end
 
 if user.reviewer?
-  can [:index], Effective::CpdAudit
-  can [:index, :show, :update], Effective::CpdAuditReview, user_id: user.id
+  can [:index], EffectiveCpd.CpdAudit
+  can [:index, :show, :update], EffectiveCpd.CpdAuditReview, user_id: user.id
 end
 
 if user.admin?
@@ -197,15 +197,21 @@ if user.admin?
   can :manage, Effective::CpdCycle
   can :manage, Effective::CpdRule
 
-  can([:index, :show], Effective::CpdStatement)
-  can(:unsubmit, Effective::CpdStatement) { |statement| statement.completed? }
+  can([:index, :show], EffectiveCpd.CpdStatement)
+  can(:unsubmit, EffectiveCpd.CpdStatement) { |statement| statement.completed? }
 
   can :manage, Effective::CpdAuditLevel
   can :manage, Effective::CpdAuditLevelSection
   can :manage, Effective::CpdAuditLevelQuestion
 
-  can :manage, Effective::CpdAudit
-  can :manage, Effective::CpdAuditReview
+  can(crud - [:destroy], EffectiveCpd.CpdAudit)
+  can(:destroy, EffectiveCpd.CpdAudit) { |audit| audit.draft? }
+
+  can(:missing, EffectiveCpd.CpdAudit) { |audit| audit.was_submitted? && !audit.missing_info? }
+  can(:complete, EffectiveCpd.CpdAudit) { |audit| audit.was_submitted? && !audit.was_completed? }
+  can(:close, EffectiveCpd.CpdAudit) { |audit| audit.was_submitted? && !audit.closed? }
+
+  can(crud - [:edit, :update], EffectiveCpd.CpdAuditReview)
 end
 ```
 

data/app/controllers/effective/cpd_audit_reviews_controller.rb

@@ -8,6 +8,8 @@ module Effective
       EffectiveCpd.CpdAuditReview.deep.where(user: current_user)
     end
 
+    page_title 'Chat', only: [:chat]
+
     # 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 = {})

data/app/controllers/effective/cpd_audits_controller.rb

@@ -8,6 +8,8 @@ module Effective
 
     submit :resubmit, 'Resubmit Audit'
 
+    page_title 'Chat', only: [:chat]
+
     # 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 = {})

data/app/models/concerns/effective_cpd_audit.rb

@@ -42,6 +42,8 @@ module EffectiveCpdAudit
     acts_as_email_form
     acts_as_tokened
     acts_as_reportable if respond_to?(:acts_as_reportable)
+    effective_messaging_parent if respond_to?(:effective_messaging_parent)
+
     log_changes(except: [:wizard_steps, :cpd_audit_reviews]) if respond_to?(:log_changes)
 
     acts_as_statused(
@@ -66,6 +68,7 @@ module EffectiveCpdAudit
       start: 'Start',
       information: 'Information',
       instructions: 'Instructions',
+      demographics: 'Demographics',         # Individual only. Users fields.
 
       # These 4 steps are determined by audit_level settings
       conflict: 'Conflict of Interest',
@@ -88,7 +91,9 @@ module EffectiveCpdAudit
 
     # App scoped
     belongs_to :cpd_audit_level, polymorphic: true
+
     belongs_to :user, polymorphic: true  # The user being audited
+    accepts_nested_attributes_for :user
 
     has_many :cpd_audit_reviews, -> { order(:id) }, inverse_of: :cpd_audit, dependent: :destroy
     accepts_nested_attributes_for :cpd_audit_reviews, allow_destroy: true
@@ -236,7 +241,7 @@ module EffectiveCpdAudit
     end
 
     def required_steps
-      steps = [:start, :information, :instructions]
+      steps = [:start, :information, :instructions, :demographics]
 
       steps << :conflict if cpd_audit_level.conflict_of_interest?
 
@@ -265,10 +270,29 @@ module EffectiveCpdAudit
 
       can_revisit_completed_steps(step)
     end
+
+    # Effective Messaging. Find or build chat.
+    def build_chat
+      chat = chats.first || chats.build
+
+      # Assign title and anonymous
+      chat.assign_attributes(title: to_s, anonymous: anonymous?)
+
+      # Create a chat user for auditee
+      chat.build_chat_user(user: user, anonymous_name: anonymous_name)
+
+      # Create a chat user for each audit reviewer
+      cpd_audit_reviews.each do |cpd_audit_review|
+        chat.build_chat_user(user: cpd_audit_review.user, anonymous_name: cpd_audit_review.anonymous_name)
+      end
+
+      chat
+    end
+
   end
 
   def to_s
-    persisted? ? "#{cpd_audit_level} Audit of #{name}" : 'audit'
+    (cpd_audit_level.present? && name.present?) ? "#{cpd_audit_level} Audit of #{name}" : 'audit'
   end
 
   def name
@@ -477,6 +501,7 @@ module EffectiveCpdAudit
 
   # called by a before_save when submitted
   def try_complete!
+    # complete! if submitted? # Automatically go from submitted->complete
     false # Nothing to do. Admin completes audits.
   end
 

data/app/models/concerns/effective_cpd_statement.rb

@@ -68,6 +68,7 @@ module EffectiveCpdStatement
 
     scope :draft, -> { where(submitted_at: nil) }
     scope :completed, -> { where.not(submitted_at: nil) }
+    scope :submitted, -> { where.not(submitted_at: nil) }
 
     # effective_reports
     def reportable_scopes

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

@@ -0,0 +1,4 @@
+- if cpd_audit.chat.present?
+  = render('effective/chats/chat', chat: cpd_audit.chat)
+- else
+  %p No chat messages

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

@@ -51,6 +51,10 @@
       - datatable = EffectiveResources.best('Admin::EffectiveCpdAuditReviewsDatatable').new(cpd_audit: cpd_audit)
       = render_datatable(datatable, inline: true, simple: true)
 
+    - if EffectiveCpd.use_effective_messaging?
+      = tab 'Chat' do
+        = render 'admin/cpd_audits/form_chat', cpd_audit: cpd_audit
+
     - if cpd_audit.respond_to?(:log_changes_datatable)
       = tab 'Logs' do
         = render_inline_datatable(cpd_audit.log_changes_datatable)

data/app/views/admin/users/_form_cpd.html.haml

@@ -13,3 +13,10 @@
 %h2 Audits
 - datatable = Admin::EffectiveCpdAuditsDatatable.new(user: user)
 = render_datatable(datatable)
+
+- if user.try(:cpd_audit_reviewer?)
+  %hr
+
+  %h2 Audit Reviews
+  - datatable = Admin::EffectiveCpdAuditReviewsDatatable.new(user: user)
+  = render_datatable(datatable)

data/app/views/admin/users/_form_cpd_audits.html.haml

@@ -0,0 +1,8 @@
+- if user.try(:cpd_audit_reviewer?)
+  %h2 Audit Reviews
+  - datatable = Admin::EffectiveCpdAuditReviewsDatatable.new(user: user)
+  = render_datatable(datatable)
+- else
+  %h2 Audits
+  - datatable = Admin::EffectiveCpdAuditsDatatable.new(user: user)
+  = render_datatable(datatable)

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

@@ -1,6 +1,6 @@
 .row
   .col-3
-    = render_wizard_sidebar(resource)
+    = render_wizard_sidebar(resource, path: effective_cpd.cpd_audit_review_build_path(resource))
 
     %table.table.mt-4
       %tbody
@@ -15,6 +15,13 @@
             %td
             %td
 
+    - if EffectiveCpd.use_effective_messaging?
+      .list-group
+        - if (controller.action_name == 'chat')
+          %a.active.list-group-item.list-group-item-action Chat
+        - else
+          %a.list-group-item.list-group-item-action{href: effective_cpd.chat_cpd_audit_review_path(resource)} Chat
+
   .col-9
     %h1= @page_title
 

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

@@ -0,0 +1,4 @@
+- # This isn't a wizard screen. It's a show view.
+
+= render('layout') do
+  = render(resource.cpd_audit.create_chat)

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

@@ -3,6 +3,7 @@
 
   - steps = cpd_audit.required_steps.select { |step| cpd_audit.has_completed_step?(step) }
   - blacklist = [:start, :information, :instructions, :waiting, :questionnaire, :submit, :submitted]
+  - blacklist += [:demographics] if cpd_audit.anonymous?
 
   - (steps - blacklist).each do |step|
     - cpd_audit.render_step = step

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

@@ -0,0 +1,3 @@
+= wizard_card(cpd_audit) do
+  - raise('demographics should not be displayed on anonymous audit') if cpd_audit.anonymous?
+  = render 'users/demographics', parent: cpd_audit, user: cpd_audit.user

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

@@ -16,7 +16,7 @@
 
         %tr
           %th Reason
-          %td= cpd_audit.exemption_request_reason
+          %td= cpd_audit.extension_request_reason
 
         %tr
           %th Status

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

@@ -1,9 +1,6 @@
 .row
   .col-3
-    = render_wizard_sidebar(resource)
-
-    - last_3_cycles = Effective::CpdCycle.sorted.where('start_at <= ?', Time.zone.now).last(3)
-    - last_3_scores = Effective::CpdStatement.where(cpd_cycle: last_3_cycles, user: resource.user).sum(&:score)
+    = render_wizard_sidebar(resource, path: effective_cpd.cpd_audit_build_path(resource))
 
     %table.table.mt-4
       %tbody
@@ -15,11 +12,26 @@
             %td
               = (Time.zone.now > resource.due_date) ? 'days overdue' : 'days left to submit'
 
+        - if resource.user_cpd_required?
+          - last_3_cycles = Effective::CpdCycle.sorted.where('start_at <= ?', Time.zone.now).last(3)
+          - last_3_statements = Effective::CpdStatement.where(cpd_cycle: last_3_cycles, user: resource.user)
+
+          %tr
+            %td
+              %h4= cpd_score(last_3_statements.sum(&:score).to_d)
+
+            %td #{cpd_credits_label} in last 3 #{cpd_cycles_label} (including this #{cpd_cycle_label})
+
         %tr
           %td
-            %h4= cpd_score(last_3_scores.to_d)
+          %td
 
-          %td #{cpd_credits_label} in last 3 #{cpd_cycles_label} (including this #{cpd_cycle_label})
+    - if EffectiveCpd.use_effective_messaging?
+      .list-group
+        - if (controller.action_name == 'chat')
+          %a.active.list-group-item.list-group-item-action Chat
+        - else
+          %a.list-group-item.list-group-item-action{href: effective_cpd.chat_cpd_audit_path(resource)} Chat
 
   .col-9
     %h1= @page_title

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

@@ -0,0 +1,4 @@
+- # This isn't a wizard screen. It's a show view.
+
+= render('layout') do
+  = render(resource.create_chat)

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

@@ -0,0 +1,9 @@
+= render('layout') do
+
+  = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+    = f.hidden_field :current_step
+
+    = f.fields_for(:user, f.object.user) do |fu|
+      = render 'users/fields_demographics', f: fu, user: f.object.user, parent: resource
+
+    = f.save 'Save and Continue'

data/app/views/users/_demographics.html.haml

@@ -0,0 +1,61 @@
+-# This is a placeholder file that should be overriden by the main application
+
+%p Placeholder
+
+%table.table.table-sm
+  %tbody
+    %tr
+      %th Name
+      %td= user.to_s
+
+    %tr
+      %th Email
+      %td= mail_to user.email
+
+    - if user.respond_to?(:job_title)
+      %tr
+        %th Job Title:
+        %td= user.job_title.presence || '-'
+
+    - if user.respond_to?(:date_of_birth)
+      %tr
+        %th Date of Birth
+        %td= user.date_of_birth&.strftime('%F').presence || '-'
+
+    - if user.respond_to?(:phone)
+      %tr
+        %th Phone:
+        %td= user.phone.presence || '-'
+
+    - if user.respond_to?(:home_phone)
+      %tr
+        %th Home Phone:
+        %td= user.home_phone.presence || '-'
+
+    - if user.respond_to?(:cell_phone)
+      %tr
+        %th Cell Phone:
+        %td= user.cell_phone.presence || '-'
+
+    - if user.respond_to?(:fax)
+      %tr
+        %th Fax:
+        %td= user.fax.presence || '-'
+
+    - if user.respond_to?(:residential_address)
+      %tr
+        %th Residential Address:
+        %td
+          - if user.residential_address.present?
+            = user.residential_address.to_html
+          - else
+            = '-'
+
+    - if user.respond_to?(:billing_address)
+      %tr
+        %th Billing Address:
+        %td
+          - if user.billing_address.present?
+            = user.billing_address.to_html
+          - else
+            = '-'

data/app/views/users/_fields_demographics.html.haml

@@ -0,0 +1,31 @@
+-# This is a placeholder file that should be overriden by the main application
+
+%p Placeholder
+
+- if f.object.respond_to?(:first_name)
+  = f.text_field :first_name
+
+- if f.object.respond_to?(:last_name)
+  = f.text_field :last_name
+
+- if f.object.respond_to?(:job_title)
+  = f.text_field :job_title
+
+- if f.object.respond_to?(:date_of_birth)
+  = f.date_field :date_of_birth
+
+- if f.object.respond_to?(:phone)
+  = f.tel_field :phone
+
+- if f.object.respond_to?(:home_phone)
+  = f.tel_field :home_phone
+
+- if f.object.respond_to?(:cell_phone)
+  = f.tel_field :cell_phone
+
+- if f.object.respond_to?(:fax)
+  = f.tel_field :fax
+
+- if f.object.respond_to?(:billing_address)
+  %h2 Billing Address
+  = effective_address_fields(f, :billing_address)

data/config/effective_cpd.rb

@@ -50,6 +50,10 @@ EffectiveCpd.setup do |config|
   # Audit Reviewer Scope Collection
   config.audit_reviewer_user_scope = :cpd_audit_reviewers
 
+  # Effective Messaging
+  # Show a chat for Cpd Audit and Cpd Audit Reviewers
+  config.use_effective_messaging = true
+
   # Mailer Settings
   # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
   #

data/config/routes.rb

@@ -18,11 +18,13 @@ EffectiveCpd::Engine.routes.draw do
 
     # Audits Auditee wizard
     resources :cpd_audits, only: [:new, :show] do
+      get :chat, on: :member
       resources :build, controller: :cpd_audits, only: [:show, :update]
     end
 
     # Audits Auditor / Audit Reviewer wizard
     resources :cpd_audit_reviews, only: [:new, :show] do
+      get :chat, on: :member
       resources :build, controller: :cpd_audit_reviews, only: [:show, :update]
     end
   end

data/lib/effective_cpd/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '1.1.0'
+  VERSION = '1.1.2'
 end

data/lib/effective_cpd.rb

@@ -15,6 +15,7 @@ module EffectiveCpd
       :cpd_audits_table_name, :cpd_audit_responses_table_name, :cpd_audit_response_options_table_name,
       :cpd_audit_reviews_table_name, :cpd_audit_review_items_table_name,
       :program_label, :cycle_label, :credit_label, :layout, :auditee_user_scope, :audit_reviewer_user_scope,
+      :use_effective_messaging,
       :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates,
       :cpd_statement_class_name, :cpd_audit_class_name, :cpd_audit_level_class_name, :cpd_audit_review_class_name
     ]
@@ -42,4 +43,8 @@ module EffectiveCpd
     cpd_audit_review_class_name&.constantize || Effective::CpdAuditReview
   end
 
+  def self.use_effective_messaging?
+    defined?(EffectiveMessaging) && !!use_effective_messaging
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_cpd
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_messaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Continuing professional development and audits rails engine
 email:
 - info@codeandeffect.com
@@ -251,6 +265,7 @@ files:
 - app/views/admin/cpd_audits/_audit_reviewer_fields.html.haml
 - app/views/admin/cpd_audits/_auditee_fields.html.haml
 - app/views/admin/cpd_audits/_form.html.haml
+- app/views/admin/cpd_audits/_form_chat.html.haml
 - app/views/admin/cpd_audits/_form_close.html.haml
 - app/views/admin/cpd_audits/_form_complete.html.haml
 - app/views/admin/cpd_audits/_form_conflict.html.haml
@@ -273,6 +288,7 @@ files:
 - app/views/admin/cpd_special_rules/_form.html.haml
 - app/views/admin/cpd_statements/_cpd_statement.html.haml
 - app/views/admin/users/_form_cpd.html.haml
+- app/views/admin/users/_form_cpd_audits.html.haml
 - app/views/effective/cpd/_dashboard.html.haml
 - app/views/effective/cpd_audit_level_questions/_cpd_audit_level_question.html.haml
 - app/views/effective/cpd_audit_responses/_cpd_audit_response.html.haml
@@ -314,6 +330,7 @@ files:
 - app/views/effective/cpd_audit_reviews/_layout.html.haml
 - app/views/effective/cpd_audit_reviews/_recommendation.html.haml
 - app/views/effective/cpd_audit_reviews/_summary.html.haml
+- app/views/effective/cpd_audit_reviews/chat.html.haml
 - app/views/effective/cpd_audit_reviews/conflict.html.haml
 - app/views/effective/cpd_audit_reviews/cpd_audit_level_section.html.haml
 - app/views/effective/cpd_audit_reviews/cpd_statement.html.haml
@@ -332,6 +349,7 @@ files:
 - app/views/effective/cpd_audits/_cpd.html.haml
 - app/views/effective/cpd_audits/_cpd_audit.html.haml
 - app/views/effective/cpd_audits/_cpd_audit_level_section.html.haml
+- app/views/effective/cpd_audits/_demographics.html.haml
 - app/views/effective/cpd_audits/_exemption.html.haml
 - app/views/effective/cpd_audits/_extension.html.haml
 - app/views/effective/cpd_audits/_files.html.haml
@@ -339,9 +357,11 @@ files:
 - app/views/effective/cpd_audits/_missing_info.html.haml
 - app/views/effective/cpd_audits/_summary.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
 - app/views/effective/cpd_audits/cpd.html.haml
 - app/views/effective/cpd_audits/cpd_audit_level_section.html.haml
+- app/views/effective/cpd_audits/demographics.html.haml
 - app/views/effective/cpd_audits/exemption.html.haml
 - app/views/effective/cpd_audits/extension.html.haml
 - app/views/effective/cpd_audits/files.html.haml
@@ -384,6 +404,8 @@ files:
 - app/views/effective/cpd_statements/complete.html.haml
 - app/views/effective/cpd_statements/start.html.haml
 - app/views/effective/cpd_statements/submit.html.haml
+- app/views/users/_demographics.html.haml
+- app/views/users/_fields_demographics.html.haml
 - config/effective_cpd.rb
 - config/routes.rb
 - db/migrate/01_create_effective_cpd.rb.erb