effective_cpd 0.5.4 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa9017248147c4af300594830ead405a65e2730a927643b17c4305e2b4bfed14
-  data.tar.gz: e7b981130d75f07009ab9e9230124a4fc8a7945d90d8762b372cdca52d76ecc0
+  metadata.gz: 2a95ee01fbfe7c486fd9ad091133538b2b8403c30783b0cb6a43b46f01c74ada
+  data.tar.gz: 2906c5e7b24e4cce48178461b8604f022f4a80b13eced676d5780f2ef193859e
 SHA512:
-  metadata.gz: 6e8dd1a783788c1a236b152758ebc10a67f2dcc3d6a3ea23e110400be6314b50a7774de677535fccdd57ef3612f08acfeadea3c475de35ff0c8ac2249b03dc00
-  data.tar.gz: 40c86b4159c7ed278fbbf4eeb2197b0b5d5c4e6333c6d06e644589c80ab3699d88eba75b9a07c2d37de79651441374b57a5d9dc8c8814b3f2f5ec157bbff6886
+  metadata.gz: 6c9ebe344d70ad88cada7edf2588cf3a1f3da7a180e28acfa3d383974611d117b7cba60ab3511339777736005489cc5c23cd6874455ea0b92a3c8ac6ac4249a0
+  data.tar.gz: fedf95f5ea68064701da0a05e573608c8547c4ad5d6a13b70ed6ebd7802d5ef8639aeaf538147dade3f281273212479f012e0716dc2d8264b2a72f2a9d55b00a

data/app/controllers/admin/cpd_statement_activities_controller.rb

@@ -5,6 +5,8 @@ module Admin
 
     include Effective::CrudController
 
+    page_title(only: :index) { "#{EffectiveCpd.program_label} Statement Activities" }
+
     # def permitted_params
     #   params.require(:effective_cpd_statement).permit!
     # end

data/app/controllers/admin/cpd_statements_controller.rb

@@ -5,9 +5,17 @@ module Admin
 
     include Effective::CrudController
 
-    # def permitted_params
-    #   params.require(:effective_cpd_statement).permit!
-    # end
+    resource_scope -> { EffectiveCpd.CpdStatement.deep.all }
+    datatable -> { Admin::EffectiveCpdStatementsDatatable.new }
+
+    page_title(only: :index) { "#{EffectiveCpd.program_label} Statements" }
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_cpd_statement) ? :effective_cpd_statement : :cpd_statement)
+      params.require(model).permit!
+    end
 
   end
 end

data/app/controllers/effective/cpd_cycles_controller.rb

@@ -7,7 +7,7 @@ module Effective
       cycle = Effective::CpdCycle.find(params[:id])
       EffectiveResources.authorize!(self, :show, cycle)
 
-      statement = Effective::CpdStatement.where(cpd_cycle: cycle, user: current_user).first
+      statement = EffectiveCpd.CpdStatement.where(cpd_cycle: cycle, user: current_user).first
 
       if statement.present?
         redirect_to effective_cpd.cpd_cycle_cpd_statement_build_path(cycle, statement, statement.next_step)

data/app/controllers/effective/cpd_statement_activities_controller.rb

@@ -4,7 +4,7 @@ module Effective
 
     include Effective::CrudController
 
-    resource_scope -> { CpdStatement.find(params[:cpd_statement_id]).cpd_statement_activities }
+    resource_scope -> { EffectiveCpd.CpdStatement.find(params[:cpd_statement_id]).cpd_statement_activities }
 
     # Score all statements when we change any activity
     after_save do

data/app/controllers/effective/cpd_statements_controller.rb

@@ -7,7 +7,7 @@ module Effective
 
     resource_scope do
       cycle = Effective::CpdCycle.find(params[:cpd_cycle_id])
-      Effective::CpdStatement.deep.where(cpd_cycle: cycle, user: current_user)
+      EffectiveCpd.CpdStatement.deep.where(cpd_cycle: cycle, user: current_user)
     end
 
     after_save(if: -> { step == :start }) do
@@ -16,8 +16,7 @@ module Effective
 
     # Enforce one statement per user per cycle. Redirect them to an existing statement for this cycle.
     before_action(only: [:new, :show]) do
-      cycle = Effective::CpdCycle.find(params[:cpd_cycle_id])
-      existing = Effective::CpdStatement.where(cpd_cycle: cycle, user: current_user).where.not(id: resource).first
+      existing = resource_scope.where.not(id: resource).first
 
       if existing.present?
         redirect_to effective_cpd.cpd_cycle_cpd_statement_build_path(existing.cpd_cycle, existing, existing.next_step)
@@ -44,17 +43,16 @@ module Effective
     end
 
     def permitted_params
+      model = (params.key?(:effective_cpd_statement) ? :effective_cpd_statement : :cpd_statement)
       case step
       when :start
-        params.require(:effective_cpd_statement).permit(:current_step)
+        params.require(model).permit(:current_step)
       when :activities
-        params.require(:effective_cpd_statement).permit(:current_step)
+        params.require(model).permit(:current_step)
       when :agreements
-        params.require(:effective_cpd_statement).permit(
-          :current_step, :confirm_read, :confirm_factual, files: []
-        )
+        params.require(model).permit(:current_step, :confirm_read, :confirm_factual, files: [])
       when :submit
-        params.require(:effective_cpd_statement).permit(:current_step, :confirm_readonly)
+        params.require(model).permit(:current_step, :confirm_readonly)
       when :complete
         raise('unexpected post to complete')
       else

data/app/datatables/admin/effective_cpd_statements_datatable.rb

@@ -36,7 +36,7 @@ module Admin
     end
 
     collection do
-      Effective::CpdStatement.all.deep
+      EffectiveCpd.CpdStatement.all.deep
     end
   end
 end

data/app/datatables/effective_cpd_available_cycles_datatable.rb

@@ -10,7 +10,7 @@ class EffectiveCpdAvailableCyclesDatatable < Effective::Datatable
     col :available_date, label: 'Available'
 
     col :required_score, label: 'Required' do |cpd_cycle|
-      cpd_statement = Effective::CpdStatement.new(cpd_cycle: cpd_cycle, user: current_user)
+      cpd_statement = EffectiveCpd.CpdStatement.new(cpd_cycle: cpd_cycle, user: current_user)
       cpd_score(cpd_statement.required_score || cpd_statement.targeted_score)
     end
 
@@ -27,7 +27,7 @@ class EffectiveCpdAvailableCyclesDatatable < Effective::Datatable
 
   collection do
     raise('expected a current_user') unless current_user.present?
-    completed = Effective::CpdStatement.completed.where(user: current_user)
+    completed = EffectiveCpd.CpdStatement.completed.where(user: current_user)
     Effective::CpdCycle.available.where.not(id: completed.select('cpd_cycle_id as id'))
   end
 

data/app/datatables/effective_cpd_completed_statements_datatable.rb

@@ -27,7 +27,8 @@ class EffectiveCpdCompletedStatementsDatatable < Effective::Datatable
   collection do
     raise('expected a current_user') unless current_user.present?
     user = (current_user.class.find(attributes[:user_id]) if attributes[:user_id])
-    Effective::CpdStatement.completed.where(user: user || current_user).includes(:cpd_cycle)
+
+    EffectiveCpd.CpdStatement.completed.where(user: user || current_user).includes(:cpd_cycle)
   end
 
 end

data/app/models/concerns/effective_cpd_statement.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# EffectiveCpdStatement
+#
+# Mark your owner model with effective_cpd_statement to get all the includes
+
+module EffectiveCpdStatement
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_cpd_statement
+      include ::EffectiveCpdStatement
+    end
+  end
+
+  module ClassMethods
+    def effective_cpd_statement?; true; end
+  end
+
+  included do
+    acts_as_tokened
+
+    acts_as_wizard(
+      start: 'Start',
+      activities: 'Enter Activities',
+      agreements: 'Sign Agreements',
+      submit: 'Confirm & Submit',
+      complete: 'Complete'
+    )
+
+    log_changes(except: :wizard_steps) if respond_to?(:log_changes)
+
+    has_many_attached :files
+
+    attr_accessor :current_user
+    attr_accessor :current_step
+
+    # App scoped
+    belongs_to :user, polymorphic: true
+
+    # Effective Namespace
+    belongs_to :cpd_cycle, class_name: 'Effective::CpdCycle'
+
+    has_many :cpd_statement_activities, -> { order(:id) }, inverse_of: :cpd_statement, dependent: :destroy, class_name: 'Effective::CpdStatementActivity'
+    accepts_nested_attributes_for :cpd_statement_activities
+
+    effective_resource do
+      score                   :integer
+
+      confirm_read            :boolean
+      confirm_factual         :boolean
+      confirm_readonly        :boolean
+
+      submitted_at            :datetime, permitted: false
+
+      # Acts as tokened
+      token                  :string, permitted: false
+
+      # Acts as Wizard
+      wizard_steps           :text, permitted: false
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:cpd_cycle, :user, cpd_statement_activities: [:files_attachments, :cpd_category, :original, cpd_activity: [:rich_text_body]]) }
+    scope :sorted, -> { order(:cpd_cycle_id) }
+
+    scope :draft, -> { where(submitted_at: nil) }
+    scope :completed, -> { where.not(submitted_at: nil) }
+
+    before_validation(if: -> { new_record? }) do
+      self.user ||= current_user
+      self.score ||= 0
+    end
+
+    validate(if: -> { completed? }) do
+      min = required_score() || 0.0
+      self.errors.add(:score, "must be #{min} or greater to submit a statement") if score < min
+    end
+
+    with_options(if: -> { current_step == :agreements }) do
+      validates :confirm_read, acceptance: true
+      validates :confirm_factual, acceptance: true
+    end
+
+    with_options(if: -> { current_step == :submit}) do
+      validates :confirm_readonly, acceptance: true
+    end
+  end
+
+  def to_s
+    cpd_cycle.present? ? "#{cpd_cycle} Statement" : 'statement'
+  end
+
+  def import!(date: nil)
+    date ||= Time.zone.now
+
+    wizard_steps[:start] ||= date
+    wizard_steps[:activities] ||= date
+    cpd_statement_activities.each { |activity| activity.importing = true }
+
+    save!
+  end
+
+  # This is the review step where they click Submit Ballot
+  def submit!
+    wizard_steps[:complete] ||= Time.zone.now
+
+    update!(submitted_at: Time.zone.now)
+  end
+
+  # Called by admin only. This is an exceptional action
+  def unsubmit!
+    update!(wizard_steps: {}, submitted_at: nil, confirm_readonly: nil)
+  end
+
+  def in_progress?
+    submitted_at.blank?
+  end
+
+  def completed?
+    submitted_at.present?
+  end
+  alias_method :submitted?, :completed?
+
+  def required_score
+    required_by_cycle = cpd_cycle&.required_score
+    required_by_user = user.cpd_statement_required_score(self) if user.respond_to?(:cpd_statement_required_score)
+
+    [required_by_cycle, required_by_user].compact.max
+  end
+
+  def targeted_score
+    targeted_by_cycle = cpd_cycle&.targeted_score
+    targeted_by_user = user.cpd_statement_targeted_score(self) if user.respond_to?(:cpd_statement_targeted_score)
+
+    [targeted_by_cycle, targeted_by_user].compact.max
+  end
+
+  def carry_forward
+    cpd_statement_activities.sum { |activity| activity.carry_forward || BigDecimal(0) }.to_d
+  end
+
+  # {category_id => 20, category_id => 15}
+  def score_per_category
+    @score_per_category ||= Hash.new(BigDecimal(0)).tap do |scores|
+      cpd_statement_activities.each { |activity| scores[activity.cpd_category_id] += activity.score.to_d }
+    end
+  end
+
+end

data/app/models/concerns/effective_cpd_user.rb

@@ -13,7 +13,10 @@ module EffectiveCpdUser
   end
 
   included do
-    has_many :cpd_statements, -> { Effective::CpdStatement.sorted }, inverse_of: :user, class_name: 'Effective::CpdStatement'
+    # App Scoped
+    has_many :cpd_statements, -> { order(:cpd_cycle_id) }, inverse_of: :user
+
+    # Effective
     has_many :cpd_audits, -> { Effective::CpdAudit.sorted }, inverse_of: :user, class_name: 'Effective::CpdAudit'
     has_many :cpd_audit_reviews, -> { Effective::CpdAuditReview.sorted }, inverse_of: :user, class_name: 'Effective::CpdAuditReview'
 

data/app/models/effective/cpd_scorer.rb

@@ -4,10 +4,10 @@ module Effective
 
     def initialize(user:, from: nil)
       @cycles = CpdCycle.deep.sorted.all
-      @statements = CpdStatement.deep.where(user: user).sorted.all
+      @statements = EffectiveCpd.CpdStatement.deep.where(user: user).sorted.all
 
       if from.present?
-        raise('expected from to be a CpdStatement') unless from.kind_of?(CpdStatement)
+        raise('expected from to be a CpdStatement') unless from.class.respond_to?(:effective_cpd_statement?)
         @statements = @statements.where('cpd_cycle_id >= ?', from.cpd_cycle_id)
       end
 
@@ -43,7 +43,7 @@ module Effective
     protected
 
     def save!
-      CpdStatement.transaction do
+      EffectiveCpd.CpdStatement.transaction do
         @statements.each { |statement| statement.save! }; true
       end
     end

data/app/models/effective/cpd_statement.rb

@@ -1,132 +1,5 @@
 module Effective
   class CpdStatement < ActiveRecord::Base
-    attr_accessor :current_user
-    attr_accessor :current_step
-
-    belongs_to :cpd_cycle
-    belongs_to :user, polymorphic: true
-
-    has_many :cpd_statement_activities, -> { order(:id) }, inverse_of: :cpd_statement, dependent: :destroy
-    accepts_nested_attributes_for :cpd_statement_activities
-
-    has_many_attached :files
-
-    if respond_to?(:log_changes)
-      log_changes(except: [:wizard_steps])
-    end
-
-    acts_as_tokened
-
-    acts_as_wizard(
-      start: 'Start',
-      activities: 'Enter Activities',
-      agreements: 'Sign Agreements',
-      submit: 'Confirm & Submit',
-      complete: 'Complete'
-    )
-
-    effective_resource do
-      score                   :integer
-
-      confirm_read            :boolean
-      confirm_factual         :boolean
-      confirm_readonly        :boolean
-
-      submitted_at            :datetime, permitted: false
-
-      # Acts as tokened
-      token                  :string, permitted: false
-
-      # Acts as Wizard
-      wizard_steps           :text, permitted: false
-
-      timestamps
-    end
-
-    scope :deep, -> { includes(:cpd_cycle, :user, cpd_statement_activities: [:files_attachments, :cpd_category, :original, cpd_activity: [:rich_text_body]]) }
-    scope :sorted, -> { order(:cpd_cycle_id) }
-
-    scope :draft, -> { where(submitted_at: nil) }
-    scope :completed, -> { where.not(submitted_at: nil) }
-
-    before_validation(if: -> { new_record? }) do
-      self.user ||= current_user
-      self.score ||= 0
-    end
-
-    validate(if: -> { completed? }) do
-      min = required_score() || 0.0
-      self.errors.add(:score, "must be #{min} or greater to submit a statement") if score < min
-    end
-
-    with_options(if: -> { current_step == :agreements }) do
-      validates :confirm_read, acceptance: true
-      validates :confirm_factual, acceptance: true
-    end
-
-    with_options(if: -> { current_step == :submit}) do
-      validates :confirm_readonly, acceptance: true
-    end
-
-    def to_s
-      cpd_cycle.present? ? "#{cpd_cycle} Statement" : 'statement'
-    end
-
-    def import!(date: nil)
-      date ||= Time.zone.now
-
-      wizard_steps[:start] ||= date
-      wizard_steps[:activities] ||= date
-      cpd_statement_activities.each { |activity| activity.importing = true }
-
-      save!
-    end
-
-    # This is the review step where they click Submit Ballot
-    def submit!
-      wizard_steps[:complete] ||= Time.zone.now
-
-      update!(submitted_at: Time.zone.now)
-    end
-
-    # Called by admin only. This is an exceptional action
-    def unsubmit!
-      update!(wizard_steps: {}, submitted_at: nil, confirm_readonly: nil)
-    end
-
-    def in_progress?
-      submitted_at.blank?
-    end
-
-    def completed?
-      submitted_at.present?
-    end
-    alias_method :submitted?, :completed?
-
-    def required_score
-      required_by_cycle = cpd_cycle&.required_score
-      required_by_user = user.cpd_statement_required_score(self) if user.respond_to?(:cpd_statement_required_score)
-
-      [required_by_cycle, required_by_user].compact.max
-    end
-
-    def targeted_score
-      targeted_by_cycle = cpd_cycle&.targeted_score
-      targeted_by_user = user.cpd_statement_targeted_score(self) if user.respond_to?(:cpd_statement_targeted_score)
-
-      [targeted_by_cycle, targeted_by_user].compact.max
-    end
-
-    def carry_forward
-      cpd_statement_activities.sum { |activity| activity.carry_forward || BigDecimal(0) }.to_d
-    end
-
-    # {category_id => 20, category_id => 15}
-    def score_per_category
-      @score_per_category ||= Hash.new(BigDecimal(0)).tap do |scores|
-        cpd_statement_activities.each { |activity| scores[activity.cpd_category_id] += activity.score.to_d }
-      end
-    end
-
+    effective_cpd_statement
   end
 end

data/app/models/effective/cpd_statement_activity.rb

@@ -11,7 +11,7 @@ module Effective
     belongs_to :cpd_cycle
     belongs_to :user, polymorphic: true
 
-    belongs_to :original, class_name: 'CpdStatementActivity', optional: true # If this is a Carryover, the original_statement_activity will be set.
+    belongs_to :original, class_name: 'Effective::CpdStatementActivity', optional: true # If this is a Carryover, the original_statement_activity will be set.
     #has_many :carried, class_name: 'CpdStatementActivity', foreign_key: 'original_id', dependent: :delete_all
 
     has_many_attached :files
@@ -41,8 +41,8 @@ module Effective
     scope :deep, -> { includes(:cpd_statement, :cpd_category, :cpd_activity, :original) }
     scope :sorted, -> { order(:id) }
 
-    scope :draft, -> { where(cpd_statement_id: CpdStatement.draft) }
-    scope :completed, -> { where(cpd_statement_id: CpdStatement.completed) }
+    scope :draft, -> { where(cpd_statement_id: EffectiveCpd.CpdStatement.draft) }
+    scope :completed, -> { where(cpd_statement_id: EffectiveCpd.CpdStatement.completed) }
 
     validates :original, presence: true, if: -> { (carry_over || 0) > 0 }
     validates :description, presence: true

data/app/views/effective/cpd_statements/complete.html.haml

@@ -1,13 +1,20 @@
 = render('layout') do
   %h1= resource.cpd_cycle
 
+  - raise('expected a submitted cpd_statement') unless resource.submitted_at.present?
+
+  .alert.alert-warning.mb-4
+    Successfully submitted on #{resource.submitted_at.strftime('%F')}.
+
   - if resource.cpd_cycle.all_steps_content.present?
     .mb-2= resource.cpd_cycle.all_steps_content.to_s
 
   - if resource.cpd_cycle.complete_content.present?
     .mb-2= resource.cpd_cycle.complete_content.to_s
 
-  = render(resource)
+  = link_to "Return to Dashboard", root_path, class: 'btn btn-lg btn-primary mb-4'
+
+  = render('effective/cpd_statements/cpd_statement', cpd_statement: resource)
 
   %hr
-  .text-center= link_to 'Home', root_url, class: 'btn btn-primary'
+  = link_to "Return to Dashboard", root_path, class: 'btn btn-lg btn-primary'

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

@@ -7,7 +7,7 @@
   - if resource.cpd_cycle.submit_content.present?
     .mb-2= resource.cpd_cycle.submit_content.to_s
 
-  = render(resource)
+  = render('effective/cpd_statements/cpd_statement', cpd_statement: resource)
 
   %p= link_to 'Change Activities', wizard_path(:activities)
 

data/config/effective_cpd.rb

@@ -29,7 +29,12 @@ EffectiveCpd.setup do |config|
     admin: 'admin'
   }
 
+  # CPD Class Settings
+  # Configure the class responsible for the cpd statements.
+  # config.cpd_statement_class_name = 'Effective::CpdStatement'
+
   # Program label settings
+  config.program_label = 'CPD'      # CPD or MCE
   config.cycle_label = 'year'       # 'cycle', 'season'
   config.credit_label = 'credit'    # 'credit', 'PDH', 'PDU', 'CCC'
 

data/lib/effective_cpd/engine.rb

@@ -11,6 +11,7 @@ module EffectiveCpd
     initializer 'effective_cpd.active_record' do |app|
       ActiveSupport.on_load :active_record do
         ActiveRecord::Base.extend(EffectiveCpdUser::Base)
+        ActiveRecord::Base.extend(EffectiveCpdStatement::Base)
       end
     end
 

data/lib/effective_cpd/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '0.5.4'
+  VERSION = '0.6.1'
 end

data/lib/effective_cpd.rb

@@ -14,8 +14,9 @@ module EffectiveCpd
       :cpd_audit_level_questions_table_name, :cpd_audit_level_question_options_table_name,
       :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,
-      :cycle_label, :credit_label, :layout, :auditee_user_scope, :audit_reviewer_user_scope,
-      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates
+      :program_label, :cycle_label, :credit_label, :layout, :auditee_user_scope, :audit_reviewer_user_scope,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates,
+      :cpd_statement_class_name
     ]
   end
 
@@ -25,4 +26,8 @@ module EffectiveCpd
     mailer&.constantize || Effective::CpdMailer
   end
 
+  def self.CpdStatement
+    cpd_statement_class_name&.constantize || Effective::CpdStatement
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_cpd
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -216,6 +216,7 @@ files:
 - app/helpers/effective_cpd_audits_helper.rb
 - app/helpers/effective_cpd_helper.rb
 - app/mailers/effective/cpd_mailer.rb
+- app/models/concerns/effective_cpd_statement.rb
 - app/models/concerns/effective_cpd_user.rb
 - app/models/effective/cpd_activity.rb
 - app/models/effective/cpd_audit.rb